1/* ld.h -- general linker header file
2   Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3   2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4   Free Software Foundation, Inc.
5
6   This file is part of the GNU Binutils.
7
8   This program is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 3 of the License, or
11   (at your option) any later version.
12
13   This program is distributed in the hope that it will be useful,
14   but WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16   GNU General Public License for more details.
17
18   You should have received a copy of the GNU General Public License
19   along with this program; if not, write to the Free Software
20   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21   MA 02110-1301, USA.  */
22
23#ifndef LD_H
24#define LD_H
25
26#ifdef HAVE_LOCALE_H
27#endif
28#ifndef SEEK_CUR
29#define SEEK_CUR 1
30#endif
31#ifndef SEEK_END
32#define SEEK_END 2
33#endif
34
35#ifdef HAVE_LOCALE_H
36# ifndef ENABLE_NLS
37   /* The Solaris version of locale.h always includes libintl.h.  If we have
38      been configured with --disable-nls then ENABLE_NLS will not be defined
39      and the dummy definitions of bindtextdomain (et al) below will conflict
40      with the defintions in libintl.h.  So we define these values to prevent
41      the bogus inclusion of libintl.h.  */
42#  define _LIBINTL_H
43#  define _LIBGETTEXT_H
44# endif
45# include <locale.h>
46#endif
47
48#ifdef ENABLE_NLS
49# include <libintl.h>
50# define _(String) gettext (String)
51# ifdef gettext_noop
52#  define N_(String) gettext_noop (String)
53# else
54#  define N_(String) (String)
55# endif
56#else
57# define gettext(Msgid) (Msgid)
58# define dgettext(Domainname, Msgid) (Msgid)
59# define dcgettext(Domainname, Msgid, Category) (Msgid)
60# define textdomain(Domainname) while (0) /* nothing */
61# define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
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 */
78typedef struct name_list {
79  const char *name;
80  struct name_list *next;
81}
82name_list;
83
84typedef enum {sort_none, sort_ascending, sort_descending} sort_order;
85
86/* A wildcard specification.  */
87
88typedef enum {
89  none, by_name, by_alignment, by_name_alignment, by_alignment_name
90} sort_type;
91
92extern sort_type sort_section;
93
94struct wildcard_spec {
95  const char *name;
96  struct name_list *exclude_name_list;
97  sort_type sorted;
98};
99
100struct wildcard_list {
101  struct wildcard_list *next;
102  struct wildcard_spec spec;
103};
104
105struct map_symbol_def {
106  struct bfd_link_hash_entry *entry;
107  struct map_symbol_def *next;
108};
109
110/* The initial part of fat_user_section_struct has to be idential with
111   lean_user_section_struct.  */
112typedef struct fat_user_section_struct {
113  /* For input sections, when writing a map file: head / tail of a linked
114     list of hash table entries for symbols defined in this section.  */
115  struct map_symbol_def *map_symbol_def_head;
116  struct map_symbol_def **map_symbol_def_tail;
117  unsigned long map_symbol_def_count;
118} fat_section_userdata_type;
119
120#define get_userdata(x) ((x)->userdata)
121
122#define BYTE_SIZE	(1)
123#define SHORT_SIZE	(2)
124#define LONG_SIZE	(4)
125#define QUAD_SIZE	(8)
126
127enum endian_enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE };
128
129enum symbolic_enum
130  {
131    symbolic_unset = 0,
132    symbolic,
133    symbolic_functions,
134  };
135
136enum dynamic_list_enum
137  {
138    dynamic_list_unset = 0,
139    dynamic_list_data,
140    dynamic_list
141  };
142
143typedef struct {
144  /* 1 => assign space to common symbols even if `relocatable_output'.  */
145  bfd_boolean force_common_definition;
146
147  /* 1 => do not assign addresses to common symbols.  */
148  bfd_boolean inhibit_common_definition;
149
150  /* Enable or disable target specific optimizations.
151
152     Not all targets have optimizations to enable.
153
154     Normally these optimizations are disabled by default but some targets
155     prefer to enable them by default.  So this field is a tri-state variable.
156     The values are:
157
158     zero: Enable the optimizations (either from --relax being specified on
159       the command line or the backend's before_allocation emulation function.
160
161     positive: The user has requested that these optimizations be disabled.
162       (Via the --no-relax command line option).
163
164     negative: The optimizations are disabled.  (Set when initializing the
165       args_type structure in ldmain.c:main.  */
166  signed int disable_target_specific_optimizations;
167#define RELAXATION_DISABLED_BY_DEFAULT (command_line.disable_target_specific_optimizations < 0)
168#define RELAXATION_DISABLED_BY_USER    (command_line.disable_target_specific_optimizations > 0)
169#define RELAXATION_ENABLED (command_line.disable_target_specific_optimizations == 0)
170#define DISABLE_RELAXATION do { command_line.disable_target_specific_optimizations = 1; } while (0)
171#define ENABLE_RELAXATION  do { command_line.disable_target_specific_optimizations = 0; } while (0)
172
173  /* If TRUE, build MIPS embedded PIC relocation tables in the output
174     file.  */
175  bfd_boolean embedded_relocs;
176
177  /* If TRUE, force generation of a file with a .exe file.  */
178  bfd_boolean force_exe_suffix;
179
180  /* If TRUE, generate a cross reference report.  */
181  bfd_boolean cref;
182
183  /* If TRUE (which is the default), warn about mismatched input
184     files.  */
185  bfd_boolean warn_mismatch;
186
187  /* Warn on attempting to open an incompatible library during a library
188     search.  */
189  bfd_boolean warn_search_mismatch;
190
191  /* If non-zero check section addresses, once computed,
192     for overlaps.  Relocatable links only check when this is > 0.  */
193  signed char check_section_addresses;
194
195  /* If TRUE allow the linking of input files in an unknown architecture
196     assuming that the user knows what they are doing.  This was the old
197     behaviour of the linker.  The new default behaviour is to reject such
198     input files.  */
199  bfd_boolean accept_unknown_input_arch;
200
201  /* Big or little endian as set on command line.  */
202  enum endian_enum endian;
203
204  /* -Bsymbolic and -Bsymbolic-functions, as set on command line.  */
205  enum symbolic_enum symbolic;
206
207  /* --dynamic-list, --dynamic-list-cpp-new, --dynamic-list-cpp-typeinfo
208     and --dynamic-list FILE, as set on command line.  */
209  enum dynamic_list_enum dynamic_list;
210
211  /* Name of runtime interpreter to invoke.  */
212  char *interpreter;
213
214  /* Name to give runtime libary from the -soname argument.  */
215  char *soname;
216
217  /* Runtime library search path from the -rpath argument.  */
218  char *rpath;
219
220  /* Link time runtime library search path from the -rpath-link
221     argument.  */
222  char *rpath_link;
223
224  /* Name of shared object whose symbol table should be filtered with
225     this shared object.  From the --filter option.  */
226  char *filter_shlib;
227
228  /* Name of shared object for whose symbol table this shared object
229     is an auxiliary filter.  From the --auxiliary option.  */
230  char **auxiliary_filters;
231
232  /* A version symbol to be applied to the symbol names found in the
233     .exports sections.  */
234  char *version_exports_section;
235
236  /* Default linker script.  */
237  char *default_script;
238} args_type;
239
240extern args_type command_line;
241
242typedef int token_code_type;
243
244typedef struct {
245  bfd_boolean magic_demand_paged;
246  bfd_boolean make_executable;
247
248  /* If TRUE, doing a dynamic link.  */
249  bfd_boolean dynamic_link;
250
251  /* If TRUE, -shared is supported.  */
252  /* ??? A better way to do this is perhaps to define this in the
253     ld_emulation_xfer_struct since this is really a target dependent
254     parameter.  */
255  bfd_boolean has_shared;
256
257  /* If TRUE, build constructors.  */
258  bfd_boolean build_constructors;
259
260  /* If TRUE, warn about any constructors.  */
261  bfd_boolean warn_constructors;
262
263  /* If TRUE, warn about merging common symbols with others.  */
264  bfd_boolean warn_common;
265
266  /* If TRUE, only warn once about a particular undefined symbol.  */
267  bfd_boolean warn_once;
268
269  /* If TRUE, warn if multiple global-pointers are needed (Alpha
270     only).  */
271  bfd_boolean warn_multiple_gp;
272
273  /* If TRUE, warn if the starting address of an output section
274     changes due to the alignment of an input section.  */
275  bfd_boolean warn_section_align;
276
277  /* If TRUE, warning messages are fatal */
278  bfd_boolean fatal_warnings;
279
280  sort_order sort_common;
281
282  bfd_boolean text_read_only;
283
284  bfd_boolean stats;
285
286  /* If set, orphan input sections will be mapped to separate output
287     sections.  */
288  bfd_boolean unique_orphan_sections;
289
290  /* If set, only search library directories explicitly selected
291     on the command line.  */
292  bfd_boolean only_cmd_line_lib_dirs;
293
294  /* If set, numbers and absolute symbols are simply treated as
295     numbers everywhere.  */
296  bfd_boolean sane_expr;
297
298  /* The rpath separation character.  Usually ':'.  */
299  char rpath_separator;
300
301  char *map_filename;
302  FILE *map_file;
303
304  unsigned int split_by_reloc;
305  bfd_size_type split_by_file;
306
307  bfd_size_type specified_data_size;
308
309  /* The size of the hash table to use.  */
310  bfd_size_type hash_table_size;
311
312  /* The maximum page size for ELF.  */
313  bfd_vma maxpagesize;
314
315  /* The common page size for ELF.  */
316  bfd_vma commonpagesize;
317} ld_config_type;
318
319extern ld_config_type config;
320
321extern FILE * saved_script_handle;
322extern bfd_boolean force_make_executable;
323
324/* Non-zero if we are processing a --defsym from the command line.  */
325extern int parsing_defsym;
326
327extern int yyparse (void);
328extern void add_cref (const char *, bfd *, asection *, bfd_vma);
329extern bfd_boolean handle_asneeded_cref (bfd *, enum notice_asneeded_action);
330extern void output_cref (FILE *);
331extern void check_nocrossrefs (void);
332extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
333
334/* If gcc >= 2.6, we can give a function name, too.  */
335#if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
336#define __PRETTY_FUNCTION__  NULL
337#endif
338
339#undef abort
340#define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
341
342#endif
343