freebsd-dev/sys/kern/linker_if.m
Stacey Son 00a5db46de Add the ksyms(4) pseudo driver. The ksyms driver allows a process to
get a quick snapshot of the kernel's symbol table including the symbols
from any loaded modules (the symbols are all merged into one symbol
table).  Unlike like other implementations, this ksyms driver maps
memory in the process memory space to store the snapshot at the time
/dev/ksyms is opened.  It also checks to see if the process has already
a snapshot open and won't allow it to open /dev/ksyms it again until it
closes first.  This prevents kernel and process memory from being
exhausted.  Note that /dev/ksyms is used by the lockstat(1) command.

Reviewed by:	gallatin kib (freebsd-arch)
Approved by:	gnn (mentor)
2009-05-26 21:39:09 +00:00

146 lines
4.0 KiB
Objective-C

#-
# Copyright (c) 2000 Doug Rabson
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# $FreeBSD$
#
#include <sys/linker.h>
INTERFACE linker;
#
# Lookup a symbol in the file's symbol table. If the symbol is not
# found then return ENOENT, otherwise zero.
#
METHOD int lookup_symbol {
linker_file_t file;
const char* name;
c_linker_sym_t* symp;
};
METHOD int symbol_values {
linker_file_t file;
c_linker_sym_t sym;
linker_symval_t* valp;
};
METHOD int search_symbol {
linker_file_t file;
caddr_t value;
c_linker_sym_t* symp;
long* diffp;
};
#
# Call the callback with each specified function defined in the file.
# Stop and return the error if the callback returns an error.
#
METHOD int each_function_name {
linker_file_t file;
linker_function_name_callback_t callback;
void* opaque;
};
#
# Call the callback with each specified function and it's value
# defined in the file.
# Stop and return the error if the callback returns an error.
#
METHOD int each_function_nameval {
linker_file_t file;
linker_function_nameval_callback_t callback;
void* opaque;
};
#
# Search for a linker set in a file. Return a pointer to the first
# entry (which is itself a pointer), and the number of entries.
# "stop" points to the entry beyond the last valid entry.
# If count, start or stop are NULL, they are not returned.
#
METHOD int lookup_set {
linker_file_t file;
const char* name;
void*** start;
void*** stop;
int* count;
};
#
# Unload a file, releasing dependancies and freeing storage.
#
METHOD void unload {
linker_file_t file;
};
#
# Load CTF data if necessary and if there is a .SUNW_ctf section
# in the ELF file, returning info in the linker CTF structure.
#
METHOD int ctf_get {
linker_file_t file;
linker_ctf_t *lc;
};
#
# Get the symbol table, returning it in **symtab. Return the
# number of symbols, otherwise zero.
#
METHOD long symtab_get {
linker_file_t file;
Elf_Sym **symtab;
};
#
# Get the string table, returning it in *strtab. Return the
# size (in bytes) of the string table, otherwise zero.
#
METHOD long strtab_get {
linker_file_t file;
caddr_t *strtab;
};
#
# Load a file, returning the new linker_file_t in *result. If
# the class does not recognise the file type, zero should be
# returned, without modifying *result. If the file is
# recognised, the file should be loaded, *result set to the new
# file and zero returned. If some other error is detected an
# appropriate errno should be returned.
#
STATICMETHOD int load_file {
linker_class_t cls;
const char* filename;
linker_file_t* result;
};
STATICMETHOD int link_preload {
linker_class_t cls;
const char* filename;
linker_file_t* result;
};
METHOD int link_preload_finish {
linker_file_t file;
};