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