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