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