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