binutils-gdb/gdb
Maciej W. Rozycki 3e29f34a4e MIPS: Keep the ISA bit in compressed code addresses
1. Background information

The MIPS architecture, as originally designed and implemented in
mid-1980s has a uniform instruction word size that is 4 bytes, naturally
aligned.  As such all MIPS instructions are located at addresses that
have their bits #1 and #0 set to zeroes, and any attempt to execute an
instruction from an address that has any of the two bits set to one
causes an address error exception.  This may for example happen when a
jump-register instruction is executed whose register value used as the
jump target has any of these bits set.

Then in mid 1990s LSI sought a way to improve code density for their
TinyRISC family of MIPS cores and invented an alternatively encoded
instruction set in a joint effort with MIPS Technologies (then a
subsidiary of SGI).  The new instruction set has been named the MIPS16
ASE (Application-Specific Extension) and uses a variable instruction
word size, which is 2 bytes (as the name of the ASE suggests) for most,
but there are a couple of exceptions that take 4 bytes, and then most of
the 2-byte instructions can be treated with a 2-byte extension prefix to
expand the range of the immediate operands used.

As a result instructions are no longer 4-byte aligned, instead they are
aligned to a multiple of 2.  That left the bit #0 still unused for code
references, be it for the standard MIPS (i.e. as originally invented) or
for the MIPS16 instruction set, and based on that observation a clever
trick was invented that on one hand allowed the processor to be
seamlessly switched between the two instruction sets at any time at the
run time while on the other avoided the introduction of any special
control register to do that.

So it is the bit #0 of the instruction address that was chosen as the
selector and named the ISA bit.  Any instruction executed at an even
address is interpreted as a standard MIPS instruction (the address still
has to have its bit #1 clear), any instruction executed at an odd
address is interpreted as a MIPS16 instruction.

To switch between modes ordinary jump instructions are used, such as
used for function calls and returns, specifically the bit #0 of the
source register used in jump-register instructions selects the execution
(ISA) mode for the following piece of code to be interpreted in.
Additionally new jump-immediate instructions were added that flipped the
ISA bit to select the opposite mode upon execution.  They were
considered necessary to avoid the need to make register jumps in all
cases as the original jump-immediate instructions provided no way to
change the bit #0 at all.

This was all important for cases where standard MIPS and MIPS16 code had
to be mixed, either for compatibility with the existing binary code base
or to access resources not reachable from MIPS16 code (the MIPS16
instruction set only provides access to general-purpose registers, and
not for example floating-point unit registers or privileged coprocessor
0 registers) -- pieces of code in the opposite mode can be executed as
ordinary subroutine calls.

A similar approach has been more recently adopted for the MIPS16
replacement instruction set defined as the so called microMIPS ASE.
This is another instruction set encoding introduced to the MIPS
architecture.  Just like the MIPS16 ASE, the microMIPS instruction set
uses a variable-length encoding, where each instruction takes a multiple
of 2 bytes.  The ISA bit has been reused and for microMIPS-capable
processors selects between the standard MIPS and the microMIPS mode
instead.

2. Statement of the problem

To put it shortly, MIPS16 and microMIPS code pointers used by GDB are
different to these observed at the run time.  This results in the same
expressions being evaluated producing different results in GDB and in
the program being debugged.  Obviously it's the results obtained at the
run time that are correct (they define how the program behaves) and
therefore by definition the results obtained in GDB are incorrect.

A bit longer description will record that obviously at the run time the
ISA bit has to be set correctly (refer to background information above
if unsure why so) or the program will not run as expected.  This is
recorded in all the executable file structures used at the run time: the
dynamic symbol table (but not always the static one!), the GOT, and
obviously in all the addresses embedded in code or data of the program
itself, calculated by applying the appropriate relocations at the static
link time.

While a program is being processed by GDB, the ISA bit is stripped off
from any code addresses, presumably to make them the same as the
respective raw memory byte address used by the processor to access the
instruction in the instruction fetch access cycle.  This stripping is
actually performed outside GDB proper, in BFD, specifically
_bfd_mips_elf_symbol_processing (elfxx-mips.c, see the piece of code at
the very bottom of that function, starting with an: "If this is an
odd-valued function symbol, assume it's a MIPS16 or microMIPS one."
comment).

This function is also responsible for symbol table dumps made by
`objdump' too, so you'll never see the ISA bit reported there by that
tool, you need to use `readelf'.

This is however unlike what is ever done at the run time, the ISA bit
once present is never stripped off, for example a cast like this:

(short *) main

will not strip the ISA bit off and if the resulting pointer is intended
to be used to access instructions as data, for example for software
instruction decoding (like for fault recovery or emulation in a signal
handler) or for self-modifying code then the bit still has to be
stripped off by an explicit AND operation.

This is probably best illustrated with a simple real program example.
Let's consider the following simple program:

$ cat foobar.c
int __attribute__ ((mips16)) foo (void)
{
  return 1;
}

int __attribute__ ((mips16)) bar (void)
{
  return 2;
}

int __attribute__ ((nomips16)) foo32 (void)
{
  return 3;
}

int (*foo32p) (void) = foo32;
int (*foop) (void) = foo;
int fooi = (int) foo;

int
main (void)
{
  return foop ();
}
$

This is plain C with no odd tricks, except from the instruction mode
attributes.  They are not necessary to trigger this problem, I just put
them here so that the program can be contained in a single source file
and to make it obvious which function is MIPS16 code and which is not.

Let's try it with Linux, so that everyone can repeat this experiment:

$ mips-linux-gnu-gcc -mips16 -g -O2 -o foobar foobar.c
$

Let's have a look at some interesting symbols:

$ mips-linux-gnu-readelf -s foobar | egrep 'table|foo|bar'
Symbol table '.dynsym' contains 7 entries:
Symbol table '.symtab' contains 95 entries:
    55: 00000000     0 FILE    LOCAL  DEFAULT  ABS foobar.c
    66: 0040068c     4 FUNC    GLOBAL DEFAULT [MIPS16]    12 bar
    68: 00410848     4 OBJECT  GLOBAL DEFAULT   21 foo32p
    70: 00410844     4 OBJECT  GLOBAL DEFAULT   21 foop
    78: 00400684     8 FUNC    GLOBAL DEFAULT   12 foo32
    80: 00400680     4 FUNC    GLOBAL DEFAULT [MIPS16]    12 foo
    88: 00410840     4 OBJECT  GLOBAL DEFAULT   21 fooi
$

Hmm, no sight of the ISA bit, but notice how foo and bar (but not
foo32!) have been marked as MIPS16 functions (ELF symbol structure's
`st_other' field is used for that).

So let's try to run and poke at this program with GDB.  I'll be using a
native system for simplicity (I'll be using ellipses here and there to
remove unrelated clutter):

$ ./foobar
$ echo $?
1
$

So far, so good.

$ gdb ./foobar
[...]
(gdb) break main
Breakpoint 1 at 0x400490: file foobar.c, line 23.
(gdb) run
Starting program: .../foobar

Breakpoint 1, main () at foobar.c:23
23        return foop ();
(gdb)

Yay, it worked!  OK, so let's poke at it:

(gdb) print main
$1 = {int (void)} 0x400490 <main>
(gdb) print foo32
$2 = {int (void)} 0x400684 <foo32>
(gdb) print foo32p
$3 = (int (*)(void)) 0x400684 <foo32>
(gdb) print bar
$4 = {int (void)} 0x40068c <bar>
(gdb) print foo
$5 = {int (void)} 0x400680 <foo>
(gdb) print foop
$6 = (int (*)(void)) 0x400681 <foo>
(gdb)

A-ha!  Here's the difference and finally the ISA bit!

(gdb) print /x fooi
$7 = 0x400681
(gdb) p/x $pc
p/x $pc
$8 = 0x400491
(gdb)

And here as well...

(gdb) advance foo
foo () at foobar.c:4
4       }
(gdb) disassemble
Dump of assembler code for function foo:
   0x00400680 <+0>:     jr      ra
   0x00400682 <+2>:     li      v0,1
End of assembler dump.
(gdb) finish
Run till exit from #0  foo () at foobar.c:4
main () at foobar.c:24
24      }
Value returned is $9 = 1
(gdb) continue
Continuing.
[Inferior 1 (process 14103) exited with code 01]
(gdb)

So let's be a bit inquisitive...

(gdb) run
Starting program: .../foobar

Breakpoint 1, main () at foobar.c:23
23        return foop ();
(gdb)

Actually we do not like to run foo here at all.  Let's run bar instead!

(gdb) set foop = bar
(gdb) print foop
$10 = (int (*)(void)) 0x40068c <bar>
(gdb)

Hmm, no ISA bit.  Is it going to work?

(gdb) advance bar
bar () at foobar.c:9
9       }
(gdb) p/x $pc
$11 = 0x40068c
(gdb) disassemble
Dump of assembler code for function bar:
=> 0x0040068c <+0>:     jr      ra
   0x0040068e <+2>:     li      v0,2
End of assembler dump.
(gdb) finish
Run till exit from #0  bar () at foobar.c:9

Program received signal SIGILL, Illegal instruction.
bar () at foobar.c:9
9       }
(gdb)

Oops!

(gdb) p/x $pc
$12 = 0x40068c
(gdb)

We're still there!

(gdb) continue
Continuing.

Program terminated with signal SIGILL, Illegal instruction.
The program no longer exists.
(gdb)

So let's try something else:

(gdb) run
Starting program: .../foobar

Breakpoint 1, main () at foobar.c:23
23        return foop ();
(gdb) set foop = foo
(gdb) advance foo
foo () at foobar.c:4
4       }
(gdb) disassemble
Dump of assembler code for function foo:
=> 0x00400680 <+0>:     jr      ra
   0x00400682 <+2>:     li      v0,1
End of assembler dump.
(gdb) finish
Run till exit from #0  foo () at foobar.c:4

Program received signal SIGILL, Illegal instruction.
foo () at foobar.c:4
4       }
(gdb) continue
Continuing.

Program terminated with signal SIGILL, Illegal instruction.
The program no longer exists.
(gdb)

The same problem!

(gdb) run
Starting program:
/net/build2-lucid-cs/scratch/macro/mips-linux-fsf-gcc/isa-bit/foobar

Breakpoint 1, main () at foobar.c:23
23        return foop ();
(gdb) set foop = foo32
(gdb) advance foo32
foo32 () at foobar.c:14
14      }
(gdb) disassemble
Dump of assembler code for function foo32:
=> 0x00400684 <+0>:     jr      ra
   0x00400688 <+4>:     li      v0,3
End of assembler dump.
(gdb) finish
Run till exit from #0  foo32 () at foobar.c:14
main () at foobar.c:24
24      }
Value returned is $14 = 3
(gdb) continue
Continuing.
[Inferior 1 (process 14113) exited with code 03]
(gdb)

That did work though, so it's the ISA bit only!

(gdb) quit

Enough!

That's the tip of the iceberg only though.  So let's rebuild the
executable with some dynamic symbols:

$ mips-linux-gnu-gcc -mips16 -Wl,--export-dynamic -g -O2 -o foobar-dyn foobar.c
$ mips-linux-gnu-readelf -s foobar-dyn | egrep 'table|foo|bar'
Symbol table '.dynsym' contains 32 entries:
     6: 004009cd     4 FUNC    GLOBAL DEFAULT   12 bar
     8: 00410b88     4 OBJECT  GLOBAL DEFAULT   21 foo32p
     9: 00410b84     4 OBJECT  GLOBAL DEFAULT   21 foop
    15: 004009c4     8 FUNC    GLOBAL DEFAULT   12 foo32
    17: 004009c1     4 FUNC    GLOBAL DEFAULT   12 foo
    25: 00410b80     4 OBJECT  GLOBAL DEFAULT   21 fooi
Symbol table '.symtab' contains 95 entries:
    55: 00000000     0 FILE    LOCAL  DEFAULT  ABS foobar.c
    69: 004009cd     4 FUNC    GLOBAL DEFAULT   12 bar
    71: 00410b88     4 OBJECT  GLOBAL DEFAULT   21 foo32p
    72: 00410b84     4 OBJECT  GLOBAL DEFAULT   21 foop
    79: 004009c4     8 FUNC    GLOBAL DEFAULT   12 foo32
    81: 004009c1     4 FUNC    GLOBAL DEFAULT   12 foo
    89: 00410b80     4 OBJECT  GLOBAL DEFAULT   21 fooi
$

OK, now the ISA bit is there for a change, but the MIPS16 `st_other'
attribute gone, hmm...  What does `objdump' do then:

$ mips-linux-gnu-objdump -Tt foobar-dyn | egrep 'SYMBOL|foo|bar'
foobar-dyn:     file format elf32-tradbigmips
SYMBOL TABLE:
00000000 l    df *ABS*  00000000              foobar.c
004009cc g     F .text  00000004              0xf0 bar
00410b88 g     O .data  00000004              foo32p
00410b84 g     O .data  00000004              foop
004009c4 g     F .text  00000008              foo32
004009c0 g     F .text  00000004              0xf0 foo
00410b80 g     O .data  00000004              fooi
DYNAMIC SYMBOL TABLE:
004009cc g    DF .text  00000004  Base        0xf0 bar
00410b88 g    DO .data  00000004  Base        foo32p
00410b84 g    DO .data  00000004  Base        foop
004009c4 g    DF .text  00000008  Base        foo32
004009c0 g    DF .text  00000004  Base        0xf0 foo
00410b80 g    DO .data  00000004  Base        fooi
$

Hmm, the attribute (0xf0, printed raw) is back, and the ISA bit gone
again.

Let's have a look at some DWARF-2 records GDB uses (I'll be stripping
off a lot here for brevity) -- debug info:

$ mips-linux-gnu-readelf -wi foobar
Contents of the .debug_info section:
[...]
  Compilation Unit @ offset 0x88:
   Length:        0xbb (32-bit)
   Version:       4
   Abbrev Offset: 62
   Pointer Size:  4
 <0><93>: Abbrev Number: 1 (DW_TAG_compile_unit)
    <94>   DW_AT_producer    : (indirect string, offset: 0x19e): GNU C 4.8.0 20120513 (experimental) -meb -mips16 -march=mips32r2 -mhard-float -mllsc -mplt -mno-synci -mno-shared -mabi=32 -g -O2
    <98>   DW_AT_language    : 1        (ANSI C)
    <99>   DW_AT_name        : (indirect string, offset: 0x190): foobar.c
    <9d>   DW_AT_comp_dir    : (indirect string, offset: 0x225): [...]
    <a1>   DW_AT_ranges      : 0x0
    <a5>   DW_AT_low_pc      : 0x0
    <a9>   DW_AT_stmt_list   : 0x27
 <1><ad>: Abbrev Number: 2 (DW_TAG_subprogram)
    <ae>   DW_AT_external    : 1
    <ae>   DW_AT_name        : foo
    <b2>   DW_AT_decl_file   : 1
    <b3>   DW_AT_decl_line   : 1
    <b4>   DW_AT_prototyped  : 1
    <b4>   DW_AT_type        : <0xc2>
    <b8>   DW_AT_low_pc      : 0x400680
    <bc>   DW_AT_high_pc     : 0x400684
    <c0>   DW_AT_frame_base  : 1 byte block: 9c         (DW_OP_call_frame_cfa)
    <c2>   DW_AT_GNU_all_call_sites: 1
 <1><c2>: Abbrev Number: 3 (DW_TAG_base_type)
    <c3>   DW_AT_byte_size   : 4
    <c4>   DW_AT_encoding    : 5        (signed)
    <c5>   DW_AT_name        : int
 <1><c9>: Abbrev Number: 4 (DW_TAG_subprogram)
    <ca>   DW_AT_external    : 1
    <ca>   DW_AT_name        : (indirect string, offset: 0x18a): foo32
    <ce>   DW_AT_decl_file   : 1
    <cf>   DW_AT_decl_line   : 11
    <d0>   DW_AT_prototyped  : 1
    <d0>   DW_AT_type        : <0xc2>
    <d4>   DW_AT_low_pc      : 0x400684
    <d8>   DW_AT_high_pc     : 0x40068c
    <dc>   DW_AT_frame_base  : 1 byte block: 9c         (DW_OP_call_frame_cfa)
    <de>   DW_AT_GNU_all_call_sites: 1
 <1><de>: Abbrev Number: 2 (DW_TAG_subprogram)
    <df>   DW_AT_external    : 1
    <df>   DW_AT_name        : bar
    <e3>   DW_AT_decl_file   : 1
    <e4>   DW_AT_decl_line   : 6
    <e5>   DW_AT_prototyped  : 1
    <e5>   DW_AT_type        : <0xc2>
    <e9>   DW_AT_low_pc      : 0x40068c
    <ed>   DW_AT_high_pc     : 0x400690
    <f1>   DW_AT_frame_base  : 1 byte block: 9c         (DW_OP_call_frame_cfa)
    <f3>   DW_AT_GNU_all_call_sites: 1
 <1><f3>: Abbrev Number: 5 (DW_TAG_subprogram)
    <f4>   DW_AT_external    : 1
    <f4>   DW_AT_name        : (indirect string, offset: 0x199): main
    <f8>   DW_AT_decl_file   : 1
    <f9>   DW_AT_decl_line   : 21
    <fa>   DW_AT_prototyped  : 1
    <fa>   DW_AT_type        : <0xc2>
    <fe>   DW_AT_low_pc      : 0x400490
    <102>   DW_AT_high_pc     : 0x4004a4
    <106>   DW_AT_frame_base  : 1 byte block: 9c        (DW_OP_call_frame_cfa)
    <108>   DW_AT_GNU_all_tail_call_sites: 1
[...]
$

-- no sign of the ISA bit anywhere -- frame info:

$ mips-linux-gnu-readelf -wf foobar
[...]
Contents of the .debug_frame section:

00000000 0000000c ffffffff CIE
  Version:               1
  Augmentation:          ""
  Code alignment factor: 1
  Data alignment factor: -4
  Return address column: 31

  DW_CFA_def_cfa_register: r29
  DW_CFA_nop

00000010 0000000c 00000000 FDE cie=00000000 pc=00400680..00400684

00000020 0000000c 00000000 FDE cie=00000000 pc=00400684..0040068c

00000030 0000000c 00000000 FDE cie=00000000 pc=0040068c..00400690

00000040 00000018 00000000 FDE cie=00000000 pc=00400490..004004a4
  DW_CFA_advance_loc: 6 to 00400496
  DW_CFA_def_cfa_offset: 32
  DW_CFA_offset: r31 at cfa-4
  DW_CFA_advance_loc: 6 to 0040049c
  DW_CFA_restore: r31
  DW_CFA_def_cfa_offset: 0
  DW_CFA_nop
  DW_CFA_nop
  DW_CFA_nop
[...]
$

-- no sign of the ISA bit anywhere -- range info (GDB doesn't use arange):

$ mips-linux-gnu-readelf -wR foobar
Contents of the .debug_ranges section:

    Offset   Begin    End
    00000000 00400680 00400690
    00000000 00400490 004004a4
    00000000 <End of list>

$

-- no sign of the ISA bit anywhere -- line info:

$ mips-linux-gnu-readelf -wl foobar
Raw dump of debug contents of section .debug_line:
[...]
  Offset:                      0x27
  Length:                      78
  DWARF Version:               2
  Prologue Length:             31
  Minimum Instruction Length:  1
  Initial value of 'is_stmt':  1
  Line Base:                   -5
  Line Range:                  14
  Opcode Base:                 13

 Opcodes:
  Opcode 1 has 0 args
  Opcode 2 has 1 args
  Opcode 3 has 1 args
  Opcode 4 has 1 args
  Opcode 5 has 1 args
  Opcode 6 has 0 args
  Opcode 7 has 0 args
  Opcode 8 has 0 args
  Opcode 9 has 1 args
  Opcode 10 has 0 args
  Opcode 11 has 0 args
  Opcode 12 has 1 args

 The Directory Table is empty.

 The File Name Table:
  Entry Dir     Time    Size    Name
  1     0       0       0       foobar.c

 Line Number Statements:
  Extended opcode 2: set Address to 0x400681
  Special opcode 6: advance Address by 0 to 0x400681 and Line by 1 to 2
  Special opcode 7: advance Address by 0 to 0x400681 and Line by 2 to 4
  Special opcode 55: advance Address by 3 to 0x400684 and Line by 8 to 12
  Special opcode 7: advance Address by 0 to 0x400684 and Line by 2 to 14
  Advance Line by -7 to 7
  Special opcode 131: advance Address by 9 to 0x40068d and Line by 0 to 7
  Special opcode 7: advance Address by 0 to 0x40068d and Line by 2 to 9
  Advance PC by 3 to 0x400690
  Extended opcode 1: End of Sequence

  Extended opcode 2: set Address to 0x400491
  Advance Line by 21 to 22
  Copy
  Special opcode 6: advance Address by 0 to 0x400491 and Line by 1 to 23
  Special opcode 60: advance Address by 4 to 0x400495 and Line by -1 to 22
  Special opcode 34: advance Address by 2 to 0x400497 and Line by 1 to 23
  Special opcode 62: advance Address by 4 to 0x40049b and Line by 1 to 24
  Special opcode 32: advance Address by 2 to 0x40049d and Line by -1 to 23
  Special opcode 6: advance Address by 0 to 0x40049d and Line by 1 to 24
  Advance PC by 7 to 0x4004a4
  Extended opcode 1: End of Sequence
[...]

-- a-ha, the ISA bit is there!  However it's not always right for some
reason, I don't have a small test case to show it, but here's an excerpt
from MIPS16 libc, a prologue of a function:

00019630 <__libc_init_first>:
   19630:       e8a0            jrc     ra
   19632:       6500            nop

00019634 <_init>:
   19634:       f000 6a11       li      v0,17
   19638:       f7d8 0b08       la      v1,15e00 <_DYNAMIC+0x15c54>
   1963c:       f400 3240       sll     v0,16
   19640:       e269            addu    v0,v1
   19642:       659a            move    gp,v0
   19644:       64f6            save    48,ra,s0-s1
   19646:       671c            move    s0,gp
   19648:       d204            sw      v0,16(sp)
   1964a:       f352 984c       lw      v0,-27828(s0)
   1964e:       6724            move    s1,a0

and the corresponding DWARF-2 line info:

 Line Number Statements:
  Extended opcode 2: set Address to 0x19631
  Advance Line by 44 to 45
  Copy
  Special opcode 8: advance Address by 0 to 0x19631 and Line by 3 to 48
  Special opcode 66: advance Address by 4 to 0x19635 and Line by 5 to 53
  Advance PC by constant 17 to 0x19646
  Special opcode 25: advance Address by 1 to 0x19647 and Line by 6 to 59
  Advance Line by -6 to 53
  Special opcode 33: advance Address by 2 to 0x19649 and Line by 0 to 53
  Special opcode 39: advance Address by 2 to 0x1964b and Line by 6 to 59
  Advance Line by -6 to 53
  Special opcode 61: advance Address by 4 to 0x1964f and Line by 0 to 53

-- see that "Advance PC by constant 17" there?  It clears the ISA bit,
however code at 0x19646 is not standard MIPS code at all.  For some
reason the constant is always 17, I've never seen DW_LNS_const_add_pc
used with any other value -- is that a binutils bug or what?

3. Solution:

I think we should retain the value of the ISA bit in code references,
that is effectively treat them as cookies as they indeed are (although
trivially calculated) rather than raw memory byte addresses.

In a perfect world both the static symbol table and the respective
DWARF-2 records should be fixed to include the ISA bit in all the cases.
I think however that this is infeasible.

All the uses of `_bfd_mips_elf_symbol_processing' can not necessarily be
tracked down.  This function is used by `elf_slurp_symbol_table' that in
turn is used by `bfd_canonicalize_symtab' and
`bfd_canonicalize_dynamic_symtab', which are public interfaces.

Similarly DWARF-2 records are used outside GDB, one notable if a bit
questionable is the exception unwinder (libgcc/unwind-dw2.c) -- I have
identified at least bits in `execute_cfa_program' and
`uw_frame_state_for', both around the calls to `_Unwind_IsSignalFrame',
that would need an update as they effectively flip the ISA bit freely;
see also the comment about MASK_RETURN_ADDR in gcc/config/mips/mips.h.
But there may be more places.  Any change in how DWARF-2 records are
produced would require an update there and would cause compatibility
problems with libgcc.a binaries already distributed; given that this is
a static library a complex change involving function renames would
likely be required.

I propose therefore to accept the existing inconsistencies and deal with
them entirely within GDB.  I have figured out that the ISA bit lost in
various places can still be recovered as long as we have symbol
information -- that'll have the `st_other' attribute correctly set to
one of standard MIPS/MIPS16/microMIPS encoding.

Here's the resulting change.  It adds a couple of new `gdbarch' hooks,
one to update symbol information with the ISA bit lost in
`_bfd_mips_elf_symbol_processing', and two other ones to adjust DWARF-2
records as they're processed.  The ISA bit is set in each address
handled according to information retrieved from the symbol table for the
symbol spanning the address if any; limits are adjusted based on the
address they point to related to the respective base address.
Additionally minimal symbol information has to be adjusted accordingly
in its gdbarch hook.

With these changes in place some complications with ISA bit juggling in
the PC that never fully worked can be removed from the MIPS backend.
Conversely, the generic dynamic linker event special breakpoint symbol
handler has to be updated to call the minimal symbol gdbarch hook to
record that the symbol is a MIPS16 or microMIPS address if applicable or
the breakpoint will be set at the wrong address and either fail to work
or cause SIGTRAPs (this is because the symbol is handled early on and
bypasses regular symbol processing).

4. Results obtained

The change fixes the example above -- to repeat only the crucial steps:

(gdb) break main
Breakpoint 1 at 0x400491: file foobar.c, line 23.
(gdb) run
Starting program: .../foobar

Breakpoint 1, main () at foobar.c:23
23        return foop ();
(gdb) print foo
$1 = {int (void)} 0x400681 <foo>
(gdb) set foop = bar
(gdb) advance bar
bar () at foobar.c:9
9       }
(gdb) disassemble
Dump of assembler code for function bar:
=> 0x0040068d <+0>:     jr      ra
   0x0040068f <+2>:     li      v0,2
End of assembler dump.
(gdb) finish
Run till exit from #0  bar () at foobar.c:9
main () at foobar.c:24
24      }
Value returned is $2 = 2
(gdb) continue
Continuing.
[Inferior 1 (process 14128) exited with code 02]
(gdb)

-- excellent!

The change removes about 90 failures per MIPS16 multilib in mips-sde-elf
testing too, results for MIPS16 are now similar to that for standard
MIPS; microMIPS results are a bit worse because of host-I/O problems in
QEMU used instead of MIPSsim for microMIPS testing only:

                === gdb Summary ===

# of expected passes            14299
# of unexpected failures        187
# of expected failures          56
# of known failures             58
# of unresolved testcases       11
# of untested testcases         52
# of unsupported tests          174

MIPS16:

                === gdb Summary ===

# of expected passes            14298
# of unexpected failures        187
# of unexpected successes       2
# of expected failures          54
# of known failures             58
# of unresolved testcases       12
# of untested testcases         52
# of unsupported tests          174

microMIPS:

                === gdb Summary ===

# of expected passes            14149
# of unexpected failures        201
# of unexpected successes       2
# of expected failures          54
# of known failures             58
# of unresolved testcases       7
# of untested testcases         53
# of unsupported tests          175

2014-12-12  Maciej W. Rozycki  <macro@codesourcery.com>
            Maciej W. Rozycki  <macro@mips.com>
            Pedro Alves  <pedro@codesourcery.com>

	gdb/
	* gdbarch.sh (elf_make_msymbol_special): Change type to `F',
	remove `predefault' and `invalid_p' initializers.
	(make_symbol_special): New architecture method.
	(adjust_dwarf2_addr, adjust_dwarf2_line): Likewise.
	(objfile, symbol): New declarations.
	* arch-utils.h (default_elf_make_msymbol_special): Remove
	prototype.
	(default_make_symbol_special): New prototype.
	(default_adjust_dwarf2_addr): Likewise.
	(default_adjust_dwarf2_line): Likewise.
	* mips-tdep.h (mips_unmake_compact_addr): New prototype.
	* arch-utils.c (default_elf_make_msymbol_special): Remove
	function.
	(default_make_symbol_special): New function.
	(default_adjust_dwarf2_addr): Likewise.
	(default_adjust_dwarf2_line): Likewise.
	* dwarf2-frame.c (decode_frame_entry_1): Call
	`gdbarch_adjust_dwarf2_addr'.
	* dwarf2loc.c (dwarf2_find_location_expression): Likewise.
	* dwarf2read.c (create_addrmap_from_index): Likewise.
	(process_psymtab_comp_unit_reader): Likewise.
	(add_partial_symbol): Likewise.
	(add_partial_subprogram): Likewise.
	(process_full_comp_unit): Likewise.
	(read_file_scope): Likewise.
	(read_func_scope): Likewise.  Call `gdbarch_make_symbol_special'.
	(read_lexical_block_scope): Call `gdbarch_adjust_dwarf2_addr'.
	(read_call_site_scope): Likewise.
	(dwarf2_ranges_read): Likewise.
	(dwarf2_record_block_ranges): Likewise.
	(read_attribute_value): Likewise.
	(dwarf_decode_lines_1): Call `gdbarch_adjust_dwarf2_line'.
	(new_symbol_full): Call `gdbarch_adjust_dwarf2_addr'.
	* elfread.c (elf_symtab_read): Don't call
	`gdbarch_elf_make_msymbol_special' if unset.
	* mips-linux-tdep.c (micromips_linux_sigframe_validate): Strip
	the ISA bit from the PC.
	* mips-tdep.c (mips_unmake_compact_addr): New function.
	(mips_elf_make_msymbol_special): Set the ISA bit in the symbol's
	address appropriately.
	(mips_make_symbol_special): New function.
	(mips_pc_is_mips): Set the ISA bit before symbol lookup.
	(mips_pc_is_mips16): Likewise.
	(mips_pc_is_micromips): Likewise.
	(mips_pc_isa): Likewise.
	(mips_adjust_dwarf2_addr): New function.
	(mips_adjust_dwarf2_line): Likewise.
	(mips_read_pc, mips_unwind_pc): Keep the ISA bit.
	(mips_addr_bits_remove): Likewise.
	(mips_skip_trampoline_code): Likewise.
	(mips_write_pc): Don't set the ISA bit.
	(mips_eabi_push_dummy_call): Likewise.
	(mips_o64_push_dummy_call): Likewise.
	(mips_gdbarch_init): Install `mips_make_symbol_special',
	`mips_adjust_dwarf2_addr' and `mips_adjust_dwarf2_line' gdbarch
	handlers.
	* solib.c (gdb_bfd_lookup_symbol_from_symtab): Get
	target-specific symbol address adjustments.
	* gdbarch.h: Regenerate.
	* gdbarch.c: Regenerate.

2014-12-12  Maciej W. Rozycki  <macro@codesourcery.com>

	gdb/testsuite/
	* gdb.base/func-ptrs.c: New file.
	* gdb.base/func-ptrs.exp: New file.
2014-12-12 13:49:06 +00:00
..
cli SYMTAB_DIRNAME: New macro. 2014-11-18 09:28:32 -08:00
common Fix make_cleanup_dtor signature to match declaration 2014-12-03 08:56:10 -05:00
config Use core regset iterators on Sparc Solaris 2014-12-03 15:38:46 +01:00
contrib
data-directory
doc New "owner" attribute for gdb.Objfile. 2014-12-08 08:50:48 -08:00
features S390: Fix 'expedite' for s390-te-linux64 2014-12-02 10:47:30 +01:00
gdbserver S390: Fix gdbserver support for TDB 2014-12-12 14:15:07 +01:00
gnulib Import rename module 2014-11-28 18:38:21 +08:00
guile Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
mi Restore terminal state in mi_thread_exit (PR gdb/17627) 2014-12-10 13:03:47 -05:00
nat
po
python python/py-objfile.c (objfpy_get_owner): Increment refcount of result. 2014-12-08 18:27:41 -08:00
regformats S390: Fix 'expedite' for s390-te-linux64 2014-12-02 10:47:30 +01:00
stubs
syscalls
system-gdbinit
target
testsuite MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
tui Specify SA_RESTART when registering the SIGWINCH signal handler 2014-11-23 14:12:05 +04:00
.dir-locals.el
.gitignore
aarch64-linux-nat.c
aarch64-linux-tdep.c
aarch64-linux-tdep.h
aarch64-newlib-tdep.c
aarch64-tdep.c
aarch64-tdep.h
acinclude.m4
aclocal.m4
acx_configure_dir.m4
ada-exp.y symtab.h (SYMTAB_BLOCKVECTOR): Renamed from BLOCKVECTOR. All uses updated. 2014-11-18 09:41:45 -08:00
ada-lang.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
ada-lang.h
ada-lex.l
ada-operator.def
ada-tasks.c
ada-typeprint.c
ada-valprint.c
ada-varobj.c
addrmap.c
addrmap.h
agent.c
aix-thread.c
alpha-linux-nat.c
alpha-linux-tdep.c
alpha-mdebug-tdep.c
alpha-tdep.c
alpha-tdep.h
alphabsd-nat.c
alphabsd-tdep.c
alphabsd-tdep.h
alphafbsd-tdep.c
alphanbsd-tdep.c
alphaobsd-tdep.c
amd64-darwin-tdep.c
amd64-darwin-tdep.h
amd64-dicos-tdep.c
amd64-linux-nat.c
amd64-linux-tdep.c Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
amd64-linux-tdep.h
amd64-nat.c
amd64-nat.h
amd64-sol2-tdep.c
amd64-tdep.c Fix amd64 dwarf register number mapping (MMX register and higher) 2014-11-28 19:30:43 +04:00
amd64-tdep.h
amd64-windows-nat.c
amd64-windows-tdep.c
amd64bsd-nat.c
amd64bsd-nat.h
amd64fbsd-nat.c
amd64fbsd-tdep.c
amd64nbsd-nat.c
amd64nbsd-tdep.c
amd64obsd-nat.c
amd64obsd-tdep.c
annotate.c
annotate.h
arch-utils.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
arch-utils.h MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
arm-linux-nat.c
arm-linux-tdep.c Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
arm-linux-tdep.h
arm-symbian-tdep.c
arm-tdep.c Improve arm_skip_prologue by using arm_analyze_prologue 2014-12-12 08:46:34 +08:00
arm-tdep.h
arm-wince-tdep.c
armbsd-tdep.c
armnbsd-nat.c
armnbsd-tdep.c
armobsd-tdep.c
auto-load.c Add add-auto-load-scripts-directory. 2014-11-30 20:25:48 +01:00
auto-load.h
auxv.c
auxv.h
avr-tdep.c
ax-gdb.c
ax-gdb.h
ax-general.c
ax.h
bcache.c
bcache.h
bfd-target.c
bfd-target.h
bfin-linux-tdep.c Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
bfin-tdep.c
bfin-tdep.h
block.c Accelerate lookup_symbol_aux_objfile 85x 2014-12-04 08:26:26 +01:00
block.h Accelerate lookup_symbol_aux_objfile 85x 2014-12-04 08:26:26 +01:00
blockframe.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
break-catch-sig.c
break-catch-throw.c
breakpoint.c Only leave dprintf inserted if it is marked as persistent (PR breakpoints/17012) 2014-12-10 16:10:05 -05:00
breakpoint.h
bsd-kvm.c
bsd-kvm.h
bsd-uthread.c
bsd-uthread.h
btrace.c
btrace.h
build-id.c New python attribute gdb.Objfile.build_id. 2014-12-04 11:32:24 -08:00
build-id.h New python attribute gdb.Objfile.build_id. 2014-12-04 11:32:24 -08:00
buildsym.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
buildsym.h Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
c-exp.y symtab.h (SYMTAB_BLOCKVECTOR): Renamed from BLOCKVECTOR. All uses updated. 2014-11-18 09:41:45 -08:00
c-lang.c
c-lang.h
c-typeprint.c
c-valprint.c
c-varobj.c
ChangeLog MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
ChangeLog-3.x
ChangeLog-1990
ChangeLog-1991
ChangeLog-1992
ChangeLog-1993
ChangeLog-1994
ChangeLog-1995
ChangeLog-1996
ChangeLog-1997
ChangeLog-1998
ChangeLog-1999
ChangeLog-2000
ChangeLog-2001
ChangeLog-2002
ChangeLog-2003
ChangeLog-2004
ChangeLog-2005
ChangeLog-2006
ChangeLog-2007
ChangeLog-2008
ChangeLog-2009
ChangeLog-2010
ChangeLog-2011
ChangeLog-2012
ChangeLog-2013
charset-list.h
charset.c handle 'iconv's that define EILSEQ to ENOENT 2014-11-14 15:58:09 +00:00
charset.h
cli-out.c
cli-out.h
coff-pe-read.c
coff-pe-read.h
coffread.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
command.h
complaints.c
complaints.h
completer.c
completer.h
config.in Use canonicalize_file_name unconditionally 2014-11-28 18:38:16 +08:00
configure Use canonicalize_file_name unconditionally 2014-11-28 18:38:16 +08:00
configure.ac Use canonicalize_file_name unconditionally 2014-11-28 18:38:16 +08:00
configure.host
configure.tgt
continuations.c
continuations.h
CONTRIBUTE
COPYING
copying.awk
copying.c
copyright.py
core-regset.c
corefile.c
corelow.c
cp-abi.c
cp-abi.h
cp-name-parser.y
cp-namespace.c cp-namespace.c (cp_lookup_nested_symbol): Fix comments. 2014-12-11 12:05:25 -08:00
cp-support.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
cp-support.h cp_lookup_symbol_imports: Make static. 2014-12-10 10:05:32 -08:00
cp-valprint.c
cris-linux-tdep.c
cris-tdep.c
cris-tdep.h
ctf.c
ctf.h
d-exp.y
d-lang.c
d-lang.h
d-valprint.c
darwin-nat-info.c
darwin-nat.c
darwin-nat.h
dbug-rom.c
dbxread.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
dcache.c
dcache.h
debug.c
defs.h Include alloca.h unconditionally 2014-11-21 22:05:41 +08:00
demangle.c
dfp.c
dfp.h
dicos-tdep.c
dicos-tdep.h
dictionary.c
dictionary.h
dink32-rom.c
disasm.c symtab.h (SYMTAB_LINETABLE): Renamed from LINETABLE. All uses updated. 2014-11-18 09:32:10 -08:00
disasm.h
doublest.c
doublest.h
dsrec.c
dummy-frame.c
dummy-frame.h
dwarf2-frame-tailcall.c
dwarf2-frame-tailcall.h
dwarf2-frame.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
dwarf2-frame.h
dwarf2expr.c
dwarf2expr.h
dwarf2loc.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
dwarf2loc.h
dwarf2read.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
elfread.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
environ.c
environ.h
eval.c Check that thread stack temps are not already enabled before enabling them. 2014-11-29 15:47:39 -08:00
event-loop.c
event-loop.h
event-top.c Fix the processing of Meta-key commands in TUI 2014-11-23 14:04:09 +04:00
event-top.h Fix the processing of Meta-key commands in TUI 2014-11-23 14:04:09 +04:00
exc_request.defs
exceptions.c
exceptions.h
exec.c
exec.h
expprint.c
expression.h
extension-priv.h
extension.c
extension.h
f-exp.y
f-lang.c
f-lang.h
f-typeprint.c
f-valprint.c
fbsd-nat.c
fbsd-nat.h
fbsd-tdep.c
fbsd-tdep.h
filesystem.c
filesystem.h
findcmd.c
findvar.c Use SYMBOL_OBJFILE more. 2014-11-18 08:54:06 -08:00
fork-child.c
frame-base.c
frame-base.h
frame-unwind.c
frame-unwind.h
frame.c frame.c: Fix the check for FID_STACK_INVALID in frame_id_eq() 2014-11-30 19:37:31 +04:00
frame.h
frv-linux-tdep.c
frv-tdep.c
frv-tdep.h
gcore.c
gcore.h
gcore.in
gdb_bfd.c
gdb_bfd.h
gdb_buildall.sh
gdb_curses.h
gdb_expat.h
gdb_indent.sh
gdb_mbuild.sh
gdb_obstack.c
gdb_obstack.h
gdb_proc_service.h
gdb_ptrace.h
gdb_regex.h
gdb_select.h
gdb_usleep.c
gdb_usleep.h
gdb_vfork.h
gdb_wchar.h Include wchar.h and wctype.h unconditionally 2014-11-21 22:05:41 +08:00
gdb-code-style.el
gdb-demangle.h
gdb-dlfcn.c
gdb-dlfcn.h
gdb-gdb.gdb.in
gdb-gdb.py
gdb-stabs.h
gdb.c
gdb.gdb
gdb.h
gdbarch.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
gdbarch.h MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
gdbarch.sh MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
gdbcmd.h
gdbcore.h
gdbthread.h Enable chained function calls in C++ expressions. 2014-11-28 16:01:16 -08:00
gdbtypes.c Enable chained function calls in C++ expressions. 2014-11-28 16:01:16 -08:00
gdbtypes.h Enable chained function calls in C++ expressions. 2014-11-28 16:01:16 -08:00
glibc-tdep.c
glibc-tdep.h
gnu-nat.c [Hurd] Fix deallocation after proc_getprocinfo call 2014-11-24 13:28:03 +04:00
gnu-nat.h
gnu-v2-abi.c
gnu-v3-abi.c
go32-nat.c Add missing parenthesis 2014-11-15 17:04:30 +08:00
go-exp.y
go-lang.c
go-lang.h
go-typeprint.c
go-valprint.c
gregset.h
h8300-tdep.c
hppa-hpux-nat.c
hppa-hpux-tdep.c
hppa-linux-nat.c
hppa-linux-offsets.h
hppa-linux-tdep.c
hppa-tdep.c
hppa-tdep.h
hppabsd-nat.c
hppabsd-tdep.c
hppabsd-tdep.h
hppanbsd-nat.c
hppanbsd-tdep.c
hppaobsd-tdep.c
i386-cygwin-tdep.c
i386-darwin-nat.c
i386-darwin-tdep.c
i386-darwin-tdep.h
i386-dicos-tdep.c
i386-linux-nat.c
i386-linux-nat.h
i386-linux-tdep.c Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
i386-linux-tdep.h
i386-nto-tdep.c
i386-sol2-nat.c
i386-sol2-tdep.c
i386-tdep.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
i386-tdep.h
i386-windows-nat.c
i386bsd-nat.c
i386bsd-nat.h
i386bsd-tdep.c
i386fbsd-nat.c
i386fbsd-tdep.c
i386gnu-nat.c Use core regset iterators on GNU Hurd 2014-12-01 13:42:41 +01:00
i386gnu-tdep.c Use core regset iterators on GNU Hurd 2014-12-01 13:42:41 +01:00
i386nbsd-nat.c
i386nbsd-tdep.c
i386obsd-nat.c
i386obsd-tdep.c
i386v4-nat.c
i387-tdep.c
i387-tdep.h
ia64-hpux-nat.c
ia64-hpux-tdep.c
ia64-hpux-tdep.h
ia64-libunwind-tdep.c
ia64-libunwind-tdep.h
ia64-linux-nat.c
ia64-linux-tdep.c
ia64-tdep.c
ia64-tdep.h
ia64-vms-tdep.c
inf-child.c Use readlink unconditionally 2014-11-28 18:37:52 +08:00
inf-child.h
inf-loop.c
inf-loop.h
inf-ptrace.c
inf-ptrace.h
inf-ttrace.c
inf-ttrace.h
infcall.c New python events: inferior call, register/memory changed. 2014-12-02 11:15:29 -08:00
infcall.h
infcmd.c
inferior.c
inferior.h
inflow.c
inflow.h
infrun.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
infrun.h
inline-frame.c
inline-frame.h
interps.c
interps.h
iq2000-tdep.c
jit-reader.in
jit.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
jit.h
jv-exp.y
jv-lang.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
jv-lang.h
jv-typeprint.c
jv-valprint.c
jv-varobj.c
language.c
language.h
libmcheck.m4
linespec.c Revert: linespec.c (iterate_name_matcher): Fix arguments to symbol_name_cmp. 2014-12-05 01:04:07 -08:00
linespec.h
linux-fork.c checkpoint: print index of new checkpoint in response message 2014-11-23 13:58:06 +04:00
linux-fork.h
linux-nat.c
linux-nat.h
linux-record.c
linux-record.h
linux-tdep.c
linux-tdep.h
linux-thread-db.c
lm32-tdep.c
m2-exp.y
m2-lang.c
m2-lang.h
m2-typeprint.c
m2-valprint.c
m32c-tdep.c
m32r-linux-nat.c
m32r-linux-tdep.c
m32r-rom.c
m32r-tdep.c
m32r-tdep.h
m68hc11-tdep.c
m68k-tdep.c
m68k-tdep.h
m68kbsd-nat.c
m68kbsd-tdep.c
m68klinux-nat.c Remove (dead-code) native core file sniffers on Linux targets 2014-11-28 15:53:05 +01:00
m68klinux-tdep.c
m88k-tdep.c
m88k-tdep.h
m88kbsd-nat.c
machoread.c
macrocmd.c
macroexp.c
macroexp.h
macroscope.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
macroscope.h
macrotab.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
macrotab.h Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
main.c
main.h
maint.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
maint.h
MAINTAINERS Add myself as write after approval maintainer 2014-12-05 11:35:34 -05:00
make-target-delegates
Makefile.in New python events: inferior call, register/memory changed. 2014-12-02 11:15:29 -08:00
mdebugread.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
mdebugread.h
mem-break.c
memattr.c
memattr.h
memory-map.c
memory-map.h
memrange.c
memrange.h
mep-tdep.c
microblaze-linux-tdep.c
microblaze-rom.c
microblaze-tdep.c
microblaze-tdep.h
mingw-hdep.c
minidebug.c
minsyms.c
minsyms.h
mips64obsd-nat.c
mips64obsd-tdep.c
mips-linux-nat.c
mips-linux-tdep.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
mips-linux-tdep.h
mips-tdep.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
mips-tdep.h MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
mipsnbsd-nat.c
mipsnbsd-tdep.c
mipsnbsd-tdep.h
mipsread.c
mn10300-linux-tdep.c
mn10300-tdep.c
mn10300-tdep.h
monitor.c
monitor.h
moxie-tdep.c
moxie-tdep.h
msg_reply.defs
msg.defs
msp430-tdep.c
mt-tdep.c
nbsd-nat.c
nbsd-nat.h
nbsd-tdep.c
nbsd-tdep.h
NEWS New "owner" attribute for gdb.Objfile. 2014-12-08 08:50:48 -08:00
nios2-linux-tdep.c
nios2-tdep.c Fix Nios II prologue analyzer to handle multiple stack adjustments. 2014-11-25 18:40:28 -08:00
nios2-tdep.h
notify.defs
nto-procfs.c
nto-tdep.c
nto-tdep.h
objc-lang.c
objc-lang.h
objfiles.c Remove duplicate comment 2014-12-01 09:12:59 -05:00
objfiles.h Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
obsd-nat.c
obsd-nat.h
obsd-tdep.c
obsd-tdep.h
observer.c
observer.sh
opencl-lang.c
osabi.c
osabi.h
osdata.c
osdata.h
p-exp.y symtab.h (SYMTAB_BLOCKVECTOR): Renamed from BLOCKVECTOR. All uses updated. 2014-11-18 09:41:45 -08:00
p-lang.c
p-lang.h
p-typeprint.c
p-valprint.c
parse.c symtab.h (SYMTAB_BLOCKVECTOR): Renamed from BLOCKVECTOR. All uses updated. 2014-11-18 09:41:45 -08:00
parser-defs.h
posix-hdep.c
ppc64-tdep.c
ppc64-tdep.h
ppc-linux-nat.c
ppc-linux-tdep.c Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
ppc-linux-tdep.h
ppc-ravenscar-thread.c
ppc-ravenscar-thread.h
ppc-sysv-tdep.c
ppc-tdep.h
ppcbug-rom.c
ppcfbsd-nat.c
ppcfbsd-tdep.c
ppcfbsd-tdep.h
ppcnbsd-nat.c
ppcnbsd-tdep.c
ppcnbsd-tdep.h
ppcobsd-nat.c
ppcobsd-tdep.c
ppcobsd-tdep.h
printcmd.c Use SYMBOL_OBJFILE more. 2014-11-18 08:54:06 -08:00
probe.c
probe.h
PROBLEMS
proc-api.c
proc-events.c
proc-flags.c
proc-service.c
proc-service.list
proc-utils.h
proc-why.c
process_reply.defs
procfs.c
procfs.h
progspace.c
progspace.h
prologue-value.c
prologue-value.h
psympriv.h Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
psymtab.c psymtab.c (psymtab_search_name): Fix whitespace. 2014-11-21 09:50:56 -08:00
psymtab.h
ravenscar-thread.c
ravenscar-thread.h
README
record-btrace.c
record-full.c
record-full.h
record.c
record.h
regcache.c
regcache.h
reggroups.c
reggroups.h
registry.c
registry.h
regset.h
remote-fileio.c
remote-fileio.h
remote-m32r-sdi.c
remote-mips.c
remote-notif.c
remote-notif.h
remote-sim.c
remote.c
remote.h
reply_mig_hack.awk
reverse.c
rl78-tdep.c
rs6000-aix-tdep.c
rs6000-aix-tdep.h
rs6000-lynx178-tdep.c
rs6000-nat.c
rs6000-tdep.c
rs6000-tdep.h
rx-tdep.c
s390-linux-nat.c
s390-linux-tdep.c Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
s390-linux-tdep.h
score-tdep.c
score-tdep.h
sentinel-frame.c
sentinel-frame.h
ser-base.c
ser-base.h
ser-go32.c
ser-mingw.c
ser-pipe.c
ser-tcp.c
ser-tcp.h
ser-unix.c
ser-unix.h
serial.c
serial.h
sh64-tdep.c
sh64-tdep.h
sh-linux-tdep.c
sh-tdep.c
sh-tdep.h
shnbsd-nat.c
shnbsd-tdep.c
sim-regno.h
skip.c
skip.h
sol2-tdep.c
sol2-tdep.h
sol-thread.c
solib-aix.c
solib-aix.h
solib-darwin.c Remove const from many struct objfile * 2014-12-05 19:11:53 +01:00
solib-darwin.h
solib-dsbt.c
solib-frv.c
solib-ia64-hpux.c
solib-ia64-hpux.h
solib-pa64.c
solib-pa64.h
solib-som.c
solib-som.h
solib-spu.c Remove const from many struct objfile * 2014-12-05 19:11:53 +01:00
solib-spu.h
solib-svr4.c Remove const from many struct objfile * 2014-12-05 19:11:53 +01:00
solib-svr4.h
solib-target.c
solib-target.h
solib.c MIPS: Keep the ISA bit in compressed code addresses 2014-12-12 13:49:06 +00:00
solib.h
solist.h Remove const from many struct objfile * 2014-12-05 19:11:53 +01:00
somread.c
source.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
source.h
sparc64-linux-nat.c
sparc64-linux-tdep.c Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
sparc64-nat.c
sparc64-sol2-tdep.c Use core regset iterators on Sparc Solaris 2014-12-03 15:38:46 +01:00
sparc64-tdep.c
sparc64-tdep.h
sparc64fbsd-nat.c
sparc64fbsd-tdep.c
sparc64nbsd-nat.c
sparc64nbsd-tdep.c
sparc64obsd-nat.c
sparc64obsd-tdep.c
sparc-linux-nat.c
sparc-linux-tdep.c Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
sparc-nat.c
sparc-nat.h
sparc-ravenscar-thread.c
sparc-ravenscar-thread.h
sparc-sol2-nat.c
sparc-sol2-tdep.c Use core regset iterators on Sparc Solaris 2014-12-03 15:38:46 +01:00
sparc-tdep.c
sparc-tdep.h
sparcnbsd-nat.c
sparcnbsd-tdep.c
sparcobsd-tdep.c
spu-linux-nat.c
spu-multiarch.c
spu-tdep.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
spu-tdep.h
srec.h
stabsread.c
stabsread.h
stack.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
stack.h
stap-probe.c
stap-probe.h
std-operator.def
std-regs.c
symfile-debug.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
symfile-mem.c
symfile.c Use lstat unconditionally 2014-11-28 18:38:02 +08:00
symfile.h Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
symmisc.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
symtab.c (lookup_global_symbol_from_objfile): Simplify. 2014-12-11 09:55:29 -08:00
symtab.h Remove const from many struct objfile * 2014-12-05 19:11:53 +01:00
target-dcache.c
target-dcache.h
target-debug.h
target-delegates.c
target-descriptions.c
target-descriptions.h
target-memory.c
target.c Restore terminal state in mi_thread_exit (PR gdb/17627) 2014-12-10 13:03:47 -05:00
target.h Restore terminal state in mi_thread_exit (PR gdb/17627) 2014-12-10 13:03:47 -05:00
terminal.h
thread.c Enable chained function calls in C++ expressions. 2014-11-28 16:01:16 -08:00
tic6x-linux-tdep.c
tic6x-tdep.c
tic6x-tdep.h
tilegx-linux-nat.c
tilegx-linux-tdep.c
tilegx-tdep.c
tilegx-tdep.h
top.c
top.h
tracefile-tfile.c
tracefile.c
tracefile.h
tracepoint.c Use SYMBOL_OBJFILE more. 2014-11-18 08:54:06 -08:00
tracepoint.h
trad-frame.c
trad-frame.h
tramp-frame.c MIPS: Add support for microMIPS Linux signal trampolines 2014-12-03 20:57:06 +00:00
tramp-frame.h MIPS: Add support for microMIPS Linux signal trampolines 2014-12-03 20:57:06 +00:00
typeprint.c
typeprint.h
ui-file.c
ui-file.h
ui-out.c
ui-out.h
unwind_stop_reasons.def
user-regs.c
user-regs.h
utils.c New python attribute gdb.Objfile.build_id. 2014-12-04 11:32:24 -08:00
utils.h New python attribute gdb.Objfile.build_id. 2014-12-04 11:32:24 -08:00
v850-tdep.c
valarith.c
valops.c Remove remnant of Chill support. 2014-12-02 16:15:53 -08:00
valprint.c Refine read_string 2014-11-23 13:57:00 +08:00
valprint.h
value.c Enable chained function calls in C++ expressions. 2014-11-28 16:01:16 -08:00
value.h Enable chained function calls in C++ expressions. 2014-11-28 16:01:16 -08:00
varobj-iter.h
varobj.c
varobj.h
vax-tdep.c
vax-tdep.h
vaxbsd-nat.c
vaxnbsd-tdep.c
vaxobsd-tdep.c
version.in
windows-nat.c
windows-nat.h
windows-tdep.c
windows-tdep.h
windows-termcap.c
x86-linux-nat.c
x86-linux-nat.h
x86-nat.c
x86-nat.h
xcoffread.c Split struct symtab into two: struct symtab and compunit_symtab. 2014-11-20 07:47:44 -08:00
xcoffread.h
xml-support.c
xml-support.h
xml-syscall.c Fix build breakage from previous commit 2014-11-20 13:33:28 -05:00
xml-syscall.h Partial fix for PR breakpoints/10737: Make syscall info be per-arch instead of global 2014-11-20 12:28:18 -05:00
xml-tdesc.c
xml-tdesc.h
xstormy16-tdep.c
xtensa-config.c
xtensa-linux-nat.c
xtensa-linux-tdep.c
xtensa-tdep.c
xtensa-tdep.h
xtensa-xtregs.c

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

		     README for GDB release

This is GDB, the GNU source-level debugger.

A summary of new features is in the file `gdb/NEWS'.

Check the GDB home page at http://www.gnu.org/software/gdb/ for up to
date release information, mailing list links and archives, etc.

The file `gdb/PROBLEMS' contains information on problems identified
late in the release cycle.  GDB's bug tracking data base at
http://www.gnu.org/software/gdb/bugs/ contains a more complete list of
bugs.


Unpacking and Installation -- quick overview
==========================

   The release is provided as a gzipped tar file called
'gdb-VERSION.tar.gz', where VERSION is the version of GDB.

   The GDB debugger sources, the generic GNU include
files, the BFD ("binary file description") library, the readline
library, and other libraries all have directories of their own
underneath the gdb-VERSION directory.  The idea is that a variety of GNU
tools can share a common copy of these things.  Be aware of variation
over time--for example don't try to build GDB with a copy of bfd from
a release other than the GDB release (such as a binutils release),
especially if the releases are more than a few weeks apart.
Configuration scripts and makefiles exist to cruise up and down this
directory tree and automatically build all the pieces in the right
order.

   When you unpack the gdb-VERSION.tar.gz file, it will create a
source directory called `gdb-VERSION'.

You can build GDB right in the source directory:

      cd gdb-VERSION
      ./configure
      make
      cp gdb/gdb /usr/local/bin/gdb	(or wherever you want)

However, we recommend that an empty directory be used instead.
This way you do not clutter your source tree with binary files
and will be able to create different builds with different 
configuration options.

You can build GDB in any empty build directory:

      mkdir build
      cd build
      <full path to your sources>/gdb-VERSION/configure
      make
      cp gdb/gdb /usr/local/bin/gdb	(or wherever you want)

(Building GDB with DJGPP tools for MS-DOS/MS-Windows is slightly
different; see the file gdb-VERSION/gdb/config/djgpp/README for details.)

   This will configure and build all the libraries as well as GDB.  If
`configure' can't determine your system type, specify one as its
argument, e.g., `./configure sun4' or `./configure decstation'.

   Make sure that your 'configure' line ends in 'gdb-VERSION/configure':

      /berman/migchain/source/gdb-VERSION/configure      # RIGHT
      /berman/migchain/source/gdb-VERSION/gdb/configure  # WRONG

   The GDB package contains several subdirectories, such as 'gdb',
'bfd', and 'readline'.  If your 'configure' line ends in
'gdb-VERSION/gdb/configure', then you are configuring only the gdb
subdirectory, not the whole GDB package.  This leads to build errors
such as:

      make: *** No rule to make target `../bfd/bfd.h', needed by `gdb.o'.  Stop.

   If you get other compiler errors during this stage, see the `Reporting
Bugs' section below; there are a few known problems.

   GDB requires an ISO C (ANSI C) compiler.  If you do not have an ISO
C compiler for your system, you may be able to download and install
the GNU CC compiler.  It is available via anonymous FTP from the
directory `ftp://ftp.gnu.org/pub/gnu/gcc'.  GDB also requires an ISO
C standard library.  The GDB remote server, GDBserver, builds with some
non-ISO standard libraries - e.g. for Windows CE.

   GDB uses Expat, an XML parsing library, to implement some target-specific
features.  Expat will be linked in if it is available at build time, or
those features will be disabled.  The latest version of Expat should be
available from `http://expat.sourceforge.net'.

   GDB can be used as a cross-debugger, running on a machine of one
type while debugging a program running on a machine of another type.
See below.


More Documentation
******************

   All the documentation for GDB comes as part of the machine-readable
distribution.  The documentation is written in Texinfo format, which
is a documentation system that uses a single source file to produce
both on-line information and a printed manual.  You can use one of the
Info formatting commands to create the on-line version of the
documentation and TeX (or `texi2roff') to typeset the printed version.

   GDB includes an already formatted copy of the on-line Info version
of this manual in the `gdb/doc' subdirectory.  The main Info file is
`gdb-VERSION/gdb/doc/gdb.info', and it refers to subordinate files
matching `gdb.info*' in the same directory.  If necessary, you can
print out these files, or read them with any editor; but they are
easier to read using the `info' subsystem in GNU Emacs or the
standalone `info' program, available as part of the GNU Texinfo
distribution.

   If you want to format these Info files yourself, you need one of the
Info formatting programs, such as `texinfo-format-buffer' or
`makeinfo'.

   If you have `makeinfo' installed, and are in the top level GDB
source directory (`gdb-VERSION'), you can make the Info file by
typing:

      cd gdb/doc
      make info

   If you want to typeset and print copies of this manual, you need
TeX, a program to print its DVI output files, and `texinfo.tex', the
Texinfo definitions file.  This file is included in the GDB
distribution, in the directory `gdb-VERSION/texinfo'.

   TeX is a typesetting program; it does not print files directly, but
produces output files called DVI files.  To print a typeset document,
you need a program to print DVI files.  If your system has TeX
installed, chances are it has such a program.  The precise command to
use depends on your system; `lpr -d' is common; another (for PostScript
devices) is `dvips'.  The DVI print command may require a file name
without any extension or a `.dvi' extension.

   TeX also requires a macro definitions file called `texinfo.tex'. 
This file tells TeX how to typeset a document written in Texinfo
format.  On its own, TeX cannot read, much less typeset a Texinfo file.
 `texinfo.tex' is distributed with GDB and is located in the
`gdb-VERSION/texinfo' directory.

   If you have TeX and a DVI printer program installed, you can typeset
and print this manual.  First switch to the `gdb' subdirectory of
the main source directory (for example, to `gdb-VERSION/gdb') and then type:

      make doc/gdb.dvi

   If you prefer to have the manual in PDF format, type this from the
`gdb/doc' subdirectory of the main source directory:

      make gdb.pdf

For this to work, you will need the PDFTeX package to be installed.


Installing GDB
**************

   GDB comes with a `configure' script that automates the process of
preparing GDB for installation; you can then use `make' to build the
`gdb' program.

   The GDB distribution includes all the source code you need for GDB in
a single directory.  That directory contains:

`gdb-VERSION/{COPYING,COPYING.LIB}'
     Standard GNU license files.  Please read them.

`gdb-VERSION/bfd'
     source for the Binary File Descriptor library

`gdb-VERSION/config*'
     script for configuring GDB, along with other support files

`gdb-VERSION/gdb'
     the source specific to GDB itself

`gdb-VERSION/include'
     GNU include files

`gdb-VERSION/libiberty'
     source for the `-liberty' free software library

`gdb-VERSION/opcodes'
     source for the library of opcode tables and disassemblers

`gdb-VERSION/readline'
     source for the GNU command-line interface
     NOTE:  The readline library is compiled for use by GDB, but will
     not be installed on your system when "make install" is issued.

`gdb-VERSION/sim'
     source for some simulators (ARM, D10V, SPARC, M32R, MIPS, PPC, V850, etc)

`gdb-VERSION/texinfo'
     The `texinfo.tex' file, which you need in order to make a printed
     manual using TeX.

`gdb-VERSION/etc'
     Coding standards, useful files for editing GDB, and other
     miscellanea.

   Note: the following instructions are for building GDB on Unix or
Unix-like systems.  Instructions for building with DJGPP for
MS-DOS/MS-Windows are in the file gdb/config/djgpp/README.

   The simplest way to configure and build GDB is to run `configure'
from the `gdb-VERSION' directory.

   First switch to the `gdb-VERSION' source directory if you are
not already in it; then run `configure'.

   For example:

      cd gdb-VERSION
      ./configure
      make

   Running `configure' followed by `make' builds the `bfd',
`readline', `mmalloc', and `libiberty' libraries, then `gdb' itself.
The configured source files, and the binaries, are left in the
corresponding source directories.

   `configure' is a Bourne-shell (`/bin/sh') script; if your system
does not recognize this automatically when you run a different shell,
you may need to run `sh' on it explicitly:

      sh configure

   If you run `configure' from a directory that contains source
directories for multiple libraries or programs, `configure' creates
configuration files for every directory level underneath (unless
you tell it not to, with the `--norecursion' option).

   You can install `gdb' anywhere; it has no hardwired paths. However,
you should make sure that the shell on your path (named by the `SHELL'
environment variable) is publicly readable.  Remember that GDB uses the
shell to start your program--some systems refuse to let GDB debug child
processes whose programs are not readable.


Compiling GDB in another directory
==================================

   If you want to run GDB versions for several host or target machines,
you need a different `gdb' compiled for each combination of host and
target.  `configure' is designed to make this easy by allowing you to
generate each configuration in a separate subdirectory, rather than in
the source directory.  If your `make' program handles the `VPATH'
feature correctly (GNU `make' and SunOS 'make' are two that should),
running `make' in each of these directories builds the `gdb' program
specified there.

   To build `gdb' in a separate directory, run `configure' with the
`--srcdir' option to specify where to find the source. (You also need
to specify a path to find `configure' itself from your working
directory.  If the path to `configure' would be the same as the
argument to `--srcdir', you can leave out the `--srcdir' option; it
will be assumed.)

   For example, you can build GDB in a separate
directory for a Sun 4 like this:

     cd gdb-VERSION
     mkdir ../gdb-sun4
     cd ../gdb-sun4
     ../gdb-VERSION/configure
     make

   When `configure' builds a configuration using a remote source
directory, it creates a tree for the binaries with the same structure
(and using the same names) as the tree under the source directory.  In
the example, you'd find the Sun 4 library `libiberty.a' in the
directory `gdb-sun4/libiberty', and GDB itself in `gdb-sun4/gdb'.

   One popular reason to build several GDB configurations in separate
directories is to configure GDB for cross-compiling (where GDB runs on
one machine--the host--while debugging programs that run on another
machine--the target).  You specify a cross-debugging target by giving
the `--target=TARGET' option to `configure'.

   When you run `make' to build a program or library, you must run it
in a configured directory--whatever directory you were in when you
called `configure' (or one of its subdirectories).

   The `Makefile' that `configure' generates in each source directory
also runs recursively.  If you type `make' in a source directory such
as `gdb-VERSION' (or in a separate configured directory configured with
`--srcdir=PATH/gdb-VERSION'), you will build all the required libraries,
and then build GDB.

   When you have multiple hosts or targets configured in separate
directories, you can run `make' on them in parallel (for example, if
they are NFS-mounted on each of the hosts); they will not interfere
with each other.


Specifying names for hosts and targets
======================================

   The specifications used for hosts and targets in the `configure'
script are based on a three-part naming scheme, but some short
predefined aliases are also supported.  The full naming scheme encodes
three pieces of information in the following pattern:

     ARCHITECTURE-VENDOR-OS

   For example, you can use the alias `sun4' as a HOST argument or in a
`--target=TARGET' option.  The equivalent full name is
`sparc-sun-sunos4'.

   The `configure' script accompanying GDB does not provide any query
facility to list all supported host and target names or aliases. 
`configure' calls the Bourne shell script `config.sub' to map
abbreviations to full names; you can read the script, if you wish, or
you can use it to test your guesses on abbreviations--for example:

     % sh config.sub sun4
     sparc-sun-sunos4.1.1
     % sh config.sub sun3
     m68k-sun-sunos4.1.1
     % sh config.sub decstation
     mips-dec-ultrix4.2
     % sh config.sub hp300bsd
     m68k-hp-bsd
     % sh config.sub i386v
     i386-pc-sysv
     % sh config.sub i786v
     Invalid configuration `i786v': machine `i786v' not recognized

`config.sub' is also distributed in the GDB source directory.


`configure' options
===================

   Here is a summary of the `configure' options and arguments that are
most often useful for building GDB.  `configure' also has several other
options not listed here.  *note : (configure.info)What Configure Does,
for a full explanation of `configure'.

     configure [--help]
               [--prefix=DIR]
               [--srcdir=PATH]
               [--norecursion] [--rm]
	       [--enable-build-warnings]
               [--target=TARGET]
	       [--host=HOST]
	       [HOST]

You may introduce options with a single `-' rather than `--' if you
prefer; but you may abbreviate option names if you use `--'.

`--help'
     Display a quick summary of how to invoke `configure'.

`-prefix=DIR'
     Configure the source to install programs and files under directory
     `DIR'.

`--srcdir=PATH'
     *Warning: using this option requires GNU `make', or another `make'
     that compatibly implements the `VPATH' feature.*
     Use this option to make configurations in directories separate
     from the GDB source directories.  Among other things, you can use
     this to build (or maintain) several configurations simultaneously,
     in separate directories.  `configure' writes configuration
     specific files in the current directory, but arranges for them to
     use the source in the directory PATH.  `configure' will create
     directories under the working directory in parallel to the source
     directories below PATH.

`--host=HOST'
     Configure GDB to run on the specified HOST.

     There is no convenient way to generate a list of all available
     hosts.

`HOST ...'
     Same as `--host=HOST'.  If you omit this, GDB will guess; it's
     quite accurate.

`--norecursion'
     Configure only the directory level where `configure' is executed;
     do not propagate configuration to subdirectories.

`--rm'
     Remove the configuration that the other arguments specify.

`--enable-build-warnings'
     When building the GDB sources, ask the compiler to warn about any
     code which looks even vaguely suspicious.  You should only using
     this feature if you're compiling with GNU CC.  It passes the
     following flags:
	-Wimplicit
	-Wreturn-type
	-Wcomment
	-Wtrigraphs
	-Wformat
	-Wparentheses
	-Wpointer-arith

`--enable-werror'
     Treat compiler warnings as werrors.  Use this only with GCC.  It
     adds the -Werror flag to the compiler, which will fail the
     compilation if the compiler outputs any warning messages.

`--target=TARGET'
     Configure GDB for cross-debugging programs running on the specified
     TARGET.  Without this option, GDB is configured to debug programs
     that run on the same machine (HOST) as GDB itself.

     There is no convenient way to generate a list of all available
     targets.

`--with-gdb-datadir=PATH'
     Set the GDB-specific data directory.  GDB will look here for
     certain supporting files or scripts.  This defaults to the `gdb'
     subdirectory of `datadir' (which can be set using `--datadir').

`--with-relocated-sources=DIR'
     Sets up the default source path substitution rule so that
     directory names recorded in debug information will be
     automatically adjusted for any directory under DIR.  DIR should
     be a subdirectory of GDB's configured prefix, the one mentioned
     in the `--prefix' or `--exec-prefix' options to configure.  This
     option is useful if GDB is supposed to be moved to a different
     place after it is built.

`--enable-64-bit-bfd'
     Enable 64-bit support in BFD on 32-bit hosts.

`--disable-gdbmi'
     Build GDB without the GDB/MI machine interface.

`--enable-tui'
     Build GDB with the text-mode full-screen user interface (TUI).
     Requires a curses library (ncurses and cursesX are also
     supported).

`--enable-gdbtk'
     Build GDB with the gdbtk GUI interface.  Requires TCL/Tk to be
     installed.

`--with-libunwind-ia64'
     Use the libunwind library for unwinding function call stack on ia64
     target platforms.
     See http://www.nongnu.org/libunwind/index.html for details.

`--with-curses'
     Use the curses library instead of the termcap library, for
     text-mode terminal operations.

`--enable-profiling' Enable profiling of GDB itself.  Necessary if you
     want to use the "maint set profile" command for profiling GDB.
     Requires the functions `monstartup' and `_mcleanup' to be present
     in the standard C library used to build GDB, and also requires a
     compiler that supports the `-pg' option.

`--with-system-readline'
     Use the readline library installed on the host, rather than the
     library supplied as part of GDB tarball.

`--with-expat'
     Build GDB with the libexpat library.  (Done by default if
     libexpat is installed and found at configure time.)  This library
     is used to read XML files supplied with GDB.  If it is
     unavailable, some features, such as remote protocol memory maps,
     target descriptions, and shared library lists, that are based on
     XML files, will not be available in GDB.  If your host does not
     have libexpat installed, you can  get the latest version from
     http://expat.sourceforge.net.

`--with-python[=PATH]'
     Build GDB with Python scripting support.  (Done by default if
     libpython is present and found at configure time.)  Python makes
     GDB scripting much more powerful than the restricted CLI
     scripting language.  If your host does not have Python installed,
     you can find it on http://www.python.org/download/.  The oldest
     version of Python supported by GDB is 2.4.  The optional argument
     PATH says where to find the Python headers and libraries; the
     configure script will look in PATH/include for headers and in
     PATH/lib for the libraries.

`--without-included-regex'
     Don't use the regex library included with GDB (as part of the
     libiberty library).  This is the default on hosts with version 2
     of the GNU C library.

`--with-sysroot=DIR'
     Use DIR as the default system root directory for libraries whose
     file names begin with `/lib' or `/usr/lib'.  (The value of DIR
     can be modified at run time by using the "set sysroot" command.)
     If DIR is under the GDB configured prefix (set with `--prefix' or
     `--exec-prefix' options), the default system root will be
     automatically adjusted if and when GDB is moved to a different
     location.

`--with-system-gdbinit=FILE'
     Configure GDB to automatically load a system-wide init file.
     FILE should be an absolute file name.  If FILE is in a directory
     under the configured prefix, and GDB is moved to another location
     after being built, the location of the system-wide init file will
     be adjusted accordingly. 

`configure' accepts other options, for compatibility with configuring
other GNU tools recursively; but these are the only options that affect
GDB or its supporting libraries.


Remote debugging
=================

   The files m68k-stub.c, i386-stub.c, and sparc-stub.c are examples
of remote stubs to be used with remote.c.  They are designed to run
standalone on an m68k, i386, or SPARC cpu and communicate properly
with the remote.c stub over a serial line.

   The directory gdb/gdbserver/ contains `gdbserver', a program that
allows remote debugging for Unix applications.  GDBserver is only
supported for some native configurations, including Sun 3, Sun 4, and
Linux.
The file gdb/gdbserver/README includes further notes on GDBserver; in
particular, it explains how to build GDBserver for cross-debugging
(where GDBserver runs on the target machine, which is of a different
architecture than the host machine running GDB).

   There are a number of remote interfaces for talking to existing ROM
monitors and other hardware:

	remote-mips.c	 MIPS remote debugging protocol
	remote-sds.c	 PowerPC SDS monitor
	remote-sim.c	 Generalized simulator protocol


Reporting Bugs in GDB
=====================

   There are several ways of reporting bugs in GDB.  The prefered
method is to use the World Wide Web:

      http://www.gnu.org/software/gdb/bugs/

As an alternative, the bug report can be submitted, via e-mail, to the
address "bug-gdb@gnu.org".

   When submitting a bug, please include the GDB version number, and
how you configured it (e.g., "sun4" or "mach386 host,
i586-intel-synopsys target").  Since GDB now supports so many
different configurations, it is important that you be precise about
this.  If at all possible, you should include the actual banner
that GDB prints when it starts up, or failing that, the actual
configure command that you used when configuring GDB.

   For more information on how/whether to report bugs, see the
Reporting Bugs chapter of the GDB manual (gdb/doc/gdb.texinfo).


Graphical interface to GDB -- X Windows, MS Windows
==========================

   Several graphical interfaces to GDB are available.  You should
check:

	http://www.gnu.org/software/gdb/links/

for an up-to-date list.

   Emacs users will very likely enjoy the Grand Unified Debugger mode;
try typing `M-x gdb RET'.


Writing Code for GDB
=====================

   There is information about writing code for GDB in the file
`CONTRIBUTE' and at the website:

	http://www.gnu.org/software/gdb/

in particular in the wiki.

   If you are pondering writing anything but a short patch, especially
take note of the information about copyrights and copyright assignment.
It can take quite a while to get all the paperwork done, so
we encourage you to start that process as soon as you decide you are
planning to work on something, or at least well ahead of when you
think you will be ready to submit the patches.


GDB Testsuite
=============

   Included with the GDB distribution is a DejaGNU based testsuite
that can either be used to test your newly built GDB, or for
regression testing a GDB with local modifications.

   Running the testsuite requires the prior installation of DejaGNU,
which is generally available via ftp.  The directory
ftp://sources.redhat.com/pub/dejagnu/ will contain a recent snapshot.
Once DejaGNU is installed, you can run the tests in one of the
following ways:

  (1)	cd gdb-VERSION
	make check-gdb

or

  (2)	cd gdb-VERSION/gdb
	make check

or

  (3)	cd gdb-VERSION/gdb/testsuite
	make site.exp	(builds the site specific file)
	runtest -tool gdb GDB=../gdb    (or GDB=<somepath> as appropriate)

When using a `make'-based method, you can use the Makefile variable
`RUNTESTFLAGS' to pass flags to `runtest', e.g.:

	make RUNTESTFLAGS=--directory=gdb.cp check

If you use GNU make, you can use its `-j' option to run the testsuite
in parallel.  This can greatly reduce the amount of time it takes for
the testsuite to run.  In this case, if you set `RUNTESTFLAGS' then,
by default, the tests will be run serially even under `-j'.  You can
override this and force a parallel run by setting the `make' variable
`FORCE_PARALLEL' to any non-empty value.  Note that the parallel `make
check' assumes that you want to run the entire testsuite, so it is not
compatible with some dejagnu options, like `--directory'.

The last method gives you slightly more control in case of problems
with building one or more test executables or if you are using the
testsuite `standalone', without it being part of the GDB source tree.

See the DejaGNU documentation for further details.


Copyright and License Notices
=============================

Most files maintained by the GDB Project contain a copyright notice
as well as a license notice, usually at the start of the file.

To reduce the length of copyright notices, consecutive years in the
copyright notice can be combined into a single range.  For instance,
the following list of copyright years...

    1986, 1988, 1989, 1991-1993, 1999, 2000, 2007, 2008, 2009, 2010, 2011

... is abbreviated into:

    1986, 1988-1989, 1991-1993, 1999-2000, 2007-2011

Every year of each range, inclusive, is a copyrightable year that
could be listed individually.


(this is for editing this file with GNU emacs)
Local Variables:
mode: text
End: