1 .\" Copyright (c) 1992, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software developed by the Computer Systems
5 .\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
6 .\" BG 91-66 and contributed to Berkeley.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\" must display the following acknowledgement:
18 .\" This product includes software developed by the University of
19 .\" California, Berkeley and its contributors.
20 .\" 4. Neither the name of the University nor the names of its contributors
21 .\" may be used to endorse or promote products derived from this software
22 .\" without specific prior written permission.
24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .\" @(#)kvm_getprocs.3 8.1 (Berkeley) 6/4/93
37 .\" $FreeBSD: src/lib/libkvm/kvm_getprocs.3,v 1.6.2.7 2003/04/29 14:37:04 trhodes Exp $
38 .\" $DragonFly: src/lib/libkvm/kvm_getprocs.3,v 1.4 2007/02/01 10:33:25 corecode Exp $
47 .Nd access user process state
56 .Ft struct kinfo_proc *
57 .Fn kvm_getprocs "kvm_t *kd" "int op" "int arg" "int *cnt"
59 .Fn kvm_getargv "kvm_t *kd" "const struct kinfo_proc *p" "int nchr"
61 .Fn kvm_getenvv "kvm_t *kd" "const struct kinfo_proc *p" "int nchr"
64 returns a (sub-)set of active processes in the kernel indicated by
70 arguments constitute a predicate which limits the set of processes
71 returned. The value of
73 describes the filtering predicate as follows:
75 .Bl -tag -width 20n -offset indent -compact
79 processes with process id
82 processes with process group
84 .It Sy KERN_PROC_SESSION
85 processes with session
91 processes with effective user id
94 processes with real user id
98 If the list of processes should contain all light weight processes,
100 .Sy KERN_PROC_FLAG_LWP
104 The number of processes found is returned in the reference parameter
106 The processes are returned as a contiguous array of kinfo_proc structures.
107 This memory is locally allocated, and subsequent calls to
111 will overwrite this storage.
114 returns a null-terminated argument vector that corresponds to the
115 command line arguments passed to process indicated by
117 Most likely, these arguments correspond to the values passed to
119 on process creation. This information is, however,
120 deliberately under control of the process itself.
121 Note that the original command name can be found, unaltered,
122 in the p_comm field of the process structure returned by
127 argument indicates the maximum number of characters, including null bytes,
128 to use in building the strings. If this amount is exceeded, the string
129 causing the overflow is truncated and the partial result is returned.
130 This is handy for programs like
134 that print only a one line summary of a command and should not copy
135 out large amounts of text only to ignore it.
138 is zero, no limit is imposed and all argument strings are returned in
141 The memory allocated to the argv pointers and string storage
142 is owned by the kvm library. Subsequent
146 calls will clobber this storage.
150 function is similar to
152 but returns the vector of environment strings. This data is
153 also alterable by the process.
168 .Xr kvm_openfiles 3 ,
172 These routines do not belong in the kvm interface.