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, 2008, 2009
   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 #ifdef HAVE_LOCALE_H
  36 # ifndef ENABLE_NLS
  37    /* The Solaris version of locale.h always includes libintl.h.  If we have
  38       been configured with --disable-nls then ENABLE_NLS will not be defined
  39       and the dummy definitions of bindtextdomain (et al) below will conflict
  40       with the defintions in libintl.h.  So we define these values to prevent
  41       the bogus inclusion of libintl.h.  */
  42 #  define _LIBINTL_H
  43 #  define _LIBGETTEXT_H
  44 # endif
  45 # include <locale.h>
  46 #endif
  47
  48 #ifdef ENABLE_NLS
  49 # include <libintl.h>
  50 # define _(String) gettext (String)
  51 # ifdef gettext_noop
  52 #  define N_(String) gettext_noop (String)
  53 # else
  54 #  define N_(String) (String)
  55 # endif
  56 #else
  57 # define gettext(Msgid) (Msgid)
  58 # define dgettext(Domainname, Msgid) (Msgid)
  59 # define dcgettext(Domainname, Msgid, Category) (Msgid)
  60 # define textdomain(Domainname) while (0) /* nothing */
  61 # define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
  62 # define _(String) (String)
  63 # define N_(String) (String)
  64 #endif
  65
  66 /* Look in this environment name for the linker to pretend to be */
  67 #define EMULATION_ENVIRON "LDEMULATION"
  68 /* If in there look for the strings: */
  69
  70 /* Look in this variable for a target format */
  71 #define TARGET_ENVIRON "GNUTARGET"
  72
  73 /* Input sections which are put in a section of this name are actually
  74    discarded.  */
  75 #define DISCARD_SECTION_NAME "/DISCARD/"
  76
  77 /* A file name list */
  78 typedef struct name_list {
  79   const char *name;
  80   struct name_list *next;
  81 }
  82 name_list;
  83
  84 typedef enum {sort_none, sort_ascending, sort_descending} sort_order;
  85
  86 /* A wildcard specification.  */
  87
  88 typedef enum {
  89   none, by_name, by_alignment, by_name_alignment, by_alignment_name,
  90   by_init_priority
  91 } sort_type;
  92
  93 extern sort_type sort_section;
  94
  95 struct wildcard_spec {
  96   const char *name;
  97   struct name_list *exclude_name_list;
  98   sort_type sorted;
  99 };
 100
 101 struct wildcard_list {
 102   struct wildcard_list *next;
 103   struct wildcard_spec spec;
 104 };
 105
 106 struct map_symbol_def {
 107   struct bfd_link_hash_entry *entry;
 108   struct map_symbol_def *next;
 109 };
 110
 111 /* The initial part of fat_user_section_struct has to be idential with
 112    lean_user_section_struct.  */
 113 typedef struct fat_user_section_struct {
 114   /* For input sections, when writing a map file: head / tail of a linked
 115      list of hash table entries for symbols defined in this section.  */
 116   struct map_symbol_def *map_symbol_def_head;
 117   struct map_symbol_def **map_symbol_def_tail;
 118   unsigned long map_symbol_def_count;
 119 } fat_section_userdata_type;
 120
 121 #define get_userdata(x) ((x)->userdata)
 122
 123 #define BYTE_SIZE       (1)
 124 #define SHORT_SIZE      (2)
 125 #define LONG_SIZE       (4)
 126 #define QUAD_SIZE       (8)
 127
 128 enum endian_enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE };
 129
 130 enum symbolic_enum
 131   {
 132     symbolic_unset = 0,
 133     symbolic,
 134     symbolic_functions,
 135   };
 136
 137 enum dynamic_list_enum
 138   {
 139     dynamic_list_unset = 0,
 140     dynamic_list_data,
 141     dynamic_list
 142   };
 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
 151   /* Enable or disable target specific optimizations.
 152
 153      Not all targets have optimizations to enable.
 154
 155      Normally these optimizations are disabled by default but some targets
 156      prefer to enable them by default.  So this field is a tri-state variable.
 157      The values are:
 158
 159      zero: Enable the optimizations (either from --relax being specified on
 160        the command line or the backend's before_allocation emulation function.
 161
 162      positive: The user has requested that these optimizations be disabled.
 163        (Via the --no-relax command line option).
 164
 165      negative: The optimizations are disabled.  (Set when initializing the
 166        args_type structure in ldmain.c:main.  */
 167   signed int disable_target_specific_optimizations;
 168 #define RELAXATION_DISABLED_BY_DEFAULT (command_line.disable_target_specific_optimizations < 0)
 169 #define RELAXATION_DISABLED_BY_USER    (command_line.disable_target_specific_optimizations > 0)
 170 #define RELAXATION_ENABLED (command_line.disable_target_specific_optimizations == 0)
 171 #define DISABLE_RELAXATION do { command_line.disable_target_specific_optimizations = 1; } while (0)
 172 #define ENABLE_RELAXATION  do { command_line.disable_target_specific_optimizations = 0; } while (0)
 173
 174   /* If TRUE, build MIPS embedded PIC relocation tables in the output
 175      file.  */
 176   bfd_boolean embedded_relocs;
 177
 178   /* If TRUE, force generation of a file with a .exe file.  */
 179   bfd_boolean force_exe_suffix;
 180
 181   /* If TRUE, generate a cross reference report.  */
 182   bfd_boolean cref;
 183
 184   /* If TRUE (which is the default), warn about mismatched input
 185      files.  */
 186   bfd_boolean warn_mismatch;
 187
 188   /* Warn on attempting to open an incompatible library during a library
 189      search.  */
 190   bfd_boolean warn_search_mismatch;
 191
 192   /* If non-zero check section addresses, once computed,
 193      for overlaps.  Relocatable links only check when this is > 0.  */
 194   signed char check_section_addresses;
 195
 196   /* If TRUE allow the linking of input files in an unknown architecture
 197      assuming that the user knows what they are doing.  This was the old
 198      behaviour of the linker.  The new default behaviour is to reject such
 199      input files.  */
 200   bfd_boolean accept_unknown_input_arch;
 201
 202   /* Big or little endian as set on command line.  */
 203   enum endian_enum endian;
 204
 205   /* -Bsymbolic and -Bsymbolic-functions, as set on command line.  */
 206   enum symbolic_enum symbolic;
 207
 208   /* --dynamic-list, --dynamic-list-cpp-new, --dynamic-list-cpp-typeinfo
 209      and --dynamic-list FILE, as set on command line.  */
 210   enum dynamic_list_enum dynamic_list;
 211
 212   /* Name of runtime interpreter to invoke.  */
 213   char *interpreter;
 214
 215   /* Name to give runtime libary from the -soname argument.  */
 216   char *soname;
 217
 218   /* Runtime library search path from the -rpath argument.  */
 219   char *rpath;
 220
 221   /* Link time runtime library search path from the -rpath-link
 222      argument.  */
 223   char *rpath_link;
 224
 225   /* Name of shared object whose symbol table should be filtered with
 226      this shared object.  From the --filter option.  */
 227   char *filter_shlib;
 228
 229   /* Name of shared object for whose symbol table this shared object
 230      is an auxiliary filter.  From the --auxiliary option.  */
 231   char **auxiliary_filters;
 232
 233   /* A version symbol to be applied to the symbol names found in the
 234      .exports sections.  */
 235   char *version_exports_section;
 236
 237   /* Default linker script.  */
 238   char *default_script;
 239 } args_type;
 240
 241 extern args_type command_line;
 242
 243 typedef int token_code_type;
 244
 245 typedef struct {
 246   bfd_boolean magic_demand_paged;
 247   bfd_boolean make_executable;
 248
 249   /* If TRUE, doing a dynamic link.  */
 250   bfd_boolean dynamic_link;
 251
 252   /* If TRUE, -shared is supported.  */
 253   /* ??? A better way to do this is perhaps to define this in the
 254      ld_emulation_xfer_struct since this is really a target dependent
 255      parameter.  */
 256   bfd_boolean has_shared;
 257
 258   /* If TRUE, build constructors.  */
 259   bfd_boolean build_constructors;
 260
 261   /* If TRUE, warn about any constructors.  */
 262   bfd_boolean warn_constructors;
 263
 264   /* If TRUE, warn about merging common symbols with others.  */
 265   bfd_boolean warn_common;
 266
 267   /* If TRUE, only warn once about a particular undefined symbol.  */
 268   bfd_boolean warn_once;
 269
 270   /* If TRUE, warn if multiple global-pointers are needed (Alpha
 271      only).  */
 272   bfd_boolean warn_multiple_gp;
 273
 274   /* If TRUE, warn if the starting address of an output section
 275      changes due to the alignment of an input section.  */
 276   bfd_boolean warn_section_align;
 277
 278   /* If TRUE, warning messages are fatal */
 279   bfd_boolean fatal_warnings;
 280
 281   sort_order sort_common;
 282
 283   bfd_boolean text_read_only;
 284
 285   bfd_boolean stats;
 286
 287   /* If set, orphan input sections will be mapped to separate output
 288      sections.  */
 289   bfd_boolean unique_orphan_sections;
 290
 291   /* If set, only search library directories explicitly selected
 292      on the command line.  */
 293   bfd_boolean only_cmd_line_lib_dirs;
 294
 295   /* The rpath separation character.  Usually ':'.  */
 296   char rpath_separator;
 297
 298   char *map_filename;
 299   FILE *map_file;
 300
 301   unsigned int split_by_reloc;
 302   bfd_size_type split_by_file;
 303
 304   bfd_size_type specified_data_size;
 305
 306   /* The size of the hash table to use.  */
 307   bfd_size_type hash_table_size;
 308
 309   /* The maximum page size for ELF.  */
 310   bfd_vma maxpagesize;
 311
 312   /* The common page size for ELF.  */
 313   bfd_vma commonpagesize;
 314 } ld_config_type;
 315
 316 extern ld_config_type config;
 317
 318 extern FILE * saved_script_handle;
 319 extern bfd_boolean force_make_executable;
 320
 321 /* Non-zero if we are processing a --defsym from the command line.  */
 322 extern int parsing_defsym;
 323
 324 extern int yyparse (void);
 325 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
 326 extern bfd_boolean handle_asneeded_cref (bfd *, enum notice_asneeded_action);
 327 extern void output_cref (FILE *);
 328 extern void check_nocrossrefs (void);
 329 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
 330
 331 /* If gcc >= 2.6, we can give a function name, too.  */
 332 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 333 #define __PRETTY_FUNCTION__  NULL
 334 #endif
 335
 336 #undef abort
 337 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 338
 339 #endif