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