PR24857, ld: error adding symbols: bad value
[external/binutils.git] / include / bfdlink.h
1 /* bfdlink.h -- header file for BFD link routines
2    Copyright (C) 1993-2019 Free Software Foundation, Inc.
3    Written by Steve Chamberlain and Ian Lance Taylor, Cygnus Support.
4
5    This file is part of BFD, the Binary File Descriptor library.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
20    MA 02110-1301, USA.  */
21
22 #ifndef BFDLINK_H
23 #define BFDLINK_H
24
25 /* Which symbols to strip during a link.  */
26 enum bfd_link_strip
27 {
28   strip_none,           /* Don't strip any symbols.  */
29   strip_debugger,       /* Strip debugging symbols.  */
30   strip_some,           /* keep_hash is the list of symbols to keep.  */
31   strip_all             /* Strip all symbols.  */
32 };
33
34 /* Which local symbols to discard during a link.  This is irrelevant
35    if strip_all is used.  */
36 enum bfd_link_discard
37 {
38   discard_sec_merge,    /* Discard local temporary symbols in SEC_MERGE
39                            sections.  */
40   discard_none,         /* Don't discard any locals.  */
41   discard_l,            /* Discard local temporary symbols.  */
42   discard_all           /* Discard all locals.  */
43 };
44
45 /* Whether to generate ELF common symbols with the STT_COMMON type
46    during a relocatable link.  */
47 enum bfd_link_elf_stt_common
48 {
49   unchanged,
50   elf_stt_common,
51   no_elf_stt_common
52 };
53
54 /* Describes the type of hash table entry structure being used.
55    Different hash table structure have different fields and so
56    support different linking features.  */
57 enum bfd_link_hash_table_type
58   {
59     bfd_link_generic_hash_table,
60     bfd_link_elf_hash_table
61   };
62 \f
63 /* These are the possible types of an entry in the BFD link hash
64    table.  */
65
66 enum bfd_link_hash_type
67 {
68   bfd_link_hash_new,            /* Symbol is new.  */
69   bfd_link_hash_undefined,      /* Symbol seen before, but undefined.  */
70   bfd_link_hash_undefweak,      /* Symbol is weak and undefined.  */
71   bfd_link_hash_defined,        /* Symbol is defined.  */
72   bfd_link_hash_defweak,        /* Symbol is weak and defined.  */
73   bfd_link_hash_common,         /* Symbol is common.  */
74   bfd_link_hash_indirect,       /* Symbol is an indirect link.  */
75   bfd_link_hash_warning         /* Like indirect, but warn if referenced.  */
76 };
77
78 enum bfd_link_common_skip_ar_symbols
79 {
80   bfd_link_common_skip_none,
81   bfd_link_common_skip_text,
82   bfd_link_common_skip_data,
83   bfd_link_common_skip_all
84 };
85
86 struct bfd_link_hash_common_entry
87   {
88     unsigned int alignment_power;       /* Alignment.  */
89     asection *section;          /* Symbol section.  */
90   };
91
92 /* The linking routines use a hash table which uses this structure for
93    its elements.  */
94
95 struct bfd_link_hash_entry
96 {
97   /* Base hash table entry structure.  */
98   struct bfd_hash_entry root;
99
100   /* Type of this entry.  */
101   ENUM_BITFIELD (bfd_link_hash_type) type : 8;
102
103   /* Symbol is referenced in a normal regular object file,
104      as distinct from a LTO IR object file.  */
105   unsigned int non_ir_ref_regular : 1;
106
107   /* Symbol is referenced in a normal dynamic object file,
108      as distinct from a LTO IR object file.  */
109   unsigned int non_ir_ref_dynamic : 1;
110
111   /* Symbol is a built-in define.  These will be overridden by PROVIDE
112      in a linker script.  */
113   unsigned int linker_def : 1;
114
115   /* Symbol defined in a linker script.  */
116   unsigned int ldscript_def : 1;
117
118   /* Symbol will be converted from absolute to section-relative.  Set for
119      symbols defined by a script from "dot" (also SEGMENT_START or ORIGIN)
120      outside of an output section statement.  */
121   unsigned int rel_from_abs : 1;
122
123   /* A union of information depending upon the type.  */
124   union
125     {
126       /* Nothing is kept for bfd_hash_new.  */
127       /* bfd_link_hash_undefined, bfd_link_hash_undefweak.  */
128       struct
129         {
130           /* Undefined and common symbols are kept in a linked list through
131              this field.  This field is present in all of the union element
132              so that we don't need to remove entries from the list when we
133              change their type.  Removing entries would either require the
134              list to be doubly linked, which would waste more memory, or
135              require a traversal.  When an undefined or common symbol is
136              created, it should be added to this list, the head of which is in
137              the link hash table itself.  As symbols are defined, they need
138              not be removed from the list; anything which reads the list must
139              doublecheck the symbol type.
140
141              Weak symbols are not kept on this list.
142
143              Defined and defweak symbols use this field as a reference marker.
144              If the field is not NULL, or this structure is the tail of the
145              undefined symbol list, the symbol has been referenced.  If the
146              symbol is undefined and becomes defined, this field will
147              automatically be non-NULL since the symbol will have been on the
148              undefined symbol list.  */
149           struct bfd_link_hash_entry *next;
150           /* BFD symbol was found in.  */
151           bfd *abfd;
152         } undef;
153       /* bfd_link_hash_defined, bfd_link_hash_defweak.  */
154       struct
155         {
156           struct bfd_link_hash_entry *next;
157           /* Symbol section.  */
158           asection *section;
159           /* Symbol value.  */
160           bfd_vma value;
161         } def;
162       /* bfd_link_hash_indirect, bfd_link_hash_warning.  */
163       struct
164         {
165           struct bfd_link_hash_entry *next;
166           /* Real symbol.  */
167           struct bfd_link_hash_entry *link;
168           /* Warning message (bfd_link_hash_warning only).  */
169           const char *warning;
170         } i;
171       /* bfd_link_hash_common.  */
172       struct
173         {
174           struct bfd_link_hash_entry *next;
175           /* The linker needs to know three things about common
176              symbols: the size, the alignment, and the section in
177              which the symbol should be placed.  We store the size
178              here, and we allocate a small structure to hold the
179              section and the alignment.  The alignment is stored as a
180              power of two.  We don't store all the information
181              directly because we don't want to increase the size of
182              the union; this structure is a major space user in the
183              linker.  */
184           struct bfd_link_hash_common_entry *p;
185           /* Common symbol size.  */
186           bfd_size_type size;
187         } c;
188     } u;
189 };
190
191 /* This is the link hash table.  It is a derived class of
192    bfd_hash_table.  */
193
194 struct bfd_link_hash_table
195 {
196   /* The hash table itself.  */
197   struct bfd_hash_table table;
198   /* A linked list of undefined and common symbols, linked through the
199      next field in the bfd_link_hash_entry structure.  */
200   struct bfd_link_hash_entry *undefs;
201   /* Entries are added to the tail of the undefs list.  */
202   struct bfd_link_hash_entry *undefs_tail;
203   /* Function to free the hash table on closing BFD.  */
204   void (*hash_table_free) (bfd *);
205   /* The type of the link hash table.  */
206   enum bfd_link_hash_table_type type;
207 };
208
209 /* Look up an entry in a link hash table.  If FOLLOW is TRUE, this
210    follows bfd_link_hash_indirect and bfd_link_hash_warning links to
211    the real symbol.  */
212 extern struct bfd_link_hash_entry *bfd_link_hash_lookup
213   (struct bfd_link_hash_table *, const char *, bfd_boolean create,
214    bfd_boolean copy, bfd_boolean follow);
215
216 /* Look up an entry in the main linker hash table if the symbol might
217    be wrapped.  This should only be used for references to an
218    undefined symbol, not for definitions of a symbol.  */
219
220 extern struct bfd_link_hash_entry *bfd_wrapped_link_hash_lookup
221   (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
222    bfd_boolean, bfd_boolean);
223
224 /* If H is a wrapped symbol, ie. the symbol name starts with "__wrap_"
225    and the remainder is found in wrap_hash, return the real symbol.  */
226
227 extern struct bfd_link_hash_entry *unwrap_hash_lookup
228   (struct bfd_link_info *, bfd *, struct bfd_link_hash_entry *);
229
230 /* Traverse a link hash table.  */
231 extern void bfd_link_hash_traverse
232   (struct bfd_link_hash_table *,
233     bfd_boolean (*) (struct bfd_link_hash_entry *, void *),
234     void *);
235
236 /* Add an entry to the undefs list.  */
237 extern void bfd_link_add_undef
238   (struct bfd_link_hash_table *, struct bfd_link_hash_entry *);
239
240 /* Remove symbols from the undefs list that don't belong there.  */
241 extern void bfd_link_repair_undef_list
242   (struct bfd_link_hash_table *table);
243
244 /* Read symbols and cache symbol pointer array in outsymbols.  */
245 extern bfd_boolean bfd_generic_link_read_symbols (bfd *);
246
247 /* Check the relocs in the BFD.  Called after all the input
248    files have been loaded, and garbage collection has tagged
249    any unneeded sections.  */
250 extern bfd_boolean bfd_link_check_relocs (bfd *,struct bfd_link_info *);
251
252 struct bfd_sym_chain
253 {
254   struct bfd_sym_chain *next;
255   const char *name;
256 };
257 \f
258 /* How to handle unresolved symbols.
259    There are four possibilities which are enumerated below:  */
260 enum report_method
261 {
262   /* This is the initial value when then link_info structure is created.
263      It allows the various stages of the linker to determine whether they
264      allowed to set the value.  */
265   RM_NOT_YET_SET = 0,
266   RM_IGNORE,
267   RM_GENERATE_WARNING,
268   RM_GENERATE_ERROR
269 };
270
271 typedef enum {with_flags, without_flags} flag_type;
272
273 /* A section flag list.  */
274 struct flag_info_list
275 {
276   flag_type with;
277   const char *name;
278   bfd_boolean valid;
279   struct flag_info_list *next;
280 };
281
282 /* Section flag info.  */
283 struct flag_info
284 {
285   flagword only_with_flags;
286   flagword not_with_flags;
287   struct flag_info_list *flag_list;
288   bfd_boolean flags_initialized;
289 };
290
291 struct bfd_elf_dynamic_list;
292 struct bfd_elf_version_tree;
293
294 /* Types of output.  */
295
296 enum output_type
297 {
298   type_pde,
299   type_pie,
300   type_relocatable,
301   type_dll,
302 };
303
304 #define bfd_link_pde(info)         ((info)->type == type_pde)
305 #define bfd_link_dll(info)         ((info)->type == type_dll)
306 #define bfd_link_relocatable(info) ((info)->type == type_relocatable)
307 #define bfd_link_pie(info)         ((info)->type == type_pie)
308 #define bfd_link_executable(info)  (bfd_link_pde (info) || bfd_link_pie (info))
309 #define bfd_link_pic(info)         (bfd_link_dll (info) || bfd_link_pie (info))
310
311 /* This structure holds all the information needed to communicate
312    between BFD and the linker when doing a link.  */
313
314 struct bfd_link_info
315 {
316   /* Output type.  */
317   ENUM_BITFIELD (output_type) type : 2;
318
319   /* TRUE if BFD should pre-bind symbols in a shared object.  */
320   unsigned int symbolic: 1;
321
322   /* TRUE if executable should not contain copy relocs.
323      Setting this true may result in a non-sharable text segment.  */
324   unsigned int nocopyreloc: 1;
325
326   /* TRUE if BFD should export all symbols in the dynamic symbol table
327      of an executable, rather than only those used.  */
328   unsigned int export_dynamic: 1;
329
330   /* TRUE if a default symbol version should be created and used for
331      exported symbols.  */
332   unsigned int create_default_symver: 1;
333
334   /* TRUE if unreferenced sections should be removed.  */
335   unsigned int gc_sections: 1;
336
337   /* TRUE if exported symbols should be kept during section gc.  */
338   unsigned int gc_keep_exported: 1;
339
340   /* TRUE if every symbol should be reported back via the notice
341      callback.  */
342   unsigned int notice_all: 1;
343
344   /* TRUE if the LTO plugin is active.  */
345   unsigned int lto_plugin_active: 1;
346
347   /* TRUE if global symbols in discarded sections should be stripped.  */
348   unsigned int strip_discarded: 1;
349
350   /* TRUE if all data symbols should be dynamic.  */
351   unsigned int dynamic_data: 1;
352
353   /* TRUE if section groups should be resolved.  */
354   unsigned int resolve_section_groups: 1;
355
356   /* Which symbols to strip.  */
357   ENUM_BITFIELD (bfd_link_strip) strip : 2;
358
359   /* Which local symbols to discard.  */
360   ENUM_BITFIELD (bfd_link_discard) discard : 2;
361
362   /* Whether to generate ELF common symbols with the STT_COMMON type.  */
363   ENUM_BITFIELD (bfd_link_elf_stt_common) elf_stt_common : 2;
364
365   /* Criteria for skipping symbols when determining
366      whether to include an object from an archive. */
367   ENUM_BITFIELD (bfd_link_common_skip_ar_symbols) common_skip_ar_symbols : 2;
368
369   /* What to do with unresolved symbols in an object file.
370      When producing executables the default is GENERATE_ERROR.
371      When producing shared libraries the default is IGNORE.  The
372      assumption with shared libraries is that the reference will be
373      resolved at load/execution time.  */
374   ENUM_BITFIELD (report_method) unresolved_syms_in_objects : 2;
375
376   /* What to do with unresolved symbols in a shared library.
377      The same defaults apply.  */
378   ENUM_BITFIELD (report_method) unresolved_syms_in_shared_libs : 2;
379
380   /* TRUE if shared objects should be linked directly, not shared.  */
381   unsigned int static_link: 1;
382
383   /* TRUE if symbols should be retained in memory, FALSE if they
384      should be freed and reread.  */
385   unsigned int keep_memory: 1;
386
387   /* TRUE if BFD should generate relocation information in the final
388      executable.  */
389   unsigned int emitrelocations: 1;
390
391   /* TRUE if PT_GNU_RELRO segment should be created.  */
392   unsigned int relro: 1;
393
394   /* TRUE if separate code segment should be created.  */
395   unsigned int separate_code: 1;
396
397   /* Nonzero if .eh_frame_hdr section and PT_GNU_EH_FRAME ELF segment
398      should be created.  1 for DWARF2 tables, 2 for compact tables.  */
399   unsigned int eh_frame_hdr_type: 2;
400
401   /* TRUE if we should warn when adding a DT_TEXTREL to a shared object.  */
402   unsigned int warn_shared_textrel: 1;
403
404   /* TRUE if we should error when adding a DT_TEXTREL.  */
405   unsigned int error_textrel: 1;
406
407   /* TRUE if .hash section should be created.  */
408   unsigned int emit_hash: 1;
409
410   /* TRUE if .gnu.hash section should be created.  */
411   unsigned int emit_gnu_hash: 1;
412
413   /* If TRUE reduce memory overheads, at the expense of speed. This will
414      cause map file generation to use an O(N^2) algorithm and disable
415      caching ELF symbol buffer.  */
416   unsigned int reduce_memory_overheads: 1;
417
418   /* TRUE if the output file should be in a traditional format.  This
419      is equivalent to the setting of the BFD_TRADITIONAL_FORMAT flag
420      on the output file, but may be checked when reading the input
421      files.  */
422   unsigned int traditional_format: 1;
423
424   /* TRUE if non-PLT relocs should be merged into one reloc section
425      and sorted so that relocs against the same symbol come together.  */
426   unsigned int combreloc: 1;
427
428   /* TRUE if a default symbol version should be created and used for
429      imported symbols.  */
430   unsigned int default_imported_symver: 1;
431
432   /* TRUE if the new ELF dynamic tags are enabled. */
433   unsigned int new_dtags: 1;
434
435   /* FALSE if .eh_frame unwind info should be generated for PLT and other
436      linker created sections, TRUE if it should be omitted.  */
437   unsigned int no_ld_generated_unwind_info: 1;
438
439   /* TRUE if BFD should generate a "task linked" object file,
440      similar to relocatable but also with globals converted to
441      statics.  */
442   unsigned int task_link: 1;
443
444   /* TRUE if ok to have multiple definition.  */
445   unsigned int allow_multiple_definition: 1;
446
447   /* TRUE if ok to have prohibit multiple definition of absolute symbols.  */
448   unsigned int prohibit_multiple_definition_absolute: 1;
449
450   /* TRUE if ok to have version with no definition.  */
451   unsigned int allow_undefined_version: 1;
452
453   /* TRUE if some symbols have to be dynamic, controlled by
454      --dynamic-list command line options.  */
455   unsigned int dynamic: 1;
456
457   /* TRUE if PT_GNU_STACK segment should be created with PF_R|PF_W|PF_X
458      flags.  */
459   unsigned int execstack: 1;
460
461   /* TRUE if PT_GNU_STACK segment should be created with PF_R|PF_W
462      flags.  */
463   unsigned int noexecstack: 1;
464
465   /* TRUE if we want to produced optimized output files.  This might
466      need much more time and therefore must be explicitly selected.  */
467   unsigned int optimize: 1;
468
469   /* TRUE if user should be informed of removed unreferenced sections.  */
470   unsigned int print_gc_sections: 1;
471
472   /* TRUE if we should warn alternate ELF machine code.  */
473   unsigned int warn_alternate_em: 1;
474
475   /* TRUE if the linker script contained an explicit PHDRS command.  */
476   unsigned int user_phdrs: 1;
477
478   /* TRUE if program headers ought to be loaded.  */
479   unsigned int load_phdrs: 1;
480
481   /* TRUE if we should check relocations after all input files have
482      been opened.  */
483   unsigned int check_relocs_after_open_input: 1;
484
485   /* TRUE if generation of .interp/PT_INTERP should be suppressed.  */
486   unsigned int nointerp: 1;
487
488   /* TRUE if common symbols should be treated as undefined.  */
489   unsigned int inhibit_common_definition : 1;
490
491   /* TRUE if "-Map map" is passed to linker.  */
492   unsigned int has_map_file : 1;
493
494   /* Char that may appear as the first char of a symbol, but should be
495      skipped (like symbol_leading_char) when looking up symbols in
496      wrap_hash.  Used by PowerPC Linux for 'dot' symbols.  */
497   char wrap_char;
498
499   /* Separator between archive and filename in linker script filespecs.  */
500   char path_separator;
501
502   /* Compress DWARF debug sections.  */
503   enum compressed_debug_section_type compress_debug;
504
505   /* Default stack size.  Zero means default (often zero itself), -1
506      means explicitly zero-sized.  */
507   bfd_signed_vma stacksize;
508
509   /* Enable or disable target specific optimizations.
510
511      Not all targets have optimizations to enable.
512
513      Normally these optimizations are disabled by default but some targets
514      prefer to enable them by default.  So this field is a tri-state variable.
515      The values are:
516      
517      zero: Enable the optimizations (either from --relax being specified on
518        the command line or the backend's before_allocation emulation function.
519        
520      positive: The user has requested that these optimizations be disabled.
521        (Via the --no-relax command line option).
522
523      negative: The optimizations are disabled.  (Set when initializing the
524        args_type structure in ldmain.c:main.  */
525   signed int disable_target_specific_optimizations;
526
527   /* Function callbacks.  */
528   const struct bfd_link_callbacks *callbacks;
529
530   /* Hash table handled by BFD.  */
531   struct bfd_link_hash_table *hash;
532
533   /* Hash table of symbols to keep.  This is NULL unless strip is
534      strip_some.  */
535   struct bfd_hash_table *keep_hash;
536
537   /* Hash table of symbols to report back via the notice callback.  If
538      this is NULL, and notice_all is FALSE, then no symbols are
539      reported back.  */
540   struct bfd_hash_table *notice_hash;
541
542   /* Hash table of symbols which are being wrapped (the --wrap linker
543      option).  If this is NULL, no symbols are being wrapped.  */
544   struct bfd_hash_table *wrap_hash;
545
546   /* Hash table of symbols which may be left unresolved during
547      a link.  If this is NULL, no symbols can be left unresolved.  */
548   struct bfd_hash_table *ignore_hash;
549
550   /* The output BFD.  */
551   bfd *output_bfd;
552
553   /* The import library generated.  */
554   bfd *out_implib_bfd;
555
556   /* The list of input BFD's involved in the link.  These are chained
557      together via the link.next field.  */
558   bfd *input_bfds;
559   bfd **input_bfds_tail;
560
561   /* If a symbol should be created for each input BFD, this is section
562      where those symbols should be placed.  It must be a section in
563      the output BFD.  It may be NULL, in which case no such symbols
564      will be created.  This is to support CREATE_OBJECT_SYMBOLS in the
565      linker command language.  */
566   asection *create_object_symbols_section;
567
568   /* List of global symbol names that are starting points for marking
569      sections against garbage collection.  */
570   struct bfd_sym_chain *gc_sym_list;
571
572   /* If a base output file is wanted, then this points to it */
573   void *base_file;
574
575   /* The function to call when the executable or shared object is
576      loaded.  */
577   const char *init_function;
578
579   /* The function to call when the executable or shared object is
580      unloaded.  */
581   const char *fini_function;
582
583   /* Number of relaxation passes.  Usually only one relaxation pass
584      is needed.  But a backend can have as many relaxation passes as
585      necessary.  During bfd_relax_section call, it is set to the
586      current pass, starting from 0.  */
587   int relax_pass;
588
589   /* Number of relaxation trips.  This number is incremented every
590      time the relaxation pass is restarted due to a previous
591      relaxation returning true in *AGAIN.  */
592   int relax_trip;
593
594   /* > 0 to treat protected data defined in the shared library as
595      reference external.  0 to treat it as internal.  -1 to let
596      backend to decide.  */
597   int extern_protected_data;
598
599   /* 1 to make undefined weak symbols dynamic when building a dynamic
600      object.  0 to resolve undefined weak symbols to zero.  -1 to let
601      the backend decide.  */
602   int dynamic_undefined_weak;
603
604   /* Non-zero if auto-import thunks for DATA items in pei386 DLLs
605      should be generated/linked against.  Set to 1 if this feature
606      is explicitly requested by the user, -1 if enabled by default.  */
607   int pei386_auto_import;
608
609   /* Non-zero if runtime relocs for DATA items with non-zero addends
610      in pei386 DLLs should be generated.  Set to 1 if this feature
611      is explicitly requested by the user, -1 if enabled by default.  */
612   int pei386_runtime_pseudo_reloc;
613
614   /* How many spare .dynamic DT_NULL entries should be added?  */
615   unsigned int spare_dynamic_tags;
616
617   /* May be used to set DT_FLAGS for ELF. */
618   bfd_vma flags;
619
620   /* May be used to set DT_FLAGS_1 for ELF. */
621   bfd_vma flags_1;
622
623   /* Start and end of RELRO region.  */
624   bfd_vma relro_start, relro_end;
625
626   /* List of symbols should be dynamic.  */
627   struct bfd_elf_dynamic_list *dynamic_list;
628
629   /* The version information.  */
630   struct bfd_elf_version_tree *version_info;
631 };
632
633 /* This structures holds a set of callback functions.  These are called
634    by the BFD linker routines.  */
635
636 struct bfd_link_callbacks
637 {
638   /* A function which is called when an object is added from an
639      archive.  ABFD is the archive element being added.  NAME is the
640      name of the symbol which caused the archive element to be pulled
641      in.  This function may set *SUBSBFD to point to an alternative
642      BFD from which symbols should in fact be added in place of the
643      original BFD's symbols.  Returns TRUE if the object should be
644      added, FALSE if it should be skipped.  */
645   bfd_boolean (*add_archive_element)
646     (struct bfd_link_info *, bfd *abfd, const char *name, bfd **subsbfd);
647   /* A function which is called when a symbol is found with multiple
648      definitions.  H is the symbol which is defined multiple times.
649      NBFD is the new BFD, NSEC is the new section, and NVAL is the new
650      value.  NSEC may be bfd_com_section or bfd_ind_section.  */
651   void (*multiple_definition)
652     (struct bfd_link_info *, struct bfd_link_hash_entry *h,
653      bfd *nbfd, asection *nsec, bfd_vma nval);
654   /* A function which is called when a common symbol is defined
655      multiple times.  H is the symbol appearing multiple times.
656      NBFD is the BFD of the new symbol.  NTYPE is the type of the new
657      symbol, one of bfd_link_hash_defined, bfd_link_hash_common, or
658      bfd_link_hash_indirect.  If NTYPE is bfd_link_hash_common, NSIZE
659      is the size of the new symbol.  */
660   void (*multiple_common)
661     (struct bfd_link_info *, struct bfd_link_hash_entry *h,
662      bfd *nbfd, enum bfd_link_hash_type ntype, bfd_vma nsize);
663   /* A function which is called to add a symbol to a set.  ENTRY is
664      the link hash table entry for the set itself (e.g.,
665      __CTOR_LIST__).  RELOC is the relocation to use for an entry in
666      the set when generating a relocatable file, and is also used to
667      get the size of the entry when generating an executable file.
668      ABFD, SEC and VALUE identify the value to add to the set.  */
669   void (*add_to_set)
670     (struct bfd_link_info *, struct bfd_link_hash_entry *entry,
671      bfd_reloc_code_real_type reloc, bfd *abfd, asection *sec, bfd_vma value);
672   /* A function which is called when the name of a g++ constructor or
673      destructor is found.  This is only called by some object file
674      formats.  CONSTRUCTOR is TRUE for a constructor, FALSE for a
675      destructor.  This will use BFD_RELOC_CTOR when generating a
676      relocatable file.  NAME is the name of the symbol found.  ABFD,
677      SECTION and VALUE are the value of the symbol.  */
678   void (*constructor)
679     (struct bfd_link_info *, bfd_boolean constructor, const char *name,
680      bfd *abfd, asection *sec, bfd_vma value);
681   /* A function which is called to issue a linker warning.  For
682      example, this is called when there is a reference to a warning
683      symbol.  WARNING is the warning to be issued.  SYMBOL is the name
684      of the symbol which triggered the warning; it may be NULL if
685      there is none.  ABFD, SECTION and ADDRESS identify the location
686      which trigerred the warning; either ABFD or SECTION or both may
687      be NULL if the location is not known.  */
688   void (*warning)
689     (struct bfd_link_info *, const char *warning, const char *symbol,
690      bfd *abfd, asection *section, bfd_vma address);
691   /* A function which is called when a relocation is attempted against
692      an undefined symbol.  NAME is the symbol which is undefined.
693      ABFD, SECTION and ADDRESS identify the location from which the
694      reference is made. IS_FATAL indicates whether an undefined symbol is
695      a fatal error or not. In some cases SECTION may be NULL.  */
696   void (*undefined_symbol)
697     (struct bfd_link_info *, const char *name, bfd *abfd,
698      asection *section, bfd_vma address, bfd_boolean is_fatal);
699   /* A function which is called when a reloc overflow occurs. ENTRY is
700      the link hash table entry for the symbol the reloc is against.
701      NAME is the name of the local symbol or section the reloc is
702      against, RELOC_NAME is the name of the relocation, and ADDEND is
703      any addend that is used.  ABFD, SECTION and ADDRESS identify the
704      location at which the overflow occurs; if this is the result of a
705      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
706      ABFD will be NULL.  */
707   void (*reloc_overflow)
708     (struct bfd_link_info *, struct bfd_link_hash_entry *entry,
709      const char *name, const char *reloc_name, bfd_vma addend,
710      bfd *abfd, asection *section, bfd_vma address);
711   /* A function which is called when a dangerous reloc is performed.
712      MESSAGE is an appropriate message.
713      ABFD, SECTION and ADDRESS identify the location at which the
714      problem occurred; if this is the result of a
715      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
716      ABFD will be NULL.  */
717   void (*reloc_dangerous)
718     (struct bfd_link_info *, const char *message,
719      bfd *abfd, asection *section, bfd_vma address);
720   /* A function which is called when a reloc is found to be attached
721      to a symbol which is not being written out.  NAME is the name of
722      the symbol.  ABFD, SECTION and ADDRESS identify the location of
723      the reloc; if this is the result of a
724      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
725      ABFD will be NULL.  */
726   void (*unattached_reloc)
727     (struct bfd_link_info *, const char *name,
728      bfd *abfd, asection *section, bfd_vma address);
729   /* A function which is called when a symbol in notice_hash is
730      defined or referenced.  H is the symbol, INH the indirect symbol
731      if applicable.  ABFD, SECTION and ADDRESS are the (new) value of
732      the symbol.  If SECTION is bfd_und_section, this is a reference.
733      FLAGS are the symbol BSF_* flags.  */
734   bfd_boolean (*notice)
735     (struct bfd_link_info *, struct bfd_link_hash_entry *h,
736      struct bfd_link_hash_entry *inh,
737      bfd *abfd, asection *section, bfd_vma address, flagword flags);
738   /* Error or warning link info message.  */
739   void (*einfo)
740     (const char *fmt, ...);
741   /* General link info message.  */
742   void (*info)
743     (const char *fmt, ...);
744   /* Message to be printed in linker map file.  */
745   void (*minfo)
746     (const char *fmt, ...);
747   /* This callback provides a chance for users of the BFD library to
748      override its decision about whether to place two adjacent sections
749      into the same segment.  */
750   bfd_boolean (*override_segment_assignment)
751     (struct bfd_link_info *, bfd * abfd,
752      asection * current_section, asection * previous_section,
753      bfd_boolean new_segment);
754 };
755 \f
756 /* The linker builds link_order structures which tell the code how to
757    include input data in the output file.  */
758
759 /* These are the types of link_order structures.  */
760
761 enum bfd_link_order_type
762 {
763   bfd_undefined_link_order,     /* Undefined.  */
764   bfd_indirect_link_order,      /* Built from a section.  */
765   bfd_data_link_order,          /* Set to explicit data.  */
766   bfd_section_reloc_link_order, /* Relocate against a section.  */
767   bfd_symbol_reloc_link_order   /* Relocate against a symbol.  */
768 };
769
770 /* This is the link_order structure itself.  These form a chain
771    attached to the output section whose contents they are describing.  */
772
773 struct bfd_link_order
774 {
775   /* Next link_order in chain.  */
776   struct bfd_link_order *next;
777   /* Type of link_order.  */
778   enum bfd_link_order_type type;
779   /* Offset within output section.  */
780   bfd_vma offset;
781   /* Size within output section.  */
782   bfd_size_type size;
783   /* Type specific information.  */
784   union
785     {
786       struct
787         {
788           /* Section to include.  If this is used, then
789              section->output_section must be the section the
790              link_order is attached to, section->output_offset must
791              equal the link_order offset field, and section->size
792              must equal the link_order size field.  Maybe these
793              restrictions should be relaxed someday.  */
794           asection *section;
795         } indirect;
796       struct
797         {
798           /* Size of contents, or zero when contents should be filled by
799              the architecture-dependent fill function.
800              A non-zero value allows filling of the output section
801              with an arbitrary repeated pattern.  */
802           unsigned int size;
803           /* Data to put into file.  */
804           bfd_byte *contents;
805         } data;
806       struct
807         {
808           /* Description of reloc to generate.  Used for
809              bfd_section_reloc_link_order and
810              bfd_symbol_reloc_link_order.  */
811           struct bfd_link_order_reloc *p;
812         } reloc;
813     } u;
814 };
815
816 /* A linker order of type bfd_section_reloc_link_order or
817    bfd_symbol_reloc_link_order means to create a reloc against a
818    section or symbol, respectively.  This is used to implement -Ur to
819    generate relocs for the constructor tables.  The
820    bfd_link_order_reloc structure describes the reloc that BFD should
821    create.  It is similar to a arelent, but I didn't use arelent
822    because the linker does not know anything about most symbols, and
823    any asymbol structure it creates will be partially meaningless.
824    This information could logically be in the bfd_link_order struct,
825    but I didn't want to waste the space since these types of relocs
826    are relatively rare.  */
827
828 struct bfd_link_order_reloc
829 {
830   /* Reloc type.  */
831   bfd_reloc_code_real_type reloc;
832
833   union
834     {
835       /* For type bfd_section_reloc_link_order, this is the section
836          the reloc should be against.  This must be a section in the
837          output BFD, not any of the input BFDs.  */
838       asection *section;
839       /* For type bfd_symbol_reloc_link_order, this is the name of the
840          symbol the reloc should be against.  */
841       const char *name;
842     } u;
843
844   /* Addend to use.  The object file should contain zero.  The BFD
845      backend is responsible for filling in the contents of the object
846      file correctly.  For some object file formats (e.g., COFF) the
847      addend must be stored into in the object file, and for some
848      (e.g., SPARC a.out) it is kept in the reloc.  */
849   bfd_vma addend;
850 };
851
852 /* Allocate a new link_order for a section.  */
853 extern struct bfd_link_order *bfd_new_link_order (bfd *, asection *);
854
855 /* These structures are used to describe version information for the
856    ELF linker.  These structures could be manipulated entirely inside
857    BFD, but it would be a pain.  Instead, the regular linker sets up
858    these structures, and then passes them into BFD.  */
859
860 /* Glob pattern for a version.  */
861
862 struct bfd_elf_version_expr
863 {
864   /* Next glob pattern for this version.  */
865   struct bfd_elf_version_expr *next;
866   /* Glob pattern.  */
867   const char *pattern;
868   /* Set if pattern is not a glob.  */
869   unsigned int literal : 1;
870   /* Defined by ".symver".  */
871   unsigned int symver : 1;
872   /* Defined by version script.  */
873   unsigned int script : 1;
874   /* Pattern type.  */
875 #define BFD_ELF_VERSION_C_TYPE          1
876 #define BFD_ELF_VERSION_CXX_TYPE        2
877 #define BFD_ELF_VERSION_JAVA_TYPE       4
878   unsigned int mask : 3;
879 };
880
881 struct bfd_elf_version_expr_head
882 {
883   /* List of all patterns, both wildcards and non-wildcards.  */
884   struct bfd_elf_version_expr *list;
885   /* Hash table for non-wildcards.  */
886   void *htab;
887   /* Remaining patterns.  */
888   struct bfd_elf_version_expr *remaining;
889   /* What kind of pattern types are present in list (bitmask).  */
890   unsigned int mask;
891 };
892
893 /* Version dependencies.  */
894
895 struct bfd_elf_version_deps
896 {
897   /* Next dependency for this version.  */
898   struct bfd_elf_version_deps *next;
899   /* The version which this version depends upon.  */
900   struct bfd_elf_version_tree *version_needed;
901 };
902
903 /* A node in the version tree.  */
904
905 struct bfd_elf_version_tree
906 {
907   /* Next version.  */
908   struct bfd_elf_version_tree *next;
909   /* Name of this version.  */
910   const char *name;
911   /* Version number.  */
912   unsigned int vernum;
913   /* Regular expressions for global symbols in this version.  */
914   struct bfd_elf_version_expr_head globals;
915   /* Regular expressions for local symbols in this version.  */
916   struct bfd_elf_version_expr_head locals;
917   /* List of versions which this version depends upon.  */
918   struct bfd_elf_version_deps *deps;
919   /* Index of the version name.  This is used within BFD.  */
920   unsigned int name_indx;
921   /* Whether this version tree was used.  This is used within BFD.  */
922   int used;
923   /* Matching hook.  */
924   struct bfd_elf_version_expr *(*match)
925     (struct bfd_elf_version_expr_head *head,
926      struct bfd_elf_version_expr *prev, const char *sym);
927 };
928
929 struct bfd_elf_dynamic_list
930 {
931   struct bfd_elf_version_expr_head head;
932   struct bfd_elf_version_expr *(*match)
933     (struct bfd_elf_version_expr_head *head,
934      struct bfd_elf_version_expr *prev, const char *sym);
935 };
936
937 #endif