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

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