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