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