2005-02-28 Paolo Bonzini <bonzini@gnu.org>
[binutils.git] / ld / ld.h
blobc2337b6a1e981d74109a3ee7d2e4386e0b8a3be1
1 /* ld.h -- general linker header file
2 Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2004
3 Free Software Foundation, Inc.
5 This file is part of GLD, the Gnu Linker.
7 GLD is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GLD is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GLD; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA. */
22 #ifndef LD_H
23 #define LD_H
25 #ifdef HAVE_LOCALE_H
26 # include <locale.h>
27 #endif
29 #ifdef ENABLE_NLS
30 # include <libintl.h>
31 # define _(String) gettext (String)
32 # ifdef gettext_noop
33 # define N_(String) gettext_noop (String)
34 # else
35 # define N_(String) (String)
36 # endif
37 #else
38 # define gettext(Msgid) (Msgid)
39 # define dgettext(Domainname, Msgid) (Msgid)
40 # define dcgettext(Domainname, Msgid, Category) (Msgid)
41 # define textdomain(Domainname) while (0) /* nothing */
42 # define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
43 # define _(String) (String)
44 # define N_(String) (String)
45 #endif
47 #include "bin-bugs.h"
49 /* Look in this environment name for the linker to pretend to be */
50 #define EMULATION_ENVIRON "LDEMULATION"
51 /* If in there look for the strings: */
53 /* Look in this variable for a target format */
54 #define TARGET_ENVIRON "GNUTARGET"
56 /* Input sections which are put in a section of this name are actually
57 discarded. */
58 #define DISCARD_SECTION_NAME "/DISCARD/"
60 /* A file name list */
61 typedef struct name_list {
62 const char *name;
63 struct name_list *next;
65 name_list;
67 /* A wildcard specification. */
69 typedef enum {
70 none, by_name, by_alignment, by_name_alignment, by_alignment_name
71 } sort_type;
73 extern sort_type sort_section;
75 struct wildcard_spec {
76 const char *name;
77 struct name_list *exclude_name_list;
78 sort_type sorted;
81 struct wildcard_list {
82 struct wildcard_list *next;
83 struct wildcard_spec spec;
86 struct map_symbol_def {
87 struct bfd_link_hash_entry *entry;
88 struct map_symbol_def *next;
91 /* Extra information we hold on sections */
92 typedef struct lean_user_section_struct {
93 /* For output sections: pointer to the section where this data will go. */
94 struct lang_input_statement_struct *file;
95 } lean_section_userdata_type;
97 /* The initial part of fat_user_section_struct has to be idential with
98 lean_user_section_struct. */
99 typedef struct fat_user_section_struct {
100 /* For output sections: pointer to the section where this data will go. */
101 struct lang_input_statement_struct *file;
102 /* For input sections, when writing a map file: head / tail of a linked
103 list of hash table entries for symbols defined in this section. */
104 struct map_symbol_def *map_symbol_def_head;
105 struct map_symbol_def **map_symbol_def_tail;
106 } fat_section_userdata_type;
108 #define SECTION_USERDATA_SIZE \
109 (command_line.reduce_memory_overheads \
110 ? sizeof (lean_section_userdata_type) \
111 : sizeof (fat_section_userdata_type))
113 #define get_userdata(x) ((x)->userdata)
115 #define BYTE_SIZE (1)
116 #define SHORT_SIZE (2)
117 #define LONG_SIZE (4)
118 #define QUAD_SIZE (8)
120 typedef struct {
121 /* 1 => assign space to common symbols even if `relocatable_output'. */
122 bfd_boolean force_common_definition;
124 /* 1 => do not assign addresses to common symbols. */
125 bfd_boolean inhibit_common_definition;
126 bfd_boolean relax;
128 /* Name of runtime interpreter to invoke. */
129 char *interpreter;
131 /* Name to give runtime libary from the -soname argument. */
132 char *soname;
134 /* Runtime library search path from the -rpath argument. */
135 char *rpath;
137 /* Link time runtime library search path from the -rpath-link
138 argument. */
139 char *rpath_link;
141 /* Big or little endian as set on command line. */
142 enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE } endian;
144 /* If TRUE, build MIPS embedded PIC relocation tables in the output
145 file. */
146 bfd_boolean embedded_relocs;
148 /* If TRUE, force generation of a file with a .exe file. */
149 bfd_boolean force_exe_suffix;
151 /* If TRUE, generate a cross reference report. */
152 bfd_boolean cref;
154 /* If TRUE (which is the default), warn about mismatched input
155 files. */
156 bfd_boolean warn_mismatch;
158 /* Remove unreferenced sections? */
159 bfd_boolean gc_sections;
161 /* Name of shared object whose symbol table should be filtered with
162 this shared object. From the --filter option. */
163 char *filter_shlib;
165 /* Name of shared object for whose symbol table this shared object
166 is an auxiliary filter. From the --auxiliary option. */
167 char **auxiliary_filters;
169 /* A version symbol to be applied to the symbol names found in the
170 .exports sections. */
171 char *version_exports_section;
173 /* If TRUE (the default) check section addresses, once compute,
174 fpor overlaps. */
175 bfd_boolean check_section_addresses;
177 /* If TRUE allow the linking of input files in an unknown architecture
178 assuming that the user knows what they are doing. This was the old
179 behaviour of the linker. The new default behaviour is to reject such
180 input files. */
181 bfd_boolean accept_unknown_input_arch;
183 /* If TRUE reduce memory overheads, at the expense of speed.
184 This will cause map file generation to use an O(N^2) algorithm. */
185 bfd_boolean reduce_memory_overheads;
187 } args_type;
189 extern args_type command_line;
191 typedef int token_code_type;
193 typedef struct {
194 bfd_size_type specified_data_size;
195 bfd_boolean magic_demand_paged;
196 bfd_boolean make_executable;
198 /* If TRUE, doing a dynamic link. */
199 bfd_boolean dynamic_link;
201 /* If TRUE, -shared is supported. */
202 /* ??? A better way to do this is perhaps to define this in the
203 ld_emulation_xfer_struct since this is really a target dependent
204 parameter. */
205 bfd_boolean has_shared;
207 /* If TRUE, build constructors. */
208 bfd_boolean build_constructors;
210 /* If TRUE, warn about any constructors. */
211 bfd_boolean warn_constructors;
213 /* If TRUE, warn about merging common symbols with others. */
214 bfd_boolean warn_common;
216 /* If TRUE, only warn once about a particular undefined symbol. */
217 bfd_boolean warn_once;
219 /* If TRUE, warn if multiple global-pointers are needed (Alpha
220 only). */
221 bfd_boolean warn_multiple_gp;
223 /* If TRUE, warn if the starting address of an output section
224 changes due to the alignment of an input section. */
225 bfd_boolean warn_section_align;
227 /* If TRUE, warning messages are fatal */
228 bfd_boolean fatal_warnings;
230 bfd_boolean sort_common;
232 bfd_boolean text_read_only;
234 char *map_filename;
235 FILE *map_file;
237 bfd_boolean stats;
239 /* If set, orphan input sections will be mapped to separate output
240 sections. */
241 bfd_boolean unique_orphan_sections;
243 unsigned int split_by_reloc;
244 bfd_size_type split_by_file;
246 /* If set, only search library directories explicitly selected
247 on the command line. */
248 bfd_boolean only_cmd_line_lib_dirs;
250 /* The size of the hash table to use. */
251 bfd_size_type hash_table_size;
252 } ld_config_type;
254 extern ld_config_type config;
256 typedef enum {
257 lang_first_phase_enum,
258 lang_allocating_phase_enum,
259 lang_final_phase_enum
260 } lang_phase_type;
262 extern FILE * saved_script_handle;
263 extern bfd_boolean force_make_executable;
265 /* Non-zero if we are processing a --defsym from the command line. */
266 extern int parsing_defsym;
268 extern int yyparse (void);
269 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
270 extern void output_cref (FILE *);
271 extern void check_nocrossrefs (void);
272 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
274 /* If gcc >= 2.6, we can give a function name, too. */
275 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
276 #define __PRETTY_FUNCTION__ NULL
277 #endif
279 #undef abort
280 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
282 #endif