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