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