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