2 .\" Copyright (c) 2008 Peter Wemm
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
31 .Nd function for getting per-process memory map information
38 .Ft struct kinfo_vmentry *
39 .Fn kinfo_getvmmap "pid_t pid" "int *cntp"
41 This function is used for obtaining virtual memory mapping information
42 of a particular process.
46 field contains the process identifier.
47 This should be the a process that you have privilege to access.
50 field is allows the caller to know how many records are returned.
52 This function is a wrapper around
57 While the kernel returns a packed structure, this function expands the
58 data into a fixed record format.
62 function returns a pointer to an array of
63 .Vt struct kinfo_vmentry
64 structures as defined by
66 The array was obtained by an internal call to
68 and must be freed by the caller with a call to
81 function first appeared in
85 calls can cause significant CPU consumption because calculating the residency
86 counts requires iterating over all memory pages of the process.
87 Setting the sysctl variable
88 .Va kern.proc_vmmap_skip_resident_count
89 to 1 prevents this calculation.