lib/libutil/kinfo_getvmmap.3

   1 .\"
   2 .\" Copyright (c) 2008 Peter Wemm
   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 December 6, 2008
  29 .Dt KINFO_GETVMMAP 3
  30 .Os
  31 .Sh NAME
  32 .Nm kinfo_getvmmap
  33 .Nd function for getting per-process memory map information
  34 .Sh LIBRARY
  35 .Lb libutil
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In libutil.h
  39 .Ft struct kinfo_vmentry *
  40 .Fn kinfo_getvmmap "pid_t pid" "int *cntp"
  41 .Sh DESCRIPTION
  42 This function is used for obtaining virtual memory mapping information
  43 of a particular process.
  44 .Pp
  45 The
  46 .Ar pid
  47 field contains the process identifier.
  48 This should be the a process that you have privilege to access.
  49 The
  50 .Ar cntp
  51 field is allows the caller to know how many records are returned.
  52 .Pp
  53 This function is a wrapper around
  54 .Xr sysctl 3
  55 with the
  56 .Dv KERN_PROC_VMMAP
  57 mib.
  58 While the kernel returns a packed structure, this function expands the
  59 data into a fixed record format.
  60 .Sh RETURN VALUES
  61 On success the
  62 .Fn kinfo_getvmmap
  63 function returns a pointer to an array of
  64 .Vt struct kinfo_vmentry
  65 structures as defined by
  66 .In sys/user.h .
  67 The array was obtained by an internal call to
  68 .Xr malloc 3
  69 and must be freed by the caller with a call to
  70 .Xr free 3 .
  71 On failure the
  72 .Fn kinfo_getvmmap
  73 function returns
  74 .Dv NULL .
  75 .Sh SEE ALSO
  76 .Xr free 3 ,
  77 .Xr kinfo_getfile 3 ,
  78 .Xr malloc 3