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