[BACK]Return to kvm_getfiles.3 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / lib / libkvm

Annotation of src/lib/libkvm/kvm_getfiles.3, Revision 1.10

1.10    ! agc         1: .\"    $NetBSD: kvm_getfiles.3,v 1.9 2003/04/16 13:35:07 wiz Exp $
1.3       thorpej     2: .\"
1.1       cgd         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.
1.10    ! agc        18: .\" 3. Neither the name of the University nor the names of its contributors
1.1       cgd        19: .\"    may be used to endorse or promote products derived from this software
                     20: .\"    without specific prior written permission.
                     21: .\"
                     22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     25: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     32: .\" SUCH DAMAGE.
                     33: .\"
                     34: .\"     @(#)kvm_getfiles.3     8.2 (Berkeley) 4/19/94
                     35: .\"
                     36: .Dd April 19, 1994
                     37: .Dt KVM_GETFILES 3
                     38: .Os
                     39: .Sh NAME
                     40: .Nm kvm_getfiles
                     41: .Nd survey open files
1.5       perry      42: .Sh LIBRARY
                     43: .Lb libkvm
1.1       cgd        44: .Sh SYNOPSIS
1.9       wiz        45: .In kvm.h
                     46: .In sys/kinfo.h
1.2       jtc        47: .Fd #define _KERNEL
1.9       wiz        48: .In sys/file.h
1.2       jtc        49: .Fd #undef _KERNEL
1.1       cgd        50: .\" .Fa kvm_t *kd
                     51: .br
                     52: .Ft char *
                     53: .Fn kvm_getfiles "kvm_t *kd" "int op" "int arg" "int *cnt"
                     54: .Sh DESCRIPTION
                     55: .Fn kvm_getfiles
                     56: returns a (sub-)set of the open files in the kernel indicated by
1.6       wiz        57: .Fa kd .
1.1       cgd        58: The
                     59: .Fa op
                     60: and
                     61: .Fa arg
                     62: arguments constitute a predicate which limits the set of files
1.8       wiz        63: returned.
                     64: No predicates are currently defined.
1.1       cgd        65: .Pp
                     66: The number of processes found is returned in the reference parameter
                     67: .Fa cnt .
                     68: The files are returned as a contiguous array of file structures,
                     69: preceded by the address of the first file entry in the kernel.
                     70: This memory is owned by kvm and is not guaranteed to be persistent across
1.8       wiz        71: subsequent kvm library calls.
                     72: Data should be copied out if it needs to be saved.
1.1       cgd        73: .Sh RETURN VALUES
                     74: .Fn kvm_getfiles
1.4       cgd        75: will return
                     76: .Dv NULL
                     77: on failure.
1.1       cgd        78: .Sh SEE ALSO
                     79: .Xr kvm 3 ,
1.6       wiz        80: .Xr kvm_close 3 ,
                     81: .Xr kvm_geterr 3 ,
                     82: .Xr kvm_nlist 3 ,
1.1       cgd        83: .Xr kvm_open 3 ,
                     84: .Xr kvm_openfiles 3 ,
                     85: .Xr kvm_read 3 ,
1.6       wiz        86: .Xr kvm_write 3
                     87: .Sh BUGS
                     88: This routine does not belong in the kvm interface.

CVSweb <webmaster@jp.NetBSD.org>