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