1.\" $NetBSD: kvm_nlist.3,v 1.6 2002/02/07 07:00:48 ross Exp $ 2.\" 3.\" Copyright (c) 1992, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software developed by the Computer Systems 7.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract 8.\" BG 91-66 and contributed to Berkeley. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. All advertising materials mentioning features or use of this software 19.\" must display the following acknowledgement: 20.\" This product includes software developed by the University of 21.\" California, Berkeley and its contributors. 22.\" 4. Neither the name of the University nor the names of its contributors 23.\" may be used to endorse or promote products derived from this software 24.\" without specific prior written permission. 25.\" 26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36.\" SUCH DAMAGE. 37.\" 38.\" @(#)kvm_nlist.3 8.1 (Berkeley) 6/4/93 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.Fd #include \*[Lt]kvm.h\*[Gt] 50.Fd #include \*[Lt]nlist.h\*[Gt] 51.Ft int 52.Fn kvm_nlist "kvm_t *kd" "struct nlist *nl" 53.Sh DESCRIPTION 54.Fn kvm_nlist 55retrieves the symbol table entries indicated by the name list argument 56.Fa \&nl . 57This argument points to an array of nlist structures, terminated by 58an entry whose n_name field is 59.Dv NULL 60(see 61.Xr nlist 3 ) . 62Each symbol is looked up using the n_name field, and if found, the 63corresponding n_type and n_value fields are filled in. These fields are set 64to 0 if the symbol is not found. 65.Pp 66The program 67.Xr kvm_mkdb 8 68builds a database from a kernel's namelist. If 69.Fa \&kd 70was created by a call to 71.Fn kvm_open 72with a 73.Dv NULL 74executable image name and 75the database matches the running kernel, 76.Fn kvm_nlist 77will use the database to speed lookups. 78.Sh RETURN VALUES 79The 80.Fn kvm_nlist 81function returns the number of invalid entries found. 82If the kernel symbol table was unreadable, -1 is returned. 83.Sh FILES 84.Bl -tag -width /var/db/kvm.db -compact 85.It Pa /var/db/kvm.db 86.El 87.Sh SEE ALSO 88.Xr kvm 3 , 89.Xr kvm_close 3 , 90.Xr kvm_getargv 3 , 91.Xr kvm_getenvv 3 , 92.Xr kvm_geterr 3 , 93.Xr kvm_getprocs 3 , 94.Xr kvm_open 3 , 95.Xr kvm_openfiles 3 , 96.Xr kvm_read 3 , 97.Xr kvm_write 3 , 98.Xr kvm_mkdb 8 99