xref: /xnu-10002.41.9/osfmk/man/etap_trace_thread.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>etap_trace_thread</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Set a thread's ETAP trace status.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>#include&ltmach/etap.h&gt</strong>
8*699cd480SApple OSS Distributions
9*699cd480SApple OSS Distributions<strong>kern_return_t   etap_trace_thread</strong>
10*699cd480SApple OSS Distributions                <strong>(thread_act_t</strong>                     <var>target_thread</var>,
11*699cd480SApple OSS Distributions                 <strong>boolean_t</strong>                               <var>active</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 DistributionsThe port of the thread who's ETAP trace status will be toggled.
19*699cd480SApple OSS Distributions<p>
20*699cd480SApple OSS Distributions<dt> <var>active</var>
21*699cd480SApple OSS Distributions<dd>
22*699cd480SApple OSS DistributionsThe boolean value (either TRUE or FALSE) stating whether the thread's
23*699cd480SApple OSS DistributionsETAP trace status will be activated or not. Passing TRUE will enable
24*699cd480SApple OSS Distributionsthe thread's trace status and FALSE will deactivate it.
25*699cd480SApple OSS Distributions</dl>
26*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
27*699cd480SApple OSS Distributions<p>
28*699cd480SApple OSS DistributionsThe <strong>etap_trace_thread</strong> system call is used to
29*699cd480SApple OSS Distributionstoggle the ETAP trace status of a thread.
30*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
31*699cd480SApple OSS Distributions<dl>
32*699cd480SApple OSS Distributions  <dt> <strong>KERN_SUCCESS</strong>
33*699cd480SApple OSS Distributions       <dd>
34*699cd480SApple OSS Distributions	    The call was performed successfully.
35*699cd480SApple OSS Distributions<p>
36*699cd480SApple OSS Distributions  <dt> <strong>KERN_INVALID_ARGUMENT</strong>
37*699cd480SApple OSS Distributions       <dd>
38*699cd480SApple OSS Distributions	    The value of <var>target_thread</var> does not name a valid thread.
39*699cd480SApple OSS Distributions<p>
40*699cd480SApple OSS Distributions  <dt> <strong>KERN_FAILURE</strong>
41*699cd480SApple OSS Distributions       <dd>
42*699cd480SApple OSS Distributions	    ETAP is not configured in the kernel.
43*699cd480SApple OSS Distributions</dl>
44*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
45*699cd480SApple OSS Distributions<p>
46*699cd480SApple OSS DistributionsFunctions:
47*699cd480SApple OSS Distributions<a href="etap_probe.html"><strong>etap_probe</strong></a>,
48*699cd480SApple OSS Distributions<a href="etap_trace_event.html"><strong>etap_trace_event</strong></a>,
49*699cd480SApple OSS Distributions<a href="etap_get_info.html"><strong>etap_get_info</strong></a>.
50