osfmk/man/processor_set_create.html

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