xref: /xnu-11215/osfmk/man/processor_info.html (revision 186b8fce)
1*e13b1fa5SApple OSS Distributions<h2>processor_info</h2>
2*e13b1fa5SApple OSS Distributions<hr>
3*e13b1fa5SApple OSS Distributions<p>
4*e13b1fa5SApple OSS Distributions<strong>Function</strong> - Return information about a processor.
5*e13b1fa5SApple OSS Distributions<h3>SYNOPSIS</h3>
6*e13b1fa5SApple OSS Distributions<pre>
7*e13b1fa5SApple OSS Distributions<strong>kern_return_t	processor_info</strong>
8*e13b1fa5SApple OSS Distributions		<strong>(processor_t</strong>	<var>processor</var>,
9*e13b1fa5SApple OSS Distributions		<strong>processor_flavor_t</strong>	<var>flavor</var>,
10*e13b1fa5SApple OSS Distributions		<strong>host_t</strong>	<var>host</var>,
11*e13b1fa5SApple OSS Distributions		<strong>processor_info_t</strong>	<var>processor_info</var>,
12*e13b1fa5SApple OSS Distributions		<strong>mach_msg_type_number_t</strong>	<var>processor_info_count</var><strong>);</strong>
13*e13b1fa5SApple OSS Distributions</pre>
14*e13b1fa5SApple OSS Distributions<h3>PARAMETERS</h3>
15*e13b1fa5SApple OSS Distributions<dl>
16*e13b1fa5SApple OSS Distributions<dt> <var>processor</var>
17*e13b1fa5SApple OSS Distributions<dd>
18*e13b1fa5SApple OSS Distributions[in processor send right]
19*e13b1fa5SApple OSS DistributionsA processor port for which information is
20*e13b1fa5SApple OSS Distributionsdesired.
21*e13b1fa5SApple OSS Distributions<dt> <var>flavor</var>
22*e13b1fa5SApple OSS Distributions<dd>
23*e13b1fa5SApple OSS Distributions[in scalar]
24*e13b1fa5SApple OSS DistributionsThe type of information requested.
25*e13b1fa5SApple OSS Distributions<dl>
26*e13b1fa5SApple OSS Distributions<dt> <strong>PROCESSOR_BASIC_INFO</strong>
27*e13b1fa5SApple OSS Distributions<dd>
28*e13b1fa5SApple OSS DistributionsBasic information, slot number, running status, etc.  The
29*e13b1fa5SApple OSS Distributionsreturned structure is <strong>processor_basic_info</strong>.
30*e13b1fa5SApple OSS Distributions</dl>
31*e13b1fa5SApple OSS Distributions<dt> <var>host</var>
32*e13b1fa5SApple OSS Distributions<dd>
33*e13b1fa5SApple OSS Distributions[out host-name send right]
34*e13b1fa5SApple OSS DistributionsThe host on which the processor resides.
35*e13b1fa5SApple OSS DistributionsThis is the host name port.
36*e13b1fa5SApple OSS Distributions<dt> <var>processor_info</var>
37*e13b1fa5SApple OSS Distributions<dd>
38*e13b1fa5SApple OSS Distributions[out structure]
39*e13b1fa5SApple OSS DistributionsInformation about the processor.
40*e13b1fa5SApple OSS Distributions<dt> <var>processor_info_count</var>
41*e13b1fa5SApple OSS Distributions<dd>
42*e13b1fa5SApple OSS Distributions[in/out scalar]
43*e13b1fa5SApple OSS DistributionsOn input, the maximum size of the buffer; on output, the
44*e13b1fa5SApple OSS Distributionssize returned (in natural-sized units).
45*e13b1fa5SApple OSS Distributions</dl>
46*e13b1fa5SApple OSS Distributions<h3>DESCRIPTION</h3>
47*e13b1fa5SApple OSS Distributions<p>
48*e13b1fa5SApple OSS DistributionsThe <strong>processor_info</strong> function returns selected information
49*e13b1fa5SApple OSS Distributionsfor a processor, as specified by <var>flavor</var>.
50*e13b1fa5SApple OSS Distributions<h3>RETURN VALUES</h3>
51*e13b1fa5SApple OSS Distributions<p>
52*e13b1fa5SApple OSS DistributionsOnly generic errors apply.
53*e13b1fa5SApple OSS Distributions<h3>RELATED INFORMATION</h3>
54*e13b1fa5SApple OSS Distributions<p>
55*e13b1fa5SApple OSS DistributionsFunctions:
56*e13b1fa5SApple OSS Distributions<a href="processor_start.html">processor_start</a>,
57*e13b1fa5SApple OSS Distributions<a href="processor_exit.html">processor_exit</a>,
58*e13b1fa5SApple OSS Distributions<a href="processor_control.html">processor_control</a>,
59*e13b1fa5SApple OSS Distributions<a href="host_processors.html">host_processors</a>.
60*e13b1fa5SApple OSS Distributions<p>
61*e13b1fa5SApple OSS DistributionsData Structures:
62*e13b1fa5SApple OSS Distributions<a href="processor_basic_info.html">processor_basic_info</a>.
63