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