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