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