lib/libutil/kinfo_getallproc.3

   1 .\"
   2 .\" Copyright (c) 2009 Ulf Lilleengen
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd May 27, 2015
  29 .Dt KINFO_GETALLPROC 3
  30 .Os
  31 .Sh NAME
  32 .Nm kinfo_getallproc
  33 .Nd function for getting process information of all processes from kernel
  34 .Sh LIBRARY
  35 .Lb libutil
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/user.h
  39 .In libutil.h
  40 .Ft struct kinfo_proc *
  41 .Fn kinfo_getallproc "int *cntp"
  42 .Sh DESCRIPTION
  43 This function is used for obtaining process information of all processes from
  44 the kernel.
  45 .Pp
  46 The
  47 .Ar cntp
  48 field is a pointer containing the number of process structures returned.
  49 This function is a wrapper around
  50 .Xr sysctl 3
  51 with the
  52 .Dv KERN_PROC_PROC
  53 mib.
  54 While the kernel returns a packed structure, this function expands the
  55 data into a fixed record format.
  56 .Sh RETURN VALUES
  57 On success the
  58 .Fn kinfo_getallproc
  59 function returns a pointer to
  60 .Ar cntp
  61 .Vt struct kinfo_proc
  62 structures as defined by
  63 .In sys/user.h .
  64 The pointer was obtained by an internal call to
  65 .Xr malloc 3
  66 and must be freed by the caller with a call to
  67 .Xr free 3 .
  68 On failure the
  69 .Fn kinfo_getallproc
  70 function returns
  71 .Dv NULL .
  72 .Sh SEE ALSO
  73 .Xr free 3 ,
  74 .Xr malloc 3 ,
  75 .Xr sysctl 3