xref: /dragonfly/contrib/binutils-2.34/ld/ld.h (revision 7ff0fc30)
1 /* ld.h -- general linker header file
2    Copyright (C) 1991-2020 Free Software Foundation, Inc.
3 
4    This file is part of the GNU Binutils.
5 
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10 
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15 
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19    MA 02110-1301, USA.  */
20 
21 #ifndef LD_H
22 #define LD_H
23 
24 #ifdef HAVE_LOCALE_H
25 #endif
26 #ifndef SEEK_CUR
27 #define SEEK_CUR 1
28 #endif
29 #ifndef SEEK_END
30 #define SEEK_END 2
31 #endif
32 
33 #ifdef HAVE_LOCALE_H
34 # ifndef ENABLE_NLS
35    /* The Solaris version of locale.h always includes libintl.h.  If we have
36       been configured with --disable-nls then ENABLE_NLS will not be defined
37       and the dummy definitions of bindtextdomain (et al) below will conflict
38       with the defintions in libintl.h.  So we define these values to prevent
39       the bogus inclusion of libintl.h.  */
40 #  define _LIBINTL_H
41 #  define _LIBGETTEXT_H
42 # endif
43 # include <locale.h>
44 #endif
45 
46 #ifdef ENABLE_NLS
47 # include <libintl.h>
48 # define _(String) gettext (String)
49 # ifdef gettext_noop
50 #  define N_(String) gettext_noop (String)
51 # else
52 #  define N_(String) (String)
53 # endif
54 #else
55 # define gettext(Msgid) (Msgid)
56 # define dgettext(Domainname, Msgid) (Msgid)
57 # define dcgettext(Domainname, Msgid, Category) (Msgid)
58 # define ngettext(Msgid1, Msgid2, n) \
59   (n == 1 ? Msgid1 : Msgid2)
60 # define dngettext(Domainname, Msgid1, Msgid2, n) \
61   (n == 1 ? Msgid1 : Msgid2)
62 # define dcngettext(Domainname, Msgid1, Msgid2, n, Category) \
63   (n == 1 ? Msgid1 : Msgid2)
64 # define textdomain(Domainname) do {} while (0)
65 # define bindtextdomain(Domainname, Dirname) do {} while (0)
66 # define _(String) (String)
67 # define N_(String) (String)
68 #endif
69 
70 /* Look in this environment name for the linker to pretend to be */
71 #define EMULATION_ENVIRON "LDEMULATION"
72 /* If in there look for the strings: */
73 
74 /* Look in this variable for a target format */
75 #define TARGET_ENVIRON "GNUTARGET"
76 
77 /* Input sections which are put in a section of this name are actually
78    discarded.  */
79 #define DISCARD_SECTION_NAME "/DISCARD/"
80 
81 /* A file name list.  */
82 typedef struct name_list
83 {
84   const char *name;
85   struct name_list *next;
86 }
87 name_list;
88 
89 typedef enum {sort_none, sort_ascending, sort_descending} sort_order;
90 
91 /* A wildcard specification.  */
92 
93 typedef enum
94 {
95   none, by_name, by_alignment, by_name_alignment, by_alignment_name,
96   by_none, by_init_priority
97 } sort_type;
98 
99 extern sort_type sort_section;
100 
101 struct wildcard_spec
102 {
103   const char *name;
104   struct name_list *exclude_name_list;
105   sort_type sorted;
106   struct flag_info *section_flag_list;
107 };
108 
109 struct wildcard_list
110 {
111   struct wildcard_list *next;
112   struct wildcard_spec spec;
113 };
114 
115 #define BYTE_SIZE	(1)
116 #define SHORT_SIZE	(2)
117 #define LONG_SIZE	(4)
118 #define QUAD_SIZE	(8)
119 
120 enum endian_enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE };
121 
122 typedef struct
123 {
124   /* 1 => assign space to common symbols even if `relocatable_output'.  */
125   bfd_boolean force_common_definition;
126 
127   /* If TRUE, build MIPS embedded PIC relocation tables in the output
128      file.  */
129   bfd_boolean embedded_relocs;
130 
131   /* If TRUE, force generation of a file with a .exe file.  */
132   bfd_boolean force_exe_suffix;
133 
134   /* If TRUE, generate a cross reference report.  */
135   bfd_boolean cref;
136 
137   /* If TRUE (which is the default), warn about mismatched input
138      files.  */
139   bfd_boolean warn_mismatch;
140 
141   /* Warn on attempting to open an incompatible library during a library
142      search.  */
143   bfd_boolean warn_search_mismatch;
144 
145   /* If non-zero check section addresses, once computed,
146      for overlaps.  Relocatable links only check when this is > 0.  */
147   signed char check_section_addresses;
148 
149   /* If TRUE allow the linking of input files in an unknown architecture
150      assuming that the user knows what they are doing.  This was the old
151      behaviour of the linker.  The new default behaviour is to reject such
152      input files.  */
153   bfd_boolean accept_unknown_input_arch;
154 
155   /* Name of the import library to generate.  */
156   char *out_implib_filename;
157 
158   /* If TRUE we'll just print the default output on stdout.  */
159   bfd_boolean print_output_format;
160 
161   /* If set, display the target memory usage (per memory region).  */
162   bfd_boolean print_memory_usage;
163 
164   /* Should we force section groups to be resolved?  Controlled with
165      --force-group-allocation on the command line or FORCE_GROUP_ALLOCATION
166      in the linker script.  */
167   bfd_boolean force_group_allocation;
168 
169   /* Big or little endian as set on command line.  */
170   enum endian_enum endian;
171 
172   /* Name of runtime interpreter to invoke.  */
173   char *interpreter;
174 
175   /* Name to give runtime library from the -soname argument.  */
176   char *soname;
177 
178   /* Runtime library search path from the -rpath argument.  */
179   char *rpath;
180 
181   /* Link time runtime library search path from the -rpath-link
182      argument.  */
183   char *rpath_link;
184 
185   /* Name of shared object whose symbol table should be filtered with
186      this shared object.  From the --filter option.  */
187   char *filter_shlib;
188 
189   /* Name of shared object for whose symbol table this shared object
190      is an auxiliary filter.  From the --auxiliary option.  */
191   char **auxiliary_filters;
192 
193   /* A version symbol to be applied to the symbol names found in the
194      .exports sections.  */
195   char *version_exports_section;
196 
197   /* Default linker script.  */
198   char *default_script;
199 } args_type;
200 
201 extern args_type command_line;
202 
203 typedef int token_code_type;
204 
205 /* Different ways we can handle orphan sections.  */
206 
207 enum orphan_handling_enum
208 {
209   /* The classic strategy, find a suitable section to place the orphan
210      into.  */
211   orphan_handling_place = 0,
212 
213   /* Discard any orphan sections as though they were assign to the section
214      /DISCARD/.  */
215   orphan_handling_discard,
216 
217   /* Find somewhere to place the orphan section, as with
218      ORPHAN_HANDLING_PLACE, but also issue a warning.  */
219   orphan_handling_warn,
220 
221   /* Issue a fatal error if any orphan sections are found.  */
222   orphan_handling_error,
223 };
224 
225 typedef struct
226 {
227   bfd_boolean magic_demand_paged;
228   bfd_boolean make_executable;
229 
230   /* If TRUE, -shared is supported.  */
231   /* ??? A better way to do this is perhaps to define this in the
232      ld_emulation_xfer_struct since this is really a target dependent
233      parameter.  */
234   bfd_boolean has_shared;
235 
236   /* If TRUE, build constructors.  */
237   bfd_boolean build_constructors;
238 
239   /* If TRUE, warn about any constructors.  */
240   bfd_boolean warn_constructors;
241 
242   /* If TRUE, warn about merging common symbols with others.  */
243   bfd_boolean warn_common;
244 
245   /* If TRUE, only warn once about a particular undefined symbol.  */
246   bfd_boolean warn_once;
247 
248   /* How should we deal with orphan sections.  */
249   enum orphan_handling_enum orphan_handling;
250 
251   /* If TRUE, warn if multiple global-pointers are needed (Alpha
252      only).  */
253   bfd_boolean warn_multiple_gp;
254 
255   /* If TRUE, warn if the starting address of an output section
256      changes due to the alignment of an input section.  */
257   bfd_boolean warn_section_align;
258 
259   /* If TRUE, warning messages are fatal */
260   bfd_boolean fatal_warnings;
261 
262   sort_order sort_common;
263 
264   bfd_boolean text_read_only;
265 
266   bfd_boolean stats;
267 
268   /* If set, orphan input sections will be mapped to separate output
269      sections.  */
270   bfd_boolean unique_orphan_sections;
271 
272   /* If set, only search library directories explicitly selected
273      on the command line.  */
274   bfd_boolean only_cmd_line_lib_dirs;
275 
276   /* If set, numbers and absolute symbols are simply treated as
277      numbers everywhere.  */
278   bfd_boolean sane_expr;
279 
280   /* If set, code and non-code sections should never be in one segment.  */
281   bfd_boolean separate_code;
282 
283   /* The rpath separation character.  Usually ':'.  */
284   char rpath_separator;
285 
286   char *map_filename;
287   FILE *map_file;
288 
289   unsigned int split_by_reloc;
290   bfd_size_type split_by_file;
291 
292   /* The size of the hash table to use.  */
293   unsigned long hash_table_size;
294 
295   /* The maximum page size for ELF.  */
296   bfd_vma maxpagesize;
297 
298   /* The common page size for ELF.  */
299   bfd_vma commonpagesize;
300 
301   /* If set, print discarded sections in map file output.  */
302   bfd_boolean print_map_discarded;
303 } ld_config_type;
304 
305 extern ld_config_type config;
306 
307 extern FILE * saved_script_handle;
308 extern bfd_boolean force_make_executable;
309 
310 extern int yyparse (void);
311 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
312 extern bfd_boolean handle_asneeded_cref (bfd *, enum notice_asneeded_action);
313 extern void output_cref (FILE *);
314 extern void check_nocrossrefs (void);
315 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
316 
317 /* If gcc >= 2.6, we can give a function name, too.  */
318 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
319 #define __PRETTY_FUNCTION__  NULL
320 #endif
321 
322 #undef abort
323 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
324 
325 #endif
326