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