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