lib/libutil/kinfo_getvmobject.3

   1 .\"
   2 .\" Copyright (c) 2015 John Baldwin <jhb@FreeBSD.org>
   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 27, 2015
  29 .Dt KINFO_GETVMOBJECT 3
  30 .Os
  31 .Sh NAME
  32 .Nm kinfo_getvmobject
  33 .Nd function for getting system-wide memory information
  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_vmobject *
  41 .Fn kinfo_getvmobject "int *cntp"
  42 .Sh DESCRIPTION
  43 This function is used to obtain information about the objects using memory
  44 in the system.
  45 .Pp
  46 The
  47 .Ar cntp
  48 argument allows the caller to know how many records are returned.
  49 .Pp
  50 This function is a wrapper around the
  51 .Dq vm.objects
  52 .Xr sysctl 3
  53 MIB.
  54 While the kernel returns a packed structure, this function expands the
  55 data into a fixed record format.
  56 .Sh RETURN VALUES
  57 On success the
  58 .Fn kinfo_getvmobject
  59 function returns a pointer to an array of
  60 .Vt struct kinfo_vmobject
  61 structures as defined by
  62 .In sys/user.h .
  63 The array is allocated by an internal call to
  64 .Xr malloc 3
  65 and must be freed by the caller with a call to
  66 .Xr free 3 .
  67 On failure the
  68 .Fn kinfo_getvmobject
  69 function returns
  70 .Dv NULL .
  71 .Sh SEE ALSO
  72 .Xr free 3 ,
  73 .Xr kinfo_getvmmap 3 ,
  74 .Xr malloc 3