xref: /xnu-10002.41.9/osfmk/man/vm_region_basic_info.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>vm_region_basic_info</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Structure</strong> - Defines the attributes of a task's memory region.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>struct vm_region_basic_info</strong>
8*699cd480SApple OSS Distributions<strong>{</strong>
9*699cd480SApple OSS Distributions       <strong>vm_prot_t</strong>             <var>protection</var><strong>;</strong>
10*699cd480SApple OSS Distributions       <strong>vm_prot_t</strong>         <var>max_protection</var><strong>;</strong>
11*699cd480SApple OSS Distributions       <strong>vm_inherit_t</strong>         <var>inheritance</var><strong>;</strong>
12*699cd480SApple OSS Distributions       <strong>boolean_t</strong>                 <var>shared</var><strong>;</strong>
13*699cd480SApple OSS Distributions       <strong>boolean_t</strong>               <var>reserved</var><strong>;</strong>
14*699cd480SApple OSS Distributions       <strong>vm_offset_t</strong>               <var>offset</var><strong>;</strong>
15*699cd480SApple OSS Distributions       <strong>vm_behavior_t</strong>           <var>behavior</var><strong>;</strong>
16*699cd480SApple OSS Distributions       <strong>unsigned short</strong>  <var>user_wired_count</var><strong>;</strong>
17*699cd480SApple OSS Distributions<strong>};</strong>
18*699cd480SApple OSS Distributions
19*699cd480SApple OSS Distributions<strong>typedef struct vm_region_basic_info* vm_region_basic_info_t;</strong>
20*699cd480SApple OSS Distributions</pre>
21*699cd480SApple OSS Distributions<h3>FIELDS</h3>
22*699cd480SApple OSS Distributions<dl>
23*699cd480SApple OSS Distributions<dt> <var>protection</var>
24*699cd480SApple OSS Distributions<dd>
25*699cd480SApple OSS DistributionsThe current protection for the region.
26*699cd480SApple OSS Distributions<p>
27*699cd480SApple OSS Distributions<dt> <var>max_protection</var>
28*699cd480SApple OSS Distributions<dd>
29*699cd480SApple OSS DistributionsThe maximum protection allowed for the region.
30*699cd480SApple OSS Distributions<p>
31*699cd480SApple OSS Distributions<dt> <var>inheritance</var>
32*699cd480SApple OSS Distributions<dd>
33*699cd480SApple OSS DistributionsThe inheritance attribute for the region.
34*699cd480SApple OSS Distributions<p>
35*699cd480SApple OSS Distributions<dt> <var>shared</var>
36*699cd480SApple OSS Distributions<dd>
37*699cd480SApple OSS DistributionsShared indicator.  If true, the region is shared by another task.  If false,
38*699cd480SApple OSS Distributionsthe region is not shared.
39*699cd480SApple OSS Distributions<p>
40*699cd480SApple OSS Distributions<dt> <var>reserved</var>
41*699cd480SApple OSS Distributions<dd>
42*699cd480SApple OSS DistributionsIf true the region is protected from random allocation.
43*699cd480SApple OSS Distributions<p>
44*699cd480SApple OSS Distributions<dt> <var>offset</var>
45*699cd480SApple OSS Distributions<dd>
46*699cd480SApple OSS DistributionsThe region's offset into the memory object.  The region begins at this
47*699cd480SApple OSS Distributionsoffset.
48*699cd480SApple OSS Distributions<p>
49*699cd480SApple OSS Distributions<dt> <var>behavior</var>
50*699cd480SApple OSS Distributions<dd>
51*699cd480SApple OSS DistributionsExpected reference pattern for the memory.  Valid values are:
52*699cd480SApple OSS Distributions<dl>
53*699cd480SApple OSS Distributions<p>
54*699cd480SApple OSS Distributions<dt> <strong>VM_BEHAVIOR_DEFAULT</strong>
55*699cd480SApple OSS Distributions<dd>
56*699cd480SApple OSS DistributionsThe system's default behavior.
57*699cd480SApple OSS Distributions<p>
58*699cd480SApple OSS Distributions<dt> <strong>VM_BEHAVIOR_RANDOM</strong>
59*699cd480SApple OSS Distributions<dd>
60*699cd480SApple OSS DistributionsNo particular order expected.
61*699cd480SApple OSS Distributions<p>
62*699cd480SApple OSS Distributions<dt> <strong>VM_BEHAVIOR_SEQUENTIAL</strong>
63*699cd480SApple OSS Distributions<dd>
64*699cd480SApple OSS DistributionsForward sequential order.
65*699cd480SApple OSS Distributions<p>
66*699cd480SApple OSS Distributions<dt> <strong>VM_BEHAVIOR_RSEQNTL</strong>
67*699cd480SApple OSS Distributions<dd>
68*699cd480SApple OSS DistributionsReverse sequential order.
69*699cd480SApple OSS Distributions</dl>
70*699cd480SApple OSS Distributions</dl>
71*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
72*699cd480SApple OSS Distributions<p>
73*699cd480SApple OSS DistributionsThe <strong>vm_region_basic_info</strong> structure defines the attributes
74*699cd480SApple OSS Distributionsof a memory region returned by <strong>vm_region</strong>.
75*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
76*699cd480SApple OSS Distributions<p>
77*699cd480SApple OSS DistributionsFunctions:
78*699cd480SApple OSS Distributions<a href="vm_region.html"><strong>vm_region</strong></a>,
79*699cd480SApple OSS Distributions<a href="vm_inherit.html"><strong>vm_inherit</strong></a>,
80*699cd480SApple OSS Distributions<a href="vm_protect.html"><strong>vm_protect</strong></a>.
81