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. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)kvm_nlist.3 8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libkvm/kvm_nlist.3,v 1.5.2.3 2001/12/17 10:08:30 ru Exp $
  34 .\" $DragonFly: src/lib/libkvm/kvm_nlist.3,v 1.2 2003/06/17 04:26:49 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  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 sys/types.h
  46 .In kvm.h
  47 .Ft int
  48 .Fn kvm_nlist "kvm_t *kd" "struct nlist *nl"
  49 .Sh DESCRIPTION
  50 .Fn kvm_nlist
  51 retrieves the symbol table entries indicated by the name list argument
  52 .Fa \&nl .
  53 This argument points to an array of nlist structures, terminated by
  54 an entry whose n_name field is
  55 .Dv NULL
  56 (see
  57 .Xr nlist 3 ) .
  58 Each symbol is looked up using the n_name field, and if found, the
  59 corresponding n_type and n_value fields are filled in.  These fields are set
  60 to 0 if the symbol is not found.
  61 .Pp
  62 .Xr kldsym 2
  63 is used to locate the symbol.  This is a less than perfect emulation
  64 of the nlist values but has the advantage of being aware of kernel modules
  65 and is reasonably fast.
  66 .Sh RETURN VALUES
  67 The
  68 .Fn kvm_nlist
  69 function returns the number of invalid entries found.
  70 If the kernel symbol table was unreadable, -1 is returned.
  71 .Sh SEE ALSO
  72 .Xr kldsym 2 ,
  73 .Xr kvm 3 ,
  74 .Xr kvm_close 3 ,
  75 .Xr kvm_getargv 3 ,
  76 .Xr kvm_getenvv 3 ,
  77 .Xr kvm_geterr 3 ,
  78 .Xr kvm_getprocs 3 ,
  79 .Xr kvm_open 3 ,
  80 .Xr kvm_openfiles 3 ,
  81 .Xr kvm_read 3 ,
  82 .Xr kvm_write 3