bbc6142cc05233c3c5b9a5c126c7c51459e0da25
[dragonfly.git] / lib / libkvm / kvm_nlist.3
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: src/lib/libkvm/kvm_nlist.3,v 1.5.2.3 2001/12/17 10:08:30 ru Exp $
38 .\" $DragonFly: src/lib/libkvm/kvm_nlist.3,v 1.2 2003/06/17 04:26:49 dillon Exp $
39 .\"
40 .Dd June 4, 1993
41 .Dt KVM_NLIST 3
42 .Os
43 .Sh NAME
44 .Nm kvm_nlist
45 .Nd retrieve symbol table names from a kernel image
46 .Sh LIBRARY
47 .Lb libkvm
48 .Sh SYNOPSIS
49 .In kvm.h
50 .In nlist.h
51 .Ft int
52 .Fn kvm_nlist "kvm_t *kd" "struct nlist *nl"
53 .Sh DESCRIPTION
54 .Fn kvm_nlist
55 retrieves the symbol table entries indicated by the name list argument
56 .Fa \&nl .
57 This argument points to an array of nlist structures, terminated by
58 an entry whose n_name field is
59 .Dv NULL
60 (see
61 .Xr nlist 3 ) .
62 Each symbol is looked up using the n_name field, and if found, the
63 corresponding n_type and n_value fields are filled in.  These fields are set
64 to 0 if the symbol is not found.
65 .Pp
66 .Xr kldsym 2
67 is used to locate the symbol.  This is a less than perfect emulation
68 of the nlist values but has the advantage of being aware of kernel modules
69 and is reasonably fast.
70 .Sh RETURN VALUES
71 The
72 .Fn kvm_nlist
73 function returns the number of invalid entries found.
74 If the kernel symbol table was unreadable, -1 is returned.
75 .Sh SEE ALSO
76 .Xr kldsym 2 ,
77 .Xr kvm 3 ,
78 .Xr kvm_close 3 ,
79 .Xr kvm_getargv 3 ,
80 .Xr kvm_getenvv 3 ,
81 .Xr kvm_geterr 3 ,
82 .Xr kvm_getprocs 3 ,
83 .Xr kvm_open 3 ,
84 .Xr kvm_openfiles 3 ,
85 .Xr kvm_read 3 ,
86 .Xr kvm_write 3