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