xref: /minix3/lib/libkvm/kvm_getfiles.3 (revision 9da227510d14c35cccbd92c6a9e316b4079c4911)
1*9da22751SDavid van Moolenbroek.\"	$NetBSD: kvm_getfiles.3,v 1.11 2009/03/10 23:49:07 joerg Exp $
2*9da22751SDavid van Moolenbroek.\"
3*9da22751SDavid van Moolenbroek.\" Copyright (c) 1992, 1993
4*9da22751SDavid van Moolenbroek.\"	The Regents of the University of California.  All rights reserved.
5*9da22751SDavid van Moolenbroek.\"
6*9da22751SDavid van Moolenbroek.\" This code is derived from software developed by the Computer Systems
7*9da22751SDavid van Moolenbroek.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
8*9da22751SDavid van Moolenbroek.\" BG 91-66 and contributed to Berkeley.
9*9da22751SDavid van Moolenbroek.\"
10*9da22751SDavid van Moolenbroek.\" Redistribution and use in source and binary forms, with or without
11*9da22751SDavid van Moolenbroek.\" modification, are permitted provided that the following conditions
12*9da22751SDavid van Moolenbroek.\" are met:
13*9da22751SDavid van Moolenbroek.\" 1. Redistributions of source code must retain the above copyright
14*9da22751SDavid van Moolenbroek.\"    notice, this list of conditions and the following disclaimer.
15*9da22751SDavid van Moolenbroek.\" 2. Redistributions in binary form must reproduce the above copyright
16*9da22751SDavid van Moolenbroek.\"    notice, this list of conditions and the following disclaimer in the
17*9da22751SDavid van Moolenbroek.\"    documentation and/or other materials provided with the distribution.
18*9da22751SDavid van Moolenbroek.\" 3. Neither the name of the University nor the names of its contributors
19*9da22751SDavid van Moolenbroek.\"    may be used to endorse or promote products derived from this software
20*9da22751SDavid van Moolenbroek.\"    without specific prior written permission.
21*9da22751SDavid van Moolenbroek.\"
22*9da22751SDavid van Moolenbroek.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23*9da22751SDavid van Moolenbroek.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24*9da22751SDavid van Moolenbroek.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25*9da22751SDavid van Moolenbroek.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26*9da22751SDavid van Moolenbroek.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27*9da22751SDavid van Moolenbroek.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28*9da22751SDavid van Moolenbroek.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29*9da22751SDavid van Moolenbroek.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30*9da22751SDavid van Moolenbroek.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31*9da22751SDavid van Moolenbroek.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32*9da22751SDavid van Moolenbroek.\" SUCH DAMAGE.
33*9da22751SDavid van Moolenbroek.\"
34*9da22751SDavid van Moolenbroek.\"     @(#)kvm_getfiles.3	8.2 (Berkeley) 4/19/94
35*9da22751SDavid van Moolenbroek.\"
36*9da22751SDavid van Moolenbroek.Dd April 19, 1994
37*9da22751SDavid van Moolenbroek.Dt KVM_GETFILES 3
38*9da22751SDavid van Moolenbroek.Os
39*9da22751SDavid van Moolenbroek.Sh NAME
40*9da22751SDavid van Moolenbroek.Nm kvm_getfiles
41*9da22751SDavid van Moolenbroek.Nd survey open files
42*9da22751SDavid van Moolenbroek.Sh LIBRARY
43*9da22751SDavid van Moolenbroek.Lb libkvm
44*9da22751SDavid van Moolenbroek.Sh SYNOPSIS
45*9da22751SDavid van Moolenbroek.In kvm.h
46*9da22751SDavid van Moolenbroek.In sys/kinfo.h
47*9da22751SDavid van Moolenbroek.Fd #define _KERNEL
48*9da22751SDavid van Moolenbroek.In sys/file.h
49*9da22751SDavid van Moolenbroek.Fd #undef _KERNEL
50*9da22751SDavid van Moolenbroek.\" .Fa kvm_t *kd
51*9da22751SDavid van Moolenbroek.Ft char *
52*9da22751SDavid van Moolenbroek.Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt"
53*9da22751SDavid van Moolenbroek.Sh DESCRIPTION
54*9da22751SDavid van Moolenbroek.Fn kvm_getfiles
55*9da22751SDavid van Moolenbroekreturns a (sub-)set of the open files in the kernel indicated by
56*9da22751SDavid van Moolenbroek.Fa kd .
57*9da22751SDavid van MoolenbroekThe
58*9da22751SDavid van Moolenbroek.Fa op
59*9da22751SDavid van Moolenbroekand
60*9da22751SDavid van Moolenbroek.Fa arg
61*9da22751SDavid van Moolenbroekarguments constitute a predicate which limits the set of files
62*9da22751SDavid van Moolenbroekreturned.
63*9da22751SDavid van MoolenbroekNo predicates are currently defined.
64*9da22751SDavid van Moolenbroek.Pp
65*9da22751SDavid van MoolenbroekThe number of processes found is returned in the reference parameter
66*9da22751SDavid van Moolenbroek.Fa cnt .
67*9da22751SDavid van MoolenbroekThe files are returned as a contiguous array of file structures,
68*9da22751SDavid van Moolenbroekpreceded by the address of the first file entry in the kernel.
69*9da22751SDavid van MoolenbroekThis memory is owned by kvm and is not guaranteed to be persistent across
70*9da22751SDavid van Moolenbroeksubsequent kvm library calls.
71*9da22751SDavid van MoolenbroekData should be copied out if it needs to be saved.
72*9da22751SDavid van Moolenbroek.Sh RETURN VALUES
73*9da22751SDavid van Moolenbroek.Fn kvm_getfiles
74*9da22751SDavid van Moolenbroekwill return
75*9da22751SDavid van Moolenbroek.Dv NULL
76*9da22751SDavid van Moolenbroekon failure.
77*9da22751SDavid van Moolenbroek.Sh SEE ALSO
78*9da22751SDavid van Moolenbroek.Xr kvm 3 ,
79*9da22751SDavid van Moolenbroek.Xr kvm_close 3 ,
80*9da22751SDavid van Moolenbroek.Xr kvm_geterr 3 ,
81*9da22751SDavid van Moolenbroek.Xr kvm_nlist 3 ,
82*9da22751SDavid van Moolenbroek.Xr kvm_open 3 ,
83*9da22751SDavid van Moolenbroek.Xr kvm_openfiles 3 ,
84*9da22751SDavid van Moolenbroek.Xr kvm_read 3 ,
85*9da22751SDavid van Moolenbroek.Xr kvm_write 3
86*9da22751SDavid van Moolenbroek.Sh BUGS
87*9da22751SDavid van MoolenbroekThis routine does not belong in the kvm interface.
88