90 lines
3.3 KiB
Groff
90 lines
3.3 KiB
Groff
.\" Copyright (c) 1992, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software developed by the Computer Systems
|
|
.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
|
|
.\" BG 91-66 and contributed to Berkeley.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)kvm_getfiles.3 8.2 (Berkeley) 4/19/94
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd April 19, 1994
|
|
.Dt KVM_GETFILES 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm kvm_getfiles
|
|
.Nd survey open files
|
|
.Sh LIBRARY
|
|
.Lb libkvm
|
|
.Sh SYNOPSIS
|
|
.Fd #include <kvm.h>
|
|
.Fd #include <sys/types.h>
|
|
.Fd #define _KERNEL
|
|
.Fd #include <sys/file.h>
|
|
.Fd #undef _KERNEL
|
|
.\" .Fa kvm_t *kd
|
|
.br
|
|
.Ft char *
|
|
.Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt"
|
|
.Sh DESCRIPTION
|
|
.Fn kvm_getfiles
|
|
returns a (sub-)set of the open files in the kernel indicated by
|
|
.Fa kd.
|
|
The
|
|
.Fa op
|
|
and
|
|
.Fa arg
|
|
arguments constitute a predicate which limits the set of files
|
|
returned. No predicates are currently defined.
|
|
.Pp
|
|
The number of processes found is returned in the reference parameter
|
|
.Fa cnt .
|
|
The files are returned as a contiguous array of file structures,
|
|
preceded by the address of the first file entry in the kernel.
|
|
This memory is owned by kvm and is not guaranteed to be persistent across
|
|
subsequent kvm library calls. Data should be copied out if it needs to be
|
|
saved.
|
|
.Sh RETURN VALUES
|
|
.Fn kvm_getfiles
|
|
will return NULL on failure.
|
|
.Pp
|
|
.Sh BUGS
|
|
This routine does not belong in the kvm interface.
|
|
.Sh SEE ALSO
|
|
.Xr kvm 3 ,
|
|
.Xr kvm_close 3 ,
|
|
.Xr kvm_geterr 3 ,
|
|
.Xr kvm_nlist 3 ,
|
|
.Xr kvm_open 3 ,
|
|
.Xr kvm_openfiles 3 ,
|
|
.Xr kvm_read 3 ,
|
|
.Xr kvm_write 3
|