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