1 /* Generic symbol-table support for the BFD library.
2 Copyright (C) 1990-2024 Free Software Foundation, Inc.
3 Written by Cygnus Support.
5 This file is part of BFD, the Binary File Descriptor library.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
20 MA 02110-1301, USA. */
26 BFD tries to maintain as much symbol information as it can when
27 it moves information from file to file. BFD passes information
28 to applications though the <<asymbol>> structure. When the
29 application requests the symbol table, BFD reads the table in
30 the native form and translates parts of it into the internal
31 format. To maintain more than the information passed to
32 applications, some targets keep some information ``behind the
33 scenes'' in a structure only the particular back end knows
34 about. For example, the coff back end keeps the original
35 symbol table structure as well as the canonical structure when
36 a BFD is read in. On output, the coff back end can reconstruct
37 the output symbol table so that no information is lost, even
38 information unique to coff which BFD doesn't know or
39 understand. If a coff symbol table were read, but were written
40 through an a.out back end, all the coff specific information
41 would be lost. The symbol table of a BFD
42 is not necessarily read in until a canonicalize request is
43 made. Then the BFD back end fills in a table provided by the
44 application with pointers to the canonical information. To
45 output symbols, the application provides BFD with a table of
46 pointers to pointers to <<asymbol>>s. This allows applications
47 like the linker to output a symbol as it was read, since the ``behind
48 the scenes'' information will be still available.
54 @* symbol handling functions::
58 Reading Symbols, Writing Symbols, Symbols, Symbols
62 There are two stages to reading a symbol table from a BFD:
63 allocating storage, and the actual reading process. This is an
64 excerpt from an application which reads the symbol table:
66 | long storage_needed;
67 | asymbol **symbol_table;
68 | long number_of_symbols;
71 | storage_needed = bfd_get_symtab_upper_bound (abfd);
73 | if (storage_needed < 0)
76 | if (storage_needed == 0)
79 | symbol_table = xmalloc (storage_needed);
82 | bfd_canonicalize_symtab (abfd, symbol_table);
84 | if (number_of_symbols < 0)
87 | for (i = 0; i < number_of_symbols; i++)
88 | process_symbol (symbol_table[i]);
90 All storage for the symbols themselves is in an objalloc
91 connected to the BFD; it is freed when the BFD is closed.
94 Writing Symbols, Mini Symbols, Reading Symbols, Symbols
98 Writing of a symbol table is automatic when a BFD open for
99 writing is closed. The application attaches a vector of
100 pointers to pointers to symbols to the BFD being written, and
101 fills in the symbol count. The close and cleanup code reads
102 through the table provided and performs all the necessary
103 operations. The BFD output code must always be provided with an
104 ``owned'' symbol: one which has come from another BFD, or one
105 which has been created using <<bfd_make_empty_symbol>>. Here is an
106 example showing the creation of a symbol table with only one element:
108 | #include "sysdep.h"
116 | abfd = bfd_openw ("foo","a.out-sunos-big");
117 | bfd_set_format (abfd, bfd_object);
118 | new = bfd_make_empty_symbol (abfd);
119 | new->name = "dummy_symbol";
120 | new->section = bfd_make_section_old_way (abfd, ".text");
121 | new->flags = BSF_GLOBAL;
122 | new->value = 0x12345;
127 | bfd_set_symtab (abfd, ptrs, 1);
134 | 00012345 A dummy_symbol
136 Many formats cannot represent arbitrary symbol information; for
137 instance, the <<a.out>> object format does not allow an
138 arbitrary number of sections. A symbol pointing to a section
139 which is not one of <<.text>>, <<.data>> or <<.bss>> cannot
143 Mini Symbols, typedef asymbol, Writing Symbols, Symbols
147 Mini symbols provide read-only access to the symbol table.
148 They use less memory space, but require more time to access.
149 They can be useful for tools like nm or objdump, which may
150 have to handle symbol tables of extremely large executables.
152 The <<bfd_read_minisymbols>> function will read the symbols
153 into memory in an internal form. It will return a <<void *>>
154 pointer to a block of memory, a symbol count, and the size of
155 each symbol. The pointer is allocated using <<malloc>>, and
156 should be freed by the caller when it is no longer needed.
158 The function <<bfd_minisymbol_to_symbol>> will take a pointer
159 to a minisymbol, and a pointer to a structure returned by
160 <<bfd_make_empty_symbol>>, and return a <<asymbol>> structure.
161 The return value may or may not be the same as the value from
162 <<bfd_make_empty_symbol>> which was passed in.
169 typedef asymbol, symbol handling functions, Mini Symbols, Symbols
174 An <<asymbol>> has the form:
177 .typedef struct bfd_symbol
179 . {* A pointer to the BFD which owns the symbol. This information
180 . is necessary so that a back end can work out what additional
181 . information (invisible to the application writer) is carried
184 . This field is *almost* redundant, since you can use section->owner
185 . instead, except that some symbols point to the global sections
186 . bfd_{abs,com,und}_section. This could be fixed by making
187 . these globals be per-bfd (or per-target-flavor). FIXME. *}
188 . struct bfd *the_bfd; {* Use bfd_asymbol_bfd(sym) to access this field. *}
190 . {* The text of the symbol. The name is left alone, and not copied; the
191 . application may not alter it. *}
194 . {* The value of the symbol. This really should be a union of a
195 . numeric value with a pointer, since some flags indicate that
196 . a pointer to another symbol is stored here. *}
199 . {* Attributes of a symbol. *}
200 .#define BSF_NO_FLAGS 0
202 . {* The symbol has local scope; <<static>> in <<C>>. The value
203 . is the offset into the section of the data. *}
204 .#define BSF_LOCAL (1 << 0)
206 . {* The symbol has global scope; initialized data in <<C>>. The
207 . value is the offset into the section of the data. *}
208 .#define BSF_GLOBAL (1 << 1)
210 . {* The symbol has global scope and is exported. The value is
211 . the offset into the section of the data. *}
212 .#define BSF_EXPORT BSF_GLOBAL {* No real difference. *}
214 . {* A normal C symbol would be one of:
215 . <<BSF_LOCAL>>, <<BSF_UNDEFINED>> or <<BSF_GLOBAL>>. *}
217 . {* The symbol is a debugging record. The value has an arbitrary
218 . meaning, unless BSF_DEBUGGING_RELOC is also set. *}
219 .#define BSF_DEBUGGING (1 << 2)
221 . {* The symbol denotes a function entry point. Used in ELF,
222 . perhaps others someday. *}
223 .#define BSF_FUNCTION (1 << 3)
225 . {* Used by the linker. *}
226 .#define BSF_KEEP (1 << 5)
228 . {* An ELF common symbol. *}
229 .#define BSF_ELF_COMMON (1 << 6)
231 . {* A weak global symbol, overridable without warnings by
232 . a regular global symbol of the same name. *}
233 .#define BSF_WEAK (1 << 7)
235 . {* This symbol was created to point to a section, e.g. ELF's
236 . STT_SECTION symbols. *}
237 .#define BSF_SECTION_SYM (1 << 8)
239 . {* The symbol used to be a common symbol, but now it is
241 .#define BSF_OLD_COMMON (1 << 9)
243 . {* In some files the type of a symbol sometimes alters its
244 . location in an output file - ie in coff a <<ISFCN>> symbol
245 . which is also <<C_EXT>> symbol appears where it was
246 . declared and not at the end of a section. This bit is set
247 . by the target BFD part to convey this information. *}
248 .#define BSF_NOT_AT_END (1 << 10)
250 . {* Signal that the symbol is the label of constructor section. *}
251 .#define BSF_CONSTRUCTOR (1 << 11)
253 . {* Signal that the symbol is a warning symbol. The name is a
254 . warning. The name of the next symbol is the one to warn about;
255 . if a reference is made to a symbol with the same name as the next
256 . symbol, a warning is issued by the linker. *}
257 .#define BSF_WARNING (1 << 12)
259 . {* Signal that the symbol is indirect. This symbol is an indirect
260 . pointer to the symbol with the same name as the next symbol. *}
261 .#define BSF_INDIRECT (1 << 13)
263 . {* BSF_FILE marks symbols that contain a file name. This is used
264 . for ELF STT_FILE symbols. *}
265 .#define BSF_FILE (1 << 14)
267 . {* Symbol is from dynamic linking information. *}
268 .#define BSF_DYNAMIC (1 << 15)
270 . {* The symbol denotes a data object. Used in ELF, and perhaps
272 .#define BSF_OBJECT (1 << 16)
274 . {* This symbol is a debugging symbol. The value is the offset
275 . into the section of the data. BSF_DEBUGGING should be set
277 .#define BSF_DEBUGGING_RELOC (1 << 17)
279 . {* This symbol is thread local. Used in ELF. *}
280 .#define BSF_THREAD_LOCAL (1 << 18)
282 . {* This symbol represents a complex relocation expression,
283 . with the expression tree serialized in the symbol name. *}
284 .#define BSF_RELC (1 << 19)
286 . {* This symbol represents a signed complex relocation expression,
287 . with the expression tree serialized in the symbol name. *}
288 .#define BSF_SRELC (1 << 20)
290 . {* This symbol was created by bfd_get_synthetic_symtab. *}
291 .#define BSF_SYNTHETIC (1 << 21)
293 . {* This symbol is an indirect code object. Unrelated to BSF_INDIRECT.
294 . The dynamic linker will compute the value of this symbol by
295 . calling the function that it points to. BSF_FUNCTION must
296 . also be also set. *}
297 .#define BSF_GNU_INDIRECT_FUNCTION (1 << 22)
298 . {* This symbol is a globally unique data object. The dynamic linker
299 . will make sure that in the entire process there is just one symbol
300 . with this name and type in use. BSF_OBJECT must also be set. *}
301 .#define BSF_GNU_UNIQUE (1 << 23)
303 . {* This section symbol should be included in the symbol table. *}
304 .#define BSF_SECTION_SYM_USED (1 << 24)
308 . {* A pointer to the section to which this symbol is
309 . relative. This will always be non NULL, there are special
310 . sections for undefined and absolute symbols. *}
311 . struct bfd_section *section;
313 . {* Back end special data. *}
325 .typedef enum bfd_print_symbol
327 . bfd_print_symbol_name,
328 . bfd_print_symbol_more,
329 . bfd_print_symbol_all
330 .} bfd_print_symbol_type;
332 .{* Information about a symbol that nm needs. *}
334 .typedef struct _symbol_info
338 . const char *name; {* Symbol name. *}
339 . unsigned char stab_type; {* Stab type. *}
340 . char stab_other; {* Stab other. *}
341 . short stab_desc; {* Stab desc. *}
342 . const char *stab_name; {* String for stab type. *}
345 .{* An empty string that will not match the address of any other
346 . symbol name, even unnamed local symbols which will also have empty
347 . string names. This can be used to flag a symbol as corrupt if its
348 . name uses an out of range string table index. *}
349 .extern const char bfd_symbol_error_name[];
355 #include "safe-ctype.h"
357 #include "aout/stab_gnu.h"
359 const char bfd_symbol_error_name
[] = { 0 };
364 symbol handling functions, , typedef asymbol, Symbols
366 Symbol handling functions
371 bfd_get_symtab_upper_bound
374 Return the number of bytes required to store a vector of pointers
375 to <<asymbols>> for all the symbols in the BFD @var{abfd},
376 including a terminal NULL pointer. If there are no symbols in
377 the BFD, then return 0. If an error occurs, return -1.
379 .#define bfd_get_symtab_upper_bound(abfd) \
380 . BFD_SEND (abfd, _bfd_get_symtab_upper_bound, (abfd))
389 bool bfd_is_local_label (bfd *abfd, asymbol *sym);
392 Return TRUE if the given symbol @var{sym} in the BFD @var{abfd} is
393 a compiler generated local label, else return FALSE.
397 bfd_is_local_label (bfd
*abfd
, asymbol
*sym
)
399 /* The BSF_SECTION_SYM check is needed for IA-64, where every label that
400 starts with '.' is local. This would accidentally catch section names
401 if we didn't reject them here. */
402 if ((sym
->flags
& (BSF_GLOBAL
| BSF_WEAK
| BSF_FILE
| BSF_SECTION_SYM
)) != 0)
404 if (sym
->name
== NULL
|| sym
->name
== bfd_symbol_error_name
)
406 return bfd_is_local_label_name (abfd
, sym
->name
);
411 bfd_is_local_label_name
414 bool bfd_is_local_label_name (bfd *abfd, const char *name);
417 Return TRUE if a symbol with the name @var{name} in the BFD
418 @var{abfd} is a compiler generated local label, else return
419 FALSE. This just checks whether the name has the form of a
422 .#define bfd_is_local_label_name(abfd, name) \
423 . BFD_SEND (abfd, _bfd_is_local_label_name, (abfd, name))
429 bfd_is_target_special_symbol
432 bool bfd_is_target_special_symbol (bfd *abfd, asymbol *sym);
435 Return TRUE iff a symbol @var{sym} in the BFD @var{abfd} is something
436 special to the particular target represented by the BFD. Such symbols
437 should normally not be mentioned to the user.
439 .#define bfd_is_target_special_symbol(abfd, sym) \
440 . BFD_SEND (abfd, _bfd_is_target_special_symbol, (abfd, sym))
446 bfd_canonicalize_symtab
449 Read the symbols from the BFD @var{abfd}, and fills in
450 the vector @var{location} with pointers to the symbols and
452 Return the actual number of symbol pointers, not
455 .#define bfd_canonicalize_symtab(abfd, location) \
456 . BFD_SEND (abfd, _bfd_canonicalize_symtab, (abfd, location))
466 (bfd *abfd, asymbol **location, unsigned int count);
469 Arrange that when the output BFD @var{abfd} is closed,
470 the table @var{location} of @var{count} pointers to symbols
475 bfd_set_symtab (bfd
*abfd
, asymbol
**location
, unsigned int symcount
)
477 if (abfd
->format
!= bfd_object
|| bfd_read_p (abfd
))
479 bfd_set_error (bfd_error_invalid_operation
);
483 abfd
->outsymbols
= location
;
484 abfd
->symcount
= symcount
;
490 bfd_print_symbol_vandf
493 void bfd_print_symbol_vandf (bfd *abfd, void *file, asymbol *symbol);
496 Print the value and flags of the @var{symbol} supplied to the
500 bfd_print_symbol_vandf (bfd
*abfd
, void *arg
, asymbol
*symbol
)
502 FILE *file
= (FILE *) arg
;
504 flagword type
= symbol
->flags
;
506 if (symbol
->section
!= NULL
)
507 bfd_fprintf_vma (abfd
, file
, symbol
->value
+ symbol
->section
->vma
);
509 bfd_fprintf_vma (abfd
, file
, symbol
->value
);
511 /* This presumes that a symbol can not be both BSF_DEBUGGING and
512 BSF_DYNAMIC, nor more than one of BSF_FUNCTION, BSF_FILE, and
514 fprintf (file
, " %c%c%c%c%c%c%c",
516 ? (type
& BSF_GLOBAL
) ? '!' : 'l'
517 : (type
& BSF_GLOBAL
) ? 'g'
518 : (type
& BSF_GNU_UNIQUE
) ? 'u' : ' '),
519 (type
& BSF_WEAK
) ? 'w' : ' ',
520 (type
& BSF_CONSTRUCTOR
) ? 'C' : ' ',
521 (type
& BSF_WARNING
) ? 'W' : ' ',
522 (type
& BSF_INDIRECT
) ? 'I' : (type
& BSF_GNU_INDIRECT_FUNCTION
) ? 'i' : ' ',
523 (type
& BSF_DEBUGGING
) ? 'd' : (type
& BSF_DYNAMIC
) ? 'D' : ' ',
524 ((type
& BSF_FUNCTION
)
528 : ((type
& BSF_OBJECT
) ? 'O' : ' '))));
533 bfd_make_empty_symbol
536 Create a new <<asymbol>> structure for the BFD @var{abfd}
537 and return a pointer to it.
539 This routine is necessary because each back end has private
540 information surrounding the <<asymbol>>. Building your own
541 <<asymbol>> and pointing to it will not create the private
542 information, and will cause problems later on.
544 .#define bfd_make_empty_symbol(abfd) \
545 . BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
551 _bfd_generic_make_empty_symbol
554 asymbol *_bfd_generic_make_empty_symbol (bfd *);
557 Create a new <<asymbol>> structure for the BFD @var{abfd}
558 and return a pointer to it. Used by core file routines,
559 binary back-end and anywhere else where no private info
564 _bfd_generic_make_empty_symbol (bfd
*abfd
)
566 size_t amt
= sizeof (asymbol
);
567 asymbol
*new_symbol
= (asymbol
*) bfd_zalloc (abfd
, amt
);
569 new_symbol
->the_bfd
= abfd
;
575 bfd_make_debug_symbol
578 Create a new <<asymbol>> structure for the BFD @var{abfd},
579 to be used as a debugging symbol.
581 .#define bfd_make_debug_symbol(abfd) \
582 . BFD_SEND (abfd, _bfd_make_debug_symbol, (abfd))
586 struct section_to_type
592 /* Map special section names to POSIX/BSD single-character symbol types.
593 This table is probably incomplete. It is sorted for convenience of
594 adding entries. Since it is so short, a linear search is used. */
595 static const struct section_to_type stt
[] =
597 {".drectve", 'i'}, /* MSVC's .drective section */
598 {".edata", 'e'}, /* MSVC's .edata (export) section */
599 {".idata", 'i'}, /* MSVC's .idata (import) section */
600 {".pdata", 'p'}, /* MSVC's .pdata (stack unwind) section */
604 /* Return the single-character symbol type corresponding to
605 section S, or '?' for an unknown COFF section.
607 Check for leading strings which match, followed by a number, '.',
608 or '$' so .idata5 matches the .idata entry. */
611 coff_section_type (const char *s
)
613 const struct section_to_type
*t
;
615 for (t
= &stt
[0]; t
->section
; t
++)
617 size_t len
= strlen (t
->section
);
618 if (strncmp (s
, t
->section
, len
) == 0
619 && memchr (".$0123456789", s
[len
], 13) != 0)
626 /* Return the single-character symbol type corresponding to section
627 SECTION, or '?' for an unknown section. This uses section flags to
630 FIXME These types are unhandled: e, i, p. If we handled these also,
631 we could perhaps obsolete coff_section_type. */
634 decode_section_type (const struct bfd_section
*section
)
636 if (section
->flags
& SEC_CODE
)
638 if (section
->flags
& SEC_DATA
)
640 if (section
->flags
& SEC_READONLY
)
642 else if (section
->flags
& SEC_SMALL_DATA
)
647 if ((section
->flags
& SEC_HAS_CONTENTS
) == 0)
649 if (section
->flags
& SEC_SMALL_DATA
)
654 if (section
->flags
& SEC_DEBUGGING
)
656 if ((section
->flags
& SEC_HAS_CONTENTS
) && (section
->flags
& SEC_READONLY
))
667 int bfd_decode_symclass (asymbol *symbol);
670 Return a character corresponding to the symbol
671 class of @var{symbol}, or '?' for an unknown class.
674 bfd_decode_symclass (asymbol
*symbol
)
679 if (symbol
== NULL
|| symbol
->section
== NULL
)
682 if (symbol
->section
&& bfd_is_com_section (symbol
->section
))
684 if (symbol
->section
->flags
& SEC_SMALL_DATA
)
689 if (bfd_is_und_section (symbol
->section
))
691 if (symbol
->flags
& BSF_WEAK
)
693 /* If weak, determine if it's specifically an object
694 or non-object weak. */
695 if (symbol
->flags
& BSF_OBJECT
)
703 if (bfd_is_ind_section (symbol
->section
))
705 if (symbol
->flags
& BSF_GNU_INDIRECT_FUNCTION
)
707 if (symbol
->flags
& BSF_WEAK
)
709 /* If weak, determine if it's specifically an object
710 or non-object weak. */
711 if (symbol
->flags
& BSF_OBJECT
)
716 if (symbol
->flags
& BSF_GNU_UNIQUE
)
718 if (!(symbol
->flags
& (BSF_GLOBAL
| BSF_LOCAL
)))
721 if (bfd_is_abs_section (symbol
->section
))
723 else if (symbol
->section
)
725 c
= coff_section_type (symbol
->section
->name
);
727 c
= decode_section_type (symbol
->section
);
731 if (symbol
->flags
& BSF_GLOBAL
)
735 /* We don't have to handle these cases just yet, but we will soon:
747 bfd_is_undefined_symclass
750 bool bfd_is_undefined_symclass (int symclass);
753 Returns non-zero if the class symbol returned by
754 bfd_decode_symclass represents an undefined symbol.
755 Returns zero otherwise.
759 bfd_is_undefined_symclass (int symclass
)
761 return symclass
== 'U' || symclass
== 'w' || symclass
== 'v';
769 void bfd_symbol_info (asymbol *symbol, symbol_info *ret);
772 Fill in the basic info about symbol that nm needs.
773 Additional info may be added by the back-ends after
774 calling this function.
778 bfd_symbol_info (asymbol
*symbol
, symbol_info
*ret
)
780 ret
->type
= bfd_decode_symclass (symbol
);
782 if (bfd_is_undefined_symclass (ret
->type
))
785 ret
->value
= symbol
->value
+ symbol
->section
->vma
;
787 ret
->name
= (symbol
->name
!= bfd_symbol_error_name
788 ? symbol
->name
: _("<corrupt>"));
793 bfd_copy_private_symbol_data
796 bool bfd_copy_private_symbol_data
797 (bfd *ibfd, asymbol *isym, bfd *obfd, asymbol *osym);
800 Copy private symbol information from @var{isym} in the BFD
801 @var{ibfd} to the symbol @var{osym} in the BFD @var{obfd}.
802 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
805 o <<bfd_error_no_memory>> -
806 Not enough memory exists to create private data for @var{osec}.
808 .#define bfd_copy_private_symbol_data(ibfd, isymbol, obfd, osymbol) \
809 . BFD_SEND (obfd, _bfd_copy_private_symbol_data, \
810 . (ibfd, isymbol, obfd, osymbol))
814 /* The generic version of the function which returns mini symbols.
815 This is used when the backend does not provide a more efficient
816 version. It just uses BFD asymbol structures as mini symbols. */
819 _bfd_generic_read_minisymbols (bfd
*abfd
,
825 asymbol
**syms
= NULL
;
829 storage
= bfd_get_dynamic_symtab_upper_bound (abfd
);
831 storage
= bfd_get_symtab_upper_bound (abfd
);
837 syms
= (asymbol
**) bfd_malloc (storage
);
842 symcount
= bfd_canonicalize_dynamic_symtab (abfd
, syms
);
844 symcount
= bfd_canonicalize_symtab (abfd
, syms
);
849 /* We return 0 above when storage is 0. Exit in the same state
850 here, so as to not complicate callers with having to deal with
851 freeing memory for zero symcount. */
856 *sizep
= sizeof (asymbol
*);
861 bfd_set_error (bfd_error_no_symbols
);
866 /* The generic version of the function which converts a minisymbol to
867 an asymbol. We don't worry about the sym argument we are passed;
868 we just return the asymbol the minisymbol points to. */
871 _bfd_generic_minisymbol_to_symbol (bfd
*abfd ATTRIBUTE_UNUSED
,
872 bool dynamic ATTRIBUTE_UNUSED
,
874 asymbol
*sym ATTRIBUTE_UNUSED
)
876 return *(asymbol
**) minisym
;
879 /* Look through stabs debugging information in .stab and .stabstr
880 sections to find the source file and line closest to a desired
881 location. This is used by COFF and ELF targets. It sets *pfound
882 to TRUE if it finds some information. The *pinfo field is used to
883 pass cached information in and out of this routine; this first time
884 the routine is called for a BFD, *pinfo should be NULL. The value
885 placed in *pinfo should be saved with the BFD, and passed back each
886 time this function is called. */
888 /* We use a cache by default. */
890 #define ENABLE_CACHING
892 /* We keep an array of indexentry structures to record where in the
893 stabs section we should look to find line number information for a
894 particular address. */
901 char *directory_name
;
907 /* Compare two indexentry structures. This is called via qsort. */
910 cmpindexentry (const void *a
, const void *b
)
912 const struct indexentry
*contestantA
= (const struct indexentry
*) a
;
913 const struct indexentry
*contestantB
= (const struct indexentry
*) b
;
915 if (contestantA
->val
< contestantB
->val
)
917 if (contestantA
->val
> contestantB
->val
)
919 return contestantA
->idx
- contestantB
->idx
;
922 /* A pointer to this structure is stored in *pinfo. */
924 struct stab_find_info
926 /* The .stab section. */
928 /* The .stabstr section. */
930 /* The contents of the .stab section. */
932 /* The contents of the .stabstr section. */
935 /* A table that indexes stabs by memory address. */
936 struct indexentry
*indextable
;
937 /* The number of entries in indextable. */
940 #ifdef ENABLE_CACHING
941 /* Cached values to restart quickly. */
942 struct indexentry
*cached_indexentry
;
943 bfd_vma cached_offset
;
944 bfd_byte
*cached_stab
;
945 char *cached_file_name
;
948 /* Saved ptr to malloc'ed filename. */
953 _bfd_stab_section_find_nearest_line (bfd
*abfd
,
958 const char **pfilename
,
959 const char **pfnname
,
963 struct stab_find_info
*info
;
964 bfd_size_type stabsize
, strsize
;
965 bfd_byte
*stab
, *str
;
966 bfd_byte
*nul_fun
, *nul_str
;
967 bfd_size_type stroff
;
968 struct indexentry
*indexentry
;
970 char *directory_name
;
971 bool saw_line
, saw_func
;
974 *pfilename
= bfd_get_filename (abfd
);
978 /* Stabs entries use a 12 byte format:
979 4 byte string table index
981 1 byte stab other field
982 2 byte stab desc field
984 FIXME: This will have to change for a 64 bit object format.
986 The stabs symbols are divided into compilation units. For the
987 first entry in each unit, the type of 0, the value is the length
988 of the string table for this unit, and the desc field is the
989 number of stabs symbols for this unit. */
996 #define STABSIZE (12)
998 info
= (struct stab_find_info
*) *pinfo
;
1001 if (info
->stabsec
== NULL
|| info
->strsec
== NULL
)
1003 /* No usable stabs debugging information. */
1007 stabsize
= (info
->stabsec
->rawsize
1008 ? info
->stabsec
->rawsize
1009 : info
->stabsec
->size
);
1010 strsize
= (info
->strsec
->rawsize
1011 ? info
->strsec
->rawsize
1012 : info
->strsec
->size
);
1016 long reloc_size
, reloc_count
;
1017 arelent
**reloc_vector
;
1019 char *function_name
;
1020 bfd_size_type amt
= sizeof *info
;
1022 info
= (struct stab_find_info
*) bfd_zalloc (abfd
, amt
);
1027 /* FIXME: When using the linker --split-by-file or
1028 --split-by-reloc options, it is possible for the .stab and
1029 .stabstr sections to be split. We should handle that. */
1031 info
->stabsec
= bfd_get_section_by_name (abfd
, ".stab");
1032 info
->strsec
= bfd_get_section_by_name (abfd
, ".stabstr");
1034 if (info
->stabsec
== NULL
|| info
->strsec
== NULL
)
1036 /* Try SOM section names. */
1037 info
->stabsec
= bfd_get_section_by_name (abfd
, "$GDB_SYMBOLS$");
1038 info
->strsec
= bfd_get_section_by_name (abfd
, "$GDB_STRINGS$");
1040 if (info
->stabsec
== NULL
|| info
->strsec
== NULL
)
1044 if ((info
->stabsec
->flags
& SEC_HAS_CONTENTS
) == 0
1045 || (info
->strsec
->flags
& SEC_HAS_CONTENTS
) == 0)
1048 stabsize
= (info
->stabsec
->rawsize
1049 ? info
->stabsec
->rawsize
1050 : info
->stabsec
->size
);
1051 stabsize
= (stabsize
/ STABSIZE
) * STABSIZE
;
1052 strsize
= (info
->strsec
->rawsize
1053 ? info
->strsec
->rawsize
1054 : info
->strsec
->size
);
1056 if (stabsize
== 0 || strsize
== 0)
1059 if (!bfd_malloc_and_get_section (abfd
, info
->stabsec
, &info
->stabs
))
1061 if (!bfd_malloc_and_get_section (abfd
, info
->strsec
, &info
->strs
))
1064 /* Stab strings ought to be nul terminated. Ensure the last one
1065 is, to prevent running off the end of the buffer. */
1066 info
->strs
[strsize
- 1] = 0;
1068 /* If this is a relocatable object file, we have to relocate
1069 the entries in .stab. This should always be simple 32 bit
1070 relocations against symbols defined in this object file, so
1071 this should be no big deal. */
1072 reloc_size
= bfd_get_reloc_upper_bound (abfd
, info
->stabsec
);
1075 reloc_vector
= (arelent
**) bfd_malloc (reloc_size
);
1076 if (reloc_vector
== NULL
&& reloc_size
!= 0)
1078 reloc_count
= bfd_canonicalize_reloc (abfd
, info
->stabsec
, reloc_vector
,
1080 if (reloc_count
< 0)
1083 free (reloc_vector
);
1091 info
->stabsec
= NULL
;
1094 if (reloc_count
> 0)
1098 for (pr
= reloc_vector
; *pr
!= NULL
; pr
++)
1103 bfd_size_type octets
;
1106 /* Ignore R_*_NONE relocs. */
1107 if (r
->howto
->dst_mask
== 0)
1110 octets
= r
->address
* bfd_octets_per_byte (abfd
, NULL
);
1111 if (r
->howto
->rightshift
!= 0
1112 || bfd_get_reloc_size (r
->howto
) != 4
1113 || r
->howto
->bitsize
!= 32
1114 || r
->howto
->pc_relative
1115 || r
->howto
->bitpos
!= 0
1116 || r
->howto
->dst_mask
!= 0xffffffff
1117 || octets
> stabsize
- 4)
1120 (_("unsupported .stab relocation"));
1121 bfd_set_error (bfd_error_invalid_operation
);
1125 val
= bfd_get_32 (abfd
, info
->stabs
+ octets
);
1126 val
&= r
->howto
->src_mask
;
1127 sym
= *r
->sym_ptr_ptr
;
1128 val
+= sym
->value
+ sym
->section
->vma
+ r
->addend
;
1129 bfd_put_32 (abfd
, (bfd_vma
) val
, info
->stabs
+ octets
);
1133 free (reloc_vector
);
1135 /* First time through this function, build a table matching
1136 function VM addresses to stabs, then sort based on starting
1137 VM address. Do this in two passes: once to count how many
1138 table entries we'll need, and a second to actually build the
1141 info
->indextablesize
= 0;
1143 for (stab
= info
->stabs
; stab
< info
->stabs
+ stabsize
; stab
+= STABSIZE
)
1145 if (stab
[TYPEOFF
] == (bfd_byte
) N_SO
)
1147 /* if we did not see a function def, leave space for one. */
1148 if (nul_fun
!= NULL
)
1149 ++info
->indextablesize
;
1151 /* N_SO with null name indicates EOF */
1152 if (bfd_get_32 (abfd
, stab
+ STRDXOFF
) == 0)
1158 /* two N_SO's in a row is a filename and directory. Skip */
1159 if (stab
+ STABSIZE
+ TYPEOFF
< info
->stabs
+ stabsize
1160 && *(stab
+ STABSIZE
+ TYPEOFF
) == (bfd_byte
) N_SO
)
1164 else if (stab
[TYPEOFF
] == (bfd_byte
) N_FUN
1165 && bfd_get_32 (abfd
, stab
+ STRDXOFF
) != 0)
1168 ++info
->indextablesize
;
1172 if (nul_fun
!= NULL
)
1173 ++info
->indextablesize
;
1175 if (info
->indextablesize
== 0)
1181 info
->stabsec
= NULL
;
1184 ++info
->indextablesize
;
1186 amt
= info
->indextablesize
;
1187 amt
*= sizeof (struct indexentry
);
1188 info
->indextable
= (struct indexentry
*) bfd_malloc (amt
);
1189 if (info
->indextable
== NULL
)
1193 directory_name
= NULL
;
1197 for (i
= 0, stab
= info
->stabs
, nul_str
= str
= info
->strs
;
1198 i
< info
->indextablesize
&& stab
< info
->stabs
+ stabsize
;
1201 switch (stab
[TYPEOFF
])
1204 /* This is the first entry in a compilation unit. */
1205 if ((bfd_size_type
) ((info
->strs
+ strsize
) - str
) < stroff
)
1208 stroff
= bfd_get_32 (abfd
, stab
+ VALOFF
);
1212 /* The main file name. */
1214 /* The following code creates a new indextable entry with
1215 a NULL function name if there were no N_FUNs in a file.
1216 Note that a N_SO without a file name is an EOF and
1217 there could be 2 N_SO following it with the new filename
1219 if (nul_fun
!= NULL
)
1221 info
->indextable
[i
].val
= bfd_get_32 (abfd
, nul_fun
+ VALOFF
);
1222 info
->indextable
[i
].stab
= nul_fun
;
1223 info
->indextable
[i
].str
= nul_str
;
1224 info
->indextable
[i
].directory_name
= directory_name
;
1225 info
->indextable
[i
].file_name
= file_name
;
1226 info
->indextable
[i
].function_name
= NULL
;
1227 info
->indextable
[i
].idx
= i
;
1231 directory_name
= NULL
;
1232 file_name
= (char *) str
+ bfd_get_32 (abfd
, stab
+ STRDXOFF
);
1233 if (file_name
== (char *) str
)
1242 if (file_name
>= (char *) info
->strs
+ strsize
1243 || file_name
< (char *) str
)
1245 if (stab
+ STABSIZE
+ TYPEOFF
< info
->stabs
+ stabsize
1246 && *(stab
+ STABSIZE
+ TYPEOFF
) == (bfd_byte
) N_SO
)
1248 /* Two consecutive N_SOs are a directory and a
1251 directory_name
= file_name
;
1252 file_name
= ((char *) str
1253 + bfd_get_32 (abfd
, stab
+ STRDXOFF
));
1254 if (file_name
>= (char *) info
->strs
+ strsize
1255 || file_name
< (char *) str
)
1262 /* The name of an include file. */
1263 file_name
= (char *) str
+ bfd_get_32 (abfd
, stab
+ STRDXOFF
);
1264 /* PR 17512: file: 0c680a1f. */
1265 /* PR 17512: file: 5da8aec4. */
1266 if (file_name
>= (char *) info
->strs
+ strsize
1267 || file_name
< (char *) str
)
1272 /* A function name. */
1273 function_name
= (char *) str
+ bfd_get_32 (abfd
, stab
+ STRDXOFF
);
1274 if (function_name
== (char *) str
)
1276 if (function_name
>= (char *) info
->strs
+ strsize
1277 || function_name
< (char *) str
)
1278 function_name
= NULL
;
1281 info
->indextable
[i
].val
= bfd_get_32 (abfd
, stab
+ VALOFF
);
1282 info
->indextable
[i
].stab
= stab
;
1283 info
->indextable
[i
].str
= str
;
1284 info
->indextable
[i
].directory_name
= directory_name
;
1285 info
->indextable
[i
].file_name
= file_name
;
1286 info
->indextable
[i
].function_name
= function_name
;
1287 info
->indextable
[i
].idx
= i
;
1293 if (nul_fun
!= NULL
)
1295 info
->indextable
[i
].val
= bfd_get_32 (abfd
, nul_fun
+ VALOFF
);
1296 info
->indextable
[i
].stab
= nul_fun
;
1297 info
->indextable
[i
].str
= nul_str
;
1298 info
->indextable
[i
].directory_name
= directory_name
;
1299 info
->indextable
[i
].file_name
= file_name
;
1300 info
->indextable
[i
].function_name
= NULL
;
1301 info
->indextable
[i
].idx
= i
;
1305 info
->indextable
[i
].val
= (bfd_vma
) -1;
1306 info
->indextable
[i
].stab
= info
->stabs
+ stabsize
;
1307 info
->indextable
[i
].str
= str
;
1308 info
->indextable
[i
].directory_name
= NULL
;
1309 info
->indextable
[i
].file_name
= NULL
;
1310 info
->indextable
[i
].function_name
= NULL
;
1311 info
->indextable
[i
].idx
= i
;
1314 info
->indextablesize
= i
;
1315 qsort (info
->indextable
, (size_t) i
, sizeof (struct indexentry
),
1319 /* We are passed a section relative offset. The offsets in the
1320 stabs information are absolute. */
1321 offset
+= bfd_section_vma (section
);
1323 #ifdef ENABLE_CACHING
1324 if (info
->cached_indexentry
!= NULL
1325 && offset
>= info
->cached_offset
1326 && offset
< (info
->cached_indexentry
+ 1)->val
)
1328 stab
= info
->cached_stab
;
1329 indexentry
= info
->cached_indexentry
;
1330 file_name
= info
->cached_file_name
;
1338 /* Cache non-existent or invalid. Do binary search on
1343 high
= info
->indextablesize
- 1;
1346 mid
= (high
+ low
) / 2;
1347 if (offset
>= info
->indextable
[mid
].val
1348 && offset
< info
->indextable
[mid
+ 1].val
)
1350 indexentry
= &info
->indextable
[mid
];
1354 if (info
->indextable
[mid
].val
> offset
)
1360 if (indexentry
== NULL
)
1363 stab
= indexentry
->stab
+ STABSIZE
;
1364 file_name
= indexentry
->file_name
;
1367 directory_name
= indexentry
->directory_name
;
1368 str
= indexentry
->str
;
1372 for (; stab
< (indexentry
+1)->stab
; stab
+= STABSIZE
)
1379 switch (stab
[TYPEOFF
])
1382 /* The name of an include file. */
1383 val
= bfd_get_32 (abfd
, stab
+ VALOFF
);
1386 file_name
= (char *) str
+ bfd_get_32 (abfd
, stab
+ STRDXOFF
);
1387 if (file_name
>= (char *) info
->strs
+ strsize
1388 || file_name
< (char *) str
)
1397 /* A line number. If the function was specified, then the value
1398 is relative to the start of the function. Otherwise, the
1399 value is an absolute address. */
1400 val
= ((indexentry
->function_name
? indexentry
->val
: 0)
1401 + bfd_get_32 (abfd
, stab
+ VALOFF
));
1402 /* If this line starts before our desired offset, or if it's
1403 the first line we've been able to find, use it. The
1404 !saw_line check works around a bug in GCC 2.95.3, which emits
1405 the first N_SLINE late. */
1406 if (!saw_line
|| val
<= offset
)
1408 *pline
= bfd_get_16 (abfd
, stab
+ DESCOFF
);
1410 #ifdef ENABLE_CACHING
1411 info
->cached_stab
= stab
;
1412 info
->cached_offset
= val
;
1413 info
->cached_file_name
= file_name
;
1414 info
->cached_indexentry
= indexentry
;
1424 if (saw_func
|| saw_line
)
1436 if (file_name
== NULL
|| IS_ABSOLUTE_PATH (file_name
)
1437 || directory_name
== NULL
)
1438 *pfilename
= file_name
;
1443 dirlen
= strlen (directory_name
);
1444 if (info
->filename
== NULL
1445 || filename_ncmp (info
->filename
, directory_name
, dirlen
) != 0
1446 || filename_cmp (info
->filename
+ dirlen
, file_name
) != 0)
1450 /* Don't free info->filename here. objdump and other
1451 apps keep a copy of a previously returned file name
1453 len
= strlen (file_name
) + 1;
1454 info
->filename
= (char *) bfd_alloc (abfd
, dirlen
+ len
);
1455 if (info
->filename
== NULL
)
1457 memcpy (info
->filename
, directory_name
, dirlen
);
1458 memcpy (info
->filename
+ dirlen
, file_name
, len
);
1461 *pfilename
= info
->filename
;
1464 if (indexentry
->function_name
!= NULL
)
1468 /* This will typically be something like main:F(0,1), so we want
1469 to clobber the colon. It's OK to change the name, since the
1470 string is in our own local storage anyhow. */
1471 s
= strchr (indexentry
->function_name
, ':');
1475 *pfnname
= indexentry
->function_name
;
1482 _bfd_stab_cleanup (bfd
*abfd ATTRIBUTE_UNUSED
, void **pinfo
)
1484 struct stab_find_info
*info
= (struct stab_find_info
*) *pinfo
;
1488 free (info
->indextable
);
1494 _bfd_nosymbols_canonicalize_symtab (bfd
*abfd ATTRIBUTE_UNUSED
,
1495 asymbol
**location ATTRIBUTE_UNUSED
)
1501 _bfd_nosymbols_print_symbol (bfd
*abfd ATTRIBUTE_UNUSED
,
1502 void *afile ATTRIBUTE_UNUSED
,
1503 asymbol
*symbol ATTRIBUTE_UNUSED
,
1504 bfd_print_symbol_type how ATTRIBUTE_UNUSED
)
1509 _bfd_nosymbols_get_symbol_info (bfd
*abfd ATTRIBUTE_UNUSED
,
1510 asymbol
*sym ATTRIBUTE_UNUSED
,
1511 symbol_info
*ret ATTRIBUTE_UNUSED
)
1516 _bfd_nosymbols_get_symbol_version_string (bfd
*abfd
,
1517 asymbol
*symbol ATTRIBUTE_UNUSED
,
1518 bool base_p ATTRIBUTE_UNUSED
,
1519 bool *hidden ATTRIBUTE_UNUSED
)
1521 return (const char *) _bfd_ptr_bfd_null_error (abfd
);
1525 _bfd_nosymbols_bfd_is_local_label_name (bfd
*abfd ATTRIBUTE_UNUSED
,
1526 const char *name ATTRIBUTE_UNUSED
)
1532 _bfd_nosymbols_get_lineno (bfd
*abfd
, asymbol
*sym ATTRIBUTE_UNUSED
)
1534 return (alent
*) _bfd_ptr_bfd_null_error (abfd
);
1538 _bfd_nosymbols_find_nearest_line
1540 asymbol
**symbols ATTRIBUTE_UNUSED
,
1541 asection
*section ATTRIBUTE_UNUSED
,
1542 bfd_vma offset ATTRIBUTE_UNUSED
,
1543 const char **filename_ptr ATTRIBUTE_UNUSED
,
1544 const char **functionname_ptr ATTRIBUTE_UNUSED
,
1545 unsigned int *line_ptr ATTRIBUTE_UNUSED
,
1546 unsigned int *discriminator_ptr ATTRIBUTE_UNUSED
)
1548 return _bfd_bool_bfd_false_error (abfd
);
1552 _bfd_nosymbols_find_nearest_line_with_alt
1554 const char *alt_filename ATTRIBUTE_UNUSED
,
1555 asymbol
**symbols ATTRIBUTE_UNUSED
,
1556 asection
*section ATTRIBUTE_UNUSED
,
1557 bfd_vma offset ATTRIBUTE_UNUSED
,
1558 const char **filename_ptr ATTRIBUTE_UNUSED
,
1559 const char **functionname_ptr ATTRIBUTE_UNUSED
,
1560 unsigned int *line_ptr ATTRIBUTE_UNUSED
,
1561 unsigned int *discriminator_ptr ATTRIBUTE_UNUSED
)
1563 return _bfd_bool_bfd_false_error (abfd
);
1567 _bfd_nosymbols_find_line (bfd
*abfd
,
1568 asymbol
**symbols ATTRIBUTE_UNUSED
,
1569 asymbol
*symbol ATTRIBUTE_UNUSED
,
1570 const char **filename_ptr ATTRIBUTE_UNUSED
,
1571 unsigned int *line_ptr ATTRIBUTE_UNUSED
)
1573 return _bfd_bool_bfd_false_error (abfd
);
1577 _bfd_nosymbols_find_inliner_info
1579 const char **filename_ptr ATTRIBUTE_UNUSED
,
1580 const char **functionname_ptr ATTRIBUTE_UNUSED
,
1581 unsigned int *line_ptr ATTRIBUTE_UNUSED
)
1583 return _bfd_bool_bfd_false_error (abfd
);
1587 _bfd_nosymbols_bfd_make_debug_symbol (bfd
*abfd
)
1589 return (asymbol
*) _bfd_ptr_bfd_null_error (abfd
);
1593 _bfd_nosymbols_read_minisymbols (bfd
*abfd
,
1594 bool dynamic ATTRIBUTE_UNUSED
,
1595 void **minisymsp ATTRIBUTE_UNUSED
,
1596 unsigned int *sizep ATTRIBUTE_UNUSED
)
1598 return _bfd_long_bfd_n1_error (abfd
);
1602 _bfd_nosymbols_minisymbol_to_symbol (bfd
*abfd
,
1603 bool dynamic ATTRIBUTE_UNUSED
,
1604 const void *minisym ATTRIBUTE_UNUSED
,
1605 asymbol
*sym ATTRIBUTE_UNUSED
)
1607 return (asymbol
*) _bfd_ptr_bfd_null_error (abfd
);
1611 _bfd_nodynamic_get_synthetic_symtab (bfd
*abfd
,
1612 long symcount ATTRIBUTE_UNUSED
,
1613 asymbol
**syms ATTRIBUTE_UNUSED
,
1614 long dynsymcount ATTRIBUTE_UNUSED
,
1615 asymbol
**dynsyms ATTRIBUTE_UNUSED
,
1616 asymbol
**ret ATTRIBUTE_UNUSED
)
1618 return _bfd_long_bfd_n1_error (abfd
);