xref: /xnu-10002.1.13/osfmk/man/vm_machine_attribute.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>vm_machine_attribute</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Function</strong> - Get/set the target memory region's special attributes.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>kern_return_t   vm_machine_attribute</strong>
8*1031c584SApple OSS Distributions                <strong>(vm_task_t</strong>                          <var>target_task</var>,
9*1031c584SApple OSS Distributions                 <strong>vm_address_t</strong>                           <var>address</var>,
10*1031c584SApple OSS Distributions                 <strong>vm_size_t</strong>                                 <var>size</var>,
11*1031c584SApple OSS Distributions                 <strong>vm_machine_attribute_t</strong>               <var>attribute</var>,
12*1031c584SApple OSS Distributions                 <strong>vm_machine_attribute_val_t</strong>               <var>value</var><strong>);</strong>
13*1031c584SApple OSS Distributions</pre>
14*1031c584SApple OSS Distributions<h3>PARAMETERS</h3>
15*1031c584SApple OSS Distributions<dl>
16*1031c584SApple OSS Distributions<p>
17*1031c584SApple OSS Distributions<dt> <var>target_task</var>
18*1031c584SApple OSS Distributions<dd>
19*1031c584SApple OSS Distributions[in task send right]
20*1031c584SApple OSS DistributionsThe port for the task in whose address space the
21*1031c584SApple OSS Distributionsmemory object is to be manipulated.
22*1031c584SApple OSS Distributions<p>
23*1031c584SApple OSS Distributions<dt> <var>address</var>
24*1031c584SApple OSS Distributions<dd>
25*1031c584SApple OSS Distributions[in scalar]
26*1031c584SApple OSS DistributionsThe starting address for the memory region.  The granularity
27*1031c584SApple OSS Distributionsof rounding of this value to page boundaries is implementation
28*1031c584SApple OSS Distributionsdependent.
29*1031c584SApple OSS Distributions<p>
30*1031c584SApple OSS Distributions<dt> <var>size</var>
31*1031c584SApple OSS Distributions<dd>
32*1031c584SApple OSS Distributions[in scalar]
33*1031c584SApple OSS DistributionsThe number of bytes in the region.  The granularity of
34*1031c584SApple OSS Distributionsrounding of this value to page boundaries is implementation dependent.
35*1031c584SApple OSS Distributions<p>
36*1031c584SApple OSS Distributions<dt> <var>attribute</var>
37*1031c584SApple OSS Distributions<dd>
38*1031c584SApple OSS Distributions[in scalar]
39*1031c584SApple OSS DistributionsThe name of the attribute to be get/set.  Possible values are:
40*1031c584SApple OSS Distributions<dl>
41*1031c584SApple OSS Distributions<p>
42*1031c584SApple OSS Distributions<dt> <strong>MATTR_CACHE</strong>
43*1031c584SApple OSS Distributions<dd>
44*1031c584SApple OSS DistributionsCachability.  Aside from the generic values listed below, the
45*1031c584SApple OSS Distributionsfollowing special values are defined:
46*1031c584SApple OSS Distributions<dl>
47*1031c584SApple OSS Distributions<p>
48*1031c584SApple OSS Distributions<dt> <strong>MATTR_VAL_CACHE_FLUSH</strong>
49*1031c584SApple OSS Distributions<dd>
50*1031c584SApple OSS DistributionsFlush from all caches
51*1031c584SApple OSS Distributions<p>
52*1031c584SApple OSS Distributions<dt> <strong>MATTR_VAL_DCACHE_FLUSH</strong>
53*1031c584SApple OSS Distributions<dd>
54*1031c584SApple OSS DistributionsFlush from data caches
55*1031c584SApple OSS Distributions<p>
56*1031c584SApple OSS Distributions<dt> <strong>MATTR_VAL_ICACHE_FLUSH</strong>
57*1031c584SApple OSS Distributions<dd>
58*1031c584SApple OSS DistributionsFlush from instruction caches
59*1031c584SApple OSS Distributions</dl>
60*1031c584SApple OSS Distributions<p>
61*1031c584SApple OSS Distributions<dt> <strong>MATTR_MIGRATE</strong>
62*1031c584SApple OSS Distributions<dd>
63*1031c584SApple OSS DistributionsMigratability.
64*1031c584SApple OSS Distributions<p>
65*1031c584SApple OSS Distributions<dt> <strong>MATTR_REPLICATE</strong>
66*1031c584SApple OSS Distributions<dd>
67*1031c584SApple OSS DistributionsReplicability.
68*1031c584SApple OSS Distributions</dl>
69*1031c584SApple OSS Distributions<p>
70*1031c584SApple OSS Distributions<dt> <var>value</var>
71*1031c584SApple OSS Distributions<dd>
72*1031c584SApple OSS Distributions[pointer to in/out scalar]
73*1031c584SApple OSS DistributionsThe new value for the attribute.  The old value
74*1031c584SApple OSS Distributionsis also returned in this variable.  The new value can be a specific value
75*1031c584SApple OSS Distributionslisted above, or one of the following generic values:
76*1031c584SApple OSS Distributions<dl>
77*1031c584SApple OSS Distributions<p>
78*1031c584SApple OSS Distributions<dt> <strong>MATTR_VAL_OFF</strong>
79*1031c584SApple OSS Distributions<dd>
80*1031c584SApple OSS DistributionsTurn attribute off.
81*1031c584SApple OSS Distributions<p>
82*1031c584SApple OSS Distributions<dt> <strong>MATTR_VAL_ON</strong>
83*1031c584SApple OSS Distributions<dd>
84*1031c584SApple OSS DistributionsTurn attribute on.
85*1031c584SApple OSS Distributions<p>
86*1031c584SApple OSS Distributions<dt> <strong>MATTR_VAL_GET</strong>
87*1031c584SApple OSS Distributions<dd>
88*1031c584SApple OSS DistributionsNo change, just return current value.
89*1031c584SApple OSS Distributions</dl>
90*1031c584SApple OSS Distributions</dl>
91*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
92*1031c584SApple OSS Distributions<p>
93*1031c584SApple OSS DistributionsThe <strong>vm_machine_attribute</strong> function gets and sets special
94*1031c584SApple OSS Distributionsattributes of the
95*1031c584SApple OSS Distributionsmemory region implemented by the underlying <strong>pmap</strong> module.  These attributes
96*1031c584SApple OSS Distributionsare properties such as cachability, migratability and replicability.
97*1031c584SApple OSS DistributionsThe behavior of this function is machine dependent.
98*1031c584SApple OSS Distributions<h3>NOTES</h3>
99*1031c584SApple OSS Distributions<p>
100*1031c584SApple OSS DistributionsThis interface is machine word length specific because of the virtual address
101*1031c584SApple OSS Distributionsparameter.
102*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3>
103*1031c584SApple OSS Distributions<dl>
104*1031c584SApple OSS Distributions<p>
105*1031c584SApple OSS Distributions<dt> <strong>KERN_INVALID_ADDRESS</strong>
106*1031c584SApple OSS Distributions<dd>
107*1031c584SApple OSS DistributionsThe address is illegal or specifies a non-allocated region.
108*1031c584SApple OSS Distributions</dl>
109*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
110*1031c584SApple OSS Distributions<p>
111*1031c584SApple OSS DistributionsFunctions:
112*1031c584SApple OSS Distributions<a href="vm_wire.html"><strong>vm_wire</strong></a>.
113