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. 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: src/lib/libkvm/kvm_getfiles.3,v 1.6.2.6 2001/12/17 10:08:30 ru Exp $
  34 .\" $DragonFly: src/lib/libkvm/kvm_getfiles.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
  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 sys/types.h
  46 .In kvm.h
  47 .Ft char *
  48 .Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt"
  49 .Sh DESCRIPTION
  50 .Fn kvm_getfiles
  51 returns a (sub-)set of the open files in the kernel indicated by
  52 .Fa kd .
  53 The
  54 .Fa op
  55 and
  56 .Fa arg
  57 arguments constitute a predicate which limits the set of files
  58 returned.  No predicates are currently defined.
  59 .Pp
  60 The number of files found is returned in the reference parameter
  61 .Fa cnt .
  62 The files are returned as a contiguous array of file structures,
  63 preceded by the address of the first file entry in the kernel.
  64 This memory is owned by kvm and is not guaranteed to be persistent across
  65 subsequent kvm library calls.  Data should be copied out if it needs to be
  66 saved.
  67 .Sh RETURN VALUES
  68 .Fn kvm_getfiles
  69 will return NULL on failure.
  70 .Sh SEE ALSO
  71 .Xr kvm 3 ,
  72 .Xr kvm_close 3 ,
  73 .Xr kvm_geterr 3 ,
  74 .Xr kvm_nlist 3 ,
  75 .Xr kvm_open 3 ,
  76 .Xr kvm_openfiles 3 ,
  77 .Xr kvm_read 3 ,
  78 .Xr kvm_write 3
  79 .Sh BUGS
  80 This routine does not belong in the kvm interface.