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