1.\" $OpenBSD: kvm_nlist.3,v 1.7 2003/06/02 20:18:41 millert 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. Neither the name of the University nor the names of its contributors 20.\" may be used to endorse or promote products derived from this software 21.\" without specific prior written permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.\" @(#)kvm_nlist.3 8.1 (Berkeley) 6/4/93 36.\" 37.Dd June 4, 1993 38.Dt KVM_NLIST 3 39.Os 40.Sh NAME 41.Nm kvm_nlist 42.Nd retrieve symbol table names from a kernel image 43.Sh SYNOPSIS 44.Fd #include <kvm.h> 45.Fd #include <nlist.h> 46.Ft int 47.Fn kvm_nlist "kvm_t *kd" "struct nlist *nl" 48.Sh DESCRIPTION 49.Fn kvm_nlist 50retrieves the symbol table entries indicated by the name list argument 51.Fa \&nl . 52This argument points to an array of nlist structures, terminated by 53an entry whose 54.Fa n_name 55field is 56.Dv NULL 57(see 58.Xr nlist 3 ) . 59Each symbol is looked up using the 60.Fa n_name 61field, and if found, the 62corresponding 63.Fa n_type 64and 65.Fa n_value 66fields are filled in. 67These fields are set 68to 0 if the symbol is not found. 69.Pp 70The program 71.Xr kvm_mkdb 8 72builds a database from the running kernel's namelist. 73If the database matches the opened kernel, 74.Fn kvm_nlist 75uses it to speed lookups. 76.Sh RETURN VALUES 77The 78.Fn kvm_nlist 79function returns the number of invalid entries found. 80If the kernel symbol table was unreadable, \-1 is returned. 81.Sh FILES 82.Bl -tag -width /var/db/kvm_bsd.db -compact 83.It Pa /var/db/kvm_bsd.db 84.El 85.Sh SEE ALSO 86.Xr kvm 3 , 87.Xr kvm_close 3 , 88.Xr kvm_getargv 3 , 89.Xr kvm_getenvv 3 , 90.Xr kvm_geterr 3 , 91.Xr kvm_getprocs 3 , 92.Xr kvm_open 3 , 93.Xr kvm_openfiles 3 , 94.Xr kvm_read 3 , 95.Xr kvm_write 3 , 96.Xr kvm_mkdb 8 97