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