ld/ld.h

   1 /* ld.h -- general linker header file
   2    Copyright (C) 1991-2017 Free Software Foundation, Inc.
   3
   4    This file is part of the GNU Binutils.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  19    MA 02110-1301, USA.  */
  20
  21 #ifndef LD_H
  22 #define LD_H
  23
  24 #ifdef HAVE_LOCALE_H
  25 #endif
  26 #ifndef SEEK_CUR
  27 #define SEEK_CUR 1
  28 #endif
  29 #ifndef SEEK_END
  30 #define SEEK_END 2
  31 #endif
  32
  33 #ifdef HAVE_LOCALE_H
  34 # ifndef ENABLE_NLS
  35    /* The Solaris version of locale.h always includes libintl.h.  If we have
  36       been configured with --disable-nls then ENABLE_NLS will not be defined
  37       and the dummy definitions of bindtextdomain (et al) below will conflict
  38       with the defintions in libintl.h.  So we define these values to prevent
  39       the bogus inclusion of libintl.h.  */
  40 #  define _LIBINTL_H
  41 #  define _LIBGETTEXT_H
  42 # endif
  43 # include <locale.h>
  44 #endif
  45
  46 #ifdef ENABLE_NLS
  47 # include <libintl.h>
  48 # define _(String) gettext (String)
  49 # ifdef gettext_noop
  50 #  define N_(String) gettext_noop (String)
  51 # else
  52 #  define N_(String) (String)
  53 # endif
  54 #else
  55 # define gettext(Msgid) (Msgid)
  56 # define dgettext(Domainname, Msgid) (Msgid)
  57 # define dcgettext(Domainname, Msgid, Category) (Msgid)
  58 # define textdomain(Domainname) while (0) /* nothing */
  59 # define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
  60 # define _(String) (String)
  61 # define N_(String) (String)
  62 #endif
  63
  64 /* Look in this environment name for the linker to pretend to be */
  65 #define EMULATION_ENVIRON "LDEMULATION"
  66 /* If in there look for the strings: */
  67
  68 /* Look in this variable for a target format */
  69 #define TARGET_ENVIRON "GNUTARGET"
  70
  71 /* Input sections which are put in a section of this name are actually
  72    discarded.  */
  73 #define DISCARD_SECTION_NAME "/DISCARD/"
  74
  75 /* A file name list.  */
  76 typedef struct name_list
  77 {
  78   const char *name;
  79   struct name_list *next;
  80 }
  81 name_list;
  82
  83 typedef enum {sort_none, sort_ascending, sort_descending} sort_order;
  84
  85 /* A wildcard specification.  */
  86
  87 typedef enum
  88 {
  89   none, by_name, by_alignment, by_name_alignment, by_alignment_name,
  90   by_none, by_init_priority
  91 } sort_type;
  92
  93 extern sort_type sort_section;
  94
  95 struct wildcard_spec
  96 {
  97   const char *name;
  98   struct name_list *exclude_name_list;
  99   sort_type sorted;
 100   struct flag_info *section_flag_list;
 101 };
 102
 103 struct wildcard_list
 104 {
 105   struct wildcard_list *next;
 106   struct wildcard_spec spec;
 107 };
 108
 109 #define BYTE_SIZE       (1)
 110 #define SHORT_SIZE      (2)
 111 #define LONG_SIZE       (4)
 112 #define QUAD_SIZE       (8)
 113
 114 enum endian_enum { ENDIAN_UNSET = 0, ENDIAN_BIG, ENDIAN_LITTLE };
 115
 116 enum symbolic_enum
 117 {
 118   symbolic_unset = 0,
 119   symbolic,
 120   symbolic_functions,
 121 };
 122
 123 enum dynamic_list_enum
 124 {
 125   dynamic_list_unset = 0,
 126   dynamic_list_data,
 127   dynamic_list
 128 };
 129
 130 typedef struct
 131 {
 132   /* 1 => assign space to common symbols even if `relocatable_output'.  */
 133   bfd_boolean force_common_definition;
 134
 135   /* If TRUE, build MIPS embedded PIC relocation tables in the output
 136      file.  */
 137   bfd_boolean embedded_relocs;
 138
 139   /* If TRUE, force generation of a file with a .exe file.  */
 140   bfd_boolean force_exe_suffix;
 141
 142   /* If TRUE, generate a cross reference report.  */
 143   bfd_boolean cref;
 144
 145   /* If TRUE (which is the default), warn about mismatched input
 146      files.  */
 147   bfd_boolean warn_mismatch;
 148
 149   /* Warn on attempting to open an incompatible library during a library
 150      search.  */
 151   bfd_boolean warn_search_mismatch;
 152
 153   /* If non-zero check section addresses, once computed,
 154      for overlaps.  Relocatable links only check when this is > 0.  */
 155   signed char check_section_addresses;
 156
 157   /* If TRUE allow the linking of input files in an unknown architecture
 158      assuming that the user knows what they are doing.  This was the old
 159      behaviour of the linker.  The new default behaviour is to reject such
 160      input files.  */
 161   bfd_boolean accept_unknown_input_arch;
 162
 163   /* Name of the import library to generate.  */
 164   char *out_implib_filename;
 165
 166   /* If TRUE we'll just print the default output on stdout.  */
 167   bfd_boolean print_output_format;
 168
 169   /* If set, display the target memory usage (per memory region).  */
 170   bfd_boolean print_memory_usage;
 171
 172   /* Should we force section groups to be resolved?  Controlled with
 173      --force-group-allocation on the command line or FORCE_GROUP_ALLOCATION
 174      in the linker script.  */
 175   bfd_boolean force_group_allocation;
 176
 177   /* Big or little endian as set on command line.  */
 178   enum endian_enum endian;
 179
 180   /* -Bsymbolic and -Bsymbolic-functions, as set on command line.  */
 181   enum symbolic_enum symbolic;
 182
 183   /* --dynamic-list, --dynamic-list-cpp-new, --dynamic-list-cpp-typeinfo
 184      and --dynamic-list FILE, as set on command line.  */
 185   enum dynamic_list_enum dynamic_list;
 186
 187   /* Name of runtime interpreter to invoke.  */
 188   char *interpreter;
 189
 190   /* Name to give runtime library from the -soname argument.  */
 191   char *soname;
 192
 193   /* Runtime library search path from the -rpath argument.  */
 194   char *rpath;
 195
 196   /* Link time runtime library search path from the -rpath-link
 197      argument.  */
 198   char *rpath_link;
 199
 200   /* Name of shared object whose symbol table should be filtered with
 201      this shared object.  From the --filter option.  */
 202   char *filter_shlib;
 203
 204   /* Name of shared object for whose symbol table this shared object
 205      is an auxiliary filter.  From the --auxiliary option.  */
 206   char **auxiliary_filters;
 207
 208   /* A version symbol to be applied to the symbol names found in the
 209      .exports sections.  */
 210   char *version_exports_section;
 211
 212   /* Default linker script.  */
 213   char *default_script;
 214 } args_type;
 215
 216 extern args_type command_line;
 217
 218 typedef int token_code_type;
 219
 220 /* Different ways we can handle orphan sections.  */
 221
 222 enum orphan_handling_enum
 223 {
 224   /* The classic strategy, find a suitable section to place the orphan
 225      into.  */
 226   orphan_handling_place = 0,
 227
 228   /* Discard any orphan sections as though they were assign to the section
 229      /DISCARD/.  */
 230   orphan_handling_discard,
 231
 232   /* Find somewhere to place the orphan section, as with
 233      ORPHAN_HANDLING_PLACE, but also issue a warning.  */
 234   orphan_handling_warn,
 235
 236   /* Issue a fatal error if any orphan sections are found.  */
 237   orphan_handling_error,
 238 };
 239
 240 typedef struct
 241 {
 242   bfd_boolean magic_demand_paged;
 243   bfd_boolean make_executable;
 244
 245   /* If TRUE, -shared is supported.  */
 246   /* ??? A better way to do this is perhaps to define this in the
 247      ld_emulation_xfer_struct since this is really a target dependent
 248      parameter.  */
 249   bfd_boolean has_shared;
 250
 251   /* If TRUE, build constructors.  */
 252   bfd_boolean build_constructors;
 253
 254   /* If TRUE, warn about any constructors.  */
 255   bfd_boolean warn_constructors;
 256
 257   /* If TRUE, warn about merging common symbols with others.  */
 258   bfd_boolean warn_common;
 259
 260   /* If TRUE, only warn once about a particular undefined symbol.  */
 261   bfd_boolean warn_once;
 262
 263   /* How should we deal with orphan sections.  */
 264   enum orphan_handling_enum orphan_handling;
 265
 266   /* If TRUE, warn if multiple global-pointers are needed (Alpha
 267      only).  */
 268   bfd_boolean warn_multiple_gp;
 269
 270   /* If TRUE, warn if the starting address of an output section
 271      changes due to the alignment of an input section.  */
 272   bfd_boolean warn_section_align;
 273
 274   /* If TRUE, warning messages are fatal */
 275   bfd_boolean fatal_warnings;
 276
 277   sort_order sort_common;
 278
 279   bfd_boolean text_read_only;
 280
 281   bfd_boolean stats;
 282
 283   /* If set, orphan input sections will be mapped to separate output
 284      sections.  */
 285   bfd_boolean unique_orphan_sections;
 286
 287   /* If set, only search library directories explicitly selected
 288      on the command line.  */
 289   bfd_boolean only_cmd_line_lib_dirs;
 290
 291   /* If set, numbers and absolute symbols are simply treated as
 292      numbers everywhere.  */
 293   bfd_boolean sane_expr;
 294
 295   /* If set, code and non-code sections should never be in one segment.  */
 296   bfd_boolean separate_code;
 297
 298   /* The rpath separation character.  Usually ':'.  */
 299   char rpath_separator;
 300
 301   char *map_filename;
 302   FILE *map_file;
 303
 304   unsigned int split_by_reloc;
 305   bfd_size_type split_by_file;
 306
 307   /* The size of the hash table to use.  */
 308   unsigned long hash_table_size;
 309
 310   /* The maximum page size for ELF.  */
 311   bfd_vma maxpagesize;
 312
 313   /* The common page size for ELF.  */
 314   bfd_vma commonpagesize;
 315 } ld_config_type;
 316
 317 extern ld_config_type config;
 318
 319 extern FILE * saved_script_handle;
 320 extern bfd_boolean force_make_executable;
 321
 322 extern int yyparse (void);
 323 extern void add_cref (const char *, bfd *, asection *, bfd_vma);
 324 extern bfd_boolean handle_asneeded_cref (bfd *, enum notice_asneeded_action);
 325 extern void output_cref (FILE *);
 326 extern void check_nocrossrefs (void);
 327 extern void ld_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
 328
 329 /* If gcc >= 2.6, we can give a function name, too.  */
 330 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 331 #define __PRETTY_FUNCTION__  NULL
 332 #endif
 333
 334 #undef abort
 335 #define abort() ld_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 336
 337 #endif