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