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