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