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