xnu-792.6.76.tar.gz

[apple/xnu.git] / osfmk / man / memory_object_server.html

diff --git a/osfmk/man/memory_object_server.html b/osfmk/man/memory_object_server.html
index 7e10a7894f6e163d17de2b8d5c46ee5017ad9bdb..98cdd9848ea9b36ab2efd421f683124ea693cd11 100755 (executable)
--- a/osfmk/man/memory_object_server.html
+++ b/osfmk/man/memory_object_server.html
@@ -1 +1,63 @@
-<h2>memory_object_server</h2>\r<hr>\r<p>\r<strong>Function</strong> - Handle kernel operation request aimed at a given memory manager.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>boolean_t  memory_object_server</strong>\r          <strong>(mach_msg_header_t</strong>     <var>request_msg</var>,\r                <strong>mach_msg_header_t</strong>      <var>reply_ms</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>in_msg</var> \r<dd>\r[pointer to in structure]\rThe memory manager message received from \rthe kernel.\r<p>\r<dt> <var>out_msg</var> \r<dd>\r[out structure]\rA reply message.  No messages to a memory manager \rexpect a direct reply, so this field is not used.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>memory_object_server</strong> function is the MIG generated\rserver handling \rfunction to handle messages from the kernel targeted to a memory manager.\r<p>\rA \*Vmemory manager\*O \ris a server task that responds to specific messages from the \rkernel in order to handle memory management functions for the kernel.  The \r<strong>memory_object_server</strong> function performs all necessary\rargument handling for \ra kernel message and calls one of the memory manager functions to interpret \rthe message.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>TRUE</strong>\r<dd>\rThe message was handled and the appropriate function was called.\r<p>\r<dt> <strong>FALSE</strong>\r<dd>\rThe message did not apply to this memory management interface and \rno other action was taken.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="MO_default_server.html"><strong>memory_object_default_server<strong></a>,\r<a href="memory_object_data_request.html"><strong>memory_object_data_request<strong></a>,\r<a href="memory_object_data_return.html"><strong>memory_object_data_return<strong></a>,\r<a href="memory_object_data_unlock.html"><strong>memory_object_data_unlock<strong></a>,\r<a href="MO_lock_completed.html"><strong>memory_object_lock_completed<strong></a>,\r<a href="MO_change_completed.html"><strong>memory_object_change_completed<strong></a>,\r<a href="MO_supply_completed.html"><strong>memory_object_supply_completed<strong></a>,\r<a href="memory_object_terminate.html"><strong>memory_object_terminate<strong></a>, \r<a href="memory_object_synchronize.html"><strong>memory_object_synchronize<strong></a>,\r<a href="SMO_server.html"><strong>seqnos_memory_object_server<strong></a>.\r
\ No newline at end of file
+<h2>memory_object_server</h2>
+<hr>
+<p>
+<strong>Function</strong> - Handle kernel operation request aimed at a given memory manager.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>boolean_t      memory_object_server</strong>
+               <strong>(mach_msg_header_t</strong>     <var>request_msg</var>,
+               <strong>mach_msg_header_t</strong>      <var>reply_ms</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>in_msg</var> 
+<dd>
+[pointer to in structure]
+The memory manager message received from 
+the kernel.
+<p>
+<dt> <var>out_msg</var> 
+<dd>
+[out structure]
+A reply message.  No messages to a memory manager 
+expect a direct reply, so this field is not used.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>memory_object_server</strong> function is the MIG generated
+server handling 
+function to handle messages from the kernel targeted to a memory manager.
+<p>
+A \*Vmemory manager\*O 
+is a server task that responds to specific messages from the 
+kernel in order to handle memory management functions for the kernel.  The 
+<strong>memory_object_server</strong> function performs all necessary
+argument handling for 
+a kernel message and calls one of the memory manager functions to interpret 
+the message.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>TRUE</strong>
+<dd>
+The message was handled and the appropriate function was called.
+<p>
+<dt> <strong>FALSE</strong>
+<dd>
+The message did not apply to this memory management interface and 
+no other action was taken.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="MO_default_server.html"><strong>memory_object_default_server<strong></a>,
+<a href="memory_object_data_request.html"><strong>memory_object_data_request<strong></a>,
+<a href="memory_object_data_return.html"><strong>memory_object_data_return<strong></a>,
+<a href="memory_object_data_unlock.html"><strong>memory_object_data_unlock<strong></a>,
+<a href="MO_lock_completed.html"><strong>memory_object_lock_completed<strong></a>,
+<a href="MO_change_completed.html"><strong>memory_object_change_completed<strong></a>,
+<a href="MO_supply_completed.html"><strong>memory_object_supply_completed<strong></a>,
+<a href="memory_object_terminate.html"><strong>memory_object_terminate<strong></a>, 
+<a href="memory_object_synchronize.html"><strong>memory_object_synchronize<strong></a>,
+<a href="SMO_server.html"><strong>seqnos_memory_object_server<strong></a>.