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