1 /* bfdlink.h -- header file for BFD link routines
2 Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2003,
3 2004 Free Software Foundation, Inc.
4 Written by Steve Chamberlain and Ian Lance Taylor, Cygnus Support.
6 This file is part of BFD, the Binary File Descriptor library.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
25 /* Which symbols to strip during a link. */
28 strip_none, /* Don't strip any symbols. */
29 strip_debugger, /* Strip debugging symbols. */
30 strip_some, /* keep_hash is the list of symbols to keep. */
31 strip_all /* Strip all symbols. */
34 /* Which local symbols to discard during a link. This is irrelevant
35 if strip_all is used. */
38 discard_sec_merge, /* Discard local temporary symbols in SEC_MERGE
40 discard_none, /* Don't discard any locals. */
41 discard_l, /* Discard local temporary symbols. */
42 discard_all /* Discard all locals. */
45 /* Describes the type of hash table entry structure being used.
46 Different hash table structure have different fields and so
47 support different linking features. */
48 enum bfd_link_hash_table_type
50 bfd_link_generic_hash_table,
51 bfd_link_elf_hash_table
54 /* These are the possible types of an entry in the BFD link hash
57 enum bfd_link_hash_type
59 bfd_link_hash_new, /* Symbol is new. */
60 bfd_link_hash_undefined, /* Symbol seen before, but undefined. */
61 bfd_link_hash_undefweak, /* Symbol is weak and undefined. */
62 bfd_link_hash_defined, /* Symbol is defined. */
63 bfd_link_hash_defweak, /* Symbol is weak and defined. */
64 bfd_link_hash_common, /* Symbol is common. */
65 bfd_link_hash_indirect, /* Symbol is an indirect link. */
66 bfd_link_hash_warning /* Like indirect, but warn if referenced. */
69 enum bfd_link_common_skip_ar_aymbols
71 bfd_link_common_skip_none,
72 bfd_link_common_skip_text,
73 bfd_link_common_skip_data,
74 bfd_link_common_skip_all
77 /* The linking routines use a hash table which uses this structure for
80 struct bfd_link_hash_entry
82 /* Base hash table entry structure. */
83 struct bfd_hash_entry root;
85 /* Type of this entry. */
86 enum bfd_link_hash_type type;
88 /* A union of information depending upon the type. */
91 /* Nothing is kept for bfd_hash_new. */
92 /* bfd_link_hash_undefined, bfd_link_hash_undefweak. */
95 /* Undefined and common symbols are kept in a linked list through
96 this field. This field is present in all of the union element
97 so that we don't need to remove entries from the list when we
98 change their type. Removing entries would either require the
99 list to be doubly linked, which would waste more memory, or
100 require a traversal. When an undefined or common symbol is
101 created, it should be added to this list, the head of which is in
102 the link hash table itself. As symbols are defined, they need
103 not be removed from the list; anything which reads the list must
104 doublecheck the symbol type.
106 Weak symbols are not kept on this list.
108 Defined and defweak symbols use this field as a reference marker.
109 If the field is not NULL, or this structure is the tail of the
110 undefined symbol list, the symbol has been referenced. If the
111 symbol is undefined and becomes defined, this field will
112 automatically be non-NULL since the symbol will have been on the
113 undefined symbol list. */
114 struct bfd_link_hash_entry *next;
115 bfd *abfd; /* BFD symbol was found in. */
117 /* bfd_link_hash_defined, bfd_link_hash_defweak. */
120 struct bfd_link_hash_entry *next;
121 asection *section; /* Symbol section. */
122 bfd_vma value; /* Symbol value. */
124 /* bfd_link_hash_indirect, bfd_link_hash_warning. */
127 struct bfd_link_hash_entry *next;
128 struct bfd_link_hash_entry *link; /* Real symbol. */
129 const char *warning; /* Warning (bfd_link_hash_warning only). */
131 /* bfd_link_hash_common. */
134 struct bfd_link_hash_entry *next;
135 /* The linker needs to know three things about common
136 symbols: the size, the alignment, and the section in
137 which the symbol should be placed. We store the size
138 here, and we allocate a small structure to hold the
139 section and the alignment. The alignment is stored as a
140 power of two. We don't store all the information
141 directly because we don't want to increase the size of
142 the union; this structure is a major space user in the
144 struct bfd_link_hash_common_entry
146 unsigned int alignment_power; /* Alignment. */
147 asection *section; /* Symbol section. */
149 bfd_size_type size; /* Common symbol size. */
154 /* This is the link hash table. It is a derived class of
157 struct bfd_link_hash_table
159 /* The hash table itself. */
160 struct bfd_hash_table table;
161 /* The back end which created this hash table. This indicates the
162 type of the entries in the hash table, which is sometimes
163 important information when linking object files of different
165 const bfd_target *creator;
166 /* A linked list of undefined and common symbols, linked through the
167 next field in the bfd_link_hash_entry structure. */
168 struct bfd_link_hash_entry *undefs;
169 /* Entries are added to the tail of the undefs list. */
170 struct bfd_link_hash_entry *undefs_tail;
171 /* The type of the link hash table. */
172 enum bfd_link_hash_table_type type;
175 /* Look up an entry in a link hash table. If FOLLOW is TRUE, this
176 follows bfd_link_hash_indirect and bfd_link_hash_warning links to
178 extern struct bfd_link_hash_entry *bfd_link_hash_lookup
179 (struct bfd_link_hash_table *, const char *, bfd_boolean create,
180 bfd_boolean copy, bfd_boolean follow);
182 /* Look up an entry in the main linker hash table if the symbol might
183 be wrapped. This should only be used for references to an
184 undefined symbol, not for definitions of a symbol. */
186 extern struct bfd_link_hash_entry *bfd_wrapped_link_hash_lookup
187 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
188 bfd_boolean, bfd_boolean);
190 /* Traverse a link hash table. */
191 extern void bfd_link_hash_traverse
192 (struct bfd_link_hash_table *,
193 bfd_boolean (*) (struct bfd_link_hash_entry *, void *),
196 /* Add an entry to the undefs list. */
197 extern void bfd_link_add_undef
198 (struct bfd_link_hash_table *, struct bfd_link_hash_entry *);
202 struct bfd_sym_chain *next;
206 /* How to handle unresolved symbols.
207 There are four possibilities which are enumerated below: */
210 /* This is the initial value when then link_info structure is created.
211 It allows the various stages of the linker to determine whether they
212 allowed to set the value. */
219 /* This structure holds all the information needed to communicate
220 between BFD and the linker when doing a link. */
224 /* TRUE if BFD should generate a relocatable object file. */
225 unsigned int relocatable: 1;
227 /* TRUE if BFD should generate relocation information in the final
229 unsigned int emitrelocations: 1;
231 /* TRUE if BFD should generate a "task linked" object file,
232 similar to relocatable but also with globals converted to
234 unsigned int task_link: 1;
236 /* TRUE if BFD should generate a shared object. */
237 unsigned int shared: 1;
239 /* TRUE if BFD should pre-bind symbols in a shared object. */
240 unsigned int symbolic: 1;
242 /* TRUE if BFD should export all symbols in the dynamic symbol table
243 of an executable, rather than only those used. */
244 unsigned int export_dynamic: 1;
246 /* TRUE if shared objects should be linked directly, not shared. */
247 unsigned int static_link: 1;
249 /* TRUE if the output file should be in a traditional format. This
250 is equivalent to the setting of the BFD_TRADITIONAL_FORMAT flag
251 on the output file, but may be checked when reading the input
253 unsigned int traditional_format: 1;
255 /* TRUE if we want to produced optimized output files. This might
256 need much more time and therefore must be explicitly selected. */
257 unsigned int optimize: 1;
259 /* TRUE if ok to have multiple definition. */
260 unsigned int allow_multiple_definition: 1;
262 /* TRUE if ok to have version with no definition. */
263 unsigned int allow_undefined_version: 1;
265 /* TRUE if symbols should be retained in memory, FALSE if they
266 should be freed and reread. */
267 unsigned int keep_memory: 1;
269 /* TRUE if every symbol should be reported back via the notice
271 unsigned int notice_all: 1;
273 /* TRUE if executable should not contain copy relocs.
274 Setting this true may result in a non-sharable text segment. */
275 unsigned int nocopyreloc: 1;
277 /* TRUE if the new ELF dynamic tags are enabled. */
278 unsigned int new_dtags: 1;
280 /* TRUE if non-PLT relocs should be merged into one reloc section
281 and sorted so that relocs against the same symbol come together. */
282 unsigned int combreloc: 1;
284 /* TRUE if .eh_frame_hdr section and PT_GNU_EH_FRAME ELF segment
285 should be created. */
286 unsigned int eh_frame_hdr: 1;
288 /* TRUE if global symbols in discarded sections should be stripped. */
289 unsigned int strip_discarded: 1;
291 /* TRUE if the final relax pass is needed. */
292 unsigned int need_relax_finalize: 1;
294 /* TRUE if generating a position independent executable. */
297 /* TRUE if generating an executable, position independent or not. */
298 unsigned int executable : 1;
300 /* TRUE if PT_GNU_STACK segment should be created with PF_R|PF_W|PF_X
302 unsigned int execstack: 1;
304 /* TRUE if PT_GNU_STACK segment should be created with PF_R|PF_W
306 unsigned int noexecstack: 1;
308 /* TRUE if PT_GNU_RELRO segment should be created. */
309 unsigned int relro: 1;
311 /* What to do with unresolved symbols in an object file.
312 When producing executables the default is GENERATE_ERROR.
313 When producing shared libraries the default is IGNORE. The
314 assumption with shared libraries is that the reference will be
315 resolved at load/execution time. */
316 enum report_method unresolved_syms_in_objects;
318 /* What to do with unresolved symbols in a shared library.
319 The same defaults apply. */
320 enum report_method unresolved_syms_in_shared_libs;
322 /* Which symbols to strip. */
323 enum bfd_link_strip strip;
325 /* Which local symbols to discard. */
326 enum bfd_link_discard discard;
328 /* Criteria for skipping symbols when detemining
329 whether to include an object from an archive. */
330 enum bfd_link_common_skip_ar_aymbols common_skip_ar_aymbols;
332 /* Char that may appear as the first char of a symbol, but should be
333 skipped (like symbol_leading_char) when looking up symbols in
334 wrap_hash. Used by PowerPC Linux for 'dot' symbols. */
337 /* Function callbacks. */
338 const struct bfd_link_callbacks *callbacks;
340 /* Hash table handled by BFD. */
341 struct bfd_link_hash_table *hash;
343 /* Hash table of symbols to keep. This is NULL unless strip is
345 struct bfd_hash_table *keep_hash;
347 /* Hash table of symbols to report back via the notice callback. If
348 this is NULL, and notice_all is FALSE, then no symbols are
350 struct bfd_hash_table *notice_hash;
352 /* Hash table of symbols which are being wrapped (the --wrap linker
353 option). If this is NULL, no symbols are being wrapped. */
354 struct bfd_hash_table *wrap_hash;
356 /* The list of input BFD's involved in the link. These are chained
357 together via the link_next field. */
360 /* If a symbol should be created for each input BFD, this is section
361 where those symbols should be placed. It must be a section in
362 the output BFD. It may be NULL, in which case no such symbols
363 will be created. This is to support CREATE_OBJECT_SYMBOLS in the
364 linker command language. */
365 asection *create_object_symbols_section;
367 /* List of global symbol names that are starting points for marking
368 sections against garbage collection. */
369 struct bfd_sym_chain *gc_sym_list;
371 /* If a base output file is wanted, then this points to it */
374 /* The function to call when the executable or shared object is
376 const char *init_function;
378 /* The function to call when the executable or shared object is
380 const char *fini_function;
382 /* Non-zero if auto-import thunks for DATA items in pei386 DLLs
383 should be generated/linked against. Set to 1 if this feature
384 is explicitly requested by the user, -1 if enabled by default. */
385 int pei386_auto_import;
387 /* Non-zero if runtime relocs for DATA items with non-zero addends
388 in pei386 DLLs should be generated. Set to 1 if this feature
389 is explicitly requested by the user, -1 if enabled by default. */
390 int pei386_runtime_pseudo_reloc;
392 /* How many spare .dynamic DT_NULL entries should be added? */
393 unsigned int spare_dynamic_tags;
395 /* May be used to set DT_FLAGS for ELF. */
398 /* May be used to set DT_FLAGS_1 for ELF. */
401 /* Start and end of RELRO region. */
402 bfd_vma relro_start, relro_end;
405 /* This structures holds a set of callback functions. These are
406 called by the BFD linker routines. The first argument to each
407 callback function is the bfd_link_info structure being used. Each
408 function returns a boolean value. If the function returns FALSE,
409 then the BFD function which called it will return with a failure
412 struct bfd_link_callbacks
414 /* A function which is called when an object is added from an
415 archive. ABFD is the archive element being added. NAME is the
416 name of the symbol which caused the archive element to be pulled
418 bfd_boolean (*add_archive_element)
419 (struct bfd_link_info *, bfd *abfd, const char *name);
420 /* A function which is called when a symbol is found with multiple
421 definitions. NAME is the symbol which is defined multiple times.
422 OBFD is the old BFD, OSEC is the old section, OVAL is the old
423 value, NBFD is the new BFD, NSEC is the new section, and NVAL is
424 the new value. OBFD may be NULL. OSEC and NSEC may be
425 bfd_com_section or bfd_ind_section. */
426 bfd_boolean (*multiple_definition)
427 (struct bfd_link_info *, const char *name,
428 bfd *obfd, asection *osec, bfd_vma oval,
429 bfd *nbfd, asection *nsec, bfd_vma nval);
430 /* A function which is called when a common symbol is defined
431 multiple times. NAME is the symbol appearing multiple times.
432 OBFD is the BFD of the existing symbol; it may be NULL if this is
433 not known. OTYPE is the type of the existing symbol, which may
434 be bfd_link_hash_defined, bfd_link_hash_defweak,
435 bfd_link_hash_common, or bfd_link_hash_indirect. If OTYPE is
436 bfd_link_hash_common, OSIZE is the size of the existing symbol.
437 NBFD is the BFD of the new symbol. NTYPE is the type of the new
438 symbol, one of bfd_link_hash_defined, bfd_link_hash_common, or
439 bfd_link_hash_indirect. If NTYPE is bfd_link_hash_common, NSIZE
440 is the size of the new symbol. */
441 bfd_boolean (*multiple_common)
442 (struct bfd_link_info *, const char *name,
443 bfd *obfd, enum bfd_link_hash_type otype, bfd_vma osize,
444 bfd *nbfd, enum bfd_link_hash_type ntype, bfd_vma nsize);
445 /* A function which is called to add a symbol to a set. ENTRY is
446 the link hash table entry for the set itself (e.g.,
447 __CTOR_LIST__). RELOC is the relocation to use for an entry in
448 the set when generating a relocatable file, and is also used to
449 get the size of the entry when generating an executable file.
450 ABFD, SEC and VALUE identify the value to add to the set. */
451 bfd_boolean (*add_to_set)
452 (struct bfd_link_info *, struct bfd_link_hash_entry *entry,
453 bfd_reloc_code_real_type reloc, bfd *abfd, asection *sec, bfd_vma value);
454 /* A function which is called when the name of a g++ constructor or
455 destructor is found. This is only called by some object file
456 formats. CONSTRUCTOR is TRUE for a constructor, FALSE for a
457 destructor. This will use BFD_RELOC_CTOR when generating a
458 relocatable file. NAME is the name of the symbol found. ABFD,
459 SECTION and VALUE are the value of the symbol. */
460 bfd_boolean (*constructor)
461 (struct bfd_link_info *, bfd_boolean constructor, const char *name,
462 bfd *abfd, asection *sec, bfd_vma value);
463 /* A function which is called to issue a linker warning. For
464 example, this is called when there is a reference to a warning
465 symbol. WARNING is the warning to be issued. SYMBOL is the name
466 of the symbol which triggered the warning; it may be NULL if
467 there is none. ABFD, SECTION and ADDRESS identify the location
468 which trigerred the warning; either ABFD or SECTION or both may
469 be NULL if the location is not known. */
470 bfd_boolean (*warning)
471 (struct bfd_link_info *, const char *warning, const char *symbol,
472 bfd *abfd, asection *section, bfd_vma address);
473 /* A function which is called when a relocation is attempted against
474 an undefined symbol. NAME is the symbol which is undefined.
475 ABFD, SECTION and ADDRESS identify the location from which the
476 reference is made. FATAL indicates whether an undefined symbol is
477 a fatal error or not. In some cases SECTION may be NULL. */
478 bfd_boolean (*undefined_symbol)
479 (struct bfd_link_info *, const char *name, bfd *abfd,
480 asection *section, bfd_vma address, bfd_boolean fatal);
481 /* A function which is called when a reloc overflow occurs. NAME is
482 the name of the symbol or section the reloc is against,
483 RELOC_NAME is the name of the relocation, and ADDEND is any
484 addend that is used. ABFD, SECTION and ADDRESS identify the
485 location at which the overflow occurs; if this is the result of a
486 bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
487 ABFD will be NULL. */
488 bfd_boolean (*reloc_overflow)
489 (struct bfd_link_info *, const char *name, const char *reloc_name,
490 bfd_vma addend, bfd *abfd, asection *section, bfd_vma address);
491 /* A function which is called when a dangerous reloc is performed.
492 The canonical example is an a29k IHCONST reloc which does not
493 follow an IHIHALF reloc. MESSAGE is an appropriate message.
494 ABFD, SECTION and ADDRESS identify the location at which the
495 problem occurred; if this is the result of a
496 bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
497 ABFD will be NULL. */
498 bfd_boolean (*reloc_dangerous)
499 (struct bfd_link_info *, const char *message,
500 bfd *abfd, asection *section, bfd_vma address);
501 /* A function which is called when a reloc is found to be attached
502 to a symbol which is not being written out. NAME is the name of
503 the symbol. ABFD, SECTION and ADDRESS identify the location of
504 the reloc; if this is the result of a
505 bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
506 ABFD will be NULL. */
507 bfd_boolean (*unattached_reloc)
508 (struct bfd_link_info *, const char *name,
509 bfd *abfd, asection *section, bfd_vma address);
510 /* A function which is called when a symbol in notice_hash is
511 defined or referenced. NAME is the symbol. ABFD, SECTION and
512 ADDRESS are the value of the symbol. If SECTION is
513 bfd_und_section, this is a reference. */
514 bfd_boolean (*notice)
515 (struct bfd_link_info *, const char *name,
516 bfd *abfd, asection *section, bfd_vma address);
519 /* The linker builds link_order structures which tell the code how to
520 include input data in the output file. */
522 /* These are the types of link_order structures. */
524 enum bfd_link_order_type
526 bfd_undefined_link_order, /* Undefined. */
527 bfd_indirect_link_order, /* Built from a section. */
528 bfd_data_link_order, /* Set to explicit data. */
529 bfd_section_reloc_link_order, /* Relocate against a section. */
530 bfd_symbol_reloc_link_order /* Relocate against a symbol. */
533 /* This is the link_order structure itself. These form a chain
534 attached to the section whose contents they are describing. */
536 struct bfd_link_order
538 /* Next link_order in chain. */
539 struct bfd_link_order *next;
540 /* Type of link_order. */
541 enum bfd_link_order_type type;
542 /* Offset within output section. */
544 /* Size within output section. */
546 /* Type specific information. */
551 /* Section to include. If this is used, then
552 section->output_section must be the section the
553 link_order is attached to, section->output_offset must
554 equal the link_order offset field, and section->size
555 must equal the link_order size field. Maybe these
556 restrictions should be relaxed someday. */
561 /* Size of contents, or zero when contents size == size
562 within output section.
563 A non-zero value allows filling of the output section
564 with an arbitrary repeated pattern. */
566 /* Data to put into file. */
571 /* Description of reloc to generate. Used for
572 bfd_section_reloc_link_order and
573 bfd_symbol_reloc_link_order. */
574 struct bfd_link_order_reloc *p;
579 /* A linker order of type bfd_section_reloc_link_order or
580 bfd_symbol_reloc_link_order means to create a reloc against a
581 section or symbol, respectively. This is used to implement -Ur to
582 generate relocs for the constructor tables. The
583 bfd_link_order_reloc structure describes the reloc that BFD should
584 create. It is similar to a arelent, but I didn't use arelent
585 because the linker does not know anything about most symbols, and
586 any asymbol structure it creates will be partially meaningless.
587 This information could logically be in the bfd_link_order struct,
588 but I didn't want to waste the space since these types of relocs
589 are relatively rare. */
591 struct bfd_link_order_reloc
594 bfd_reloc_code_real_type reloc;
598 /* For type bfd_section_reloc_link_order, this is the section
599 the reloc should be against. This must be a section in the
600 output BFD, not any of the input BFDs. */
602 /* For type bfd_symbol_reloc_link_order, this is the name of the
603 symbol the reloc should be against. */
607 /* Addend to use. The object file should contain zero. The BFD
608 backend is responsible for filling in the contents of the object
609 file correctly. For some object file formats (e.g., COFF) the
610 addend must be stored into in the object file, and for some
611 (e.g., SPARC a.out) it is kept in the reloc. */
615 /* Allocate a new link_order for a section. */
616 extern struct bfd_link_order *bfd_new_link_order (bfd *, asection *);
618 /* These structures are used to describe version information for the
619 ELF linker. These structures could be manipulated entirely inside
620 BFD, but it would be a pain. Instead, the regular linker sets up
621 these structures, and then passes them into BFD. */
623 /* Glob pattern for a version. */
625 struct bfd_elf_version_expr
627 /* Next glob pattern for this version. */
628 struct bfd_elf_version_expr *next;
631 /* NULL for a glob pattern, otherwise a straight symbol. */
633 /* Defined by ".symver". */
634 unsigned int symver : 1;
635 /* Defined by version script. */
636 unsigned int script : 1;
638 #define BFD_ELF_VERSION_C_TYPE 1
639 #define BFD_ELF_VERSION_CXX_TYPE 2
640 #define BFD_ELF_VERSION_JAVA_TYPE 4
641 unsigned int mask : 3;
644 struct bfd_elf_version_expr_head
646 /* List of all patterns, both wildcards and non-wildcards. */
647 struct bfd_elf_version_expr *list;
648 /* Hash table for non-wildcards. */
650 /* Remaining patterns. */
651 struct bfd_elf_version_expr *remaining;
652 /* What kind of pattern types are present in list (bitmask). */
656 /* Version dependencies. */
658 struct bfd_elf_version_deps
660 /* Next dependency for this version. */
661 struct bfd_elf_version_deps *next;
662 /* The version which this version depends upon. */
663 struct bfd_elf_version_tree *version_needed;
666 /* A node in the version tree. */
668 struct bfd_elf_version_tree
671 struct bfd_elf_version_tree *next;
672 /* Name of this version. */
674 /* Version number. */
676 /* Regular expressions for global symbols in this version. */
677 struct bfd_elf_version_expr_head globals;
678 /* Regular expressions for local symbols in this version. */
679 struct bfd_elf_version_expr_head locals;
680 /* List of versions which this version depends upon. */
681 struct bfd_elf_version_deps *deps;
682 /* Index of the version name. This is used within BFD. */
683 unsigned int name_indx;
684 /* Whether this version tree was used. This is used within BFD. */
687 struct bfd_elf_version_expr *(*match)
688 (struct bfd_elf_version_expr_head *head,
689 struct bfd_elf_version_expr *prev, const char *sym);