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. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)kvm_getprocs.3 8.1 (Berkeley) 6/4/93
42 .Nd access user process state
50 .Ft struct kinfo_proc *
51 .Fn kvm_getprocs "kvm_t *kd" "int op" "int arg" "int *cnt"
53 .Fn kvm_getargv "kvm_t *kd" "const struct kinfo_proc *p" "int nchr"
55 .Fn kvm_getenvv "kvm_t *kd" "const struct kinfo_proc *p" "int nchr"
59 function returns a (sub-)set of active processes in the kernel indicated by
65 arguments constitute a predicate which limits the set of processes
69 describes the filtering predicate as follows:
71 .Bl -tag -width 20n -offset indent -compact
73 all processes and kernel visible threads
75 all processes, without threads
77 processes with process ID
80 processes with process group
82 .It Dv KERN_PROC_SESSION
83 processes with session
89 processes with effective user ID
92 processes with real user ID
94 .It Dv KERN_PROC_INC_THREAD
95 modifier to return all kernel visible threads when filtering
96 by process ID, process group, TTY, user ID, and real user ID
99 The number of processes found is returned in the reference parameter
101 The processes are returned as a contiguous array of kinfo_proc structures.
102 This memory is locally allocated, and subsequent calls to
106 will overwrite this storage.
110 function returns a null-terminated argument vector that corresponds to the
111 command line arguments passed to process indicated by
113 Most likely, these arguments correspond to the values passed to
116 This information is, however,
117 deliberately under control of the process itself.
118 Note that the original command name can be found, unaltered,
119 in the p_comm field of the process structure returned by
124 argument indicates the maximum number of characters, including null bytes,
125 to use in building the strings.
126 If this amount is exceeded, the string
127 causing the overflow is truncated and the partial result is returned.
128 This is handy for programs like
132 that print only a one line summary of a command and should not copy
133 out large amounts of text only to ignore it.
136 is zero, no limit is imposed and all argument strings are returned in
139 The memory allocated to the argv pointers and string storage
140 is owned by the kvm library.
145 calls will clobber this storage.
149 function is similar to
151 but returns the vector of environment strings.
153 also alterable by the process.
169 .Xr kvm_openfiles 3 ,
173 These routines do not belong in the kvm interface.