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