* emultempl/pe.em (debug_section_p): New bfd_map_over_sections hook.
[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
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 #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 /* Look in this environment name for the linker to pretend to be */
85 #define EMULATION_ENVIRON "LDEMULATION"
86 /* If in there look for the strings: */
87
88 /* Look in this variable for a target format */
89 #define TARGET_ENVIRON "GNUTARGET"
90
91 /* Input sections which are put in a section of this name are actually
92    discarded.  */
93 #define DISCARD_SECTION_NAME "/DISCARD/"
94
95 /* A file name list */
96 typedef struct name_list {
97   const char *name;
98   struct name_list *next;
99 }
100 name_list;
101
102 typedef enum {sort_none, sort_ascending, sort_descending} sort_order;
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   /* If TRUE, build MIPS embedded PIC relocation tables in the output
153      file.  */
154   bfd_boolean embedded_relocs;
155
156   /* If TRUE, force generation of a file with a .exe file.  */
157   bfd_boolean force_exe_suffix;
158
159   /* If TRUE, generate a cross reference report.  */
160   bfd_boolean cref;
161
162   /* If TRUE (which is the default), warn about mismatched input
163      files.  */
164   bfd_boolean warn_mismatch;
165
166   /* Warn on attempting to open an incompatible library during a library
167      search.  */
168   bfd_boolean warn_search_mismatch;
169
170   /* If non-zero check section addresses, once computed,
171      for overlaps.  Relocatable links only check when this is > 0.  */
172   signed char check_section_addresses;
173
174   /* If TRUE allow the linking of input files in an unknown architecture
175      assuming that the user knows what they are doing.  This was the old
176      behaviour of the linker.  The new default behaviour is to reject such
177      input files.  */
178   bfd_boolean accept_unknown_input_arch;
179
180   /* Big or little endian as set on command line.  */
181   enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE } endian;
182
183   /* -Bsymbolic and -Bsymbolic-functions, as set on command line.  */
184   enum
185     {
186       symbolic_unset = 0,
187       symbolic,
188       symbolic_functions,
189     } symbolic;
190
191   /* --dynamic-list, --dynamic-list-cpp-new, --dynamic-list-cpp-typeinfo
192      and --dynamic-list FILE, as set on command line.  */
193   enum
194     {
195       dynamic_list_unset = 0,
196       dynamic_list_data,
197       dynamic_list
198     } dynamic_list;
199
200   /* Name of runtime interpreter to invoke.  */
201   char *interpreter;
202
203   /* Name to give runtime libary from the -soname argument.  */
204   char *soname;
205
206   /* Runtime library search path from the -rpath argument.  */
207   char *rpath;
208
209   /* Link time runtime library search path from the -rpath-link
210      argument.  */
211   char *rpath_link;
212
213   /* Name of shared object whose symbol table should be filtered with
214      this shared object.  From the --filter option.  */
215   char *filter_shlib;
216
217   /* Name of shared object for whose symbol table this shared object
218      is an auxiliary filter.  From the --auxiliary option.  */
219   char **auxiliary_filters;
220
221   /* A version symbol to be applied to the symbol names found in the
222      .exports sections.  */
223   char *version_exports_section;
224
225   /* Default linker script.  */
226   char *default_script;
227 } args_type;
228
229 extern args_type command_line;
230
231 typedef int token_code_type;
232
233 typedef struct {
234   bfd_boolean magic_demand_paged;
235   bfd_boolean make_executable;
236
237   /* If TRUE, doing a dynamic link.  */
238   bfd_boolean dynamic_link;
239
240   /* If TRUE, -shared is supported.  */
241   /* ??? A better way to do this is perhaps to define this in the
242      ld_emulation_xfer_struct since this is really a target dependent
243      parameter.  */
244   bfd_boolean has_shared;
245
246   /* If TRUE, build constructors.  */
247   bfd_boolean build_constructors;
248
249   /* If TRUE, warn about any constructors.  */
250   bfd_boolean warn_constructors;
251
252   /* If TRUE, warn about merging common symbols with others.  */
253   bfd_boolean warn_common;
254
255   /* If TRUE, only warn once about a particular undefined symbol.  */
256   bfd_boolean warn_once;
257
258   /* If TRUE, warn if multiple global-pointers are needed (Alpha
259      only).  */
260   bfd_boolean warn_multiple_gp;
261
262   /* If TRUE, warn if the starting address of an output section
263      changes due to the alignment of an input section.  */
264   bfd_boolean warn_section_align;
265
266   /* If TRUE, warning messages are fatal */
267   bfd_boolean fatal_warnings;
268
269   sort_order sort_common;
270
271   bfd_boolean text_read_only;
272
273   bfd_boolean stats;
274
275   /* If set, orphan input sections will be mapped to separate output
276      sections.  */
277   bfd_boolean unique_orphan_sections;
278
279   /* If set, only search library directories explicitly selected
280      on the command line.  */
281   bfd_boolean only_cmd_line_lib_dirs;
282
283   /* The rpath separation character.  Usually ':'.  */
284   char rpath_separator;
285
286   char *map_filename;
287   FILE *map_file;
288
289   unsigned int split_by_reloc;
290   bfd_size_type split_by_file;
291
292   bfd_size_type specified_data_size;
293
294   /* The size of the hash table to use.  */
295   bfd_size_type hash_table_size;
296
297   /* The maximum page size for ELF.  */
298   bfd_vma maxpagesize;
299
300   /* The common page size for ELF.  */
301   bfd_vma commonpagesize;
302 } ld_config_type;
303
304 extern ld_config_type config;
305
306 extern FILE * saved_script_handle;
307 extern bfd_boolean force_make_executable;
308
309 /* Non-zero if we are processing a --defsym from the command line.  */
310 extern int parsing_defsym;
311
312 extern int yyparse (void);
313 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
314 extern bfd_boolean handle_asneeded_cref (bfd *, enum notice_asneeded_action);
315 extern void output_cref (FILE *);
316 extern void check_nocrossrefs (void);
317 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
318
319 /* If gcc >= 2.6, we can give a function name, too.  */
320 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
321 #define __PRETTY_FUNCTION__  NULL
322 #endif
323
324 #undef abort
325 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
326
327 #endif