Update FSF addresses
[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 # 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 /* The initial part of fat_user_section_struct has to be idential with
93    lean_user_section_struct.  */
94 typedef struct fat_user_section_struct {
95   /* For input sections, when writing a map file: head / tail of a linked
96      list of hash table entries for symbols defined in this section.  */
97   struct map_symbol_def *map_symbol_def_head;
98   struct map_symbol_def **map_symbol_def_tail;
99 } fat_section_userdata_type;
100
101 #define get_userdata(x) ((x)->userdata)
102
103 #define BYTE_SIZE       (1)
104 #define SHORT_SIZE      (2)
105 #define LONG_SIZE       (4)
106 #define QUAD_SIZE       (8)
107
108 typedef struct {
109   /* 1 => assign space to common symbols even if `relocatable_output'.  */
110   bfd_boolean force_common_definition;
111
112   /* 1 => do not assign addresses to common symbols.  */
113   bfd_boolean inhibit_common_definition;
114   bfd_boolean relax;
115
116   /* Name of runtime interpreter to invoke.  */
117   char *interpreter;
118
119   /* Name to give runtime libary from the -soname argument.  */
120   char *soname;
121
122   /* Runtime library search path from the -rpath argument.  */
123   char *rpath;
124
125   /* Link time runtime library search path from the -rpath-link
126      argument.  */
127   char *rpath_link;
128
129   /* Big or little endian as set on command line.  */
130   enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE } endian;
131
132   /* If TRUE, build MIPS embedded PIC relocation tables in the output
133      file.  */
134   bfd_boolean embedded_relocs;
135
136   /* If TRUE, force generation of a file with a .exe file.  */
137   bfd_boolean force_exe_suffix;
138
139   /* If TRUE, generate a cross reference report.  */
140   bfd_boolean cref;
141
142   /* If TRUE (which is the default), warn about mismatched input
143      files.  */
144   bfd_boolean warn_mismatch;
145
146   /* Name of shared object whose symbol table should be filtered with
147      this shared object.  From the --filter option.  */
148   char *filter_shlib;
149
150   /* Name of shared object for whose symbol table this shared object
151      is an auxiliary filter.  From the --auxiliary option.  */
152   char **auxiliary_filters;
153
154   /* A version symbol to be applied to the symbol names found in the
155      .exports sections.  */
156   char *version_exports_section;
157
158   /* If TRUE (the default) check section addresses, once compute,
159      fpor overlaps.  */
160   bfd_boolean check_section_addresses;
161
162   /* If TRUE allow the linking of input files in an unknown architecture
163      assuming that the user knows what they are doing.  This was the old
164      behaviour of the linker.  The new default behaviour is to reject such
165      input files.  */
166   bfd_boolean accept_unknown_input_arch;
167
168   /* If TRUE reduce memory overheads, at the expense of speed.
169      This will cause map file generation to use an O(N^2) algorithm.  */
170   bfd_boolean reduce_memory_overheads;
171
172 } args_type;
173
174 extern args_type command_line;
175
176 typedef int token_code_type;
177
178 typedef struct {
179   bfd_size_type specified_data_size;
180   bfd_boolean magic_demand_paged;
181   bfd_boolean make_executable;
182
183   /* If TRUE, doing a dynamic link.  */
184   bfd_boolean dynamic_link;
185
186   /* If TRUE, -shared is supported.  */
187   /* ??? A better way to do this is perhaps to define this in the
188      ld_emulation_xfer_struct since this is really a target dependent
189      parameter.  */
190   bfd_boolean has_shared;
191
192   /* If TRUE, build constructors.  */
193   bfd_boolean build_constructors;
194
195   /* If TRUE, warn about any constructors.  */
196   bfd_boolean warn_constructors;
197
198   /* If TRUE, warn about merging common symbols with others.  */
199   bfd_boolean warn_common;
200
201   /* If TRUE, only warn once about a particular undefined symbol.  */
202   bfd_boolean warn_once;
203
204   /* If TRUE, warn if multiple global-pointers are needed (Alpha
205      only).  */
206   bfd_boolean warn_multiple_gp;
207
208   /* If TRUE, warn if the starting address of an output section
209      changes due to the alignment of an input section.  */
210   bfd_boolean warn_section_align;
211
212   /* If TRUE, warning messages are fatal */
213   bfd_boolean fatal_warnings;
214
215   bfd_boolean sort_common;
216
217   bfd_boolean text_read_only;
218
219   char *map_filename;
220   FILE *map_file;
221
222   bfd_boolean stats;
223
224   /* If set, orphan input sections will be mapped to separate output
225      sections.  */
226   bfd_boolean unique_orphan_sections;
227
228   unsigned int split_by_reloc;
229   bfd_size_type split_by_file;
230
231   /* If set, only search library directories explicitly selected
232      on the command line.  */
233   bfd_boolean only_cmd_line_lib_dirs;
234
235   /* The size of the hash table to use.  */
236   bfd_size_type hash_table_size;
237 } ld_config_type;
238
239 extern ld_config_type config;
240
241 typedef enum {
242   lang_first_phase_enum,
243   lang_allocating_phase_enum,
244   lang_final_phase_enum
245 } lang_phase_type;
246
247 extern FILE * saved_script_handle;
248 extern bfd_boolean force_make_executable;
249
250 /* Non-zero if we are processing a --defsym from the command line.  */
251 extern int parsing_defsym;
252
253 extern int yyparse (void);
254 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
255 extern void output_cref (FILE *);
256 extern void check_nocrossrefs (void);
257 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
258
259 /* If gcc >= 2.6, we can give a function name, too.  */
260 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
261 #define __PRETTY_FUNCTION__  NULL
262 #endif
263
264 #undef abort
265 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
266
267 #endif