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