]> git.saurik.com Git - apple/xnu.git/blob - osfmk/man/P_set_policy_enable.html
xnu-2422.1.72.tar.gz
[apple/xnu.git] / osfmk / man / P_set_policy_enable.html
1 <h2>processor_set_policy_enable</h2>
2 <hr>
3 <p>
4 <strong>Function</strong> - Enables a scheduling policy for a processor set.
5 <h3>SYNOPSIS</h3>
6 <pre>
7 <strong>#include&lt mach/mach_host.h&gt</strong>
8
9 <strong>kern_return_t processor_set_policy_enable</strong>
10 <strong>(processor_set_t</strong> <var>processor_set</var>,
11 <strong>int</strong> <var>policy</var><strong>);</strong>
12 </pre>
13 <h3>PARAMETERS</h3>
14 <dl>
15 <dt> <var>processor_set</var>
16 <dd>
17 [in processor-set-control port] The control port for the processor set for which a scheduling policy is to be enabled.
18 <dt> <var>policy</var>
19 <dd>
20 [in scalar] Policy to be enabled. The values currently defined are POLICY_TIMESHARE and POLICY_FIXEDPRI.
21 </dl>
22 <h3>DESCRIPTION</h3>
23 <p>
24 The <strong>processor_set_policy_enable</strong>
25 function extends the set of scheduling policies allowed for
26 <var>processor_set</var>. The set of scheduling policies allowed for a
27 processor set is the set of policies allowed to be set for threads
28 assigned to that processor set. The current set of permitted policies
29 can be obtained from <strong>processor_set_info</strong>.
30 <h3>RETURN VALUES</h3>
31 <p>
32 Only generic errors apply.
33 <h3>RELATED INFORMATION</h3>
34 <p>
35 Functions:
36 <a href="processor_set_info.html">processor_set_info</a>,
37 <a href="P_set_policy_disable.html">processor_set_policy_disable</a>,
38 <a href="thread_policy.html">thread_policy</a>.