11eaf0ac3Slogwang.\" 21eaf0ac3Slogwang.\" Copyright (c) 2015 John Baldwin <[email protected]> 31eaf0ac3Slogwang.\" 41eaf0ac3Slogwang.\" Redistribution and use in source and binary forms, with or without 51eaf0ac3Slogwang.\" modification, are permitted provided that the following conditions 61eaf0ac3Slogwang.\" are met: 71eaf0ac3Slogwang.\" 1. Redistributions of source code must retain the above copyright 81eaf0ac3Slogwang.\" notice, this list of conditions and the following disclaimer. 91eaf0ac3Slogwang.\" 2. Redistributions in binary form must reproduce the above copyright 101eaf0ac3Slogwang.\" notice, this list of conditions and the following disclaimer in the 111eaf0ac3Slogwang.\" documentation and/or other materials provided with the distribution. 121eaf0ac3Slogwang.\" 131eaf0ac3Slogwang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 141eaf0ac3Slogwang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 151eaf0ac3Slogwang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 161eaf0ac3Slogwang.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 171eaf0ac3Slogwang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 181eaf0ac3Slogwang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 191eaf0ac3Slogwang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 201eaf0ac3Slogwang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 211eaf0ac3Slogwang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 221eaf0ac3Slogwang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 231eaf0ac3Slogwang.\" SUCH DAMAGE. 241eaf0ac3Slogwang.\" 251eaf0ac3Slogwang.\" $FreeBSD$ 261eaf0ac3Slogwang.\" 27*22ce4affSfengbojiang.Dd May 20, 2020 281eaf0ac3Slogwang.Dt KINFO_GETVMOBJECT 3 291eaf0ac3Slogwang.Os 301eaf0ac3Slogwang.Sh NAME 311eaf0ac3Slogwang.Nm kinfo_getvmobject 321eaf0ac3Slogwang.Nd function for getting system-wide memory information 331eaf0ac3Slogwang.Sh LIBRARY 341eaf0ac3Slogwang.Lb libutil 351eaf0ac3Slogwang.Sh SYNOPSIS 361eaf0ac3Slogwang.In sys/types.h 371eaf0ac3Slogwang.In sys/user.h 381eaf0ac3Slogwang.In libutil.h 391eaf0ac3Slogwang.Ft struct kinfo_vmobject * 401eaf0ac3Slogwang.Fn kinfo_getvmobject "int *cntp" 411eaf0ac3Slogwang.Sh DESCRIPTION 421eaf0ac3SlogwangThis function is used to obtain information about the objects using memory 431eaf0ac3Slogwangin the system. 441eaf0ac3Slogwang.Pp 451eaf0ac3SlogwangThe 461eaf0ac3Slogwang.Ar cntp 471eaf0ac3Slogwangargument allows the caller to know how many records are returned. 481eaf0ac3Slogwang.Pp 491eaf0ac3SlogwangThis function is a wrapper around the 501eaf0ac3Slogwang.Dq vm.objects 511eaf0ac3Slogwang.Xr sysctl 3 521eaf0ac3SlogwangMIB. 531eaf0ac3SlogwangWhile the kernel returns a packed structure, this function expands the 541eaf0ac3Slogwangdata into a fixed record format. 551eaf0ac3Slogwang.Sh RETURN VALUES 561eaf0ac3SlogwangOn success the 571eaf0ac3Slogwang.Fn kinfo_getvmobject 581eaf0ac3Slogwangfunction returns a pointer to an array of 591eaf0ac3Slogwang.Vt struct kinfo_vmobject 601eaf0ac3Slogwangstructures as defined by 611eaf0ac3Slogwang.In sys/user.h . 621eaf0ac3SlogwangThe array is allocated by an internal call to 631eaf0ac3Slogwang.Xr malloc 3 641eaf0ac3Slogwangand must be freed by the caller with a call to 651eaf0ac3Slogwang.Xr free 3 . 661eaf0ac3SlogwangOn failure the 671eaf0ac3Slogwang.Fn kinfo_getvmobject 681eaf0ac3Slogwangfunction returns 691eaf0ac3Slogwang.Dv NULL . 701eaf0ac3Slogwang.Sh SEE ALSO 711eaf0ac3Slogwang.Xr free 3 , 721eaf0ac3Slogwang.Xr kinfo_getvmmap 3 , 731eaf0ac3Slogwang.Xr malloc 3 74*22ce4affSfengbojiang.Sh HISTORY 75*22ce4affSfengbojiangThe 76*22ce4affSfengbojiang.Fn kinfo_getvmobject 77*22ce4affSfengbojiangfunction first appeared in 78*22ce4affSfengbojiang.Fx 10.2 . 79