xref: /xnu-11215/osfmk/man/processor_exit.html (revision 186b8fce)
1*e13b1fa5SApple OSS Distributions<h2>processor_exit</h2>
2*e13b1fa5SApple OSS Distributions<hr>
3*e13b1fa5SApple OSS Distributions<p>
4*e13b1fa5SApple OSS Distributions<strong>Function</strong> - Exit a processor.
5*e13b1fa5SApple OSS Distributions<h3>SYNOPSIS</h3>
6*e13b1fa5SApple OSS Distributions<pre>
7*e13b1fa5SApple OSS Distributions<strong>kern_return_t	processor_exit</strong>
8*e13b1fa5SApple OSS Distributions		<strong>(processor_t</strong>	<var>processor</var><strong>);</strong>
9*e13b1fa5SApple OSS Distributions</pre>
10*e13b1fa5SApple OSS Distributions<h3>PARAMETERS</h3>
11*e13b1fa5SApple OSS Distributions<dl>
12*e13b1fa5SApple OSS Distributions<dt> <var>processor</var>
13*e13b1fa5SApple OSS Distributions<dd>
14*e13b1fa5SApple OSS Distributions[in processor send right]
15*e13b1fa5SApple OSS DistributionsThe processor to be controlled.
16*e13b1fa5SApple OSS Distributions</dl>
17*e13b1fa5SApple OSS Distributions<h3>DESCRIPTION</h3>
18*e13b1fa5SApple OSS Distributions<p>
19*e13b1fa5SApple OSS DistributionsThe <strong>processor_exit</strong> function allows privileged software
20*e13b1fa5SApple OSS Distributionsto exit a processor in a
21*e13b1fa5SApple OSS Distributionsmulti-processor that so allows it.  An exited processor is removed from the
22*e13b1fa5SApple OSS Distributionsprocessor set to which it was assigned and ceases to be active.
23*e13b1fa5SApple OSS DistributionsThe interpretation of
24*e13b1fa5SApple OSS Distributionsthis operation is machine dependent.
25*e13b1fa5SApple OSS Distributions<h3>NOTES</h3>
26*e13b1fa5SApple OSS Distributions<p>
27*e13b1fa5SApple OSS DistributionsThis operation is machine dependent.  It may do nothing.
28*e13b1fa5SApple OSS Distributions<h3>CAUTIONS</h3>
29*e13b1fa5SApple OSS Distributions<p>
30*e13b1fa5SApple OSS DistributionsThe ability to restart an exited processor is machine dependent.
31*e13b1fa5SApple OSS Distributions<h3>RETURN VALUES</h3>
32*e13b1fa5SApple OSS Distributions<dl>
33*e13b1fa5SApple OSS Distributions<dt> <strong>KERN_FAILURE</strong>
34*e13b1fa5SApple OSS Distributions<dd>
35*e13b1fa5SApple OSS DistributionsThe operation was not performed.  A likely reason is that it
36*e13b1fa5SApple OSS Distributionsis not supported on this processor.
37*e13b1fa5SApple OSS Distributions</dl>
38*e13b1fa5SApple OSS Distributions<h3>RELATED INFORMATION</h3>
39*e13b1fa5SApple OSS Distributions<p>
40*e13b1fa5SApple OSS DistributionsFunctions:
41*e13b1fa5SApple OSS Distributions<a href="processor_control.html">processor_control</a>,
42*e13b1fa5SApple OSS Distributions<a href="processor_start.html">processor_start</a>,
43*e13b1fa5SApple OSS Distributions<a href="processor_info.html">processor_info</a>,
44*e13b1fa5SApple OSS Distributions<a href="host_processors.html">host_processors</a>.
45