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