xnu-1504.3.12.tar.gz

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

<h2>host_processor_slots</h2>
<hr>
<p>
<strong>Function</strong> - Return a list of numbers that map processor slots to active processors.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   host_processor_slots</strong>
                <strong>(host_t</strong>                                    <var>host</var>,
                 <strong>processor_slot_t</strong>                         <var>slots</var>,
                 <strong>host</strong>                                     <var>count</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>host</var> 
<dd>
[in host-name send right]
The name (or control) port for the host for 
which information is to be obtained.
<p>
<dt> <var>slots</var> 
<dd>
[out array of <var>processor_slot_t</var>]
An array of the processor slot numbers 
for active processors.
<p>
<dt> <var>count</var> 
<dd>
[pointer to in/out scalar]
On input, the maximum size of the slots
buffer; on output, the number of returned slot numbers.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>host_processor_slots</strong> function returns an array
of the processor slots
defined for the host.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="host_info.html"><strong>host_info</strong></a>,
<a href="host_processors.html"><strong>host_processors</strong></a>,
<a href="processor_info.html"><strong>processor_info</strong></a>.