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