lib/libutil/kinfo_getproc.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 .Dd May 10, 2020
  27 .Dt KINFO_GETPROC 3
  28 .Os
  29 .Sh NAME
  30 .Nm kinfo_getproc
  31 .Nd function for getting process information from kernel
  32 .Sh LIBRARY
  33 .Lb libutil
  34 .Sh SYNOPSIS
  35 .In sys/types.h
  36 .In sys/user.h
  37 .In libutil.h
  38 .Ft struct kinfo_proc *
  39 .Fn kinfo_getproc "pid_t pid"
  40 .Sh DESCRIPTION
  41 This function is used for obtaining process information from the kernel.
  42 .Pp
  43 The
  44 .Ar pid
  45 field contains the process identifier.
  46 This should be a process that you have privilege to access.
  47 This function is a wrapper around
  48 .Xr sysctl 3
  49 with the
  50 .Dv KERN_PROC_PID
  51 mib.
  52 While the kernel returns a packed structure, this function expands the
  53 data into a fixed record format.
  54 .Sh RETURN VALUES
  55 On success the
  56 .Fn kinfo_getproc
  57 function returns a pointer to a
  58 .Vt struct kinfo_proc
  59 structure as defined by
  60 .In sys/user.h .
  61 The pointer was obtained by an internal call to
  62 .Xr malloc 3
  63 and must be freed by the caller with a call to
  64 .Xr free 3 .
  65 On failure the
  66 .Fn kinfo_getproc
  67 function returns
  68 .Dv NULL .
  69 .Sh SEE ALSO
  70 .Xr free 3 ,
  71 .Xr malloc 3 ,
  72 .Xr sysctl 3
  73 .Sh HISTORY
  74 The
  75 .Fn kinfo_getproc
  76 function first appeared in
  77 .Fx 7.0 .