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