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