osfmk/man/processor_exit.html

   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]
  15 The processor to be controlled.
  16 </dl>
  17 <h3>DESCRIPTION</h3>
  18 <p>
  19 The <strong>processor_exit</strong> function allows privileged software
  20 to exit a processor in a
  21 multi-processor that so allows it.  An exited processor is removed from the
  22 processor set to which it was assigned and ceases to be active.
  23 The interpretation of
  24 this operation is machine dependent.
  25 <h3>NOTES</h3>
  26 <p>
  27 This operation is machine dependent.  It may do nothing.
  28 <h3>CAUTIONS</h3>
  29 <p>
  30 The ability to restart an exited processor is machine dependent.
  31 <h3>RETURN VALUES</h3>
  32 <dl>
  33 <dt> <strong>KERN_FAILURE</strong>
  34 <dd>
  35 The operation was not performed.  A likely reason is that it
  36 is not supported on this processor.
  37 </dl>
  38 <h3>RELATED INFORMATION</h3>
  39 <p>
  40 Functions:
  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>.