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 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)kvm_getfiles.3      8.2 (Berkeley) 4/19/94
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd April 19, 1994
  40 .Dt KVM_GETFILES 3
  41 .Os
  42 .Sh NAME
  43 .Nm kvm_getfiles
  44 .Nd survey open files
  45 .Sh LIBRARY
  46 .Lb libkvm
  47 .Sh SYNOPSIS
  48 .In kvm.h
  49 .In sys/types.h
  50 .Fd #define _KERNEL
  51 .In sys/file.h
  52 .Fd #undef _KERNEL
  53 .\" .Fa kvm_t *kd
  54 .Ft char *
  55 .Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt"
  56 .Sh DESCRIPTION
  57 The
  58 .Fn kvm_getfiles
  59 function returns a (sub-)set of the open files in the kernel indicated by
  60 .Fa kd .
  61 The
  62 .Fa op
  63 and
  64 .Fa arg
  65 arguments constitute a predicate which limits the set of files
  66 returned.
  67 No predicates are currently defined.
  68 .Pp
  69 The number of files found is returned in the reference parameter
  70 .Fa cnt .
  71 The files are returned as a contiguous array of file structures,
  72 preceded by the address of the first file entry in the kernel.
  73 This memory is owned by kvm and is not guaranteed to be persistent across
  74 subsequent kvm library calls.
  75 Data should be copied out if it needs to be
  76 saved.
  77 .Sh RETURN VALUES
  78 The
  79 .Fn kvm_getfiles
  80 function will return NULL on failure.
  81 .Sh SEE ALSO
  82 .Xr kvm 3 ,
  83 .Xr kvm_close 3 ,
  84 .Xr kvm_geterr 3 ,
  85 .Xr kvm_nlist 3 ,
  86 .Xr kvm_open 3 ,
  87 .Xr kvm_openfiles 3 ,
  88 .Xr kvm_read 3 ,
  89 .Xr kvm_write 3
  90 .Sh BUGS
  91 This routine does not belong in the kvm interface.