X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/743b15655a24ee3fe9f458f383003e011db0558f..13fec9890cf095cc781fdf7b8917cb03bf32dd4c:/osfmk/man/thread_basic_info.html diff --git a/osfmk/man/thread_basic_info.html b/osfmk/man/thread_basic_info.html index c852420d0..a39f88a2f 100755 --- a/osfmk/man/thread_basic_info.html +++ b/osfmk/man/thread_basic_info.html @@ -1 +1,100 @@ -

thread_basic_info


Structure - Defines basic information for a thread.

SYNOPSIS

struct thread_basic_info
{
       time_value_t     user_time;
       time_value_t   system_time;
       integer_t        cpu_usage;
       policy_t            policy;
       integer_t        run_state;
       integer_t            flags;
       integer_t    suspend_count;
       integer_t       sleep_time;
};

typedef struct thread_basic_info* thread_basic_info_t;

FIELDS

user_time
The total user run time for the thread.

system_time
The total system run time for the thread.

cpu_usage
Scaled CPU usage percentage for the thread.

policy
Scheduling policy in effect

run_state
The thread's run state. Possible values are:

TH_STATE_RUNNING
The thread is running normally.

TH_STATE_STOPPED
The thread is stopped.

TH_STATE_WAITING
The thread is waiting normally.

TH_STATE_UNINTERRUPTIBLE
The thread is in an un-interruptible wait state.

TH_STATE_HALTED
The thread is halted at a clean point.

flags
Swap/idle flags for the thread. Possible values are:

TH_FLAGS_SWAPPED
The thread is swapped out.

TH_FLAGS_IDLE
The thread is an idle thread.

suspend_count
The current suspend count for the thread.

sleep_time
The number of seconds that the thread has been sleeping.

DESCRIPTION

The thread_basic_info structure defines the basic information array for threads. The thread_info function returns this array for a specified thread.

RELATED INFORMATION

Functions: thread_info.

Data Structures: policy_fifo_info, policy_rr_info, policy_timeshare_info. \ No newline at end of file +

thread_basic_info

+
+

+Structure - Defines basic information for a thread. +

SYNOPSIS

+
+struct thread_basic_info
+{
+       time_value_t     user_time;
+       time_value_t   system_time;
+       integer_t        cpu_usage;
+       policy_t            policy;
+       integer_t        run_state;
+       integer_t            flags;
+       integer_t    suspend_count;
+       integer_t       sleep_time;
+};
+
+typedef struct thread_basic_info* thread_basic_info_t;
+
+

FIELDS

+
+
user_time +
+The total user run time for the thread. +

+

system_time +
+The total system run time for the thread. +

+

cpu_usage +
+Scaled CPU usage percentage for the thread. +

+

policy +
+Scheduling policy in effect +

+

run_state +
+The thread's run state. Possible values are: +
+

+

TH_STATE_RUNNING +
+The thread is running normally. +

+

TH_STATE_STOPPED +
+The thread is stopped. +

+

TH_STATE_WAITING +
+The thread is waiting normally. +

+

TH_STATE_UNINTERRUPTIBLE +
+The thread is in an un-interruptible wait state. +

+

TH_STATE_HALTED +
+The thread is halted at a clean point. +
+

+

flags +
+Swap/idle flags for the thread. Possible values are: +
+

+

TH_FLAGS_SWAPPED +
+The thread is swapped out. +

+

TH_FLAGS_IDLE +
+The thread is an idle thread. +
+

+

suspend_count +
+The current suspend count for the thread. +

+

sleep_time +
+The number of seconds that the thread has been sleeping. +
+

DESCRIPTION

+

+The thread_basic_info structure defines the basic information +array for threads. +The thread_info function returns this array for a specified thread. +

RELATED INFORMATION

+

+Functions: +thread_info. +

+Data Structures: +policy_fifo_info, +policy_rr_info, +policy_timeshare_info.