osfmk/man/memory_object_server.html

   1 <h2>memory_object_server</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Handle kernel operation request aimed at a given memory manager.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>boolean_t       memory_object_server</strong>
   8                 <strong>(mach_msg_header_t</strong>     <var>request_msg</var>,
   9                 <strong>mach_msg_header_t</strong>      <var>reply_ms</var><strong>);</strong>
  10 </pre>
  11 <h3>PARAMETERS</h3>
  12 <dl>
  13 <p>
  14 <dt> <var>in_msg</var>
  15 <dd>
  16 [pointer to in structure]
  17 The memory manager message received from
  18 the kernel.
  19 <p>
  20 <dt> <var>out_msg</var>
  21 <dd>
  22 [out structure]
  23 A reply message.  No messages to a memory manager
  24 expect a direct reply, so this field is not used.
  25 </dl>
  26 <h3>DESCRIPTION</h3>
  27 <p>
  28 The <strong>memory_object_server</strong> function is the MIG generated
  29 server handling
  30 function to handle messages from the kernel targeted to a memory manager.
  31 <p>
  32 A \*Vmemory manager\*O
  33 is a server task that responds to specific messages from the
  34 kernel in order to handle memory management functions for the kernel.  The
  35 <strong>memory_object_server</strong> function performs all necessary
  36 argument handling for
  37 a kernel message and calls one of the memory manager functions to interpret
  38 the message.
  39 <h3>RETURN VALUES</h3>
  40 <dl>
  41 <p>
  42 <dt> <strong>TRUE</strong>
  43 <dd>
  44 The message was handled and the appropriate function was called.
  45 <p>
  46 <dt> <strong>FALSE</strong>
  47 <dd>
  48 The message did not apply to this memory management interface and
  49 no other action was taken.
  50 </dl>
  51 <h3>RELATED INFORMATION</h3>
  52 <p>
  53 Functions:
  54 <a href="MO_default_server.html"><strong>memory_object_default_server<strong></a>,
  55 <a href="memory_object_data_request.html"><strong>memory_object_data_request<strong></a>,
  56 <a href="memory_object_data_return.html"><strong>memory_object_data_return<strong></a>,
  57 <a href="memory_object_data_unlock.html"><strong>memory_object_data_unlock<strong></a>,
  58 <a href="MO_lock_completed.html"><strong>memory_object_lock_completed<strong></a>,
  59 <a href="MO_change_completed.html"><strong>memory_object_change_completed<strong></a>,
  60 <a href="MO_supply_completed.html"><strong>memory_object_supply_completed<strong></a>,
  61 <a href="memory_object_terminate.html"><strong>memory_object_terminate<strong></a>,
  62 <a href="memory_object_synchronize.html"><strong>memory_object_synchronize<strong></a>,
  63 <a href="SMO_server.html"><strong>seqnos_memory_object_server<strong></a>.