xref: /xnu-8796.121.2/osfmk/man/thread_info.html (revision c54f35ca767986246321eb901baf8f5ff7923f6a)
1*c54f35caSApple OSS Distributions<h2>thread_info</h2>
2*c54f35caSApple OSS Distributions<hr>
3*c54f35caSApple OSS Distributions<p>
4*c54f35caSApple OSS Distributions<strong>Function</strong> - Return information about a thread.
5*c54f35caSApple OSS Distributions<h3>SYNOPSIS</h3>
6*c54f35caSApple OSS Distributions<pre>
7*c54f35caSApple OSS Distributions<strong>kern_return_t   thread_info</strong>
8*c54f35caSApple OSS Distributions                <strong>(thread_act_t</strong>                     <var>target_thread</var>,
9*c54f35caSApple OSS Distributions                 <strong>thread_flavor_t</strong>                         <var>flavor</var>,
10*c54f35caSApple OSS Distributions                 <strong>thread_info_t</strong>                      <var>thread_info</var>,
11*c54f35caSApple OSS Distributions                 <strong>mach_msg_type_number_t</strong>       <var>thread_info_count</var><strong>);</strong>
12*c54f35caSApple OSS Distributions</pre>
13*c54f35caSApple OSS Distributions<h3>PARAMETERS</h3>
14*c54f35caSApple OSS Distributions<dl>
15*c54f35caSApple OSS Distributions<p>
16*c54f35caSApple OSS Distributions<dt> <var>target_thread</var>
17*c54f35caSApple OSS Distributions<dd>
18*c54f35caSApple OSS Distributions[in thread send right]
19*c54f35caSApple OSS DistributionsThe thread for which the information is to be
20*c54f35caSApple OSS Distributionsreturned.
21*c54f35caSApple OSS Distributions<p>
22*c54f35caSApple OSS Distributions<dt> <var>flavor</var>
23*c54f35caSApple OSS Distributions<dd>
24*c54f35caSApple OSS Distributions[in scalar]
25*c54f35caSApple OSS DistributionsThe type of information to be returned.  Valid values are:
26*c54f35caSApple OSS Distributions<dl>
27*c54f35caSApple OSS Distributions<p>
28*c54f35caSApple OSS Distributions<dt> <strong>THREAD_BASIC_INFO</strong>
29*c54f35caSApple OSS Distributions<dd>
30*c54f35caSApple OSS DistributionsReturns basic information about the thread, such as the
31*c54f35caSApple OSS Distributionsthread's run state and suspend count.  The returned structure is
32*c54f35caSApple OSS Distributions<strong>thread_basic_info</strong>.
33*c54f35caSApple OSS Distributions<p>
34*c54f35caSApple OSS Distributions<dt> <strong>THREAD_SCHED_FIFO_INFO</strong>
35*c54f35caSApple OSS Distributions<dd>
36*c54f35caSApple OSS DistributionsReturns FIFO scheduling policy information about the thread.
37*c54f35caSApple OSS DistributionsThe returned structure is <strong>policy_fifo_info</strong>.
38*c54f35caSApple OSS Distributions<p>
39*c54f35caSApple OSS Distributions<dt> <strong>THREAD_SCHED_RR_INFO</strong>
40*c54f35caSApple OSS Distributions<dd>
41*c54f35caSApple OSS DistributionsReturns round-robin scheduling policy information about the
42*c54f35caSApple OSS Distributionsthread.  The returned structure is <strong>policy_rr_info</strong>.
43*c54f35caSApple OSS Distributions<p>
44*c54f35caSApple OSS Distributions<dt> <strong>THREAD_SCHED_TIMESHARE_INFO</strong>
45*c54f35caSApple OSS Distributions<dd>
46*c54f35caSApple OSS DistributionsReturns timeshare scheduling policy information about the
47*c54f35caSApple OSS Distributionsthread.  The returned structure is <strong>policy_timeshare_info</strong>.
48*c54f35caSApple OSS Distributions</dl>
49*c54f35caSApple OSS Distributions<p>
50*c54f35caSApple OSS Distributions<dt> <var>thread_info</var>
51*c54f35caSApple OSS Distributions<dd>
52*c54f35caSApple OSS Distributions[out structure]
53*c54f35caSApple OSS DistributionsInformation about the specified thread.
54*c54f35caSApple OSS Distributions<p>
55*c54f35caSApple OSS Distributions<dt> <var>thread_info_count</var>
56*c54f35caSApple OSS Distributions<dd>
57*c54f35caSApple OSS Distributions[in/out scalar]
58*c54f35caSApple OSS DistributionsOn input, the maximum size of the buffer; on output, the
59*c54f35caSApple OSS Distributionssize returned (in natural-sized units).
60*c54f35caSApple OSS Distributions</dl>
61*c54f35caSApple OSS Distributions<h3>DESCRIPTION</h3>
62*c54f35caSApple OSS Distributions<p>
63*c54f35caSApple OSS DistributionsThe <strong>thread_info</strong> function returns an information structure
64*c54f35caSApple OSS Distributionsof type <var>flavor</var>.
65*c54f35caSApple OSS Distributions<h3>NOTES</h3>
66*c54f35caSApple OSS Distributions<p>
67*c54f35caSApple OSS DistributionsAt any given time, a thread has only one scheduling policy in
68*c54f35caSApple OSS Distributionseffect for it.  Thus,
69*c54f35caSApple OSS Distributionsonly one of the scheduling information structures will be valid,
70*c54f35caSApple OSS Distributionsthat so indicated
71*c54f35caSApple OSS Distributionsby the policy value returned by <strong>THREAD_BASIC_INFO</strong>.
72*c54f35caSApple OSS Distributions<h3>RETURN VALUES</h3>
73*c54f35caSApple OSS Distributions<p>
74*c54f35caSApple OSS DistributionsOnly generic errors apply.
75*c54f35caSApple OSS Distributions<h3>RELATED INFORMATION</h3>
76*c54f35caSApple OSS Distributions<p>
77*c54f35caSApple OSS DistributionsFunctions:
78*c54f35caSApple OSS Distributions<a href="task_info.html"><strong>task_info</strong></a>,
79*c54f35caSApple OSS Distributions<a href="task_threads.html"><strong>task_threads</strong></a>,
80*c54f35caSApple OSS Distributions<a href="thread_get_state.html"><strong>thread_get_state</strong></a>,
81*c54f35caSApple OSS Distributions<a href="thread_set_special_port.html"><strong>thread_set_special_port</strong></a>,
82*c54f35caSApple OSS Distributions<a href="thread_set_state.html"><strong>thread_set_state</strong></a>.
83*c54f35caSApple OSS Distributions<p>
84*c54f35caSApple OSS DistributionsData Structures:
85*c54f35caSApple OSS Distributions<a href="thread_basic_info.html"><strong>thread_basic_info</strong></a>,
86*c54f35caSApple OSS Distributions<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>,
87*c54f35caSApple OSS Distributions<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>,
88*c54f35caSApple OSS Distributions<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>.
89