1.\" $NetBSD: kvm_getfiles.3,v 1.7 2002/02/07 07:00:48 ross Exp $ 2.\" 3.\" Copyright (c) 1992, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software developed by the Computer Systems 7.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract 8.\" BG 91-66 and contributed to Berkeley. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. All advertising materials mentioning features or use of this software 19.\" must display the following acknowledgement: 20.\" This product includes software developed by the University of 21.\" California, Berkeley and its contributors. 22.\" 4. Neither the name of the University nor the names of its contributors 23.\" may be used to endorse or promote products derived from this software 24.\" without specific prior written permission. 25.\" 26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36.\" SUCH DAMAGE. 37.\" 38.\" @(#)kvm_getfiles.3 8.2 (Berkeley) 4/19/94 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.Fd #include \*[Lt]kvm.h\*[Gt] 50.Fd #include \*[Lt]sys/kinfo.h\*[Gt] 51.Fd #define _KERNEL 52.Fd #include \*[Lt]sys/file.h\*[Gt] 53.Fd #undef _KERNEL 54.\" .Fa kvm_t *kd 55.br 56.Ft char * 57.Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt" 58.Sh DESCRIPTION 59.Fn kvm_getfiles 60returns a (sub-)set of the open files in the kernel indicated by 61.Fa kd . 62The 63.Fa op 64and 65.Fa arg 66arguments constitute a predicate which limits the set of files 67returned. No predicates are currently defined. 68.Pp 69The number of processes found is returned in the reference parameter 70.Fa cnt . 71The files are returned as a contiguous array of file structures, 72preceded by the address of the first file entry in the kernel. 73This memory is owned by kvm and is not guaranteed to be persistent across 74subsequent kvm library calls. Data should be copied out if it needs to be 75saved. 76.Sh RETURN VALUES 77.Fn kvm_getfiles 78will return 79.Dv NULL 80on 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 91This routine does not belong in the kvm interface. 92