osfmk/man/HD_memory_manager.html

   1 <h2>host_default_memory_manager</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Establish the official connection between the kernel and its default pager task.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   host_default_memory_manager</strong>
   8                 <strong>(host_priv_t</strong>                          <var>host_priv</var>,
   9                  <strong>mach_port_make_send_t</strong>          <var>default_manager</var>,
  10                  <strong>vm_size_t</strong>                         <var>cluster_size</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <p>
  15 <dt> <var>host_priv</var>
  16 <dd>
  17 [in host-control send right]
  18 The control port naming the host for which
  19 the default memory manager is to be set.
  20 <p>
  21 <dt> <var>default_manager</var>
  22 <dd>
  23 [pointer to in/out default-pager send right]
  24 A memory manager port to
  25 the new default memory manager.  If this value is <strong>MACH_PORT_NULL</strong>,
  26 the old memory manager is not changed.  The old memory
  27 manager port is returned in this variable.
  28 <p>
  29 <dt> <var>cluster_size</var>
  30 <dd>
  31 [in scalar]
  32 The preferred cluster size (in bytes) for temporary memory
  33 objects.
  34 </dl>
  35 <h3>DESCRIPTION</h3>
  36 <p>
  37 The <strong>host_default_memory_manager</strong> function establishes the default
  38 memory manager for a host.  The named manager will be the target for future
  39 <strong>memory_object_create</strong> calls.
  40 <h3>RETURN VALUES</h3>
  41 <p>
  42 Only generic errors apply.
  43 <h3>RELATED INFORMATION</h3>
  44 <p>
  45 Functions:
  46 <a href="memory_object_create.html"><strong>memory_object_create</strong></a>,
  47 <a href="vm_allocate.html"><strong>vm_allocate</strong></a>.