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