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