[apple/xnu.git] / osfmk / man / task_basic_info.html

<h2>task_basic_info</h2>\r<hr>\r<p>\r<strong>Structure</strong> - Defines basic information for a task.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>struct task_basic_info</strong>\r<strong>{</strong>\r       <strong>integer_t</strong>      <var>suspend_count</var><strong>;</strong>\r       <strong>vm_size_t</strong>       <var>virtual_size</var><strong>;</strong>\r       <strong>vm_size_t</strong>      <var>resident_size</var><strong>;</strong>\r       <strong>time_value_t</strong>       <var>user_time</var><strong>;</strong>\r       <strong>time_value_t</strong>     <var>system_time</var><strong>;</strong>\r       <strong>policy_t</strong>              <var>policy</var><strong>;</strong>\r<strong>};</strong>\r\r<strong>typedef struct task_basic_info* task_basic_info_t;</strong>\r</pre>\r<h3>FIELDS</h3>\r<dl>\r<dt> <var>suspend_count</var>\r<dd>\rThe current suspend count for the task.\r     <p>\r<dt> <var>virtual_size</var>\r<dd>\rThe number of virtual pages for the task.\r          <p>\r<dt> <var>resident_size</var>\r<dd>\rThe number of resident pages for the task\r          <p>\r<dt> <var>user_time</var>\r<dd>\rThe total user run time for terminated threads within the task.\r          <p>\r<dt> <var>system_time</var>\r<dd>\rThe total system run time for terminated threads within the task.\r          <p>\r<dt> <var>policy</var>\r<dd>\rDefault scheduling policy to apply to new threads.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_basic_info</strong> structure defines the basic information array for \rtasks.  The <strong>task_info</strong> function returns this array for a specified task.\r<h3>NOTES</h3>\r<p>\rThis structure is machine word length sensitive due\rto the presence of the\rvirtual address sizes.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_info.html"><strong>task_info</strong></a>.\r<p>\rData Structures:\r<a href="task_thread_times_info.html"><strong>task_thread_times_info</strong></a>,\r<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>,\r<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,\r<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.\r