xref: /freebsd/lib/libkvm/kvm_nlist.3 (revision 41466b50c1d5bfd1cf6adaae547a579a75d7c04e)
1.\" Copyright (c) 1992, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software developed by the Computer Systems
5.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
6.\" BG 91-66 and contributed to Berkeley.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)kvm_nlist.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD$
38.\"
39.Dd June 4, 1993
40.Dt KVM_NLIST 3
41.Os
42.Sh NAME
43.Nm kvm_nlist
44.Nd retrieve symbol table names from a kernel image
45.Sh LIBRARY
46.Lb libkvm
47.Sh SYNOPSIS
48.In kvm.h
49.In nlist.h
50.Ft int
51.Fn kvm_nlist "kvm_t *kd" "struct nlist *nl"
52.Sh DESCRIPTION
53.Fn kvm_nlist
54retrieves the symbol table entries indicated by the name list argument
55.Fa \&nl .
56This argument points to an array of nlist structures, terminated by
57an entry whose n_name field is
58.Dv NULL
59(see
60.Xr nlist 3 ) .
61Each symbol is looked up using the n_name field, and if found, the
62corresponding n_type and n_value fields are filled in.  These fields are set
63to 0 if the symbol is not found.
64.Pp
65.Xr kldsym 2
66is used to locate the symbol.  This is a less than perfect emulation
67of the nlist values but has the advantage of being aware of kernel modules
68and is reasonably fast.
69.Sh RETURN VALUES
70The
71.Fn kvm_nlist
72function returns the number of invalid entries found.
73If the kernel symbol table was unreadable, -1 is returned.
74.Sh SEE ALSO
75.Xr kldsym 2 ,
76.Xr kvm 3 ,
77.Xr kvm_close 3 ,
78.Xr kvm_getargv 3 ,
79.Xr kvm_getenvv 3 ,
80.Xr kvm_geterr 3 ,
81.Xr kvm_getprocs 3 ,
82.Xr kvm_open 3 ,
83.Xr kvm_openfiles 3 ,
84.Xr kvm_read 3 ,
85.Xr kvm_write 3
86