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