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