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

<h2>processor_exit</h2>\r<hr>\r<p>\r<strong>Function</strong> - Exit a processor.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t	processor_exit</strong>\r		<strong>(processor_t</strong>	<var>processor</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>processor</var> \r<dd>\r[in processor send right]\rThe processor to be controlled.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_exit</strong> function allows privileged software\rto exit a processor in a \rmulti-processor that so allows it.  An exited processor is removed from the\rprocessor set to which it was assigned and ceases to be active.\rThe interpretation of \rthis operation is machine dependent.\r<h3>NOTES</h3>\r<p>\rThis operation is machine dependent.  It may do nothing.\r<h3>CAUTIONS</h3>\r<p>\rThe ability to restart an exited processor is machine dependent.\r<h3>RETURN VALUES</h3>\r<dl>\r<dt> <strong>KERN_FAILURE</strong>\r<dd>\rThe operation was not performed.  A likely reason is that it\ris not supported on this processor.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="processor_control.html">processor_control</a>,\r<a href="processor_start.html">processor_start</a>,\r<a href="processor_info.html">processor_info</a>,\r<a href="host_processors.html">host_processors</a>.\r