xnu-2422.1.72.tar.gz
[apple/xnu.git] / osfmk / man / MO_change_attributes.html
old mode 100755 (executable)
new mode 100644 (file)
index 1bca010..26f2b4f
@@ -1 +1,88 @@
-<h2>memory_object_change_attributes</h2>\r<hr>\r<p>\r<strong>Function</strong> - Modify caller-specified subset of attributes representing target memory object.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   memory_object_change_attributes</strong>\r                <strong>(memory_object_control_t</strong>         <var>memory_control</var>,\r                 <strong>memory_object_flavor_t</strong>                  <var>flavor</var>,\r                 <strong>memory_object_info_t</strong>                <var>attributes</var>,\r                 <strong>attributes</strong>                    <var>attributes_count</var>,\r                 <strong>mach_port_t</strong>                           <var>reply_to</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>memory_control</var> \r<dd>\r[in memory-cache-control send right]\rThe memory cache control port \rto be used by the memory manager for cache management requests. \rThis port is provided by the kernel in a <strong>memory_object_init</strong>\r     or <strong>memory_object_create</strong> call.\r<p>\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of information to be changed.  Valid values are:\r<dl>\r<p>\r<dt> <strong>MEMORY_OBJECT_PERFORMANCE_INFO</strong>\r<dd>\rPerformance related attributes such as the cache indicator and \rthe cluster size.  <var>attributes</var> should specify a structure of type \r<strong>memory_object_perf_info</strong>.\r<p>\r<dt> <strong>MEMORY_OBJECT_BEHAVIOR_INFO</strong>\r<dd>\rBehavior related attributes such as the copy strategy and sync \rinvalidate flag.  <var>attributes</var> should specify a structure of type \r<strong>memory_object_behavior_info</strong>.\r<p>\r<dt> <strong>MEMORY_OBJECT_ATTRIBUTES_INFO</strong>\r<dd>\rBehavior and performance related attributes such as the copy strategy,\rcache indicator, and cluster size.  <var>attributes</var> should specify a structure of type \r<strong>memory_object_attr_info</strong>.\r</dl>\r<p>\r<dt> <var>attributes</var> \r<dd>\r[pointer to in structure]\rNew attributes.\r<p>\r<dt> <var>attributes_count</var> \r<dd>\r[in scalar]\rThe size of the buffer (in natural-sized units).\r<p>\r<dt> <var>reply_port</var> \r<dd>\r[in reply receive (to be converted to send) right]\rA port to which a\rreply (<strong>memory_object_change_completed</strong>) is to be sent indicating the \rcompletion of the attribute change.  Such a reply would be useful if the \rcache attribute is turned off, since such a change, if the memory object \ris no longer mapped, may result in the object being terminated.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>memory_object_change_attributes</strong> function sets various\rattributes of the \rspecified memory object.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="MO_change_completed.html"><strong>memory_object_change_completed</strong></a>,\r<a href="MO_get_attributes.html"><strong>memory_object_get_attributes</strong></a>,\r<a href="memory_object_create.html"><strong>memory_object_create</strong></a>.\r<p>\rData Structures:\r<a href="memory_object_perf_info.html"><strong>memory_object_perf_info</strong></a>,\r<a href="memory_object_attr_info.html"><strong>memory_object_attr_info</strong></a>.\r\r\r
\ No newline at end of file
+<h2>memory_object_change_attributes</h2>
+<hr>
+<p>
+<strong>Function</strong> - Modify caller-specified subset of attributes representing target memory object.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   memory_object_change_attributes</strong>
+                <strong>(memory_object_control_t</strong>         <var>memory_control</var>,
+                 <strong>memory_object_flavor_t</strong>                  <var>flavor</var>,
+                 <strong>memory_object_info_t</strong>                <var>attributes</var>,
+                 <strong>attributes</strong>                    <var>attributes_count</var>,
+                 <strong>mach_port_t</strong>                           <var>reply_to</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>memory_control</var> 
+<dd>
+[in memory-cache-control send right]
+The memory cache control port 
+to be used by the memory manager for cache management requests. 
+This port is provided by the kernel in a <strong>memory_object_init</strong>
+     or <strong>memory_object_create</strong> call.
+<p>
+<dt> <var>flavor</var> 
+<dd>
+[in scalar]
+The type of information to be changed.  Valid values are:
+<dl>
+<p>
+<dt> <strong>MEMORY_OBJECT_PERFORMANCE_INFO</strong>
+<dd>
+Performance related attributes such as the cache indicator and 
+the cluster size.  <var>attributes</var> should specify a structure of type 
+<strong>memory_object_perf_info</strong>.
+<p>
+<dt> <strong>MEMORY_OBJECT_BEHAVIOR_INFO</strong>
+<dd>
+Behavior related attributes such as the copy strategy and sync 
+invalidate flag.  <var>attributes</var> should specify a structure of type 
+<strong>memory_object_behavior_info</strong>.
+<p>
+<dt> <strong>MEMORY_OBJECT_ATTRIBUTES_INFO</strong>
+<dd>
+Behavior and performance related attributes such as the copy strategy,
+cache indicator, and cluster size.  <var>attributes</var> should specify a structure of type 
+<strong>memory_object_attr_info</strong>.
+</dl>
+<p>
+<dt> <var>attributes</var> 
+<dd>
+[pointer to in structure]
+New attributes.
+<p>
+<dt> <var>attributes_count</var> 
+<dd>
+[in scalar]
+The size of the buffer (in natural-sized units).
+<p>
+<dt> <var>reply_port</var> 
+<dd>
+[in reply receive (to be converted to send) right]
+A port to which a
+reply (<strong>memory_object_change_completed</strong>) is to be sent indicating the 
+completion of the attribute change.  Such a reply would be useful if the 
+cache attribute is turned off, since such a change, if the memory object 
+is no longer mapped, may result in the object being terminated.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>memory_object_change_attributes</strong> function sets various
+attributes of the 
+specified memory object.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="MO_change_completed.html"><strong>memory_object_change_completed</strong></a>,
+<a href="MO_get_attributes.html"><strong>memory_object_get_attributes</strong></a>,
+<a href="memory_object_create.html"><strong>memory_object_create</strong></a>.
+<p>
+Data Structures:
+<a href="memory_object_perf_info.html"><strong>memory_object_perf_info</strong></a>,
+<a href="memory_object_attr_info.html"><strong>memory_object_attr_info</strong></a>.
+
+