osfmk/man/processor_set_info.html

   1 <h2>processor_set_info</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return processor set state according to caller-specified flavor.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   processor_set_info</strong>
   8                 <strong>(processor_set_name_t</strong>  <var>processor_set_name</var>,
   9                 <strong>int</strong>    <var>flavor</var>,
  10                 <strong>host_t</strong> <var>host</var>,
  11                 <strong>processor_set_info_t</strong>   <var>processor_set_info</var>,
  12                 <strong>mach_msg_type_number_t</strong> <var>processor_set_info_count</var><strong>);</strong>
  13 </pre>
  14 <h3>PARAMETERS</h3>
  15 <dl>
  16 <dt> <var>processor_set_name</var>
  17 <dd>
  18 [in processor-set-name send right]
  19 A processor set name (or control)
  20 port for which information is desired.
  21 <dt> <var>flavor</var>
  22 <dd>
  23 [in scalar]
  24 The type of information requested.
  25 <dl>
  26 <dt> <strong>PROCESSOR_SET_BASIC_INFO</strong>
  27 <dd>
  28 Basic information concerning the processor set (number of
  29 assigned processors and default policy).  The returned structure
  30 is defined by <strong>processor_set_basic_info</strong>.
  31 <dt> <strong>PROCESSOR_SET_TIMESHARE_DEFAULT</strong>
  32 <dd>
  33 The base attributes for the timeshare scheduling policy.  The
  34 returned structure is <strong>policy_timeshare_base</strong>.
  35 <dt> <strong>PROCESSOR_SET_FIFO_DEFAULT</strong>
  36 <dd>
  37 The base attributes for the FIFO scheduling policy.  The
  38 returned structure is <strong>policy_fifo_base</strong>.
  39 <dt> <strong>PROCESSOR_SET_RR_DEFAULT</strong>
  40 <dd>
  41 The base attributes for the round-robin scheduling policy.  The
  42 returned structure is <strong>policy_rr_base</strong>.
  43 <dt> <strong>PROCESSOR_SET_TIMESHARE_LIMITS</strong>
  44 <dd>
  45 Limits on the allowed timeshare policy attributes.  The
  46 returned structure is defined by <strong>policy_timeshare_limit</strong>.
  47 <dt> <strong>PROCESSOR_SET_RR_LIMITS</strong>
  48 <dd>
  49 Limits on the allowed round robin policy attributes.  The
  50 returned structure is defined by <strong>policy_rr_limit</strong>.
  51 <dt> <strong>PROCESSOR_SET_FIFO_LIMITS</strong>
  52 <dd>
  53 Limits on the allowed first-in, first-out policy attributes.  The
  54 returned structure is defined by <strong>policy_fifo_limit</strong>.
  55 <dt> <strong>PROCESSOR_SET_ENABLED_POLICIES</strong>
  56 <dd>
  57 The set of enabled policies.  The returned data is a bit-vector.
  58 </dl>
  59 <dt> <var>host</var>
  60 <dd>
  61 [out host-name send right]
  62 The name port for the host on which the
  63 processor set resides.
  64 <dt> <var>processor_set_info</var>
  65 <dd>
  66 [out structure]
  67 Information about the processor set.
  68 <dt> <var>processor_set_info_count</var>
  69 <dd>
  70 [in/out scalar]
  71 On input, the maximum size of the buffer; on output, the
  72 size returned (in natural-sized units).
  73 </dl>
  74 <h3>DESCRIPTION</h3>
  75 <p>
  76 The <strong>processor_set_info</strong> function returns selected information
  77 for a processor set, as specified by <var>flavor</var>.
  78 <h3>NOTES</h3>
  79 <p>
  80 A processor set has a single default scheduling policy in effect for it (as
  81 returned by <strong>PROCESSOR_SET_BASIC_INFO</strong>), so only one of the default
  82 scheduling structures has valid information.  On the other hand,
  83 a processor set
  84 maintains limits for all defined scheduling policies, so all
  85 of the scheduling limit
  86 structures return valid values.
  87 <h3>RETURN VALUES</h3>
  88 <p>
  89 Only generic errors apply.
  90 <h3>RELATED INFORMATION</h3>
  91 <p>
  92 Functions:
  93 <a href="processor_set_statistics.html">processor_set_statistics</a>,
  94 <a href="processor_set_create.html">processor_set_create</a>,
  95 <a href="processor_set_default.html">processor_set_default</a>,
  96 <a href="processor_assign.html">processor_assign</a>,
  97 <a href="P_set_policy_control.html">processor_set_policy_control</a>.
  98 <p>
  99 Data Structures:
 100 <a href="processor_set_basic_info.html">processor_set_basic_info</a>,
 101 <a href="policy_timeshare_info.html">policy_timeshare_info</a>,
 102 <a href="policy_rr_info.html">policy_rr_info</a>,
 103 <a href="policy_fifo_info.html">policy_fifo_info</a>.