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