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.\" $FreeBSD$ 26.\" 27.Dd May 20, 2020 28.Dt KINFO_GETVMOBJECT 3 29.Os 30.Sh NAME 31.Nm kinfo_getvmobject 32.Nd function for getting system-wide memory information 33.Sh LIBRARY 34.Lb libutil 35.Sh SYNOPSIS 36.In sys/types.h 37.In sys/user.h 38.In libutil.h 39.Ft struct kinfo_vmobject * 40.Fn kinfo_getvmobject "int *cntp" 41.Sh DESCRIPTION 42This function is used to obtain information about the objects using memory 43in the system. 44.Pp 45The 46.Ar cntp 47argument allows the caller to know how many records are returned. 48.Pp 49This function is a wrapper around the 50.Dq vm.objects 51.Xr sysctl 3 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_getvmobject 58function returns a pointer to an array of 59.Vt struct kinfo_vmobject 60structures as defined by 61.In sys/user.h . 62The array is allocated 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_getvmobject 68function returns 69.Dv NULL . 70.Sh SEE ALSO 71.Xr free 3 , 72.Xr kinfo_getvmmap 3 , 73.Xr malloc 3 74.Sh HISTORY 75The 76.Fn kinfo_getvmobject 77function first appeared in 78.Fx 10.2 . 79