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

<h2>thread_basic_info</h2>\r<hr>\r<p>\r<strong>Structure</strong> - Defines basic information for a thread.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>struct thread_basic_info</strong>\r<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>integer_t</strong>        <var>cpu_usage</var><strong>;</strong>\r       <strong>policy_t</strong>            <var>policy</var><strong>;</strong>\r       <strong>integer_t</strong>        <var>run_state</var><strong>;</strong>\r       <strong>integer_t</strong>            <var>flags</var><strong>;</strong>\r       <strong>integer_t</strong>    <var>suspend_count</var><strong>;</strong>\r       <strong>integer_t</strong>       <var>sleep_time</var><strong>;</strong>\r<strong>};</strong>\r\r<strong>typedef struct thread_basic_info* thread_basic_info_t;</strong>\r</pre>\r<h3>FIELDS</h3>\r<dl>\r<dt> <var>user_time</var>\r<dd>\rThe total user run time for the thread.\r     <p>\r<dt> <var>system_time</var>\r<dd>\rThe total system run time for the thread.\r          <p>\r<dt> <var>cpu_usage</var>\r<dd>\rScaled <strong>CPU</strong> usage percentage for the thread.\r          <p>\r<dt> <var>policy</var>\r<dd>\rScheduling policy in effect\r          <p>\r<dt> <var>run_state</var>\r<dd>\rThe thread's run state.  Possible values are:\r<dl>\r       <p>\r<dt> <strong>TH_STATE_RUNNING</strong>\r<dd>\rThe thread is running normally.\r          <p>\r<dt> <strong>TH_STATE_STOPPED</strong>\r<dd>\rThe thread is stopped.\r          <p>\r<dt> <strong>TH_STATE_WAITING</strong>\r<dd>\rThe thread is waiting normally.\r          <p>\r<dt> <strong>TH_STATE_UNINTERRUPTIBLE</strong>\r<dd>\rThe thread is in an un-interruptible wait state.\r          <p>\r<dt> <strong>TH_STATE_HALTED</strong>\r<dd>\rThe thread is halted at a clean point.\r</dl>\r     <p>\r<dt> <var>flags</var>\r<dd>\rSwap/idle flags for the thread.  Possible values are:\r<dl>\r       <p>\r<dt> <strong>TH_FLAGS_SWAPPED</strong>\r<dd>\rThe thread is swapped out.\r          <p>\r<dt> <strong>TH_FLAGS_IDLE</strong>\r<dd>\rThe thread is an idle thread.\r</dl>\r     <p>\r<dt> <var>suspend_count</var>\r<dd>\rThe current suspend count for the thread.\r          <p>\r<dt> <var>sleep_time</var>\r<dd>\rThe number of seconds that the thread has been sleeping.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>thread_basic_info</strong> structure defines the basic information\rarray for threads. \rThe <strong>thread_info</strong> function returns this array for a specified thread.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="thread_info.html"><strong>thread_info</strong></a>.\r<p>\rData Structures:\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