lib/libkvm/kvm_getfiles.3

   1 .\"     $NetBSD: kvm_getfiles.3,v 1.11 2009/03/10 23:49:07 joerg 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_getfiles.3      8.2 (Berkeley) 4/19/94
  35 .\"
  36 .Dd April 19, 1994
  37 .Dt KVM_GETFILES 3
  38 .Os
  39 .Sh NAME
  40 .Nm kvm_getfiles
  41 .Nd survey open files
  42 .Sh LIBRARY
  43 .Lb libkvm
  44 .Sh SYNOPSIS
  45 .In kvm.h
  46 .In sys/kinfo.h
  47 .Fd #define _KERNEL
  48 .In sys/file.h
  49 .Fd #undef _KERNEL
  50 .\" .Fa kvm_t *kd
  51 .Ft char *
  52 .Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt"
  53 .Sh DESCRIPTION
  54 .Fn kvm_getfiles
  55 returns a (sub-)set of the open files in the kernel indicated by
  56 .Fa kd .
  57 The
  58 .Fa op
  59 and
  60 .Fa arg
  61 arguments constitute a predicate which limits the set of files
  62 returned.
  63 No predicates are currently defined.
  64 .Pp
  65 The number of processes found is returned in the reference parameter
  66 .Fa cnt .
  67 The files are returned as a contiguous array of file structures,
  68 preceded by the address of the first file entry in the kernel.
  69 This memory is owned by kvm and is not guaranteed to be persistent across
  70 subsequent kvm library calls.
  71 Data should be copied out if it needs to be saved.
  72 .Sh RETURN VALUES
  73 .Fn kvm_getfiles
  74 will return
  75 .Dv NULL
  76 on failure.
  77 .Sh SEE ALSO
  78 .Xr kvm 3 ,
  79 .Xr kvm_close 3 ,
  80 .Xr kvm_geterr 3 ,
  81 .Xr kvm_nlist 3 ,
  82 .Xr kvm_open 3 ,
  83 .Xr kvm_openfiles 3 ,
  84 .Xr kvm_read 3 ,
  85 .Xr kvm_write 3
  86 .Sh BUGS
  87 This routine does not belong in the kvm interface.