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$
  34 .\"
  35 .Dd November 27, 2015
  36 .Dt KVM_NLIST 3
  37 .Os
  38 .Sh NAME
  39 .Nm kvm_nlist ,
  40 .Nm kvm_nlist2
  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 .Ft int
  50 .Fn kvm_nlist2 "kvm_t *kd" "struct kvm_nlist *nl"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn kvm_nlist
  54 function retrieves the symbol table entries indicated by the name list argument
  55 .Fa \&nl .
  56 This argument points to an array of nlist structures, terminated by
  57 an entry whose
  58 .Fa n_name
  59 field is
  60 .Dv NULL
  61 (see
  62 .Xr nlist 3 ) .
  63 Each symbol is looked up using the
  64 .Fa n_name
  65 field, and if found, the
  66 corresponding
  67 .Fa n_type
  68 and
  69 .Fa n_value
  70 fields are filled in.
  71 These fields are set
  72 to 0 if the symbol is not found.
  73 .Pp
  74 The
  75 .Xr kldsym 2
  76 system call is used to locate symbols in live kernels.
  77 This is a less than perfect
  78 emulation of the nlist values but has the advantage of being aware of kernel
  79 modules and is reasonably fast.
  80 .Pp
  81 The
  82 .Fn kvm_nlist2
  83 function retrieves the symbol table entries indicated by the name list argument
  84 .Fa nl .
  85 This argument points to an array of
  86 .Vt "struct kvm_nlist"
  87 structures,
  88 terminated by an entry whose
  89 .Fa n_name
  90 field is
  91 .Dv NULL
  92 These structures are similar to the nlist structures used by
  93 .Fn kvm_nlist
  94 except that the
  95 .Fa n_value
  96 field uses a different type
  97 .Pq Vt kvaddr_t
  98 to avoid truncation when examining non-native kernel images.
  99 .Sh RETURN VALUES
 100 The
 101 .Fn kvm_nlist
 102 and
 103 .Fn kvm_nlist2
 104 functions return the number of invalid entries found.
 105 If the kernel symbol table was unreadable, -1 is returned.
 106 .Sh SEE ALSO
 107 .Xr kldsym 2 ,
 108 .Xr kvm 3 ,
 109 .Xr kvm_close 3 ,
 110 .Xr kvm_getargv 3 ,
 111 .Xr kvm_getenvv 3 ,
 112 .Xr kvm_geterr 3 ,
 113 .Xr kvm_getprocs 3 ,
 114 .Xr kvm_native 3 ,
 115 .Xr kvm_open 3 ,
 116 .Xr kvm_openfiles 3 ,
 117 .Xr kvm_read 3 ,
 118 .Xr kvm_write 3