99 lines
3.5 KiB
Groff
99 lines
3.5 KiB
Groff
.\" $NetBSD: kvm_nlist.3,v 1.6 2002/02/07 07:00:48 ross Exp $
|
|
.\"
|
|
.\" Copyright (c) 1992, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software developed by the Computer Systems
|
|
.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
|
|
.\" BG 91-66 and contributed to Berkeley.
|
|
.\"
|
|
.\" 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.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
|
|
.\"
|
|
.\" @(#)kvm_nlist.3 8.1 (Berkeley) 6/4/93
|
|
.\"
|
|
.Dd June 4, 1993
|
|
.Dt KVM_NLIST 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm kvm_nlist
|
|
.Nd retrieve symbol table names from a kernel image
|
|
.Sh LIBRARY
|
|
.Lb libkvm
|
|
.Sh SYNOPSIS
|
|
.Fd #include \*[Lt]kvm.h\*[Gt]
|
|
.Fd #include \*[Lt]nlist.h\*[Gt]
|
|
.Ft int
|
|
.Fn kvm_nlist "kvm_t *kd" "struct nlist *nl"
|
|
.Sh DESCRIPTION
|
|
.Fn kvm_nlist
|
|
retrieves the symbol table entries indicated by the name list argument
|
|
.Fa \&nl .
|
|
This argument points to an array of nlist structures, terminated by
|
|
an entry whose n_name field is
|
|
.Dv NULL
|
|
(see
|
|
.Xr nlist 3 ) .
|
|
Each symbol is looked up using the n_name field, and if found, the
|
|
corresponding n_type and n_value fields are filled in. These fields are set
|
|
to 0 if the symbol is not found.
|
|
.Pp
|
|
The program
|
|
.Xr kvm_mkdb 8
|
|
builds a database from a kernel's namelist. If
|
|
.Fa \&kd
|
|
was created by a call to
|
|
.Fn kvm_open
|
|
with a
|
|
.Dv NULL
|
|
executable image name and
|
|
the database matches the running kernel,
|
|
.Fn kvm_nlist
|
|
will use the database to speed lookups.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn kvm_nlist
|
|
function returns the number of invalid entries found.
|
|
If the kernel symbol table was unreadable, -1 is returned.
|
|
.Sh FILES
|
|
.Bl -tag -width /var/db/kvm.db -compact
|
|
.It Pa /var/db/kvm.db
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr kvm 3 ,
|
|
.Xr kvm_close 3 ,
|
|
.Xr kvm_getargv 3 ,
|
|
.Xr kvm_getenvv 3 ,
|
|
.Xr kvm_geterr 3 ,
|
|
.Xr kvm_getprocs 3 ,
|
|
.Xr kvm_open 3 ,
|
|
.Xr kvm_openfiles 3 ,
|
|
.Xr kvm_read 3 ,
|
|
.Xr kvm_write 3 ,
|
|
.Xr kvm_mkdb 8
|