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