osfmk/man/P_set_policy_disable.html

   1 <h2>processor_set_policy_disable</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Disables 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_disable</strong>
  10                 <strong>(processor_set_t</strong>       <var>processor_set</var>,
  11                 <strong>int</strong>    <var>policy</var>,
  12                 <strong>boolean_t</strong>      <var>change_threads</var><strong>);</strong>
  13 </pre>
  14 <h3>PARAMETERS</h3>
  15 <dl>
  16 <dt> <var>processor_set</var>
  17 <dd>
  18 [in processor-set-control port] The control port for the processor set for which a scheduling policy is to be disabled.
  19 <dt> <var>policy</var>
  20 <dd>
  21 [in scalar] Policy to be disabled. The values currently defined are POLICY_TIMESHARE and POLICY_FIXEDPRI.
  22 <dt> <var>change_threads</var>
  23 <dd>
  24 [in scalar] If true, causes the scheduling policy for all threads currently running with policy to POLICY_TIMESHARE.
  25 </dl>
  26 <h3>DESCRIPTION</h3>
  27 <p>
  28 The <strong>processor_set_policy_disable</strong>
  29 function restricts the set of scheduling policies allowed for
  30 <var>processor_set</var>. The set of scheduling policies allowed for a
  31 processor set is the set of policies allowed to be set for threads
  32 assigned to that processor set. The current set of permitted policies
  33 can be obtained from <strong>processor_set_info</strong>. Timesharing may
  34 not be forbidden for any processor set. This is a compromise to reduce
  35 the complexity of the assign operation; any thread whose
  36 <var>policy</var> is forbidden by its target processor set has its
  37 <var>policy</var> reset to timesharing. Disabling a scheduling
  38 <var>policy</var> for a processor set has no effect on threads
  39 currently assigned to that processor set unless
  40 <var>change_threads</var> is TRUE, in which case their policies will
  41 be reset to timesharing.
  42 <h3>RETURN VALUES</h3>
  43 <p>
  44 Only generic errors apply.
  45 <h3>RELATED INFORMATION</h3>
  46 <p>
  47 Functions:
  48 <a href="P_set_policy_enable.html">processor_set_policy_enable</a>,
  49 <a href="processor_set_info.html">processor_set_info</a>,
  50 <a href="thread_policy.html">thread_policy</a>.