1 /* plugin-api.h -- External linker plugin API. */
3 /* Copyright 2009 Free Software Foundation, Inc.
4 Written by Cary Coutant <ccoutant@google.com>.
6 This file is part of binutils.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 MA 02110-1301, USA. */
23 /* This file defines the interface for writing a linker plugin, which is
24 described at < http://gcc.gnu.org/wiki/whopr/driver >. */
30 #include <sys/types.h>
37 /* Status code returned by most API routines. */
42 LDPS_NO_SYMS
, /* Attempt to get symbols that haven't been added. */
43 LDPS_BAD_HANDLE
, /* No claimed object associated with given handle. */
45 /* Additional Error codes TBD. */
48 /* The version of the API specification. */
50 enum ld_plugin_api_version
52 LD_PLUGIN_API_VERSION
= 1
55 /* The type of output file being generated by the linker. */
57 enum ld_plugin_output_file_type
64 /* An input file managed by the plugin library. */
66 struct ld_plugin_input_file
75 /* A symbol belonging to an input file managed by the plugin library. */
77 struct ld_plugin_symbol
88 /* Whether the symbol is a definition, reference, or common, weak or not. */
90 enum ld_plugin_symbol_kind
99 /* The visibility of the symbol. */
101 enum ld_plugin_symbol_visibility
109 /* How a symbol is resolved. */
111 enum ld_plugin_symbol_resolution
115 /* Symbol is still undefined at this point. */
118 /* This is the prevailing definition of the symbol, with references from
119 regular object code. */
122 /* This is the prevailing definition of the symbol, with no
123 references from regular objects. It is only referenced from IR
125 LDPR_PREVAILING_DEF_IRONLY
,
127 /* This definition was pre-empted by a definition in a regular
131 /* This definition was pre-empted by a definition in another IR file. */
134 /* This symbol was resolved by a definition in another IR file. */
137 /* This symbol was resolved by a definition in a regular object
138 linked into the main executable. */
141 /* This symbol was resolved by a definition in a shared object. */
145 /* The plugin library's "claim file" handler. */
148 enum ld_plugin_status
149 (*ld_plugin_claim_file_handler
) (
150 const struct ld_plugin_input_file
*file
, int *claimed
);
152 /* The plugin library's "all symbols read" handler. */
155 enum ld_plugin_status
156 (*ld_plugin_all_symbols_read_handler
) (void);
158 /* The plugin library's cleanup handler. */
161 enum ld_plugin_status
162 (*ld_plugin_cleanup_handler
) (void);
164 /* The linker's interface for registering the "claim file" handler. */
167 enum ld_plugin_status
168 (*ld_plugin_register_claim_file
) (ld_plugin_claim_file_handler handler
);
170 /* The linker's interface for registering the "all symbols read" handler. */
173 enum ld_plugin_status
174 (*ld_plugin_register_all_symbols_read
) (
175 ld_plugin_all_symbols_read_handler handler
);
177 /* The linker's interface for registering the cleanup handler. */
180 enum ld_plugin_status
181 (*ld_plugin_register_cleanup
) (ld_plugin_cleanup_handler handler
);
183 /* The linker's interface for adding symbols from a claimed input file. */
186 enum ld_plugin_status
187 (*ld_plugin_add_symbols
) (void *handle
, int nsyms
,
188 const struct ld_plugin_symbol
*syms
);
190 /* The linker's interface for getting the input file information with
191 an open (possibly re-opened) file descriptor. */
194 enum ld_plugin_status
195 (*ld_plugin_get_input_file
) (const void *handle
,
196 struct ld_plugin_input_file
*file
);
198 /* The linker's interface for releasing the input file. */
201 enum ld_plugin_status
202 (*ld_plugin_release_input_file
) (const void *handle
);
204 /* The linker's interface for retrieving symbol resolution information. */
207 enum ld_plugin_status
208 (*ld_plugin_get_symbols
) (const void *handle
, int nsyms
,
209 struct ld_plugin_symbol
*syms
);
211 /* The linker's interface for adding a compiled input file. */
214 enum ld_plugin_status
215 (*ld_plugin_add_input_file
) (char *pathname
);
217 /* The linker's interface for adding a library that should be searched. */
220 enum ld_plugin_status
221 (*ld_plugin_add_input_library
) (char *libname
);
223 /* The linker's interface for issuing a warning or error message. */
226 enum ld_plugin_status
227 (*ld_plugin_message
) (int level
, const char *format
, ...);
237 /* Values for the tv_tag field of the transfer vector. */
246 LDPT_REGISTER_CLAIM_FILE_HOOK
,
247 LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK
,
248 LDPT_REGISTER_CLEANUP_HOOK
,
254 LDPT_RELEASE_INPUT_FILE
,
255 LDPT_ADD_INPUT_LIBRARY
258 /* The plugin transfer vector. */
262 enum ld_plugin_tag tv_tag
;
266 const char *tv_string
;
267 ld_plugin_register_claim_file tv_register_claim_file
;
268 ld_plugin_register_all_symbols_read tv_register_all_symbols_read
;
269 ld_plugin_register_cleanup tv_register_cleanup
;
270 ld_plugin_add_symbols tv_add_symbols
;
271 ld_plugin_get_symbols tv_get_symbols
;
272 ld_plugin_add_input_file tv_add_input_file
;
273 ld_plugin_message tv_message
;
274 ld_plugin_get_input_file tv_get_input_file
;
275 ld_plugin_release_input_file tv_release_input_file
;
276 ld_plugin_add_input_library tv_add_input_library
;
280 /* The plugin library's "onload" entry point. */
283 enum ld_plugin_status
284 (*ld_plugin_onload
) (struct ld_plugin_tv
*tv
);
290 #endif /* !defined(PLUGIN_API_H) */