xnu-2422.1.72.tar.gz

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

<h2>processor_info</h2>
<hr>
<p>
<strong>Function</strong> - Return information about a processor.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t	processor_info</strong>
		<strong>(processor_t</strong>	<var>processor</var>,
		<strong>processor_flavor_t</strong>	<var>flavor</var>,
		<strong>host_t</strong>	<var>host</var>,
		<strong>processor_info_t</strong>	<var>processor_info</var>,
		<strong>mach_msg_type_number_t</strong>	<var>processor_info_count</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<dt> <var>processor</var> 
<dd>
[in processor send right]
A processor port for which information is
desired.
<dt> <var>flavor</var> 
<dd>
[in scalar]
The type of information requested.
<dl>
<dt> <strong>PROCESSOR_BASIC_INFO</strong>
<dd>
Basic information, slot number, running status, etc.  The
returned structure is <strong>processor_basic_info</strong>.
</dl>
<dt> <var>host</var> 
<dd>
[out host-name send right]
The host on which the processor resides. 
This is the host name port.
<dt> <var>processor_info</var> 
<dd>
[out structure]
Information about the processor.
<dt> <var>processor_info_count</var> 
<dd>
[in/out scalar]
On input, the maximum size of the buffer; on output, the 
size returned (in natural-sized units).
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>processor_info</strong> function returns selected information
for a processor, as specified by <var>flavor</var>.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="processor_start.html">processor_start</a>,
<a href="processor_exit.html">processor_exit</a>,
<a href="processor_control.html">processor_control</a>,
<a href="host_processors.html">host_processors</a>.
<p>
Data Structures:
<a href="processor_basic_info.html">processor_basic_info</a>.