xnu-1504.15.3.tar.gz

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

diff --git a/osfmk/man/SMO_default_server.html b/osfmk/man/SMO_default_server.html
index d3da6bbd77c919340ff3f3708bd2d59df294a843..2f8043d987cfde924e0d145b1832b37c34fe01fd 100755 (executable)
--- a/osfmk/man/SMO_default_server.html
+++ b/osfmk/man/SMO_default_server.html
@@ -1 +1,67 @@
-<h2>seqnos_memory_object_default_server</h2>\r<hr>\r<p>\r<strong>Function</strong> - Handle kernel operation request targeted for the default pager.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>boolean_t    seqnos_memory_object_default_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.  Note that no kernel messages to a \rmemory manager expect a direct reply.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>seqnos_memory_object_default_server</strong> function is\rthe MIG generated \rserver handling function to handle messages from the kernel targeted to the\rdefault memory manager.  This server function only handles messages unique to \rthe default memory manager.  Messages that are common to all memory\rmanagers are handled by <strong>seqnos_memory_object_server</strong>.\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>seqnos_memory_object_default_server</strong> function performs all necessary\rargument handling for a kernel message and calls one of the default memory \rmanager functions.\r<h3>NOTES</h3>\r<p>\r<strong>seqnos_memory_object_default_server</strong> differs from\r<strong>memory_object_default_server</strong> in that it supplies message\rsequence numbers to the server\rinterfaces it calls.\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="SMO_server.html"><strong>seqnos_memory_object_server<strong></a>,\r<a href="memory_object_create.html"><strong>seqnos_memory_object_create<strong></a>,\r<a href="MO_data_initialize.html"><strong>seqnos_memory_object_data_initialize<strong></a>,\r<a href="DP_object_create.html"><strong>seqnos_default_pager_object_create<strong></a>,\r<a href="default_pager_info.html"><strong>seqnos_default_pager_info<strong></a>.\r
\ No newline at end of file
+<h2>seqnos_memory_object_default_server</h2>
+<hr>
+<p>
+<strong>Function</strong> - Handle kernel operation request targeted for the default pager.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>boolean_t      seqnos_memory_object_default_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.  Note that no kernel messages to a 
+memory manager expect a direct reply.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>seqnos_memory_object_default_server</strong> function is
+the MIG generated 
+server handling function to handle messages from the kernel targeted to the
+default memory manager.  This server function only handles messages unique to 
+the default memory manager.  Messages that are common to all memory
+managers are handled by <strong>seqnos_memory_object_server</strong>.
+<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>seqnos_memory_object_default_server</strong> function performs all necessary
+argument handling for a kernel message and calls one of the default memory 
+manager functions.
+<h3>NOTES</h3>
+<p>
+<strong>seqnos_memory_object_default_server</strong> differs from
+<strong>memory_object_default_server</strong> in that it supplies message
+sequence numbers to the server
+interfaces it calls.
+<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="SMO_server.html"><strong>seqnos_memory_object_server<strong></a>,
+<a href="memory_object_create.html"><strong>seqnos_memory_object_create<strong></a>,
+<a href="MO_data_initialize.html"><strong>seqnos_memory_object_data_initialize<strong></a>,
+<a href="DP_object_create.html"><strong>seqnos_default_pager_object_create<strong></a>,
+<a href="default_pager_info.html"><strong>seqnos_default_pager_info<strong></a>.