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