Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2026-05-05 08:55:02

0001 /* bfdlink.h -- header file for BFD link routines
0002    Copyright (C) 1993-2025 Free Software Foundation, Inc.
0003    Written by Steve Chamberlain and Ian Lance Taylor, Cygnus Support.
0004 
0005    This file is part of BFD, the Binary File Descriptor library.
0006 
0007    This program is free software; you can redistribute it and/or modify
0008    it under the terms of the GNU General Public License as published by
0009    the Free Software Foundation; either version 3 of the License, or
0010    (at your option) any later version.
0011 
0012    This program is distributed in the hope that it will be useful,
0013    but WITHOUT ANY WARRANTY; without even the implied warranty of
0014    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0015    GNU General Public License for more details.
0016 
0017    You should have received a copy of the GNU General Public License
0018    along with this program; if not, write to the Free Software
0019    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
0020    MA 02110-1301, USA.  */
0021 
0022 #ifndef BFDLINK_H
0023 #define BFDLINK_H
0024 
0025 /* Which symbols to strip during a link.  */
0026 enum bfd_link_strip
0027 {
0028   strip_none,       /* Don't strip any symbols.  */
0029   strip_debugger,   /* Strip debugging symbols.  */
0030   strip_some,       /* keep_hash is the list of symbols to keep.  */
0031   strip_all     /* Strip all symbols.  */
0032 };
0033 
0034 /* Which local symbols to discard during a link.  This is irrelevant
0035    if strip_all is used.  */
0036 enum bfd_link_discard
0037 {
0038   discard_sec_merge,    /* Discard local temporary symbols in SEC_MERGE
0039                sections.  */
0040   discard_none,     /* Don't discard any locals.  */
0041   discard_l,        /* Discard local temporary symbols.  */
0042   discard_all       /* Discard all locals.  */
0043 };
0044 
0045 enum notice_asneeded_action {
0046   notice_as_needed,
0047   notice_not_needed,
0048   notice_needed
0049 };
0050 
0051 /* Whether to generate ELF common symbols with the STT_COMMON type
0052    during a relocatable link.  */
0053 enum bfd_link_elf_stt_common
0054 {
0055   unchanged,
0056   elf_stt_common,
0057   no_elf_stt_common
0058 };
0059 
0060 /* Describes the type of hash table entry structure being used.
0061    Different hash table structure have different fields and so
0062    support different linking features.  */
0063 enum bfd_link_hash_table_type
0064   {
0065     bfd_link_generic_hash_table,
0066     bfd_link_elf_hash_table
0067   };
0068 
0069 /* These are the possible types of an entry in the BFD link hash
0070    table.  */
0071 
0072 enum bfd_link_hash_type
0073 {
0074   bfd_link_hash_new,        /* Symbol is new.  */
0075   bfd_link_hash_undefined,  /* Symbol seen before, but undefined.  */
0076   bfd_link_hash_undefweak,  /* Symbol is weak and undefined.  */
0077   bfd_link_hash_defined,    /* Symbol is defined.  */
0078   bfd_link_hash_defweak,    /* Symbol is weak and defined.  */
0079   bfd_link_hash_common,     /* Symbol is common.  */
0080   bfd_link_hash_indirect,   /* Symbol is an indirect link.  */
0081   bfd_link_hash_warning     /* Like indirect, but warn if referenced.  */
0082 };
0083 
0084 enum bfd_link_common_skip_ar_symbols
0085 {
0086   bfd_link_common_skip_none,
0087   bfd_link_common_skip_text,
0088   bfd_link_common_skip_data,
0089   bfd_link_common_skip_all
0090 };
0091 
0092 struct bfd_link_hash_common_entry
0093   {
0094     unsigned int alignment_power;   /* Alignment.  */
0095     asection *section;      /* Symbol section.  */
0096   };
0097 
0098 /* The linking routines use a hash table which uses this structure for
0099    its elements.  */
0100 
0101 struct bfd_link_hash_entry
0102 {
0103   /* Base hash table entry structure.  */
0104   struct bfd_hash_entry root;
0105 
0106   /* Type of this entry.  */
0107   ENUM_BITFIELD (bfd_link_hash_type) type : 8;
0108 
0109   /* Symbol is referenced in a normal regular object file,
0110      as distinct from a LTO IR object file.  */
0111   unsigned int non_ir_ref_regular : 1;
0112 
0113   /* Symbol is referenced in a normal dynamic object file,
0114      as distinct from a LTO IR object file.  */
0115   unsigned int non_ir_ref_dynamic : 1;
0116 
0117   /* The symbol, SYM, is referenced by __real_SYM in an object file.  */
0118   unsigned int ref_real : 1;
0119 
0120   /* The symbol is a wrapper symbol, __wrap_SYM.  */
0121   unsigned int wrapper_symbol : 1;
0122 
0123   /* Symbol is a built-in define.  These will be overridden by PROVIDE
0124      in a linker script.  */
0125   unsigned int linker_def : 1;
0126 
0127   /* Symbol defined in a linker script.  */
0128   unsigned int ldscript_def : 1;
0129 
0130   /* Symbol will be converted from absolute to section-relative.  Set for
0131      symbols defined by a script from "dot" (also SEGMENT_START or ORIGIN)
0132      outside of an output section statement.  */
0133   unsigned int rel_from_abs : 1;
0134 
0135   /* A union of information depending upon the type.  */
0136   union
0137     {
0138       /* Nothing is kept for bfd_hash_new.  */
0139       /* bfd_link_hash_undefined, bfd_link_hash_undefweak.  */
0140       struct
0141     {
0142       /* Undefined and common symbols are kept in a linked list through
0143          this field.  This field is present in all of the union element
0144          so that we don't need to remove entries from the list when we
0145          change their type.  Removing entries would either require the
0146          list to be doubly linked, which would waste more memory, or
0147          require a traversal.  When an undefined or common symbol is
0148          created, it should be added to this list, the head of which is in
0149          the link hash table itself.  As symbols are defined, they need
0150          not be removed from the list; anything which reads the list must
0151          doublecheck the symbol type.
0152 
0153          Weak symbols are not kept on this list.
0154 
0155          Defined and defweak symbols use this field as a reference marker.
0156          If the field is not NULL, or this structure is the tail of the
0157          undefined symbol list, the symbol has been referenced.  If the
0158          symbol is undefined and becomes defined, this field will
0159          automatically be non-NULL since the symbol will have been on the
0160          undefined symbol list.  */
0161       struct bfd_link_hash_entry *next;
0162       /* BFD symbol was found in.  */
0163       bfd *abfd;
0164     } undef;
0165       /* bfd_link_hash_defined, bfd_link_hash_defweak.  */
0166       struct
0167     {
0168       struct bfd_link_hash_entry *next;
0169       /* Symbol section.  */
0170       asection *section;
0171       /* Symbol value.  */
0172       bfd_vma value;
0173     } def;
0174       /* bfd_link_hash_indirect, bfd_link_hash_warning.  */
0175       struct
0176     {
0177       struct bfd_link_hash_entry *next;
0178       /* Real symbol.  */
0179       struct bfd_link_hash_entry *link;
0180       /* Warning message (bfd_link_hash_warning only).  */
0181       const char *warning;
0182     } i;
0183       /* bfd_link_hash_common.  */
0184       struct
0185     {
0186       struct bfd_link_hash_entry *next;
0187       /* The linker needs to know three things about common
0188          symbols: the size, the alignment, and the section in
0189          which the symbol should be placed.  We store the size
0190          here, and we allocate a small structure to hold the
0191          section and the alignment.  The alignment is stored as a
0192          power of two.  We don't store all the information
0193          directly because we don't want to increase the size of
0194          the union; this structure is a major space user in the
0195          linker.  */
0196       struct bfd_link_hash_common_entry *p;
0197       /* Common symbol size.  */
0198       bfd_size_type size;
0199     } c;
0200     } u;
0201 };
0202 
0203 /* This is the link hash table.  It is a derived class of
0204    bfd_hash_table.  */
0205 
0206 struct bfd_link_hash_table
0207 {
0208   /* The hash table itself.  */
0209   struct bfd_hash_table table;
0210   /* A linked list of undefined and common symbols, linked through the
0211      next field in the bfd_link_hash_entry structure.  */
0212   struct bfd_link_hash_entry *undefs;
0213   /* Entries are added to the tail of the undefs list.  */
0214   struct bfd_link_hash_entry *undefs_tail;
0215   /* Function to free the hash table on closing BFD.  */
0216   void (*hash_table_free) (bfd *);
0217   /* The type of the link hash table.  */
0218   enum bfd_link_hash_table_type type;
0219 };
0220 
0221 /* Look up an entry in a link hash table.  If FOLLOW is TRUE, this
0222    follows bfd_link_hash_indirect and bfd_link_hash_warning links to
0223    the real symbol.  */
0224 extern struct bfd_link_hash_entry *bfd_link_hash_lookup
0225   (struct bfd_link_hash_table *, const char *, bool create,
0226    bool copy, bool follow);
0227 
0228 /* Look up an entry in the main linker hash table if the symbol might
0229    be wrapped.  This should only be used for references to an
0230    undefined symbol, not for definitions of a symbol.  */
0231 
0232 extern struct bfd_link_hash_entry *bfd_wrapped_link_hash_lookup
0233   (bfd *, struct bfd_link_info *, const char *, bool, bool, bool);
0234 
0235 /* If H is a wrapped symbol, ie. the symbol name starts with "__wrap_"
0236    and the remainder is found in wrap_hash, return the real symbol.  */
0237 
0238 extern struct bfd_link_hash_entry *unwrap_hash_lookup
0239   (struct bfd_link_info *, bfd *, struct bfd_link_hash_entry *);
0240 
0241 /* Traverse a link hash table.  */
0242 extern void bfd_link_hash_traverse
0243   (struct bfd_link_hash_table *,
0244     bool (*) (struct bfd_link_hash_entry *, void *),
0245     void *);
0246 
0247 /* Add an entry to the undefs list.  */
0248 extern void bfd_link_add_undef
0249   (struct bfd_link_hash_table *, struct bfd_link_hash_entry *);
0250 
0251 /* Remove symbols from the undefs list that don't belong there.  */
0252 extern void bfd_link_repair_undef_list
0253   (struct bfd_link_hash_table *table);
0254 
0255 /* Read symbols and cache symbol pointer array in outsymbols.  */
0256 extern bool bfd_generic_link_read_symbols (bfd *);
0257 
0258 /* Check the relocs in the BFD.  Called after all the input
0259    files have been loaded, and garbage collection has tagged
0260    any unneeded sections.  */
0261 extern bool bfd_link_check_relocs (bfd *,struct bfd_link_info *);
0262 
0263 struct bfd_sym_chain
0264 {
0265   struct bfd_sym_chain *next;
0266   const char *name;
0267 };
0268 
0269 /* How to handle unresolved symbols.
0270    There are four possibilities which are enumerated below:  */
0271 enum report_method
0272 {
0273   /* This is the initial value when then link_info structure is created.
0274      It allows the various stages of the linker to determine whether they
0275      allowed to set the value.  */
0276   RM_NOT_YET_SET = 0,
0277   RM_IGNORE,
0278   RM_DIAGNOSE,
0279 };
0280 
0281 /* How to handle DT_TEXTREL.  */
0282 
0283 enum textrel_check_method
0284 {
0285   textrel_check_none,
0286   textrel_check_warning,
0287   textrel_check_error
0288 };
0289 
0290 #define bfd_link_textrel_check(info) \
0291   (info->textrel_check != textrel_check_none)
0292 
0293 typedef enum {with_flags, without_flags} flag_type;
0294 
0295 /* A section flag list.  */
0296 struct flag_info_list
0297 {
0298   flag_type with;
0299   const char *name;
0300   bool valid;
0301   struct flag_info_list *next;
0302 };
0303 
0304 /* Section flag info.  */
0305 struct flag_info
0306 {
0307   flagword only_with_flags;
0308   flagword not_with_flags;
0309   struct flag_info_list *flag_list;
0310   bool flags_initialized;
0311 };
0312 
0313 struct bfd_elf_dynamic_list;
0314 struct bfd_elf_version_tree;
0315 
0316 /* Types of output.  */
0317 
0318 enum output_type
0319 {
0320   type_pde,
0321   type_pie,
0322   type_relocatable,
0323   type_dll,
0324 };
0325 
0326 #define bfd_link_pde(info)     ((info)->type == type_pde)
0327 #define bfd_link_dll(info)     ((info)->type == type_dll)
0328 #define bfd_link_relocatable(info) ((info)->type == type_relocatable)
0329 #define bfd_link_pie(info)     ((info)->type == type_pie)
0330 #define bfd_link_executable(info)  (bfd_link_pde (info) || bfd_link_pie (info))
0331 #define bfd_link_pic(info)     (bfd_link_dll (info) || bfd_link_pie (info))
0332 
0333 /* This structure holds all the information needed to communicate
0334    between BFD and the linker when doing a link.  */
0335 
0336 struct bfd_link_info
0337 {
0338   /* Output type.  */
0339   ENUM_BITFIELD (output_type) type : 2;
0340 
0341   /* TRUE if BFD should pre-bind symbols in a shared object.  */
0342   unsigned int symbolic: 1;
0343 
0344   /* TRUE if BFD should export all symbols in the dynamic symbol table
0345      of an executable, rather than only those used.  */
0346   unsigned int export_dynamic: 1;
0347 
0348   /* TRUE if a default symbol version should be created and used for
0349      exported symbols.  */
0350   unsigned int create_default_symver: 1;
0351 
0352   /* TRUE if unreferenced sections should be removed.  */
0353   unsigned int gc_sections: 1;
0354 
0355   /* TRUE if exported symbols should be kept during section gc.  */
0356   unsigned int gc_keep_exported: 1;
0357 
0358   /* TRUE if every symbol should be reported back via the notice
0359      callback.  */
0360   unsigned int notice_all: 1;
0361 
0362   /* TRUE if the LTO plugin is active.  */
0363   unsigned int lto_plugin_active: 1;
0364 
0365   /* TRUE if all LTO IR symbols have been read.  */
0366   unsigned int lto_all_symbols_read : 1;
0367 
0368   /* TRUE if global symbols in discarded sections should be stripped.  */
0369   unsigned int strip_discarded: 1;
0370 
0371   /* TRUE if all data symbols should be dynamic.  */
0372   unsigned int dynamic_data: 1;
0373 
0374   /* TRUE if section groups should be resolved.  */
0375   unsigned int resolve_section_groups: 1;
0376 
0377   /* Set if output file is big-endian, or if that is unknown, from
0378      the command line or first input file endianness.  */
0379   unsigned int big_endian : 1;
0380 
0381   /* Which symbols to strip.  */
0382   ENUM_BITFIELD (bfd_link_strip) strip : 2;
0383 
0384   /* Which local symbols to discard.  */
0385   ENUM_BITFIELD (bfd_link_discard) discard : 2;
0386 
0387   /* Whether to generate ELF common symbols with the STT_COMMON type.  */
0388   ENUM_BITFIELD (bfd_link_elf_stt_common) elf_stt_common : 2;
0389 
0390   /* Criteria for skipping symbols when determining
0391      whether to include an object from an archive.  */
0392   ENUM_BITFIELD (bfd_link_common_skip_ar_symbols) common_skip_ar_symbols : 2;
0393 
0394   /* What to do with unresolved symbols in an object file.
0395      When producing executables the default is GENERATE_ERROR.
0396      When producing shared libraries the default is IGNORE.  The
0397      assumption with shared libraries is that the reference will be
0398      resolved at load/execution time.  */
0399   ENUM_BITFIELD (report_method) unresolved_syms_in_objects : 2;
0400 
0401   /* What to do with unresolved symbols in a shared library.
0402      The same defaults apply.  */
0403   ENUM_BITFIELD (report_method) unresolved_syms_in_shared_libs : 2;
0404 
0405   /* TRUE if unresolved symbols are to be warned, rather than errored.  */
0406   unsigned int warn_unresolved_syms: 1;
0407 
0408   /* TRUE if shared objects should be linked directly, not shared.  */
0409   unsigned int static_link: 1;
0410 
0411   /* TRUE if symbols should be retained in memory, FALSE if they
0412      should be freed and reread.  */
0413   unsigned int keep_memory: 1;
0414 
0415   /* TRUE if BFD should generate relocation information in the final
0416      executable.  */
0417   unsigned int emitrelocations: 1;
0418 
0419   /* TRUE if PT_GNU_RELRO segment should be created.  */
0420   unsigned int relro: 1;
0421 
0422   /* TRUE if DT_RELR should be enabled for compact relative
0423      relocations.  */
0424   unsigned int enable_dt_relr: 1;
0425 
0426   /* TRUE if separate code segment should be created.  */
0427   unsigned int separate_code: 1;
0428 
0429   /* TRUE if only one read-only, non-code segment should be created.  */
0430   unsigned int one_rosegment: 1;
0431 
0432   /* TRUE if GNU_PROPERTY_MEMORY_SEAL should be generated.  */
0433   unsigned int memory_seal: 1;
0434 
0435   /* Nonzero if .eh_frame_hdr section and PT_GNU_EH_FRAME ELF segment
0436      should be created.  1 for DWARF2 tables, 2 for compact tables.  */
0437   unsigned int eh_frame_hdr_type: 2;
0438 
0439   /* What to do with DT_TEXTREL in output.  */
0440   ENUM_BITFIELD (textrel_check_method) textrel_check: 2;
0441 
0442   /* TRUE if .hash section should be created.  */
0443   unsigned int emit_hash: 1;
0444 
0445   /* TRUE if .gnu.hash section should be created.  */
0446   unsigned int emit_gnu_hash: 1;
0447 
0448   /* If TRUE reduce memory overheads, at the expense of speed. This will
0449      cause map file generation to use an O(N^2) algorithm and disable
0450      caching ELF symbol buffer.  */
0451   unsigned int reduce_memory_overheads: 1;
0452 
0453   /* TRUE if the output file should be in a traditional format.  This
0454      is equivalent to the setting of the BFD_TRADITIONAL_FORMAT flag
0455      on the output file, but may be checked when reading the input
0456      files.  */
0457   unsigned int traditional_format: 1;
0458 
0459   /* TRUE if non-PLT relocs should be merged into one reloc section
0460      and sorted so that relocs against the same symbol come together.  */
0461   unsigned int combreloc: 1;
0462 
0463   /* TRUE if a default symbol version should be created and used for
0464      imported symbols.  */
0465   unsigned int default_imported_symver: 1;
0466 
0467   /* TRUE if the new ELF dynamic tags are enabled. */
0468   unsigned int new_dtags: 1;
0469 
0470   /* FALSE if .eh_frame unwind info should be generated for PLT and other
0471      linker created sections, TRUE if it should be omitted.  */
0472   unsigned int no_ld_generated_unwind_info: 1;
0473 
0474   /* TRUE if BFD should generate a "task linked" object file,
0475      similar to relocatable but also with globals converted to
0476      statics.  */
0477   unsigned int task_link: 1;
0478 
0479   /* TRUE if ok to have multiple definitions, without warning.  */
0480   unsigned int allow_multiple_definition: 1;
0481 
0482   /* TRUE if multiple definition of absolute symbols (eg. from -R) should
0483      be reported.  */
0484   unsigned int prohibit_multiple_definition_absolute: 1;
0485 
0486   /* TRUE if multiple definitions should only warn.  */
0487   unsigned int warn_multiple_definition: 1;
0488 
0489   /* TRUE if ok to have version with no definition.  */
0490   unsigned int allow_undefined_version: 1;
0491 
0492   /* TRUE if some symbols have to be dynamic, controlled by
0493      --dynamic-list command line options.  */
0494   unsigned int dynamic: 1;
0495 
0496   /* Set if the "-z execstack" option has been used to request that a
0497      PT_GNU_STACK segment should be created with PF_R, PF_W and PF_X
0498      flags set.
0499 
0500      Note - if performing a relocatable link then a .note.GNU-stack
0501      section will be created instead, if one does not exist already.
0502      The section will have the SHF_EXECINSTR flag bit set.  */
0503   unsigned int execstack: 1;
0504 
0505   /* Set if the "-z noexecstack" option has been used to request that a
0506      PT_GNU_STACK segment should be created with PF_R and PF_W flags.  Or
0507      a non-executable .note.GNU-stack section for relocateable links.
0508 
0509      Note - this flag is not quite orthogonal to execstack, since both
0510      of these flags can be 0.  In this case a stack segment can still
0511      be created, but it will only have the PF_X flag bit set if one or
0512      more of the input files contains a .note.GNU-stack section with the
0513      SHF_EXECINSTR flag bit set, or if the default behaviour for the
0514      architecture is to create executable stacks.
0515 
0516      The execstack and noexecstack flags should never both be 1.  */
0517   unsigned int noexecstack: 1;
0518 
0519   /* Tri-state variable:
0520      0 => do not warn when creating an executable stack.
0521      1 => always warn when creating an executable stack (for any reason).
0522      2 => only warn when an executable stack has been requested an object
0523           file and execstack is 0 or noexecstack is 1.
0524      3 => not used.  */
0525   unsigned int warn_execstack: 2;
0526   /* TRUE if a warning generated because of warn_execstack should be instead
0527      be treated as an error.  */
0528   unsigned int error_execstack: 1;
0529 
0530   /* TRUE if warnings should NOT be generated for TLS segments with eXecute
0531      permission or LOAD segments with RWX permissions.  */
0532   unsigned int no_warn_rwx_segments: 1;
0533   /* TRUE if the user gave either --warn-rwx-segments or
0534      --no-warn-rwx-segments on the linker command line.  */
0535   unsigned int user_warn_rwx_segments: 1;
0536   /* TRUE if warnings generated when no_warn_rwx_segements is 0 should
0537      instead be treated as errors.  */
0538   unsigned int warn_is_error_for_rwx_segments: 1;
0539 
0540   /* TRUE if the stack can be made executable because of the absence of a
0541      .note.GNU-stack section in an input file.  Note - even if this field
0542      is set, some targets may choose to ignore the setting and not create
0543      an executable stack.  */
0544   unsigned int default_execstack : 1;
0545   
0546   /* TRUE if we want to produced optimized output files.  This might
0547      need much more time and therefore must be explicitly selected.  */
0548   unsigned int optimize: 1;
0549 
0550   /* TRUE if user should be informed of removed unreferenced sections.  */
0551   unsigned int print_gc_sections: 1;
0552 
0553   /* TRUE if we should warn alternate ELF machine code.  */
0554   unsigned int warn_alternate_em: 1;
0555 
0556   /* TRUE if the linker script contained an explicit PHDRS command.  */
0557   unsigned int user_phdrs: 1;
0558 
0559   /* TRUE if program headers ought to be loaded.  */
0560   unsigned int load_phdrs: 1;
0561 
0562   /* TRUE if we should check relocations after all input files have
0563      been opened.  */
0564   unsigned int check_relocs_after_open_input: 1;
0565 
0566   /* TRUE if generation of .interp/PT_INTERP should be suppressed.  */
0567   unsigned int nointerp: 1;
0568 
0569   /* TRUE if common symbols should be treated as undefined.  */
0570   unsigned int inhibit_common_definition : 1;
0571 
0572   /* TRUE if "-Map map" is passed to linker.  */
0573   unsigned int has_map_file : 1;
0574 
0575   /* TRUE if "--enable-non-contiguous-regions" is passed to the
0576      linker.  */
0577   unsigned int non_contiguous_regions : 1;
0578 
0579   /* TRUE if "--enable-non-contiguous-regions-warnings" is passed to
0580      the linker.  */
0581   unsigned int non_contiguous_regions_warnings : 1;
0582 
0583   /* TRUE if all symbol names should be unique.  */
0584   unsigned int unique_symbol : 1;
0585 
0586   /* TRUE if maxpagesize is set on command-line.  */
0587   unsigned int maxpagesize_is_set : 1;
0588 
0589   /* TRUE if commonpagesize is set on command-line.  */
0590   unsigned int commonpagesize_is_set : 1;
0591 
0592   /* Char that may appear as the first char of a symbol, but should be
0593      skipped (like symbol_leading_char) when looking up symbols in
0594      wrap_hash.  Used by PowerPC Linux for 'dot' symbols.  */
0595   char wrap_char;
0596 
0597   /* Separator between archive and filename in linker script filespecs.  */
0598   char path_separator;
0599 
0600   /* Default stack size.  Zero means default (often zero itself), -1
0601      means explicitly zero-sized.  */
0602   bfd_signed_vma stacksize;
0603 
0604   /* Enable or disable target specific optimizations.
0605 
0606      Not all targets have optimizations to enable.
0607 
0608      Normally these optimizations are disabled by default but some targets
0609      prefer to enable them by default.  So this field is a tri-state variable.
0610      The values are:
0611 
0612      zero: Enable the optimizations (either from --relax being specified on
0613        the command line or the backend's before_allocation emulation function.
0614 
0615      positive: The user has requested that these optimizations be disabled.
0616        (Via the --no-relax command line option).
0617 
0618      negative: The optimizations are disabled.  (Set when initializing the
0619        args_type structure in ldmain.c:main.  */
0620   signed int disable_target_specific_optimizations;
0621 
0622   /* Function callbacks.  */
0623   const struct bfd_link_callbacks *callbacks;
0624 
0625   /* Hash table handled by BFD.  */
0626   struct bfd_link_hash_table *hash;
0627 
0628   /* Hash table of symbols to keep.  This is NULL unless strip is
0629      strip_some.  */
0630   struct bfd_hash_table *keep_hash;
0631 
0632   /* Hash table of symbols to report back via the notice callback.  If
0633      this is NULL, and notice_all is FALSE, then no symbols are
0634      reported back.  */
0635   struct bfd_hash_table *notice_hash;
0636 
0637   /* Hash table of symbols which are being wrapped (the --wrap linker
0638      option).  If this is NULL, no symbols are being wrapped.  */
0639   struct bfd_hash_table *wrap_hash;
0640 
0641   /* Hash table of symbols which may be left unresolved during
0642      a link.  If this is NULL, no symbols can be left unresolved.  */
0643   struct bfd_hash_table *ignore_hash;
0644 
0645   /* The output BFD.  */
0646   bfd *output_bfd;
0647 
0648   /* The import library generated.  */
0649   bfd *out_implib_bfd;
0650 
0651   /* The list of input BFD's involved in the link.  These are chained
0652      together via the link.next field.  */
0653   bfd *input_bfds;
0654   bfd **input_bfds_tail;
0655 
0656   /* If a symbol should be created for each input BFD, this is section
0657      where those symbols should be placed.  It must be a section in
0658      the output BFD.  It may be NULL, in which case no such symbols
0659      will be created.  This is to support CREATE_OBJECT_SYMBOLS in the
0660      linker command language.  */
0661   asection *create_object_symbols_section;
0662 
0663   /* List of global symbol names that are starting points for marking
0664      sections against garbage collection.  */
0665   struct bfd_sym_chain *gc_sym_list;
0666 
0667   /* If a base output file is wanted, then this points to it */
0668   void *base_file;
0669 
0670   /* The function to call when the executable or shared object is
0671      loaded.  */
0672   const char *init_function;
0673 
0674   /* The function to call when the executable or shared object is
0675      unloaded.  */
0676   const char *fini_function;
0677 
0678   /* Number of relaxation passes.  Usually only one relaxation pass
0679      is needed.  But a backend can have as many relaxation passes as
0680      necessary.  During bfd_relax_section call, it is set to the
0681      current pass, starting from 0.  */
0682   int relax_pass;
0683 
0684   /* Number of relaxation trips.  This number is incremented every
0685      time the relaxation pass is restarted due to a previous
0686      relaxation returning true in *AGAIN.  */
0687   int relax_trip;
0688 
0689   /* > 0 to treat protected data defined in the shared library as
0690      reference external.  0 to treat it as internal.  -1 to let
0691      backend to decide.  */
0692   int extern_protected_data;
0693 
0694   /* 1 to make undefined weak symbols dynamic when building a dynamic
0695      object.  0 to resolve undefined weak symbols to zero.  -1 to let
0696      the backend decide.  */
0697   int dynamic_undefined_weak;
0698 
0699   /* Non-zero if auto-import thunks for DATA items in pei386 DLLs
0700      should be generated/linked against.  Set to 1 if this feature
0701      is explicitly requested by the user, -1 if enabled by default.  */
0702   int pei386_auto_import;
0703 
0704   /* Non-zero if runtime relocs for DATA items with non-zero addends
0705      in pei386 DLLs should be generated.  Set to 1 if this feature
0706      is explicitly requested by the user, -1 if enabled by default.  */
0707   int pei386_runtime_pseudo_reloc;
0708 
0709   /* How many spare .dynamic DT_NULL entries should be added?  */
0710   unsigned int spare_dynamic_tags;
0711 
0712   /* GNU_PROPERTY_1_NEEDED_INDIRECT_EXTERN_ACCESS control:
0713        > 1: Turn on by -z indirect-extern-access or by backend.
0714       == 1: Turn on by an input.
0715          0: Turn off.
0716        < 0: Turn on if it is set on any inputs or let backend to
0717         decide.  */
0718   int indirect_extern_access;
0719 
0720   /* Non-zero if executable should not contain copy relocs.
0721        > 1: Implied by indirect_extern_access.
0722       == 1: Turn on by -z nocopyreloc.
0723          0: Turn off.
0724     Setting this to non-zero may result in a non-sharable text
0725     segment.  */
0726   int nocopyreloc;
0727 
0728   /* Pointer to the GNU_PROPERTY_1_NEEDED property in memory.  */
0729   bfd_byte *needed_1_p;
0730 
0731   /* May be used to set DT_FLAGS for ELF. */
0732   bfd_vma flags;
0733 
0734   /* May be used to set DT_FLAGS_1 for ELF. */
0735   bfd_vma flags_1;
0736 
0737   /* May be used to set DT_GNU_FLAGS_1 for ELF. */
0738   bfd_vma gnu_flags_1;
0739 
0740   /* TRUE if references to __start_/__stop_ synthesized symbols do not
0741      specially retain C identifier named sections.  */
0742   int start_stop_gc;
0743 
0744   /* May be used to set ELF visibility for __start_* / __stop_.  */
0745   unsigned int start_stop_visibility;
0746 
0747   /* The maximum page size for ELF.  */
0748   bfd_vma maxpagesize;
0749 
0750   /* The common page size for ELF.  */
0751   bfd_vma commonpagesize;
0752 
0753   /* Start and end of RELRO region.  */
0754   bfd_vma relro_start, relro_end;
0755 
0756   /* List of symbols should be dynamic.  */
0757   struct bfd_elf_dynamic_list *dynamic_list;
0758 
0759   /* The version information.  */
0760   struct bfd_elf_version_tree *version_info;
0761 
0762   /* Size of cache.  Backend can use it to keep strace cache size.   */
0763   bfd_size_type cache_size;
0764 
0765   /* The maximum cache size.  Backend can use cache_size and and
0766      max_cache_size to decide if keep_memory should be honored.  */
0767   bfd_size_type max_cache_size;
0768 };
0769 
0770 /* Some forward-definitions used by some callbacks.  */
0771 
0772 struct elf_strtab_hash;
0773 struct elf_internal_sym;
0774 
0775 /* This structures holds a set of callback functions.  These are called
0776    by the BFD linker routines.  */
0777 
0778 struct bfd_link_callbacks
0779 {
0780   /* A function which is called when an object is added from an
0781      archive.  ABFD is the archive element being added.  NAME is the
0782      name of the symbol which caused the archive element to be pulled
0783      in.  This function may set *SUBSBFD to point to an alternative
0784      BFD from which symbols should in fact be added in place of the
0785      original BFD's symbols.  Returns TRUE if the object should be
0786      added, FALSE if it should be skipped.  */
0787   bool (*add_archive_element)
0788     (struct bfd_link_info *, bfd *abfd, const char *name, bfd **subsbfd);
0789   /* A function which is called when a symbol is found with multiple
0790      definitions.  H is the symbol which is defined multiple times.
0791      NBFD is the new BFD, NSEC is the new section, and NVAL is the new
0792      value.  NSEC may be bfd_com_section or bfd_ind_section.  */
0793   void (*multiple_definition)
0794     (struct bfd_link_info *, struct bfd_link_hash_entry *h,
0795      bfd *nbfd, asection *nsec, bfd_vma nval);
0796   /* A function which is called when a common symbol is defined
0797      multiple times.  H is the symbol appearing multiple times.
0798      NBFD is the BFD of the new symbol.  NTYPE is the type of the new
0799      symbol, one of bfd_link_hash_defined, bfd_link_hash_common, or
0800      bfd_link_hash_indirect.  If NTYPE is bfd_link_hash_common, NSIZE
0801      is the size of the new symbol.  */
0802   void (*multiple_common)
0803     (struct bfd_link_info *, struct bfd_link_hash_entry *h,
0804      bfd *nbfd, enum bfd_link_hash_type ntype, bfd_vma nsize);
0805   /* A function which is called to add a symbol to a set.  ENTRY is
0806      the link hash table entry for the set itself (e.g.,
0807      __CTOR_LIST__).  RELOC is the relocation to use for an entry in
0808      the set when generating a relocatable file, and is also used to
0809      get the size of the entry when generating an executable file.
0810      ABFD, SEC and VALUE identify the value to add to the set.  */
0811   void (*add_to_set)
0812     (struct bfd_link_info *, struct bfd_link_hash_entry *entry,
0813      bfd_reloc_code_real_type reloc, bfd *abfd, asection *sec, bfd_vma value);
0814   /* A function which is called when the name of a g++ constructor or
0815      destructor is found.  This is only called by some object file
0816      formats.  CONSTRUCTOR is TRUE for a constructor, FALSE for a
0817      destructor.  This will use BFD_RELOC_CTOR when generating a
0818      relocatable file.  NAME is the name of the symbol found.  ABFD,
0819      SECTION and VALUE are the value of the symbol.  */
0820   void (*constructor)
0821     (struct bfd_link_info *, bool constructor, const char *name,
0822      bfd *abfd, asection *sec, bfd_vma value);
0823   /* A function which is called to issue a linker warning.  For
0824      example, this is called when there is a reference to a warning
0825      symbol.  WARNING is the warning to be issued.  SYMBOL is the name
0826      of the symbol which triggered the warning; it may be NULL if
0827      there is none.  ABFD, SECTION and ADDRESS identify the location
0828      which trigerred the warning; either ABFD or SECTION or both may
0829      be NULL if the location is not known.  */
0830   void (*warning)
0831     (struct bfd_link_info *, const char *warning, const char *symbol,
0832      bfd *abfd, asection *section, bfd_vma address);
0833   /* A function which is called when a relocation is attempted against
0834      an undefined symbol.  NAME is the symbol which is undefined.
0835      ABFD, SECTION and ADDRESS identify the location from which the
0836      reference is made. IS_FATAL indicates whether an undefined symbol is
0837      a fatal error or not. In some cases SECTION may be NULL.  */
0838   void (*undefined_symbol)
0839     (struct bfd_link_info *, const char *name, bfd *abfd,
0840      asection *section, bfd_vma address, bool is_fatal);
0841   /* A function which is called when a reloc overflow occurs. ENTRY is
0842      the link hash table entry for the symbol the reloc is against.
0843      NAME is the name of the local symbol or section the reloc is
0844      against, RELOC_NAME is the name of the relocation, and ADDEND is
0845      any addend that is used.  ABFD, SECTION and ADDRESS identify the
0846      location at which the overflow occurs; if this is the result of a
0847      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
0848      ABFD will be NULL.  */
0849   void (*reloc_overflow)
0850     (struct bfd_link_info *, struct bfd_link_hash_entry *entry,
0851      const char *name, const char *reloc_name, bfd_vma addend,
0852      bfd *abfd, asection *section, bfd_vma address);
0853   /* A function which is called when a dangerous reloc is performed.
0854      MESSAGE is an appropriate message.
0855      ABFD, SECTION and ADDRESS identify the location at which the
0856      problem occurred; if this is the result of a
0857      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
0858      ABFD will be NULL.  */
0859   void (*reloc_dangerous)
0860     (struct bfd_link_info *, const char *message,
0861      bfd *abfd, asection *section, bfd_vma address);
0862   /* A function which is called when a reloc is found to be attached
0863      to a symbol which is not being written out.  NAME is the name of
0864      the symbol.  ABFD, SECTION and ADDRESS identify the location of
0865      the reloc; if this is the result of a
0866      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
0867      ABFD will be NULL.  */
0868   void (*unattached_reloc)
0869     (struct bfd_link_info *, const char *name,
0870      bfd *abfd, asection *section, bfd_vma address);
0871   /* A function which is called when a symbol in notice_hash is
0872      defined or referenced.  H is the symbol, INH the indirect symbol
0873      if applicable.  ABFD, SECTION and ADDRESS are the (new) value of
0874      the symbol.  If SECTION is bfd_und_section, this is a reference.
0875      FLAGS are the symbol BSF_* flags.  */
0876   bool (*notice)
0877     (struct bfd_link_info *, struct bfd_link_hash_entry *h,
0878      struct bfd_link_hash_entry *inh,
0879      bfd *abfd, asection *section, bfd_vma address, flagword flags);
0880   /* Fatal error.  */
0881   void (*fatal)
0882     (const char *fmt, ...) ATTRIBUTE_NORETURN;
0883   /* Error or warning link info message.  */
0884   void (*einfo)
0885     (const char *fmt, ...);
0886   /* General link info message.  */
0887   void (*info)
0888     (const char *fmt, ...);
0889   /* Message to be printed in linker map file.  */
0890   void (*minfo)
0891     (const char *fmt, ...);
0892   /* This callback provides a chance for users of the BFD library to
0893      override its decision about whether to place two adjacent sections
0894      into the same segment.  */
0895   bool (*override_segment_assignment)
0896     (struct bfd_link_info *, bfd * abfd,
0897      asection * current_section, asection * previous_section,
0898      bool new_segment);
0899   /* This callback provides a chance for callers of the BFD to examine the
0900      ELF (dynamic) string table once it is complete.  */
0901   void (*examine_strtab)
0902     (struct elf_strtab_hash *symstrtab);
0903   /* This callback is called just before a symbol is swapped out, so that the
0904      CTF machinery can look up symbols during construction.  The name is
0905      already an external strtab offset at this point.  */
0906   void (*ctf_new_symbol)
0907     (int symidx, struct elf_internal_sym *sym);
0908   /* Likewise, for dynamic symbols.  */
0909   void (*ctf_new_dynsym)
0910     (int symidx, struct elf_internal_sym *sym);
0911   /* This callback should emit the CTF section into a non-loadable section in
0912      the output BFD named .ctf or a name beginning with ".ctf.".  */
0913   void (*emit_ctf)
0914     (void);
0915 };
0916 
0917 /* The linker builds link_order structures which tell the code how to
0918    include input data in the output file.  */
0919 
0920 /* These are the types of link_order structures.  */
0921 
0922 enum bfd_link_order_type
0923 {
0924   bfd_undefined_link_order, /* Undefined.  */
0925   bfd_indirect_link_order,  /* Built from a section.  */
0926   bfd_data_link_order,      /* Set to explicit data.  */
0927   bfd_section_reloc_link_order, /* Relocate against a section.  */
0928   bfd_symbol_reloc_link_order   /* Relocate against a symbol.  */
0929 };
0930 
0931 /* This is the link_order structure itself.  These form a chain
0932    attached to the output section whose contents they are describing.  */
0933 
0934 struct bfd_link_order
0935 {
0936   /* Next link_order in chain.  */
0937   struct bfd_link_order *next;
0938   /* Type of link_order.  */
0939   enum bfd_link_order_type type;
0940   /* Offset within output section in bytes.  */
0941   bfd_vma offset;
0942   /* Size within output section in octets.  */
0943   bfd_size_type size;
0944   /* Type specific information.  */
0945   union
0946     {
0947       struct
0948     {
0949       /* Section to include.  If this is used, then
0950          section->output_section must be the section the
0951          link_order is attached to, section->output_offset must
0952          equal the link_order offset field, and section->size
0953          must equal the link_order size field.  Maybe these
0954          restrictions should be relaxed someday.  */
0955       asection *section;
0956     } indirect;
0957       struct
0958     {
0959       /* Size of contents, or zero when contents should be filled by
0960          the architecture-dependent fill function.
0961          A non-zero value allows filling of the output section
0962          with an arbitrary repeated pattern.  */
0963       unsigned int size;
0964       /* Data to put into file.  */
0965       bfd_byte *contents;
0966     } data;
0967       struct
0968     {
0969       /* Description of reloc to generate.  Used for
0970          bfd_section_reloc_link_order and
0971          bfd_symbol_reloc_link_order.  */
0972       struct bfd_link_order_reloc *p;
0973     } reloc;
0974     } u;
0975 };
0976 
0977 /* A linker order of type bfd_section_reloc_link_order or
0978    bfd_symbol_reloc_link_order means to create a reloc against a
0979    section or symbol, respectively.  This is used to implement -Ur to
0980    generate relocs for the constructor tables.  The
0981    bfd_link_order_reloc structure describes the reloc that BFD should
0982    create.  It is similar to a arelent, but I didn't use arelent
0983    because the linker does not know anything about most symbols, and
0984    any asymbol structure it creates will be partially meaningless.
0985    This information could logically be in the bfd_link_order struct,
0986    but I didn't want to waste the space since these types of relocs
0987    are relatively rare.  */
0988 
0989 struct bfd_link_order_reloc
0990 {
0991   /* Reloc type.  */
0992   bfd_reloc_code_real_type reloc;
0993 
0994   union
0995     {
0996       /* For type bfd_section_reloc_link_order, this is the section
0997      the reloc should be against.  This must be a section in the
0998      output BFD, not any of the input BFDs.  */
0999       asection *section;
1000       /* For type bfd_symbol_reloc_link_order, this is the name of the
1001      symbol the reloc should be against.  */
1002       const char *name;
1003     } u;
1004 
1005   /* Addend to use.  The object file should contain zero.  The BFD
1006      backend is responsible for filling in the contents of the object
1007      file correctly.  For some object file formats (e.g., COFF) the
1008      addend must be stored into in the object file, and for some
1009      (e.g., SPARC a.out) it is kept in the reloc.  */
1010   bfd_vma addend;
1011 };
1012 
1013 /* Allocate a new link_order for a section.  */
1014 extern struct bfd_link_order *bfd_new_link_order (bfd *, asection *);
1015 
1016 struct bfd_section_already_linked;
1017 
1018 extern bool bfd_section_already_linked_table_init (void);
1019 extern void bfd_section_already_linked_table_free (void);
1020 extern bool _bfd_handle_already_linked
1021   (struct bfd_section *, struct bfd_section_already_linked *,
1022    struct bfd_link_info *);
1023 
1024 extern struct bfd_section *_bfd_nearby_section
1025   (bfd *, struct bfd_section *, bfd_vma);
1026 
1027 extern void _bfd_fix_excluded_sec_syms
1028   (bfd *, struct bfd_link_info *);
1029 
1030 /* These structures are used to describe version information for the
1031    ELF linker.  These structures could be manipulated entirely inside
1032    BFD, but it would be a pain.  Instead, the regular linker sets up
1033    these structures, and then passes them into BFD.  */
1034 
1035 /* Glob pattern for a version.  */
1036 
1037 struct bfd_elf_version_expr
1038 {
1039   /* Next glob pattern for this version.  */
1040   struct bfd_elf_version_expr *next;
1041   /* Glob pattern.  */
1042   const char *pattern;
1043   /* Set if pattern is not a glob.  */
1044   unsigned int literal : 1;
1045   /* Defined by ".symver".  */
1046   unsigned int symver : 1;
1047   /* Defined by version script.  */
1048   unsigned int script : 1;
1049   /* Pattern type.  */
1050 #define BFD_ELF_VERSION_C_TYPE      1
1051 #define BFD_ELF_VERSION_CXX_TYPE    2
1052 #define BFD_ELF_VERSION_JAVA_TYPE   4
1053   unsigned int mask : 3;
1054 };
1055 
1056 struct bfd_elf_version_expr_head
1057 {
1058   /* List of all patterns, both wildcards and non-wildcards.  */
1059   struct bfd_elf_version_expr *list;
1060   /* Hash table for non-wildcards.  */
1061   void *htab;
1062   /* Remaining patterns.  */
1063   struct bfd_elf_version_expr *remaining;
1064   /* What kind of pattern types are present in list (bitmask).  */
1065   unsigned int mask;
1066 };
1067 
1068 /* Version dependencies.  */
1069 
1070 struct bfd_elf_version_deps
1071 {
1072   /* Next dependency for this version.  */
1073   struct bfd_elf_version_deps *next;
1074   /* The version which this version depends upon.  */
1075   struct bfd_elf_version_tree *version_needed;
1076 };
1077 
1078 /* A node in the version tree.  */
1079 
1080 struct bfd_elf_version_tree
1081 {
1082   /* Next version.  */
1083   struct bfd_elf_version_tree *next;
1084   /* Name of this version.  */
1085   const char *name;
1086   /* Version number.  */
1087   unsigned int vernum;
1088   /* Regular expressions for global symbols in this version.  */
1089   struct bfd_elf_version_expr_head globals;
1090   /* Regular expressions for local symbols in this version.  */
1091   struct bfd_elf_version_expr_head locals;
1092   /* List of versions which this version depends upon.  */
1093   struct bfd_elf_version_deps *deps;
1094   /* Index of the version name.  This is used within BFD.  */
1095   unsigned int name_indx;
1096   /* Whether this version tree was used.  This is used within BFD.  */
1097   int used;
1098   /* Matching hook.  */
1099   struct bfd_elf_version_expr *(*match)
1100     (struct bfd_elf_version_expr_head *head,
1101      struct bfd_elf_version_expr *prev, const char *sym);
1102 };
1103 
1104 struct bfd_elf_dynamic_list
1105 {
1106   struct bfd_elf_version_expr_head head;
1107   struct bfd_elf_version_expr *(*match)
1108     (struct bfd_elf_version_expr_head *head,
1109      struct bfd_elf_version_expr *prev, const char *sym);
1110 };
1111 
1112 #endif