2009-08-12 Tristan Gingold <gingold@adacore.com>
[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   unsigned long map_symbol_def_count;
118 } fat_section_userdata_type;
119
120 #define get_userdata(x) ((x)->userdata)
121
122 #define BYTE_SIZE       (1)
123 #define SHORT_SIZE      (2)
124 #define LONG_SIZE       (4)
125 #define QUAD_SIZE       (8)
126
127 typedef struct {
128   /* 1 => assign space to common symbols even if `relocatable_output'.  */
129   bfd_boolean force_common_definition;
130
131   /* 1 => do not assign addresses to common symbols.  */
132   bfd_boolean inhibit_common_definition;
133   bfd_boolean relax;
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   /* Big or little endian as set on command line.  */
164   enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE } endian;
165
166   /* -Bsymbolic and -Bsymbolic-functions, as set on command line.  */
167   enum
168     {
169       symbolic_unset = 0,
170       symbolic,
171       symbolic_functions,
172     } symbolic;
173
174   /* --dynamic-list, --dynamic-list-cpp-new, --dynamic-list-cpp-typeinfo
175      and --dynamic-list FILE, as set on command line.  */
176   enum
177     {
178       dynamic_list_unset = 0,
179       dynamic_list_data,
180       dynamic_list
181     } dynamic_list;
182
183   /* Name of runtime interpreter to invoke.  */
184   char *interpreter;
185
186   /* Name to give runtime libary from the -soname argument.  */
187   char *soname;
188
189   /* Runtime library search path from the -rpath argument.  */
190   char *rpath;
191
192   /* Link time runtime library search path from the -rpath-link
193      argument.  */
194   char *rpath_link;
195
196   /* Name of shared object whose symbol table should be filtered with
197      this shared object.  From the --filter option.  */
198   char *filter_shlib;
199
200   /* Name of shared object for whose symbol table this shared object
201      is an auxiliary filter.  From the --auxiliary option.  */
202   char **auxiliary_filters;
203
204   /* A version symbol to be applied to the symbol names found in the
205      .exports sections.  */
206   char *version_exports_section;
207
208   /* Default linker script.  */
209   char *default_script;
210 } args_type;
211
212 extern args_type command_line;
213
214 typedef int token_code_type;
215
216 typedef struct {
217   bfd_boolean magic_demand_paged;
218   bfd_boolean make_executable;
219
220   /* If TRUE, doing a dynamic link.  */
221   bfd_boolean dynamic_link;
222
223   /* If TRUE, -shared is supported.  */
224   /* ??? A better way to do this is perhaps to define this in the
225      ld_emulation_xfer_struct since this is really a target dependent
226      parameter.  */
227   bfd_boolean has_shared;
228
229   /* If TRUE, build constructors.  */
230   bfd_boolean build_constructors;
231
232   /* If TRUE, warn about any constructors.  */
233   bfd_boolean warn_constructors;
234
235   /* If TRUE, warn about merging common symbols with others.  */
236   bfd_boolean warn_common;
237
238   /* If TRUE, only warn once about a particular undefined symbol.  */
239   bfd_boolean warn_once;
240
241   /* If TRUE, warn if multiple global-pointers are needed (Alpha
242      only).  */
243   bfd_boolean warn_multiple_gp;
244
245   /* If TRUE, warn if the starting address of an output section
246      changes due to the alignment of an input section.  */
247   bfd_boolean warn_section_align;
248
249   /* If TRUE, warning messages are fatal */
250   bfd_boolean fatal_warnings;
251
252   sort_order sort_common;
253
254   bfd_boolean text_read_only;
255
256   bfd_boolean stats;
257
258   /* If set, orphan input sections will be mapped to separate output
259      sections.  */
260   bfd_boolean unique_orphan_sections;
261
262   /* If set, only search library directories explicitly selected
263      on the command line.  */
264   bfd_boolean only_cmd_line_lib_dirs;
265
266   /* The rpath separation character.  Usually ':'.  */
267   char rpath_separator;
268
269   char *map_filename;
270   FILE *map_file;
271
272   unsigned int split_by_reloc;
273   bfd_size_type split_by_file;
274
275   bfd_size_type specified_data_size;
276
277   /* The size of the hash table to use.  */
278   bfd_size_type hash_table_size;
279
280   /* The maximum page size for ELF.  */
281   bfd_vma maxpagesize;
282
283   /* The common page size for ELF.  */
284   bfd_vma commonpagesize;
285 } ld_config_type;
286
287 extern ld_config_type config;
288
289 extern FILE * saved_script_handle;
290 extern bfd_boolean force_make_executable;
291
292 /* Non-zero if we are processing a --defsym from the command line.  */
293 extern int parsing_defsym;
294
295 extern int yyparse (void);
296 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
297 extern bfd_boolean handle_asneeded_cref (bfd *, enum notice_asneeded_action);
298 extern void output_cref (FILE *);
299 extern void check_nocrossrefs (void);
300 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
301
302 /* If gcc >= 2.6, we can give a function name, too.  */
303 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
304 #define __PRETTY_FUNCTION__  NULL
305 #endif
306
307 #undef abort
308 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
309
310 #endif