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