xref: /xnu-10002.41.9/osfmk/man/processor_set_create.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>processor_set_create</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Create a new processor set object.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t	processor_set_create</strong>
8*699cd480SApple OSS Distributions		<strong>(host_t</strong>	<var>host_name</var>,
9*699cd480SApple OSS Distributions		<strong>processor_set_t</strong>	<var>new_set</var>,
10*699cd480SApple OSS Distributions		<strong>processor_set_name_t</strong>	<var>new_name</var><strong>);</strong>
11*699cd480SApple OSS Distributions</pre>
12*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
13*699cd480SApple OSS Distributions<dl>
14*699cd480SApple OSS Distributions<dt> <var>host_name</var>
15*699cd480SApple OSS Distributions<dd>
16*699cd480SApple OSS Distributions[in host-name send right]
17*699cd480SApple OSS DistributionsThe name (or control) port for the host on
18*699cd480SApple OSS Distributionswhich the set is to be created.
19*699cd480SApple OSS Distributions<dt> <var>new_set</var>
20*699cd480SApple OSS Distributions<dd>
21*699cd480SApple OSS Distributions[out processor-set-control send right]
22*699cd480SApple OSS DistributionsControl port used for performing
23*699cd480SApple OSS Distributionsoperations on the new set.
24*699cd480SApple OSS Distributions<dt> <var>new_name</var>
25*699cd480SApple OSS Distributions<dd>
26*699cd480SApple OSS Distributions[out processor-set-name send right]
27*699cd480SApple OSS DistributionsName port used to identify the new
28*699cd480SApple OSS Distributionsset and obtain information about it.
29*699cd480SApple OSS Distributions</dl>
30*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
31*699cd480SApple OSS Distributions<p>
32*699cd480SApple OSS DistributionsThe <strong>processor_set_create</strong> function creates a new processor
33*699cd480SApple OSS Distributionsset and returns the
34*699cd480SApple OSS Distributionstwo ports associated with it.  The port returned in <var>new_set</var> is the control port
35*699cd480SApple OSS Distributionsrepresenting the set.  It is used to perform operations such
36*699cd480SApple OSS Distributionsas assigning processors,
37*699cd480SApple OSS Distributionstasks or threads.  The port returned in <var>new_name</var> is the name port which
38*699cd480SApple OSS Distributionsidentifies the set, and is used to obtain information about the set.
39*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
40*699cd480SApple OSS Distributions<p>
41*699cd480SApple OSS DistributionsOnly generic values apply.
42*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
43*699cd480SApple OSS Distributions<p>
44*699cd480SApple OSS DistributionsFunctions:
45*699cd480SApple OSS Distributions<a href="processor_set_destroy.html">processor_set_destroy</a>,
46*699cd480SApple OSS Distributions<a href="processor_set_info.html">processor_set_info</a>,
47*699cd480SApple OSS Distributions<a href="processor_assign.html">processor_assign</a>,
48*699cd480SApple OSS Distributions<a href="task_assign.html">task_assign</a>,
49*699cd480SApple OSS Distributions<a href="thread_assign.html">thread_assign</a>.
50