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