xref: /xnu-8020.140.41/osfmk/man/host_processor_set_priv.html (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1*27b03b36SApple OSS Distributions<h2>host_processor_set_priv</h2>
2*27b03b36SApple OSS Distributions<hr>
3*27b03b36SApple OSS Distributions<p>
4*27b03b36SApple OSS Distributions<strong>Function</strong> - Translate a processor set name port
5*27b03b36SApple OSS Distributions  into a processor set control port.
6*27b03b36SApple OSS Distributions<h3>SYNOPSIS</h3>
7*27b03b36SApple OSS Distributions<pre>
8*27b03b36SApple OSS Distributions<strong>kern_return_t   host_processor_set_priv</strong>
9*27b03b36SApple OSS Distributions                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
10*27b03b36SApple OSS Distributions                 <strong>processor_set_name_t</strong>                  <var>set_name</var>,
11*27b03b36SApple OSS Distributions                 <strong>processor_set_t</strong>                  <var>processor_set</var><strong>);</strong>
12*27b03b36SApple OSS Distributions</pre>
13*27b03b36SApple OSS Distributions<h3>PARAMETERS</h3>
14*27b03b36SApple OSS Distributions<dl>
15*27b03b36SApple OSS Distributions<p>
16*27b03b36SApple OSS Distributions<dt> <var>host_priv</var>
17*27b03b36SApple OSS Distributions<dd>
18*27b03b36SApple OSS Distributions[in host-control send right]
19*27b03b36SApple OSS DistributionsThe control port for the host for which the
20*27b03b36SApple OSS Distributionsprocessor set is desired.
21*27b03b36SApple OSS Distributions<p>
22*27b03b36SApple OSS Distributions<dt> <var>set_name</var>
23*27b03b36SApple OSS Distributions<dd>
24*27b03b36SApple OSS Distributions[in processor-set-name send right]
25*27b03b36SApple OSS DistributionsThe name port for the processor set
26*27b03b36SApple OSS Distributionsdesired.
27*27b03b36SApple OSS Distributions<p>
28*27b03b36SApple OSS Distributions<dt> <var>processor_set</var>
29*27b03b36SApple OSS Distributions<dd>
30*27b03b36SApple OSS Distributions[out processor-set-control send right]
31*27b03b36SApple OSS DistributionsThe returned processor set
32*27b03b36SApple OSS Distributionscontrol port.
33*27b03b36SApple OSS Distributions</dl>
34*27b03b36SApple OSS Distributions<h3>DESCRIPTION</h3>
35*27b03b36SApple OSS Distributions<p>
36*27b03b36SApple OSS DistributionsThe <strong>host_processor_set_priv</strong> function returns send rights
37*27b03b36SApple OSS Distributionsfor the control port
38*27b03b36SApple OSS Distributionsfor a specified processor set currently existing on <var>host_priv</var>.
39*27b03b36SApple OSS Distributions<h3>RETURN VALUES</h3>
40*27b03b36SApple OSS Distributions<p>
41*27b03b36SApple OSS DistributionsOnly generic errors apply.
42*27b03b36SApple OSS Distributions<h3>RELATED INFORMATION</h3>
43*27b03b36SApple OSS Distributions<p>
44*27b03b36SApple OSS DistributionsFunctions:
45*27b03b36SApple OSS Distributions<a href="host_processor_sets.html"><strong>host_processor_sets</strong></a>,
46*27b03b36SApple OSS Distributions<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
47*27b03b36SApple OSS Distributions<a href="processor_set_tasks.html"><strong>processor_set_tasks</strong></a>,
48*27b03b36SApple OSS Distributions<a href="processor_set_threads.html"><strong>processor_set_threads</strong></a>.
49