xref: /xnu-8020.121.3/osfmk/man/processor_set_destroy.html (revision fdd8201d7b966f0c3ea610489d29bd841d358941)
1*fdd8201dSApple OSS Distributions<h2>processor_set_destroy</h2>
2*fdd8201dSApple OSS Distributions<hr>
3*fdd8201dSApple OSS Distributions<p>
4*fdd8201dSApple OSS Distributions<strong>Function</strong> - Destroy the target processor set object.
5*fdd8201dSApple OSS Distributions<h3>SYNOPSIS</h3>
6*fdd8201dSApple OSS Distributions<pre>
7*fdd8201dSApple OSS Distributions<strong>kern_return_t	processor_set_destroy</strong>
8*fdd8201dSApple OSS Distributions		<strong>(processor_set_t</strong>	<var>processor_set</var><strong>);</strong>
9*fdd8201dSApple OSS Distributions</pre>
10*fdd8201dSApple OSS Distributions<h3>PARAMETERS</h3>
11*fdd8201dSApple OSS Distributions<dl>
12*fdd8201dSApple OSS Distributions<dt> <var>processor_set</var>
13*fdd8201dSApple OSS Distributions<dd>
14*fdd8201dSApple OSS Distributions[in processor-set-control send right]
15*fdd8201dSApple OSS DistributionsThe control port for the processor
16*fdd8201dSApple OSS Distributionsset to be destroyed.
17*fdd8201dSApple OSS Distributions</dl>
18*fdd8201dSApple OSS Distributions<h3>DESCRIPTION</h3>
19*fdd8201dSApple OSS Distributions<p>
20*fdd8201dSApple OSS DistributionsThe <strong>processor_set_destroy</strong> function destroys the specified
21*fdd8201dSApple OSS Distributionsprocessor set.  Any
22*fdd8201dSApple OSS Distributionsassigned processors, tasks or threads are re-assigned to the default set.  The
23*fdd8201dSApple OSS Distributionsobject port (not the name port) for the processor set is required.
24*fdd8201dSApple OSS Distributions<h3>RETURN VALUES</h3>
25*fdd8201dSApple OSS Distributions<dl>
26*fdd8201dSApple OSS Distributions<dt> <strong>KERN_DEFAULT_SET</strong>
27*fdd8201dSApple OSS Distributions<dd>
28*fdd8201dSApple OSS DistributionsAn attempt was made to destroy the default processor set.
29*fdd8201dSApple OSS Distributions</dl>
30*fdd8201dSApple OSS Distributions<h3>RELATED INFORMATION</h3>
31*fdd8201dSApple OSS Distributions<p>
32*fdd8201dSApple OSS DistributionsFunctions:
33*fdd8201dSApple OSS Distributions<a href="processor_set_create.html">processor_set_create</a>,
34*fdd8201dSApple OSS Distributions<a href="processor_assign.html">processor_assign</a>,
35*fdd8201dSApple OSS Distributions<a href="task_assign.html">task_assign</a>,
36*fdd8201dSApple OSS Distributions<a href="thread_assign.html">thread_assign</a>.
37