xnu-4903.221.2.tar.gz

[apple/xnu.git] / osfmk / man / etap_trace_thread.html

<h2>etap_trace_thread</h2>
<hr>
<p>
<strong>Function</strong> - Set a thread's ETAP trace status.
<h3>SYNOPSIS</h3>
<pre>
<strong>#include&ltmach/etap.h&gt</strong>

<strong>kern_return_t   etap_trace_thread</strong>
                <strong>(thread_act_t</strong>                     <var>target_thread</var>,
                 <strong>boolean_t</strong>                               <var>active</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>target_thread</var>
<dd>
The port of the thread who's ETAP trace status will be toggled.
<p>
<dt> <var>active</var>
<dd>
The boolean value (either TRUE or FALSE) stating whether the thread's
ETAP trace status will be activated or not. Passing TRUE will enable
the thread's trace status and FALSE will deactivate it.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>etap_trace_thread</strong> system call is used to
toggle the ETAP trace status of a thread.	
<h3>RETURN VALUES</h3>
<dl>
  <dt> <strong>KERN_SUCCESS</strong>
       <dd>
	    The call was performed successfully.
<p>
  <dt> <strong>KERN_INVALID_ARGUMENT</strong>
       <dd>
	    The value of <var>target_thread</var> does not name a valid thread.
<p>
  <dt> <strong>KERN_FAILURE</strong>
       <dd>
	    ETAP is not configured in the kernel.
</dl>
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="etap_probe.html"><strong>etap_probe</strong></a>,
<a href="etap_trace_event.html"><strong>etap_trace_event</strong></a>,
<a href="etap_get_info.html"><strong>etap_get_info</strong></a>.