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