1*0a6a1f1dSLionel Sambuc.\" $NetBSD: kinfo_getvmmap.3,v 1.1 2015/09/24 14:39:20 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2008 Peter Wemm 4*0a6a1f1dSLionel Sambuc.\" All rights reserved. 5*0a6a1f1dSLionel Sambuc.\" 6*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 7*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 8*0a6a1f1dSLionel Sambuc.\" are met: 9*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 10*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 11*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 12*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 13*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 14*0a6a1f1dSLionel Sambuc.\" 15*0a6a1f1dSLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16*0a6a1f1dSLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17*0a6a1f1dSLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18*0a6a1f1dSLionel Sambuc.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19*0a6a1f1dSLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20*0a6a1f1dSLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21*0a6a1f1dSLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22*0a6a1f1dSLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23*0a6a1f1dSLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24*0a6a1f1dSLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25*0a6a1f1dSLionel Sambuc.\" SUCH DAMAGE. 26*0a6a1f1dSLionel Sambuc.\" 27*0a6a1f1dSLionel Sambuc.\" $FreeBSD: head/lib/libutil/kinfo_getvmmap.3 283622 2015-05-27 17:51:06Z jhb $ 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd September 16, 2015 30*0a6a1f1dSLionel Sambuc.Dt KINFO_GETVMMAP 3 31*0a6a1f1dSLionel Sambuc.Os 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm kinfo_getvmmap 34*0a6a1f1dSLionel Sambuc.Nd function for getting per-process memory map information 35*0a6a1f1dSLionel Sambuc.Sh LIBRARY 36*0a6a1f1dSLionel Sambuc.Lb libutil 37*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 38*0a6a1f1dSLionel Sambuc.In sys/types.h 39*0a6a1f1dSLionel Sambuc.In sys/sysctl.h 40*0a6a1f1dSLionel Sambuc.In util.h 41*0a6a1f1dSLionel Sambuc.Ft struct kinfo_vmentry * 42*0a6a1f1dSLionel Sambuc.Fn kinfo_getvmmap "pid_t pid" "size_t *cntp" 43*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 44*0a6a1f1dSLionel SambucThis function is used for obtaining virtual memory mapping information 45*0a6a1f1dSLionel Sambucof a particular process. 46*0a6a1f1dSLionel Sambuc.Pp 47*0a6a1f1dSLionel SambucThe 48*0a6a1f1dSLionel Sambuc.Ar pid 49*0a6a1f1dSLionel Sambucfield contains the process identifier. 50*0a6a1f1dSLionel SambucThis should be the a process that you have privilege to access. 51*0a6a1f1dSLionel SambucThe 52*0a6a1f1dSLionel Sambuc.Ar cntp 53*0a6a1f1dSLionel Sambucfield is allows the caller to know how many records are returned. 54*0a6a1f1dSLionel Sambuc.Pp 55*0a6a1f1dSLionel SambucThis function is a wrapper around 56*0a6a1f1dSLionel Sambuc.Xr sysctl 3 57*0a6a1f1dSLionel Sambucwith the 58*0a6a1f1dSLionel Sambuc.Dv KERN_PROC_VMMAP 59*0a6a1f1dSLionel Sambucmib. 60*0a6a1f1dSLionel SambucWhile the kernel returns a packed structure, this function expands the 61*0a6a1f1dSLionel Sambucdata into a fixed record format. 62*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 63*0a6a1f1dSLionel SambucOn success the 64*0a6a1f1dSLionel Sambuc.Fn kinfo_getvmmap 65*0a6a1f1dSLionel Sambucfunction returns a pointer to an array of 66*0a6a1f1dSLionel Sambuc.Vt struct kinfo_vmentry 67*0a6a1f1dSLionel Sambucstructures as defined by 68*0a6a1f1dSLionel Sambuc.In sys/sysctl.h . 69*0a6a1f1dSLionel SambucThe array was obtained by an internal call to 70*0a6a1f1dSLionel Sambuc.Xr malloc 3 71*0a6a1f1dSLionel Sambucand must be freed by the caller with a call to 72*0a6a1f1dSLionel Sambuc.Xr free 3 . 73*0a6a1f1dSLionel SambucOn failure the 74*0a6a1f1dSLionel Sambuc.Fn kinfo_getvmmap 75*0a6a1f1dSLionel Sambucfunction returns 76*0a6a1f1dSLionel Sambuc.Dv NULL . 77*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 78*0a6a1f1dSLionel Sambuc.Xr free 3 , 79*0a6a1f1dSLionel Sambuc.\" .Xr kinfo_getfile 3 , 80*0a6a1f1dSLionel Sambuc.Xr malloc 3 81