xnu-1504.3.12.tar.gz

[apple/xnu.git] / osfmk / man / processor_set_create.html

<h2>processor_set_create</h2>
<hr>
<p>
<strong>Function</strong> - Create a new processor set object.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t	processor_set_create</strong>
		<strong>(host_t</strong>	<var>host_name</var>,
		<strong>processor_set_t</strong>	<var>new_set</var>,
		<strong>processor_set_name_t</strong>	<var>new_name</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<dt> <var>host_name</var> 
<dd>
[in host-name send right]
The name (or control) port for the host on 
which the set is to be created.
<dt> <var>new_set</var> 
<dd>
[out processor-set-control send right]
Control port used for performing 
operations on the new set.
<dt> <var>new_name</var> 
<dd>
[out processor-set-name send right]
Name port used to identify the new 
set and obtain information about it.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>processor_set_create</strong> function creates a new processor
set and returns the 
two ports associated with it.  The port returned in <var>new_set</var> is the control port
representing the set.  It is used to perform operations such
as assigning processors, 
tasks or threads.  The port returned in <var>new_name</var> is the name port which
identifies the set, and is used to obtain information about the set.
<h3>RETURN VALUES</h3>
<p>
Only generic values apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="processor_set_destroy.html">processor_set_destroy</a>,
<a href="processor_set_info.html">processor_set_info</a>,
<a href="processor_assign.html">processor_assign</a>,
<a href="task_assign.html">task_assign</a>,
<a href="thread_assign.html">thread_assign</a>.