xnu-2422.1.72.tar.gz

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

<h2>default_pager_info</h2>
<hr>
<p>
<strong>Server Interface</strong> - Furnish caller with information about the pager's paging partition.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   default_pager_info</strong>
                <strong>(mach_port_t</strong>                              <var>pager</var>,
                 <strong>default_pager_info_t</strong>                      <var>info</var><strong>);</strong>


<strong>kern_return_t   seqnos_default_pager_info</strong>
                <strong>(mach_port_t</strong>                              <var>pager</var>,
                 <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,
                 <strong>default_pager_info_t</strong>                     <var>*info</var><strong>);</strong>

</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>pager</var> 
<dd>
[in default-pager (receive) right]
The default memory manager service 
port.
<p>
<dt> <var>seqno</var> 
<dd>
[in scalar]
The sequence number of this message relative to the pager 
port.
<p>
<dt> <var>info</var> 
<dd>
[out structure]
Total and free space consumption.
</dl>
<h3>DESCRIPTION</h3>
<p>
A <strong>default_pager_info</strong> function is called as the result
of a message requesting 
that the default memory manager return information concerning the default
pager's paging partitions.  The kernel does not make this call
itself (which is why it 
can be a synchronous call); this request is only issued by (privileged) tasks
holding the default memory manager port.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="HD_memory_manager.html"><strong>vm_set_default_memory_manager</strong></a>,
<a href="MO_default_server.html"><strong>memory_object_default_server</strong></a>,
<a href="SMO_default_server.html"><strong>seqnos_memory_object_default_server</strong></a>.
<p>
Data Structures:
<a href="default_pager_info.html"><strong>default_pager_info</strong></a>.