e1aa62cc6cfc794cfd7439908c5538f41d3933a4
[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
4    Free Software Foundation, Inc.
5
6    This file is part of GLD, the Gnu Linker.
7
8    GLD 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 2, or (at your option)
11    any later version.
12
13    GLD 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 GLD; see the file COPYING.  If not, write to the Free
20    Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
21    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 #if defined(__GNUC__) && !defined(C_ALLOCA)
36 # undef alloca
37 # define alloca __builtin_alloca
38 #else
39 # if defined(HAVE_ALLOCA_H) && !defined(C_ALLOCA)
40 #  include <alloca.h>
41 # else
42 #  ifndef alloca /* predefined by HP cc +Olibcalls */
43 #   if !defined (__STDC__) && !defined (__hpux)
44 char *alloca ();
45 #   else
46 void *alloca ();
47 #   endif /* __STDC__, __hpux */
48 #  endif /* alloca */
49 # endif /* HAVE_ALLOCA_H */
50 #endif
51
52
53 #ifdef HAVE_LOCALE_H
54 # ifndef ENABLE_NLS
55    /* The Solaris version of locale.h always includes libintl.h.  If we have
56       been configured with --disable-nls then ENABLE_NLS will not be defined
57       and the dummy definitions of bindtextdomain (et al) below will conflict
58       with the defintions in libintl.h.  So we define these values to prevent
59       the bogus inclusion of libintl.h.  */
60 #  define _LIBINTL_H
61 #  define _LIBGETTEXT_H
62 # endif
63 # include <locale.h>
64 #endif
65
66 #ifdef ENABLE_NLS
67 # include <libintl.h>
68 # define _(String) gettext (String)
69 # ifdef gettext_noop
70 #  define N_(String) gettext_noop (String)
71 # else
72 #  define N_(String) (String)
73 # endif
74 #else
75 # define gettext(Msgid) (Msgid)
76 # define dgettext(Domainname, Msgid) (Msgid)
77 # define dcgettext(Domainname, Msgid, Category) (Msgid)
78 # define textdomain(Domainname) while (0) /* nothing */
79 # define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
80 # define _(String) (String)
81 # define N_(String) (String)
82 #endif
83
84 #include "bin-bugs.h"
85
86 /* Look in this environment name for the linker to pretend to be */
87 #define EMULATION_ENVIRON "LDEMULATION"
88 /* If in there look for the strings: */
89
90 /* Look in this variable for a target format */
91 #define TARGET_ENVIRON "GNUTARGET"
92
93 /* Input sections which are put in a section of this name are actually
94    discarded.  */
95 #define DISCARD_SECTION_NAME "/DISCARD/"
96
97 /* A file name list */
98 typedef struct name_list {
99   const char *name;
100   struct name_list *next;
101 }
102 name_list;
103
104 /* A wildcard specification.  */
105
106 typedef enum {
107   none, by_name, by_alignment, by_name_alignment, by_alignment_name
108 } sort_type;
109
110 extern sort_type sort_section;
111
112 struct wildcard_spec {
113   const char *name;
114   struct name_list *exclude_name_list;
115   sort_type sorted;
116 };
117
118 struct wildcard_list {
119   struct wildcard_list *next;
120   struct wildcard_spec spec;
121 };
122
123 struct map_symbol_def {
124   struct bfd_link_hash_entry *entry;
125   struct map_symbol_def *next;
126 };
127
128 /* The initial part of fat_user_section_struct has to be idential with
129    lean_user_section_struct.  */
130 typedef struct fat_user_section_struct {
131   /* For input sections, when writing a map file: head / tail of a linked
132      list of hash table entries for symbols defined in this section.  */
133   struct map_symbol_def *map_symbol_def_head;
134   struct map_symbol_def **map_symbol_def_tail;
135 } fat_section_userdata_type;
136
137 #define get_userdata(x) ((x)->userdata)
138
139 #define BYTE_SIZE       (1)
140 #define SHORT_SIZE      (2)
141 #define LONG_SIZE       (4)
142 #define QUAD_SIZE       (8)
143
144 typedef struct {
145   /* 1 => assign space to common symbols even if `relocatable_output'.  */
146   bfd_boolean force_common_definition;
147
148   /* 1 => do not assign addresses to common symbols.  */
149   bfd_boolean inhibit_common_definition;
150   bfd_boolean relax;
151
152   /* Name of runtime interpreter to invoke.  */
153   char *interpreter;
154
155   /* Name to give runtime libary from the -soname argument.  */
156   char *soname;
157
158   /* Runtime library search path from the -rpath argument.  */
159   char *rpath;
160
161   /* Link time runtime library search path from the -rpath-link
162      argument.  */
163   char *rpath_link;
164
165   /* Big or little endian as set on command line.  */
166   enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE } endian;
167
168   /* If TRUE, build MIPS embedded PIC relocation tables in the output
169      file.  */
170   bfd_boolean embedded_relocs;
171
172   /* If TRUE, force generation of a file with a .exe file.  */
173   bfd_boolean force_exe_suffix;
174
175   /* If TRUE, generate a cross reference report.  */
176   bfd_boolean cref;
177
178   /* If TRUE (which is the default), warn about mismatched input
179      files.  */
180   bfd_boolean warn_mismatch;
181
182   /* Name of shared object whose symbol table should be filtered with
183      this shared object.  From the --filter option.  */
184   char *filter_shlib;
185
186   /* Name of shared object for whose symbol table this shared object
187      is an auxiliary filter.  From the --auxiliary option.  */
188   char **auxiliary_filters;
189
190   /* A version symbol to be applied to the symbol names found in the
191      .exports sections.  */
192   char *version_exports_section;
193
194   /* If TRUE (the default) check section addresses, once compute,
195      fpor overlaps.  */
196   bfd_boolean check_section_addresses;
197
198   /* If TRUE allow the linking of input files in an unknown architecture
199      assuming that the user knows what they are doing.  This was the old
200      behaviour of the linker.  The new default behaviour is to reject such
201      input files.  */
202   bfd_boolean accept_unknown_input_arch;
203
204   /* If TRUE reduce memory overheads, at the expense of speed.
205      This will cause map file generation to use an O(N^2) algorithm.  */
206   bfd_boolean reduce_memory_overheads;
207
208 } args_type;
209
210 extern args_type command_line;
211
212 typedef int token_code_type;
213
214 typedef struct {
215   bfd_size_type specified_data_size;
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   bfd_boolean sort_common;
252
253   bfd_boolean text_read_only;
254
255   char *map_filename;
256   FILE *map_file;
257
258   bfd_boolean stats;
259
260   /* If set, orphan input sections will be mapped to separate output
261      sections.  */
262   bfd_boolean unique_orphan_sections;
263
264   unsigned int split_by_reloc;
265   bfd_size_type split_by_file;
266
267   /* If set, only search library directories explicitly selected
268      on the command line.  */
269   bfd_boolean only_cmd_line_lib_dirs;
270
271   /* The size of the hash table to use.  */
272   bfd_size_type hash_table_size;
273 } ld_config_type;
274
275 extern ld_config_type config;
276
277 extern FILE * saved_script_handle;
278 extern bfd_boolean force_make_executable;
279
280 /* Non-zero if we are processing a --defsym from the command line.  */
281 extern int parsing_defsym;
282
283 extern int yyparse (void);
284 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
285 extern void output_cref (FILE *);
286 extern void check_nocrossrefs (void);
287 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
288
289 /* If gcc >= 2.6, we can give a function name, too.  */
290 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
291 #define __PRETTY_FUNCTION__  NULL
292 #endif
293
294 #undef abort
295 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
296
297 #endif