1/* ld-emul.h - Linker emulation 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 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_allocation
38  (void);
39extern void ldemul_before_allocation
40  (void);
41extern void ldemul_set_output_arch
42  (void);
43extern char *ldemul_choose_target
44  (int, char**);
45extern void ldemul_choose_mode
46  (char *);
47extern void ldemul_list_emulations
48  (FILE *);
49extern void ldemul_list_emulation_options
50  (FILE *);
51extern char *ldemul_get_script
52  (int *isfile);
53extern void ldemul_finish
54  (void);
55extern void ldemul_set_symbols
56  (void);
57extern void ldemul_create_output_section_statements
58  (void);
59extern lang_output_section_statement_type *ldemul_place_orphan
60  (asection *, const char *, int);
61extern bfd_boolean ldemul_parse_args
62  (int, char **);
63extern void ldemul_add_options
64  (int, char **, int, struct option **, int, struct option **);
65extern bfd_boolean ldemul_handle_option
66  (int);
67extern bfd_boolean ldemul_unrecognized_file
68  (struct lang_input_statement_struct *);
69extern bfd_boolean ldemul_recognized_file
70  (struct lang_input_statement_struct *);
71extern bfd_boolean ldemul_open_dynamic_archive
72  (const char *, struct search_dirs *, struct lang_input_statement_struct *);
73extern char *ldemul_default_target
74  (int, char**);
75extern void after_parse_default
76  (void);
77extern void after_open_default
78  (void);
79extern void after_allocation_default
80  (void);
81extern void before_allocation_default
82  (void);
83extern void finish_default
84  (void);
85extern void finish_default
86  (void);
87extern void set_output_arch_default
88  (void);
89extern void syslib_default
90  (char*);
91extern void hll_default
92  (char*);
93extern int  ldemul_find_potential_libraries
94  (char *, struct lang_input_statement_struct *);
95extern struct bfd_elf_version_expr *ldemul_new_vers_pattern
96  (struct bfd_elf_version_expr *);
97extern void ldemul_extra_map_file_text
98  (bfd *, struct bfd_link_info *, FILE *);
99
100typedef struct ld_emulation_xfer_struct {
101  /* Run before parsing the command line and script file.
102     Set the architecture, maybe other things.  */
103  void   (*before_parse) (void);
104
105  /* Handle the SYSLIB (low level library) script command.  */
106  void   (*syslib) (char *);
107
108  /* Handle the HLL (high level library) script command.  */
109  void   (*hll) (char *);
110
111  /* Run after parsing the command line and script file.  */
112  void   (*after_parse) (void);
113
114  /* Run after opening all input files, and loading the symbols.  */
115  void   (*after_open) (void);
116
117  /* Run after allocating output sections.  */
118  void   (*after_allocation)  (void);
119
120  /* Set the output architecture and machine if possible.  */
121  void   (*set_output_arch) (void);
122
123  /* Decide which target name to use.  */
124  char * (*choose_target) (int, char**);
125
126  /* Run before allocating output sections.  */
127  void   (*before_allocation) (void);
128
129  /* Return the appropriate linker script.  */
130  char * (*get_script) (int *isfile);
131
132  /* The name of this emulation.  */
133  char *emulation_name;
134
135  /* The output format.  */
136  char *target_name;
137
138  /* Run after assigning values from the script.  */
139  void	(*finish) (void);
140
141  /* Create any output sections needed by the target.  */
142  void	(*create_output_section_statements) (void);
143
144  /* Try to open a dynamic library.  ARCH is an architecture name, and
145     is normally the empty string.  ENTRY is the lang_input_statement
146     that should be opened.  */
147  bfd_boolean (*open_dynamic_archive)
148    (const char *arch, struct search_dirs *,
149     struct lang_input_statement_struct *entry);
150
151  /* Place an orphan section.  Return TRUE if it was placed, FALSE if
152     the default action should be taken.  This field may be NULL, in
153     which case the default action will always be taken.  */
154  lang_output_section_statement_type *(*place_orphan)
155    (asection *, const char *, int);
156
157  /* Run after assigning parsing with the args, but before
158     reading the script.  Used to initialize symbols used in the script.  */
159  void	(*set_symbols) (void);
160
161  /* Parse args which the base linker doesn't understand.
162     Return TRUE if the arg needs no further processing.  */
163  bfd_boolean (*parse_args) (int, char **);
164
165  /* Hook to add options to parameters passed by the base linker to
166     getopt_long and getopt_long_only calls.  */
167  void (*add_options)
168    (int, char **, int, struct option **, int, struct option **);
169
170  /* Companion to the above to handle an option.  Returns TRUE if it is
171     one of our options.  */
172  bfd_boolean (*handle_option) (int);
173
174  /* Run to handle files which are not recognized as object files or
175     archives.  Return TRUE if the file was handled.  */
176  bfd_boolean (*unrecognized_file)
177    (struct lang_input_statement_struct *);
178
179  /* Run to list the command line options which parse_args handles.  */
180  void (* list_options) (FILE *);
181
182  /* Run to specially handle files which *are* recognized as object
183     files or archives.  Return TRUE if the file was handled.  */
184  bfd_boolean (*recognized_file)
185    (struct lang_input_statement_struct *);
186
187  /* Called when looking for libraries in a directory specified
188     via a linker command line option or linker script option.
189     Files that match the pattern "lib*.a" have already been scanned.
190     (For VMS files matching ":lib*.a" have also been scanned).  */
191  int (* find_potential_libraries)
192    (char *, struct lang_input_statement_struct *);
193
194  /* Called when adding a new version pattern.  PowerPC64-ELF uses
195     this hook to add a pattern matching ".foo" for every "foo".  */
196  struct bfd_elf_version_expr * (*new_vers_pattern)
197    (struct bfd_elf_version_expr *);
198
199  /* Called when printing the map file, in case there are
200     emulation-specific sections for it.  */
201  void (*extra_map_file_text)
202    (bfd *, struct bfd_link_info *, FILE *);
203
204} ld_emulation_xfer_type;
205
206typedef enum {
207  intel_ic960_ld_mode_enum,
208  default_mode_enum,
209  intel_gld960_ld_mode_enum
210} lang_emulation_mode_enum_type;
211
212extern ld_emulation_xfer_type *ld_emulations[];
213
214#endif
215