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

<h2>host_default_memory_manager</h2>\r<hr>\r<p>\r<strong>Function</strong> - Establish the official connection between the kernel and its default pager task.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   host_default_memory_manager</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>mach_port_make_send_t</strong>          <var>default_manager</var>,\r                 <strong>vm_size_t</strong>                         <var>cluster_size</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>host_priv</var> \r<dd>\r[in host-control send right]\rThe control port naming the host for which \rthe default memory manager is to be set.\r<p>\r<dt> <var>default_manager</var> \r<dd>\r[pointer to in/out default-pager send right]\rA memory manager port to \rthe new default memory manager.  If this value is <strong>MACH_PORT_NULL</strong>, \rthe old memory manager is not changed.  The old memory\rmanager port is returned in this variable.\r<p>\r<dt> <var>cluster_size</var> \r<dd>\r[in scalar]\rThe preferred cluster size (in bytes) for temporary memory \robjects.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>host_default_memory_manager</strong> function establishes the default\rmemory manager for a host.  The named manager will be the target for future\r<strong>memory_object_create</strong> calls.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="memory_object_create.html"><strong>memory_object_create</strong></a>,\r<a href="vm_allocate.html"><strong>vm_allocate</strong></a>.\r