1/* ld.h -- general linker header file
2   Copyright (C) 1991-2017 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 textdomain(Domainname) while (0) /* nothing */
59# define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
60# define _(String) (String)
61# define N_(String) (String)
62#endif
63
64/* Look in this environment name for the linker to pretend to be */
65#define EMULATION_ENVIRON "LDEMULATION"
66/* If in there look for the strings: */
67
68/* Look in this variable for a target format */
69#define TARGET_ENVIRON "GNUTARGET"
70
71/* Input sections which are put in a section of this name are actually
72   discarded.  */
73#define DISCARD_SECTION_NAME "/DISCARD/"
74
75/* A file name list.  */
76typedef struct name_list
77{
78  const char *name;
79  struct name_list *next;
80}
81name_list;
82
83typedef enum {sort_none, sort_ascending, sort_descending} sort_order;
84
85/* A wildcard specification.  */
86
87typedef enum
88{
89  none, by_name, by_alignment, by_name_alignment, by_alignment_name,
90  by_none, by_init_priority
91} sort_type;
92
93extern sort_type sort_section;
94
95struct wildcard_spec
96{
97  const char *name;
98  struct name_list *exclude_name_list;
99  sort_type sorted;
100  struct flag_info *section_flag_list;
101};
102
103struct wildcard_list
104{
105  struct wildcard_list *next;
106  struct wildcard_spec spec;
107};
108
109#define BYTE_SIZE	(1)
110#define SHORT_SIZE	(2)
111#define LONG_SIZE	(4)
112#define QUAD_SIZE	(8)
113
114enum endian_enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE };
115
116enum symbolic_enum
117{
118  symbolic_unset = 0,
119  symbolic,
120  symbolic_functions,
121};
122
123enum dynamic_list_enum
124{
125  dynamic_list_unset = 0,
126  dynamic_list_data,
127  dynamic_list
128};
129
130typedef struct
131{
132  /* 1 => assign space to common symbols even if `relocatable_output'.  */
133  bfd_boolean force_common_definition;
134
135  /* 1 => do not assign addresses to common symbols.  */
136  bfd_boolean inhibit_common_definition;
137
138  /* If TRUE, build MIPS embedded PIC relocation tables in the output
139     file.  */
140  bfd_boolean embedded_relocs;
141
142  /* If TRUE, force generation of a file with a .exe file.  */
143  bfd_boolean force_exe_suffix;
144
145  /* If TRUE, generate a cross reference report.  */
146  bfd_boolean cref;
147
148  /* If TRUE (which is the default), warn about mismatched input
149     files.  */
150  bfd_boolean warn_mismatch;
151
152  /* Warn on attempting to open an incompatible library during a library
153     search.  */
154  bfd_boolean warn_search_mismatch;
155
156  /* If non-zero check section addresses, once computed,
157     for overlaps.  Relocatable links only check when this is > 0.  */
158  signed char check_section_addresses;
159
160  /* If TRUE allow the linking of input files in an unknown architecture
161     assuming that the user knows what they are doing.  This was the old
162     behaviour of the linker.  The new default behaviour is to reject such
163     input files.  */
164  bfd_boolean accept_unknown_input_arch;
165
166  /* Name of the import library to generate.  */
167  char *out_implib_filename;
168
169  /* If TRUE we'll just print the default output on stdout.  */
170  bfd_boolean print_output_format;
171
172  /* If set, display the target memory usage (per memory region).  */
173  bfd_boolean print_memory_usage;
174
175  /* Big or little endian as set on command line.  */
176  enum endian_enum endian;
177
178  /* -Bsymbolic and -Bsymbolic-functions, as set on command line.  */
179  enum symbolic_enum symbolic;
180
181  /* --dynamic-list, --dynamic-list-cpp-new, --dynamic-list-cpp-typeinfo
182     and --dynamic-list FILE, as set on command line.  */
183  enum dynamic_list_enum dynamic_list;
184
185  /* Name of runtime interpreter to invoke.  */
186  char *interpreter;
187
188  /* Name to give runtime library from the -soname argument.  */
189  char *soname;
190
191  /* Runtime library search path from the -rpath argument.  */
192  char *rpath;
193
194  /* Link time runtime library search path from the -rpath-link
195     argument.  */
196  char *rpath_link;
197
198  /* Name of shared object whose symbol table should be filtered with
199     this shared object.  From the --filter option.  */
200  char *filter_shlib;
201
202  /* Name of shared object for whose symbol table this shared object
203     is an auxiliary filter.  From the --auxiliary option.  */
204  char **auxiliary_filters;
205
206  /* A version symbol to be applied to the symbol names found in the
207     .exports sections.  */
208  char *version_exports_section;
209
210  /* Default linker script.  */
211  char *default_script;
212} args_type;
213
214extern args_type command_line;
215
216typedef int token_code_type;
217
218/* Different ways we can handle orphan sections.  */
219
220enum orphan_handling_enum
221{
222  /* The classic strategy, find a suitable section to place the orphan
223     into.  */
224  orphan_handling_place = 0,
225
226  /* Discard any orphan sections as though they were assign to the section
227     /DISCARD/.  */
228  orphan_handling_discard,
229
230  /* Find somewhere to place the orphan section, as with
231     ORPHAN_HANDLING_PLACE, but also issue a warning.  */
232  orphan_handling_warn,
233
234  /* Issue a fatal error if any orphan sections are found.  */
235  orphan_handling_error,
236};
237
238typedef struct
239{
240  bfd_boolean magic_demand_paged;
241  bfd_boolean make_executable;
242
243  /* If TRUE, -shared is supported.  */
244  /* ??? A better way to do this is perhaps to define this in the
245     ld_emulation_xfer_struct since this is really a target dependent
246     parameter.  */
247  bfd_boolean has_shared;
248
249  /* If TRUE, build constructors.  */
250  bfd_boolean build_constructors;
251
252  /* If TRUE, warn about any constructors.  */
253  bfd_boolean warn_constructors;
254
255  /* If TRUE, warn about merging common symbols with others.  */
256  bfd_boolean warn_common;
257
258  /* If TRUE, only warn once about a particular undefined symbol.  */
259  bfd_boolean warn_once;
260
261  /* How should we deal with orphan sections.  */
262  enum orphan_handling_enum orphan_handling;
263
264  /* If TRUE, warn if multiple global-pointers are needed (Alpha
265     only).  */
266  bfd_boolean warn_multiple_gp;
267
268  /* If TRUE, warn if the starting address of an output section
269     changes due to the alignment of an input section.  */
270  bfd_boolean warn_section_align;
271
272  /* If TRUE, warning messages are fatal */
273  bfd_boolean fatal_warnings;
274
275  sort_order sort_common;
276
277  bfd_boolean text_read_only;
278
279  bfd_boolean stats;
280
281  /* If set, orphan input sections will be mapped to separate output
282     sections.  */
283  bfd_boolean unique_orphan_sections;
284
285  /* If set, only search library directories explicitly selected
286     on the command line.  */
287  bfd_boolean only_cmd_line_lib_dirs;
288
289  /* If set, numbers and absolute symbols are simply treated as
290     numbers everywhere.  */
291  bfd_boolean sane_expr;
292
293  /* If set, code and non-code sections should never be in one segment.  */
294  bfd_boolean separate_code;
295
296  /* The rpath separation character.  Usually ':'.  */
297  char rpath_separator;
298
299  char *map_filename;
300  FILE *map_file;
301
302  unsigned int split_by_reloc;
303  bfd_size_type split_by_file;
304
305  /* The size of the hash table to use.  */
306  unsigned long hash_table_size;
307
308  /* The maximum page size for ELF.  */
309  bfd_vma maxpagesize;
310
311  /* The common page size for ELF.  */
312  bfd_vma commonpagesize;
313} ld_config_type;
314
315extern ld_config_type config;
316
317extern FILE * saved_script_handle;
318extern bfd_boolean force_make_executable;
319
320extern int yyparse (void);
321extern void add_cref (const char *, bfd *, asection *, bfd_vma);
322extern bfd_boolean handle_asneeded_cref (bfd *, enum notice_asneeded_action);
323extern void output_cref (FILE *);
324extern void check_nocrossrefs (void);
325extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
326
327/* If gcc >= 2.6, we can give a function name, too.  */
328#if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
329#define __PRETTY_FUNCTION__  NULL
330#endif
331
332#undef abort
333#define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
334
335#endif
336