/* plugin-api.h -- External linker plugin API. */
|
/* plugin-api.h -- External linker plugin API. */
|
|
|
/* Copyright 2009 Free Software Foundation, Inc.
|
/* Copyright 2009 Free Software Foundation, Inc.
|
Written by Cary Coutant <ccoutant@google.com>.
|
Written by Cary Coutant <ccoutant@google.com>.
|
|
|
This file is part of binutils.
|
This file is part of binutils.
|
|
|
This program is free software; you can redistribute it and/or modify
|
This program is free software; you can redistribute it and/or modify
|
it under the terms of the GNU General Public License as published by
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation; either version 3 of the License, or
|
the Free Software Foundation; either version 3 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program; if not, write to the Free Software
|
along with this program; if not, write to the Free Software
|
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
|
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
|
MA 02110-1301, USA. */
|
MA 02110-1301, USA. */
|
|
|
/* This file defines the interface for writing a linker plugin, which is
|
/* This file defines the interface for writing a linker plugin, which is
|
described at < http://gcc.gnu.org/wiki/whopr/driver >. */
|
described at < http://gcc.gnu.org/wiki/whopr/driver >. */
|
|
|
#ifndef PLUGIN_API_H
|
#ifndef PLUGIN_API_H
|
#define PLUGIN_API_H
|
#define PLUGIN_API_H
|
|
|
#ifdef HAVE_STDINT_H
|
#ifdef HAVE_STDINT_H
|
#include <stdint.h>
|
#include <stdint.h>
|
#elif defined(HAVE_INTTYPES_H)
|
#elif defined(HAVE_INTTYPES_H)
|
#include <inttypes.h>
|
#include <inttypes.h>
|
#endif
|
#endif
|
#include <sys/types.h>
|
#include <sys/types.h>
|
#if !defined(HAVE_STDINT_H) && !defined(HAVE_INTTYPES_H) && \
|
#if !defined(HAVE_STDINT_H) && !defined(HAVE_INTTYPES_H) && \
|
!defined(UINT64_MAX) && !defined(uint64_t)
|
!defined(UINT64_MAX) && !defined(uint64_t)
|
#error can not find uint64_t type
|
#error can not find uint64_t type
|
#endif
|
#endif
|
|
|
#ifdef __cplusplus
|
#ifdef __cplusplus
|
extern "C"
|
extern "C"
|
{
|
{
|
#endif
|
#endif
|
|
|
/* Status code returned by most API routines. */
|
/* Status code returned by most API routines. */
|
|
|
enum ld_plugin_status
|
enum ld_plugin_status
|
{
|
{
|
LDPS_OK = 0,
|
LDPS_OK = 0,
|
LDPS_NO_SYMS, /* Attempt to get symbols that haven't been added. */
|
LDPS_NO_SYMS, /* Attempt to get symbols that haven't been added. */
|
LDPS_BAD_HANDLE, /* No claimed object associated with given handle. */
|
LDPS_BAD_HANDLE, /* No claimed object associated with given handle. */
|
LDPS_ERR
|
LDPS_ERR
|
/* Additional Error codes TBD. */
|
/* Additional Error codes TBD. */
|
};
|
};
|
|
|
/* The version of the API specification. */
|
/* The version of the API specification. */
|
|
|
enum ld_plugin_api_version
|
enum ld_plugin_api_version
|
{
|
{
|
LD_PLUGIN_API_VERSION = 1
|
LD_PLUGIN_API_VERSION = 1
|
};
|
};
|
|
|
/* The type of output file being generated by the linker. */
|
/* The type of output file being generated by the linker. */
|
|
|
enum ld_plugin_output_file_type
|
enum ld_plugin_output_file_type
|
{
|
{
|
LDPO_REL,
|
LDPO_REL,
|
LDPO_EXEC,
|
LDPO_EXEC,
|
LDPO_DYN
|
LDPO_DYN
|
};
|
};
|
|
|
/* An input file managed by the plugin library. */
|
/* An input file managed by the plugin library. */
|
|
|
struct ld_plugin_input_file
|
struct ld_plugin_input_file
|
{
|
{
|
const char *name;
|
const char *name;
|
int fd;
|
int fd;
|
off_t offset;
|
off_t offset;
|
off_t filesize;
|
off_t filesize;
|
void *handle;
|
void *handle;
|
};
|
};
|
|
|
/* A symbol belonging to an input file managed by the plugin library. */
|
/* A symbol belonging to an input file managed by the plugin library. */
|
|
|
struct ld_plugin_symbol
|
struct ld_plugin_symbol
|
{
|
{
|
char *name;
|
char *name;
|
char *version;
|
char *version;
|
int def;
|
int def;
|
int visibility;
|
int visibility;
|
uint64_t size;
|
uint64_t size;
|
char *comdat_key;
|
char *comdat_key;
|
int resolution;
|
int resolution;
|
};
|
};
|
|
|
/* Whether the symbol is a definition, reference, or common, weak or not. */
|
/* Whether the symbol is a definition, reference, or common, weak or not. */
|
|
|
enum ld_plugin_symbol_kind
|
enum ld_plugin_symbol_kind
|
{
|
{
|
LDPK_DEF,
|
LDPK_DEF,
|
LDPK_WEAKDEF,
|
LDPK_WEAKDEF,
|
LDPK_UNDEF,
|
LDPK_UNDEF,
|
LDPK_WEAKUNDEF,
|
LDPK_WEAKUNDEF,
|
LDPK_COMMON
|
LDPK_COMMON
|
};
|
};
|
|
|
/* The visibility of the symbol. */
|
/* The visibility of the symbol. */
|
|
|
enum ld_plugin_symbol_visibility
|
enum ld_plugin_symbol_visibility
|
{
|
{
|
LDPV_DEFAULT,
|
LDPV_DEFAULT,
|
LDPV_PROTECTED,
|
LDPV_PROTECTED,
|
LDPV_INTERNAL,
|
LDPV_INTERNAL,
|
LDPV_HIDDEN
|
LDPV_HIDDEN
|
};
|
};
|
|
|
/* How a symbol is resolved. */
|
/* How a symbol is resolved. */
|
|
|
enum ld_plugin_symbol_resolution
|
enum ld_plugin_symbol_resolution
|
{
|
{
|
LDPR_UNKNOWN = 0,
|
LDPR_UNKNOWN = 0,
|
|
|
/* Symbol is still undefined at this point. */
|
/* Symbol is still undefined at this point. */
|
LDPR_UNDEF,
|
LDPR_UNDEF,
|
|
|
/* This is the prevailing definition of the symbol, with references from
|
/* This is the prevailing definition of the symbol, with references from
|
regular object code. */
|
regular object code. */
|
LDPR_PREVAILING_DEF,
|
LDPR_PREVAILING_DEF,
|
|
|
/* This is the prevailing definition of the symbol, with no
|
/* This is the prevailing definition of the symbol, with no
|
references from regular objects. It is only referenced from IR
|
references from regular objects. It is only referenced from IR
|
code. */
|
code. */
|
LDPR_PREVAILING_DEF_IRONLY,
|
LDPR_PREVAILING_DEF_IRONLY,
|
|
|
/* This definition was pre-empted by a definition in a regular
|
/* This definition was pre-empted by a definition in a regular
|
object file. */
|
object file. */
|
LDPR_PREEMPTED_REG,
|
LDPR_PREEMPTED_REG,
|
|
|
/* This definition was pre-empted by a definition in another IR file. */
|
/* This definition was pre-empted by a definition in another IR file. */
|
LDPR_PREEMPTED_IR,
|
LDPR_PREEMPTED_IR,
|
|
|
/* This symbol was resolved by a definition in another IR file. */
|
/* This symbol was resolved by a definition in another IR file. */
|
LDPR_RESOLVED_IR,
|
LDPR_RESOLVED_IR,
|
|
|
/* This symbol was resolved by a definition in a regular object
|
/* This symbol was resolved by a definition in a regular object
|
linked into the main executable. */
|
linked into the main executable. */
|
LDPR_RESOLVED_EXEC,
|
LDPR_RESOLVED_EXEC,
|
|
|
/* This symbol was resolved by a definition in a shared object. */
|
/* This symbol was resolved by a definition in a shared object. */
|
LDPR_RESOLVED_DYN
|
LDPR_RESOLVED_DYN
|
};
|
};
|
|
|
/* The plugin library's "claim file" handler. */
|
/* The plugin library's "claim file" handler. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_claim_file_handler) (
|
(*ld_plugin_claim_file_handler) (
|
const struct ld_plugin_input_file *file, int *claimed);
|
const struct ld_plugin_input_file *file, int *claimed);
|
|
|
/* The plugin library's "all symbols read" handler. */
|
/* The plugin library's "all symbols read" handler. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_all_symbols_read_handler) (void);
|
(*ld_plugin_all_symbols_read_handler) (void);
|
|
|
/* The plugin library's cleanup handler. */
|
/* The plugin library's cleanup handler. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_cleanup_handler) (void);
|
(*ld_plugin_cleanup_handler) (void);
|
|
|
/* The linker's interface for registering the "claim file" handler. */
|
/* The linker's interface for registering the "claim file" handler. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_register_claim_file) (ld_plugin_claim_file_handler handler);
|
(*ld_plugin_register_claim_file) (ld_plugin_claim_file_handler handler);
|
|
|
/* The linker's interface for registering the "all symbols read" handler. */
|
/* The linker's interface for registering the "all symbols read" handler. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_register_all_symbols_read) (
|
(*ld_plugin_register_all_symbols_read) (
|
ld_plugin_all_symbols_read_handler handler);
|
ld_plugin_all_symbols_read_handler handler);
|
|
|
/* The linker's interface for registering the cleanup handler. */
|
/* The linker's interface for registering the cleanup handler. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_register_cleanup) (ld_plugin_cleanup_handler handler);
|
(*ld_plugin_register_cleanup) (ld_plugin_cleanup_handler handler);
|
|
|
/* The linker's interface for adding symbols from a claimed input file. */
|
/* The linker's interface for adding symbols from a claimed input file. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_add_symbols) (void *handle, int nsyms,
|
(*ld_plugin_add_symbols) (void *handle, int nsyms,
|
const struct ld_plugin_symbol *syms);
|
const struct ld_plugin_symbol *syms);
|
|
|
/* The linker's interface for getting the input file information with
|
/* The linker's interface for getting the input file information with
|
an open (possibly re-opened) file descriptor. */
|
an open (possibly re-opened) file descriptor. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_get_input_file) (const void *handle,
|
(*ld_plugin_get_input_file) (const void *handle,
|
struct ld_plugin_input_file *file);
|
struct ld_plugin_input_file *file);
|
|
|
/* The linker's interface for releasing the input file. */
|
/* The linker's interface for releasing the input file. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_release_input_file) (const void *handle);
|
(*ld_plugin_release_input_file) (const void *handle);
|
|
|
/* The linker's interface for retrieving symbol resolution information. */
|
/* The linker's interface for retrieving symbol resolution information. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_get_symbols) (const void *handle, int nsyms,
|
(*ld_plugin_get_symbols) (const void *handle, int nsyms,
|
struct ld_plugin_symbol *syms);
|
struct ld_plugin_symbol *syms);
|
|
|
/* The linker's interface for adding a compiled input file. */
|
/* The linker's interface for adding a compiled input file. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_add_input_file) (char *pathname);
|
(*ld_plugin_add_input_file) (char *pathname);
|
|
|
/* The linker's interface for adding a library that should be searched. */
|
/* The linker's interface for adding a library that should be searched. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_add_input_library) (char *libname);
|
(*ld_plugin_add_input_library) (char *libname);
|
|
|
/* The linker's interface for issuing a warning or error message. */
|
/* The linker's interface for issuing a warning or error message. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_message) (int level, const char *format, ...);
|
(*ld_plugin_message) (int level, const char *format, ...);
|
|
|
enum ld_plugin_level
|
enum ld_plugin_level
|
{
|
{
|
LDPL_INFO,
|
LDPL_INFO,
|
LDPL_WARNING,
|
LDPL_WARNING,
|
LDPL_ERROR,
|
LDPL_ERROR,
|
LDPL_FATAL
|
LDPL_FATAL
|
};
|
};
|
|
|
/* Values for the tv_tag field of the transfer vector. */
|
/* Values for the tv_tag field of the transfer vector. */
|
|
|
enum ld_plugin_tag
|
enum ld_plugin_tag
|
{
|
{
|
LDPT_NULL = 0,
|
LDPT_NULL = 0,
|
LDPT_API_VERSION,
|
LDPT_API_VERSION,
|
LDPT_GOLD_VERSION,
|
LDPT_GOLD_VERSION,
|
LDPT_LINKER_OUTPUT,
|
LDPT_LINKER_OUTPUT,
|
LDPT_OPTION,
|
LDPT_OPTION,
|
LDPT_REGISTER_CLAIM_FILE_HOOK,
|
LDPT_REGISTER_CLAIM_FILE_HOOK,
|
LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK,
|
LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK,
|
LDPT_REGISTER_CLEANUP_HOOK,
|
LDPT_REGISTER_CLEANUP_HOOK,
|
LDPT_ADD_SYMBOLS,
|
LDPT_ADD_SYMBOLS,
|
LDPT_GET_SYMBOLS,
|
LDPT_GET_SYMBOLS,
|
LDPT_ADD_INPUT_FILE,
|
LDPT_ADD_INPUT_FILE,
|
LDPT_MESSAGE,
|
LDPT_MESSAGE,
|
LDPT_GET_INPUT_FILE,
|
LDPT_GET_INPUT_FILE,
|
LDPT_RELEASE_INPUT_FILE,
|
LDPT_RELEASE_INPUT_FILE,
|
LDPT_ADD_INPUT_LIBRARY
|
LDPT_ADD_INPUT_LIBRARY
|
};
|
};
|
|
|
/* The plugin transfer vector. */
|
/* The plugin transfer vector. */
|
|
|
struct ld_plugin_tv
|
struct ld_plugin_tv
|
{
|
{
|
enum ld_plugin_tag tv_tag;
|
enum ld_plugin_tag tv_tag;
|
union
|
union
|
{
|
{
|
int tv_val;
|
int tv_val;
|
const char *tv_string;
|
const char *tv_string;
|
ld_plugin_register_claim_file tv_register_claim_file;
|
ld_plugin_register_claim_file tv_register_claim_file;
|
ld_plugin_register_all_symbols_read tv_register_all_symbols_read;
|
ld_plugin_register_all_symbols_read tv_register_all_symbols_read;
|
ld_plugin_register_cleanup tv_register_cleanup;
|
ld_plugin_register_cleanup tv_register_cleanup;
|
ld_plugin_add_symbols tv_add_symbols;
|
ld_plugin_add_symbols tv_add_symbols;
|
ld_plugin_get_symbols tv_get_symbols;
|
ld_plugin_get_symbols tv_get_symbols;
|
ld_plugin_add_input_file tv_add_input_file;
|
ld_plugin_add_input_file tv_add_input_file;
|
ld_plugin_message tv_message;
|
ld_plugin_message tv_message;
|
ld_plugin_get_input_file tv_get_input_file;
|
ld_plugin_get_input_file tv_get_input_file;
|
ld_plugin_release_input_file tv_release_input_file;
|
ld_plugin_release_input_file tv_release_input_file;
|
ld_plugin_add_input_library tv_add_input_library;
|
ld_plugin_add_input_library tv_add_input_library;
|
} tv_u;
|
} tv_u;
|
};
|
};
|
|
|
/* The plugin library's "onload" entry point. */
|
/* The plugin library's "onload" entry point. */
|
|
|
typedef
|
typedef
|
enum ld_plugin_status
|
enum ld_plugin_status
|
(*ld_plugin_onload) (struct ld_plugin_tv *tv);
|
(*ld_plugin_onload) (struct ld_plugin_tv *tv);
|
|
|
#ifdef __cplusplus
|
#ifdef __cplusplus
|
}
|
}
|
#endif
|
#endif
|
|
|
#endif /* !defined(PLUGIN_API_H) */
|
#endif /* !defined(PLUGIN_API_H) */
|
|
|
