lib/libkvm/kvm_getfiles.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 .\" 4. 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_getfiles.3      8.2 (Berkeley) 4/19/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd April 19, 1994
  36 .Dt KVM_GETFILES 3
  37 .Os
  38 .Sh NAME
  39 .Nm kvm_getfiles
  40 .Nd survey open files
  41 .Sh LIBRARY
  42 .Lb libkvm
  43 .Sh SYNOPSIS
  44 .In kvm.h
  45 .In sys/types.h
  46 .Fd #define _KERNEL
  47 .In sys/file.h
  48 .Fd #undef _KERNEL
  49 .\" .Fa kvm_t *kd
  50 .Ft char *
  51 .Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn kvm_getfiles
  55 function 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 files 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
  72 saved.
  73 .Sh RETURN VALUES
  74 The
  75 .Fn kvm_getfiles
  76 function will return NULL 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.