Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2026-11-01 10:33:42

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