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