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