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
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, 59 Temple Place - Suite 330, Boston, MA
21    02111-1307, USA.  */
22
23 #ifndef LD_H
24 #define LD_H
25
26 #ifdef HAVE_LOCALE_H
27 # include <locale.h>
28 #endif
29
30 #ifdef ENABLE_NLS
31 # include <libintl.h>
32 # define _(String) gettext (String)
33 # ifdef gettext_noop
34 #  define N_(String) gettext_noop (String)
35 # else
36 #  define N_(String) (String)
37 # endif
38 #else
39 # define gettext(Msgid) (Msgid)
40 # define dgettext(Domainname, Msgid) (Msgid)
41 # define dcgettext(Domainname, Msgid, Category) (Msgid)
42 # define textdomain(Domainname) while (0) /* nothing */
43 # define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
44 # define _(String) (String)
45 # define N_(String) (String)
46 #endif
47
48 #include "bin-bugs.h"
49
50 /* Look in this environment name for the linker to pretend to be */
51 #define EMULATION_ENVIRON "LDEMULATION"
52 /* If in there look for the strings: */
53
54 /* Look in this variable for a target format */
55 #define TARGET_ENVIRON "GNUTARGET"
56
57 /* Input sections which are put in a section of this name are actually
58    discarded.  */
59 #define DISCARD_SECTION_NAME "/DISCARD/"
60
61 /* A file name list */
62 typedef struct name_list {
63   const char *name;
64   struct name_list *next;
65 }
66 name_list;
67
68 /* A wildcard specification.  */
69
70 typedef enum {
71   none, by_name, by_alignment, by_name_alignment, by_alignment_name
72 } sort_type;
73
74 extern sort_type sort_section;
75
76 struct wildcard_spec {
77   const char *name;
78   struct name_list *exclude_name_list;
79   sort_type sorted;
80 };
81
82 struct wildcard_list {
83   struct wildcard_list *next;
84   struct wildcard_spec spec;
85 };
86
87 struct map_symbol_def {
88   struct bfd_link_hash_entry *entry;
89   struct map_symbol_def *next;
90 };
91
92 /* Extra information we hold on sections */
93 typedef struct lean_user_section_struct {
94   /* For output sections: pointer to the section where this data will go.  */
95   struct lang_input_statement_struct *file;
96 } lean_section_userdata_type;
97
98 /* The initial part of fat_user_section_struct has to be idential with
99    lean_user_section_struct.  */
100 typedef struct fat_user_section_struct {
101   /* For output sections: pointer to the section where this data will go.  */
102   struct lang_input_statement_struct *file;
103   /* For input sections, when writing a map file: head / tail of a linked
104      list of hash table entries for symbols defined in this section.  */
105   struct map_symbol_def *map_symbol_def_head;
106   struct map_symbol_def **map_symbol_def_tail;
107 } fat_section_userdata_type;
108
109 #define SECTION_USERDATA_SIZE \
110  (command_line.reduce_memory_overheads \
111   ? sizeof (lean_section_userdata_type) \
112   : sizeof (fat_section_userdata_type))
113
114 #define get_userdata(x) ((x)->userdata)
115
116 #define BYTE_SIZE       (1)
117 #define SHORT_SIZE      (2)
118 #define LONG_SIZE       (4)
119 #define QUAD_SIZE       (8)
120
121 typedef struct {
122   /* 1 => assign space to common symbols even if `relocatable_output'.  */
123   bfd_boolean force_common_definition;
124
125   /* 1 => do not assign addresses to common symbols.  */
126   bfd_boolean inhibit_common_definition;
127   bfd_boolean relax;
128
129   /* Name of runtime interpreter to invoke.  */
130   char *interpreter;
131
132   /* Name to give runtime libary from the -soname argument.  */
133   char *soname;
134
135   /* Runtime library search path from the -rpath argument.  */
136   char *rpath;
137
138   /* Link time runtime library search path from the -rpath-link
139      argument.  */
140   char *rpath_link;
141
142   /* Big or little endian as set on command line.  */
143   enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE } endian;
144
145   /* If TRUE, build MIPS embedded PIC relocation tables in the output
146      file.  */
147   bfd_boolean embedded_relocs;
148
149   /* If TRUE, force generation of a file with a .exe file.  */
150   bfd_boolean force_exe_suffix;
151
152   /* If TRUE, generate a cross reference report.  */
153   bfd_boolean cref;
154
155   /* If TRUE (which is the default), warn about mismatched input
156      files.  */
157   bfd_boolean warn_mismatch;
158
159   /* Name of shared object whose symbol table should be filtered with
160      this shared object.  From the --filter option.  */
161   char *filter_shlib;
162
163   /* Name of shared object for whose symbol table this shared object
164      is an auxiliary filter.  From the --auxiliary option.  */
165   char **auxiliary_filters;
166
167   /* A version symbol to be applied to the symbol names found in the
168      .exports sections.  */
169   char *version_exports_section;
170
171   /* If TRUE (the default) check section addresses, once compute,
172      fpor overlaps.  */
173   bfd_boolean check_section_addresses;
174
175   /* If TRUE allow the linking of input files in an unknown architecture
176      assuming that the user knows what they are doing.  This was the old
177      behaviour of the linker.  The new default behaviour is to reject such
178      input files.  */
179   bfd_boolean accept_unknown_input_arch;
180
181   /* If TRUE reduce memory overheads, at the expense of speed.
182      This will cause map file generation to use an O(N^2) algorithm.  */
183   bfd_boolean reduce_memory_overheads;
184
185 } args_type;
186
187 extern args_type command_line;
188
189 typedef int token_code_type;
190
191 typedef struct {
192   bfd_size_type specified_data_size;
193   bfd_boolean magic_demand_paged;
194   bfd_boolean make_executable;
195
196   /* If TRUE, doing a dynamic link.  */
197   bfd_boolean dynamic_link;
198
199   /* If TRUE, -shared is supported.  */
200   /* ??? A better way to do this is perhaps to define this in the
201      ld_emulation_xfer_struct since this is really a target dependent
202      parameter.  */
203   bfd_boolean has_shared;
204
205   /* If TRUE, build constructors.  */
206   bfd_boolean build_constructors;
207
208   /* If TRUE, warn about any constructors.  */
209   bfd_boolean warn_constructors;
210
211   /* If TRUE, warn about merging common symbols with others.  */
212   bfd_boolean warn_common;
213
214   /* If TRUE, only warn once about a particular undefined symbol.  */
215   bfd_boolean warn_once;
216
217   /* If TRUE, warn if multiple global-pointers are needed (Alpha
218      only).  */
219   bfd_boolean warn_multiple_gp;
220
221   /* If TRUE, warn if the starting address of an output section
222      changes due to the alignment of an input section.  */
223   bfd_boolean warn_section_align;
224
225   /* If TRUE, warning messages are fatal */
226   bfd_boolean fatal_warnings;
227
228   bfd_boolean sort_common;
229
230   bfd_boolean text_read_only;
231
232   char *map_filename;
233   FILE *map_file;
234
235   bfd_boolean stats;
236
237   /* If set, orphan input sections will be mapped to separate output
238      sections.  */
239   bfd_boolean unique_orphan_sections;
240
241   unsigned int split_by_reloc;
242   bfd_size_type split_by_file;
243
244   /* If set, only search library directories explicitly selected
245      on the command line.  */
246   bfd_boolean only_cmd_line_lib_dirs;
247
248   /* The size of the hash table to use.  */
249   bfd_size_type hash_table_size;
250 } ld_config_type;
251
252 extern ld_config_type config;
253
254 typedef enum {
255   lang_first_phase_enum,
256   lang_allocating_phase_enum,
257   lang_final_phase_enum
258 } lang_phase_type;
259
260 extern FILE * saved_script_handle;
261 extern bfd_boolean force_make_executable;
262
263 /* Non-zero if we are processing a --defsym from the command line.  */
264 extern int parsing_defsym;
265
266 extern int yyparse (void);
267 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
268 extern void output_cref (FILE *);
269 extern void check_nocrossrefs (void);
270 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
271
272 /* If gcc >= 2.6, we can give a function name, too.  */
273 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
274 #define __PRETTY_FUNCTION__  NULL
275 #endif
276
277 #undef abort
278 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
279
280 #endif