ld/ldemul.h

   1 /* ld-emul.h - Linker emulation header file
   2    Copyright (C) 1991-2020 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 LDEMUL_H
  22 #define LDEMUL_H
  23
  24 /* Forward declaration for ldemul_add_options() and others.  */
  25 struct option;
  26
  27 extern void ldemul_hll
  28   (char *);
  29 extern void ldemul_syslib
  30   (char *);
  31 extern void ldemul_after_parse
  32   (void);
  33 extern void ldemul_before_parse
  34   (void);
  35 extern void ldemul_after_open
  36   (void);
  37 extern void ldemul_after_check_relocs
  38   (void);
  39 extern void ldemul_before_place_orphans
  40   (void);
  41 extern void ldemul_after_allocation
  42   (void);
  43 extern void ldemul_before_allocation
  44   (void);
  45 extern void ldemul_set_output_arch
  46   (void);
  47 extern char *ldemul_choose_target
  48   (int, char**);
  49 extern void ldemul_choose_mode
  50   (char *);
  51 extern void ldemul_list_emulations
  52   (FILE *);
  53 extern void ldemul_list_emulation_options
  54   (FILE *);
  55 extern char *ldemul_get_script
  56   (int *isfile);
  57 extern void ldemul_finish
  58   (void);
  59 extern void ldemul_set_symbols
  60   (void);
  61 extern void ldemul_create_output_section_statements
  62   (void);
  63 extern lang_output_section_statement_type *ldemul_place_orphan
  64   (asection *, const char *, int);
  65 extern bfd_boolean ldemul_parse_args
  66   (int, char **);
  67 extern void ldemul_add_options
  68   (int, char **, int, struct option **, int, struct option **);
  69 extern bfd_boolean ldemul_handle_option
  70   (int);
  71 extern bfd_boolean ldemul_unrecognized_file
  72   (struct lang_input_statement_struct *);
  73 extern bfd_boolean ldemul_recognized_file
  74   (struct lang_input_statement_struct *);
  75 extern bfd_boolean ldemul_open_dynamic_archive
  76   (const char *, struct search_dirs *, struct lang_input_statement_struct *);
  77 extern char *ldemul_default_target
  78   (int, char**);
  79 extern void after_parse_default
  80   (void);
  81 extern void after_open_default
  82   (void);
  83 extern void after_check_relocs_default
  84   (void);
  85 extern void before_place_orphans_default
  86   (void);
  87 extern void after_allocation_default
  88   (void);
  89 extern void before_allocation_default
  90   (void);
  91 extern void finish_default
  92   (void);
  93 extern void finish_default
  94   (void);
  95 extern void set_output_arch_default
  96   (void);
  97 extern void syslib_default
  98   (char*);
  99 extern void hll_default
 100   (char*);
 101 extern int  ldemul_find_potential_libraries
 102   (char *, struct lang_input_statement_struct *);
 103 extern struct bfd_elf_version_expr *ldemul_new_vers_pattern
 104   (struct bfd_elf_version_expr *);
 105 extern void ldemul_extra_map_file_text
 106   (bfd *, struct bfd_link_info *, FILE *);
 107 /* Return 1 if we are emitting CTF early, and 0 if ldemul_examine_strtab_for_ctf
 108    will be called by the target.  */
 109 extern int ldemul_emit_ctf_early
 110   (void);
 111 /* Called from per-target code to examine the strtab and symtab.  */
 112 extern void ldemul_examine_strtab_for_ctf
 113   (struct ctf_file *, struct elf_sym_strtab *, bfd_size_type,
 114    struct elf_strtab_hash *);
 115
 116 typedef struct ld_emulation_xfer_struct {
 117   /* Run before parsing the command line and script file.
 118      Set the architecture, maybe other things.  */
 119   void   (*before_parse) (void);
 120
 121   /* Handle the SYSLIB (low level library) script command.  */
 122   void   (*syslib) (char *);
 123
 124   /* Handle the HLL (high level library) script command.  */
 125   void   (*hll) (char *);
 126
 127   /* Run after parsing the command line and script file.  */
 128   void   (*after_parse) (void);
 129
 130   /* Run after opening all input files, and loading the symbols.  */
 131   void   (*after_open) (void);
 132
 133   /* Run after checking relocations.  */
 134   void   (*after_check_relocs)  (void);
 135
 136   /* Run before placing orphans.  */
 137   void   (*before_place_orphans)  (void);
 138
 139   /* Run after allocating output sections.  */
 140   void   (*after_allocation)  (void);
 141
 142   /* Set the output architecture and machine if possible.  */
 143   void   (*set_output_arch) (void);
 144
 145   /* Decide which target name to use.  */
 146   char * (*choose_target) (int, char**);
 147
 148   /* Run before allocating output sections.  */
 149   void   (*before_allocation) (void);
 150
 151   /* Return the appropriate linker script.  */
 152   char * (*get_script) (int *isfile);
 153
 154   /* The name of this emulation.  */
 155   char *emulation_name;
 156
 157   /* The output format.  */
 158   char *target_name;
 159
 160   /* Run after assigning values from the script.  */
 161   void  (*finish) (void);
 162
 163   /* Create any output sections needed by the target.  */
 164   void  (*create_output_section_statements) (void);
 165
 166   /* Try to open a dynamic library.  ARCH is an architecture name, and
 167      is normally the empty string.  ENTRY is the lang_input_statement
 168      that should be opened.  */
 169   bfd_boolean (*open_dynamic_archive)
 170     (const char *arch, struct search_dirs *,
 171      struct lang_input_statement_struct *entry);
 172
 173   /* Place an orphan section.  Return TRUE if it was placed, FALSE if
 174      the default action should be taken.  This field may be NULL, in
 175      which case the default action will always be taken.  */
 176   lang_output_section_statement_type *(*place_orphan)
 177     (asection *, const char *, int);
 178
 179   /* Run after assigning parsing with the args, but before
 180      reading the script.  Used to initialize symbols used in the script.  */
 181   void  (*set_symbols) (void);
 182
 183   /* Parse args which the base linker doesn't understand.
 184      Return TRUE if the arg needs no further processing.  */
 185   bfd_boolean (*parse_args) (int, char **);
 186
 187   /* Hook to add options to parameters passed by the base linker to
 188      getopt_long and getopt_long_only calls.  */
 189   void (*add_options)
 190     (int, char **, int, struct option **, int, struct option **);
 191
 192   /* Companion to the above to handle an option.  Returns TRUE if it is
 193      one of our options.  */
 194   bfd_boolean (*handle_option) (int);
 195
 196   /* Run to handle files which are not recognized as object files or
 197      archives.  Return TRUE if the file was handled.  */
 198   bfd_boolean (*unrecognized_file)
 199     (struct lang_input_statement_struct *);
 200
 201   /* Run to list the command line options which parse_args handles.  */
 202   void (* list_options) (FILE *);
 203
 204   /* Run to specially handle files which *are* recognized as object
 205      files or archives.  Return TRUE if the file was handled.  */
 206   bfd_boolean (*recognized_file)
 207     (struct lang_input_statement_struct *);
 208
 209   /* Called when looking for libraries in a directory specified
 210      via a linker command line option or linker script option.
 211      Files that match the pattern "lib*.a" have already been scanned.
 212      (For VMS files matching ":lib*.a" have also been scanned).  */
 213   int (* find_potential_libraries)
 214     (char *, struct lang_input_statement_struct *);
 215
 216   /* Called when adding a new version pattern.  PowerPC64-ELF uses
 217      this hook to add a pattern matching ".foo" for every "foo".  */
 218   struct bfd_elf_version_expr * (*new_vers_pattern)
 219     (struct bfd_elf_version_expr *);
 220
 221   /* Called when printing the map file, in case there are
 222      emulation-specific sections for it.  */
 223   void (*extra_map_file_text)
 224     (bfd *, struct bfd_link_info *, FILE *);
 225
 226   /* If this returns true, we emit CTF as early as possible: if false, we emit
 227      CTF once the strtab and symtab are laid out.  */
 228   int (*emit_ctf_early)
 229     (void);
 230
 231   /* Called to examine the string and symbol table late enough in linking that
 232      they are finally laid out.  If emit_ctf_early returns true, this is not
 233      called and ldemul_maybe_emit_ctf() emits CTF in 'early' mode: otherwise, it
 234      waits until 'late'. (Late mode needs explicit support at per-target link
 235      time to get called at all).  If set, called by ld when the examine_strtab
 236      bfd_link_callback is invoked by per-target code.  */
 237   void (*examine_strtab_for_ctf) (struct ctf_file *, struct elf_sym_strtab *,
 238                                   bfd_size_type, struct elf_strtab_hash *);
 239 } ld_emulation_xfer_type;
 240
 241 typedef enum {
 242   intel_ic960_ld_mode_enum,
 243   default_mode_enum,
 244   intel_gld960_ld_mode_enum
 245 } lang_emulation_mode_enum_type;
 246
 247 extern ld_emulation_xfer_type *ld_emulations[];
 248
 249 #endif