ddf583a289252d00acc9dc9a3c033aa471aba02a
[dragonfly.git] / 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: src/lib/libkvm/kvm_getfiles.3,v 1.6.2.6 2001/12/17 10:08:30 ru Exp $
38 .\" $DragonFly: src/lib/libkvm/kvm_getfiles.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
39 .\"
40 .Dd April 19, 1994
41 .Dt KVM_GETFILES 3
42 .Os
43 .Sh NAME
44 .Nm kvm_getfiles
45 .Nd survey open files
46 .Sh LIBRARY
47 .Lb libkvm
48 .Sh SYNOPSIS
49 .In kvm.h
50 .In sys/types.h
51 .Fd #define _KERNEL
52 .In sys/file.h
53 .Fd #undef _KERNEL
54 .\" .Fa kvm_t *kd
55 .Ft char *
56 .Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt"
57 .Sh DESCRIPTION
58 .Fn kvm_getfiles
59 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.  No predicates are currently defined.
67 .Pp
68 The number of files found is returned in the reference parameter
69 .Fa cnt .
70 The files are returned as a contiguous array of file structures,
71 preceded by the address of the first file entry in the kernel.
72 This memory is owned by kvm and is not guaranteed to be persistent across
73 subsequent kvm library calls.  Data should be copied out if it needs to be
74 saved.
75 .Sh RETURN VALUES
76 .Fn kvm_getfiles
77 will return NULL on failure.
78 .Sh SEE ALSO
79 .Xr kvm 3 ,
80 .Xr kvm_close 3 ,
81 .Xr kvm_geterr 3 ,
82 .Xr kvm_nlist 3 ,
83 .Xr kvm_open 3 ,
84 .Xr kvm_openfiles 3 ,
85 .Xr kvm_read 3 ,
86 .Xr kvm_write 3
87 .Sh BUGS
88 This routine does not belong in the kvm interface.