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