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