xref: /xnu-11215.61.5/osfmk/man/thread_sample.html (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
1*4f1223e8SApple OSS Distributions<h2>thread_sample</h2>
2*4f1223e8SApple OSS Distributions<hr>
3*4f1223e8SApple OSS Distributions<p>
4*4f1223e8SApple OSS Distributions<strong>Function</strong> - Perform periodic PC sampling for a thread.
5*4f1223e8SApple OSS Distributions<h3>SYNOPSIS</h3>
6*4f1223e8SApple OSS Distributions<pre>
7*4f1223e8SApple OSS Distributions<strong>kern_return_t   thread_sample</strong>
8*4f1223e8SApple OSS Distributions                <strong>(thread_act_t</strong>                     <var>sample_thread</var>,
9*4f1223e8SApple OSS Distributions                 <strong>mach_port_make_send_t</strong>               <var>reply_port</var><strong>);</strong>
10*4f1223e8SApple OSS Distributions</pre>
11*4f1223e8SApple OSS Distributions<h3>PARAMETERS</h3>
12*4f1223e8SApple OSS Distributions<dl>
13*4f1223e8SApple OSS Distributions<p>
14*4f1223e8SApple OSS Distributions<dt> <var>sample_thread</var>
15*4f1223e8SApple OSS Distributions<dd>
16*4f1223e8SApple OSS Distributions[in thread send right]
17*4f1223e8SApple OSS DistributionsThread whose PC is to be sampled
18*4f1223e8SApple OSS Distributions<p>
19*4f1223e8SApple OSS Distributions<dt> <var>reply_port</var>
20*4f1223e8SApple OSS Distributions<dd>
21*4f1223e8SApple OSS Distributions[in sample receive (to be converted to send) right]
22*4f1223e8SApple OSS DistributionsPort to which PC
23*4f1223e8SApple OSS Distributionssample buffers are sent.  A value of <strong>MACH_PORT_NULL</strong> stops PC
24*4f1223e8SApple OSS Distributionssampling for the thread.
25*4f1223e8SApple OSS Distributions</dl>
26*4f1223e8SApple OSS Distributions<h3>DESCRIPTION</h3>
27*4f1223e8SApple OSS Distributions<p>
28*4f1223e8SApple OSS DistributionsThe <strong>thread_sample</strong> function causes the program counter
29*4f1223e8SApple OSS Distributions(PC) of the specified
30*4f1223e8SApple OSS Distributions<var>sample_thread</var> to be sampled periodically (whenever the thread happens to be
31*4f1223e8SApple OSS Distributionsrunning at the time of the kernel's "hardclock" interrupt).
32*4f1223e8SApple OSS DistributionsThe set of PC sample
33*4f1223e8SApple OSS Distributionsvalues obtained are saved in buffers which are sent to the specified
34*4f1223e8SApple OSS Distributions<var>reply_port</var> in
35*4f1223e8SApple OSS Distributions<strong>receive_samples</strong> messages.
36*4f1223e8SApple OSS Distributions<h3>RETURN VALUES</h3>
37*4f1223e8SApple OSS Distributions<p>
38*4f1223e8SApple OSS DistributionsOnly generic errors apply.
39*4f1223e8SApple OSS Distributions<h3>RELATED INFORMATION</h3>
40*4f1223e8SApple OSS Distributions<p>
41*4f1223e8SApple OSS DistributionsFunctions:
42*4f1223e8SApple OSS Distributions<a href="task_sample.html"><strong>task_sample</strong></a>,
43*4f1223e8SApple OSS Distributions<a href="receive_samples.html"><strong>receive_samples</strong></a>.
44