lib/libkvm/kvm_getprocs.3

   1 .\" Copyright (c) 1992, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   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.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  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.
  19 .\"
  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
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)kvm_getprocs.3      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libkvm/kvm_getprocs.3,v 1.6.2.7 2003/04/29 14:37:04 trhodes Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt KVM_GETPROCS 3
  37 .Os
  38 .Sh NAME
  39 .Nm kvm_getprocs ,
  40 .Nm kvm_getargv ,
  41 .Nm kvm_getenvv
  42 .Nd access user process state
  43 .Sh LIBRARY
  44 .Lb libkvm
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In kvm.h
  48 .Ft struct kinfo_proc *
  49 .Fn kvm_getprocs "kvm_t *kd" "int op" "int arg" "int *cnt"
  50 .Ft char **
  51 .Fn kvm_getargv "kvm_t *kd" "const struct kinfo_proc *p" "int nchr"
  52 .Ft char **
  53 .Fn kvm_getenvv "kvm_t *kd" "const struct kinfo_proc *p" "int nchr"
  54 .Sh DESCRIPTION
  55 .Fn kvm_getprocs
  56 returns a (sub-)set of active processes in the kernel indicated by
  57 .Fa kd .
  58 The
  59 .Fa op
  60 and
  61 .Fa arg
  62 arguments constitute a predicate which limits the set of processes
  63 returned.
  64 The value of
  65 .Fa op
  66 describes the filtering predicate as follows:
  67 .Pp
  68 .Bl -tag -width ".Dv KERN_PROC_SESSION" -offset indent -compact
  69 .It Dv KERN_PROC_ALL
  70 all processes
  71 .It Dv KERN_PROC_PID
  72 processes with process id
  73 .Fa arg
  74 .It Dv KERN_PROC_PGRP
  75 processes with process group
  76 .Fa arg
  77 .It Dv KERN_PROC_SESSION
  78 processes with session
  79 .Fa arg
  80 .It Dv KERN_PROC_TTY
  81 processes with tty
  82 .Fa arg
  83 .It Dv KERN_PROC_UID
  84 processes with effective user id
  85 .Fa arg
  86 .It Dv KERN_PROC_RUID
  87 processes with real user id
  88 .Fa arg
  89 .El
  90 .Pp
  91 If the list of processes should contain all light weight processes,
  92 add the flag
  93 .Dv KERN_PROC_FLAG_LWP
  94 to
  95 .Fa op .
  96 .Pp
  97 The number of processes found is returned in the reference parameter
  98 .Fa cnt .
  99 The processes are returned as a contiguous array of kinfo_proc structures.
 100 This memory is locally allocated, and subsequent calls to
 101 .Fn kvm_getprocs
 102 and
 103 .Fn kvm_close
 104 will overwrite this storage.
 105 .Pp
 106 .Fn kvm_getargv
 107 returns a null-terminated argument vector that corresponds to the
 108 command line arguments passed to process indicated by
 109 .Fa p .
 110 Most likely, these arguments correspond to the values passed to
 111 .Xr exec 3
 112 on process creation.
 113 This information is, however, deliberately under control of the process itself.
 114 Note that the original command name can be found, unaltered,
 115 in the p_comm field of the process structure returned by
 116 .Fn kvm_getprocs .
 117 .Pp
 118 The
 119 .Fa nchr
 120 argument indicates the maximum number of characters, including null bytes,
 121 to use in building the strings.
 122 If this amount is exceeded, the string
 123 causing the overflow is truncated and the partial result is returned.
 124 This is handy for programs like
 125 .Xr ps 1
 126 and
 127 .Xr w 1
 128 that print only a one line summary of a command and should not copy
 129 out large amounts of text only to ignore it.
 130 If
 131 .Fa nchr
 132 is zero, no limit is imposed and all argument strings are returned in
 133 their entirety.
 134 .Pp
 135 The memory allocated to the argv pointers and string storage
 136 is owned by the kvm library.
 137 Subsequent
 138 .Fn kvm_getprocs
 139 and
 140 .Xr kvm_close 3
 141 calls will clobber this storage.
 142 .Pp
 143 The
 144 .Fn kvm_getenvv
 145 function is similar to
 146 .Fn kvm_getargv
 147 but returns the vector of environment strings.
 148 This data is also alterable by the process.
 149 .Sh RETURN VALUES
 150 .Fn kvm_getprocs ,
 151 .Fn kvm_getargv ,
 152 and
 153 .Fn kvm_getenvv ,
 154 all return
 155 .Dv NULL
 156 on failure.
 157 .Sh SEE ALSO
 158 .Xr kvm 3 ,
 159 .Xr kvm_close 3 ,
 160 .Xr kvm_geterr 3 ,
 161 .Xr kvm_nlist 3 ,
 162 .Xr kvm_open 3 ,
 163 .Xr kvm_openfiles 3 ,
 164 .Xr kvm_read 3 ,
 165 .Xr kvm_write 3
 166 .Sh BUGS
 167 These routines do not belong in the kvm interface.