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