ld/ld.h

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