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