osfmk/man/task_basic_info.html

   1 <h2>task_basic_info</h2>
   2 <hr>
   3 <p>
   4 <strong>Structure</strong> - Defines basic information for a task.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>struct task_basic_info</strong>
   8 <strong>{</strong>
   9        <strong>integer_t</strong>      <var>suspend_count</var><strong>;</strong>
  10        <strong>vm_size_t</strong>       <var>virtual_size</var><strong>;</strong>
  11        <strong>vm_size_t</strong>      <var>resident_size</var><strong>;</strong>
  12        <strong>time_value_t</strong>       <var>user_time</var><strong>;</strong>
  13        <strong>time_value_t</strong>     <var>system_time</var><strong>;</strong>
  14        <strong>policy_t</strong>              <var>policy</var><strong>;</strong>
  15 <strong>};</strong>
  16
  17 <strong>typedef struct task_basic_info* task_basic_info_t;</strong>
  18 </pre>
  19 <h3>FIELDS</h3>
  20 <dl>
  21 <dt> <var>suspend_count</var>
  22 <dd>
  23 The current suspend count for the task.
  24      <p>
  25 <dt> <var>virtual_size</var>
  26 <dd>
  27 The number of virtual pages for the task.
  28           <p>
  29 <dt> <var>resident_size</var>
  30 <dd>
  31 The number of resident pages for the task
  32           <p>
  33 <dt> <var>user_time</var>
  34 <dd>
  35 The total user run time for terminated threads within the task.
  36           <p>
  37 <dt> <var>system_time</var>
  38 <dd>
  39 The total system run time for terminated threads within the task.
  40           <p>
  41 <dt> <var>policy</var>
  42 <dd>
  43 Default scheduling policy to apply to new threads.
  44 </dl>
  45 <h3>DESCRIPTION</h3>
  46 <p>
  47 The <strong>task_basic_info</strong> structure defines the basic information array for
  48 tasks.  The <strong>task_info</strong> function returns this array for a specified task.
  49 <h3>NOTES</h3>
  50 <p>
  51 This structure is machine word length sensitive due
  52 to the presence of the
  53 virtual address sizes.
  54 <h3>RELATED INFORMATION</h3>
  55 <p>
  56 Functions:
  57 <a href="task_info.html"><strong>task_info</strong></a>.
  58 <p>
  59 Data Structures:
  60 <a href="task_thread_times_info.html"><strong>task_thread_times_info</strong></a>,
  61 <a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>,
  62 <a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,
  63 <a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.