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