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