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