bfd/
[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
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 } sort_type;
91
92 extern sort_type sort_section;
93
94 struct wildcard_spec {
95   const char *name;
96   struct name_list *exclude_name_list;
97   sort_type sorted;
98 };
99
100 struct wildcard_list {
101   struct wildcard_list *next;
102   struct wildcard_spec spec;
103 };
104
105 struct 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.  */
112 typedef 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 } fat_section_userdata_type;
118
119 #define get_userdata(x) ((x)->userdata)
120
121 #define BYTE_SIZE       (1)
122 #define SHORT_SIZE      (2)
123 #define LONG_SIZE       (4)
124 #define QUAD_SIZE       (8)
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   bfd_boolean relax;
133
134   /* If TRUE, build MIPS embedded PIC relocation tables in the output
135      file.  */
136   bfd_boolean embedded_relocs;
137
138   /* If TRUE, force generation of a file with a .exe file.  */
139   bfd_boolean force_exe_suffix;
140
141   /* If TRUE, generate a cross reference report.  */
142   bfd_boolean cref;
143
144   /* If TRUE (which is the default), warn about mismatched input
145      files.  */
146   bfd_boolean warn_mismatch;
147
148   /* Warn on attempting to open an incompatible library during a library
149      search.  */
150   bfd_boolean warn_search_mismatch;
151
152   /* If non-zero check section addresses, once computed,
153      for overlaps.  Relocatable links only check when this is > 0.  */
154   signed char check_section_addresses;
155
156   /* If TRUE allow the linking of input files in an unknown architecture
157      assuming that the user knows what they are doing.  This was the old
158      behaviour of the linker.  The new default behaviour is to reject such
159      input files.  */
160   bfd_boolean accept_unknown_input_arch;
161
162   /* Big or little endian as set on command line.  */
163   enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE } endian;
164
165   /* -Bsymbolic and -Bsymbolic-functions, as set on command line.  */
166   enum
167     {
168       symbolic_unset = 0,
169       symbolic,
170       symbolic_functions,
171     } symbolic;
172
173   /* --dynamic-list, --dynamic-list-cpp-new, --dynamic-list-cpp-typeinfo
174      and --dynamic-list FILE, as set on command line.  */
175   enum
176     {
177       dynamic_list_unset = 0,
178       dynamic_list_data,
179       dynamic_list
180     } dynamic_list;
181
182   /* Name of runtime interpreter to invoke.  */
183   char *interpreter;
184
185   /* Name to give runtime libary from the -soname argument.  */
186   char *soname;
187
188   /* Runtime library search path from the -rpath argument.  */
189   char *rpath;
190
191   /* Link time runtime library search path from the -rpath-link
192      argument.  */
193   char *rpath_link;
194
195   /* Name of shared object whose symbol table should be filtered with
196      this shared object.  From the --filter option.  */
197   char *filter_shlib;
198
199   /* Name of shared object for whose symbol table this shared object
200      is an auxiliary filter.  From the --auxiliary option.  */
201   char **auxiliary_filters;
202
203   /* A version symbol to be applied to the symbol names found in the
204      .exports sections.  */
205   char *version_exports_section;
206
207   /* Default linker script.  */
208   char *default_script;
209 } args_type;
210
211 extern args_type command_line;
212
213 typedef int token_code_type;
214
215 typedef struct {
216   bfd_boolean magic_demand_paged;
217   bfd_boolean make_executable;
218
219   /* If TRUE, doing a dynamic link.  */
220   bfd_boolean dynamic_link;
221
222   /* If TRUE, -shared is supported.  */
223   /* ??? A better way to do this is perhaps to define this in the
224      ld_emulation_xfer_struct since this is really a target dependent
225      parameter.  */
226   bfd_boolean has_shared;
227
228   /* If TRUE, build constructors.  */
229   bfd_boolean build_constructors;
230
231   /* If TRUE, warn about any constructors.  */
232   bfd_boolean warn_constructors;
233
234   /* If TRUE, warn about merging common symbols with others.  */
235   bfd_boolean warn_common;
236
237   /* If TRUE, only warn once about a particular undefined symbol.  */
238   bfd_boolean warn_once;
239
240   /* If TRUE, warn if multiple global-pointers are needed (Alpha
241      only).  */
242   bfd_boolean warn_multiple_gp;
243
244   /* If TRUE, warn if the starting address of an output section
245      changes due to the alignment of an input section.  */
246   bfd_boolean warn_section_align;
247
248   /* If TRUE, warning messages are fatal */
249   bfd_boolean fatal_warnings;
250
251   sort_order sort_common;
252
253   bfd_boolean text_read_only;
254
255   bfd_boolean stats;
256
257   /* If set, orphan input sections will be mapped to separate output
258      sections.  */
259   bfd_boolean unique_orphan_sections;
260
261   /* If set, only search library directories explicitly selected
262      on the command line.  */
263   bfd_boolean only_cmd_line_lib_dirs;
264
265   /* The rpath separation character.  Usually ':'.  */
266   char rpath_separator;
267
268   char *map_filename;
269   FILE *map_file;
270
271   unsigned int split_by_reloc;
272   bfd_size_type split_by_file;
273
274   bfd_size_type specified_data_size;
275
276   /* The size of the hash table to use.  */
277   bfd_size_type hash_table_size;
278
279   /* The maximum page size for ELF.  */
280   bfd_vma maxpagesize;
281
282   /* The common page size for ELF.  */
283   bfd_vma commonpagesize;
284 } ld_config_type;
285
286 extern ld_config_type config;
287
288 extern FILE * saved_script_handle;
289 extern bfd_boolean force_make_executable;
290
291 /* Non-zero if we are processing a --defsym from the command line.  */
292 extern int parsing_defsym;
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