kinfo_getvmobject(3)

kinfo_getvmobject3

Function for getting system-wide memory information

Usage

#include <sys/types.h>

#include <sys/user.h>

#include <libutil.h>

struct kinfo_vmobject *

kinfo_getvmobject(int *cntp);

Library

System Utilities Library (libutil, -lutil)

Overview

This function is used to obtain information about the objects using memory in the system.

The cntp argument allows the caller to know how many records are returned.

This function is a wrapper around the “vm.objects” sysctl(3) MIB. While the kernel returns a packed structure, this function expands the data into a fixed record format.

Return values

On success the kinfo_getvmobject() function returns a pointer to an array of struct kinfo_vmobject structures as defined by ⟨sys/user.h⟩. The array is allocated by an internal call to malloc(3) and must be freed by the caller with a call to free(3). On failure the kinfo_getvmobject() function returns NULL.

Releases

27 releases since FreeBSD 10.3-RELEASE; the text changed 13 times.

  1. 10.3
  2. 10.4
  3. 11.0
  4. 11.1
  5. 11.2
  6. 11.3
  7. 11.4
  8. 12.0
  9. 12.1
  10. 12.2
  11. 12.3
  12. 12.4
  13. 13.0–13.2
  14. 13.3–16.0

History

The kinfo_getvmobject() function first appeared in FreeBSD 10.2.

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.