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