<h2>etap_probe</h2>

<strong>System Trap</strong> - Record event data in the kernel's

ETAP buffer(s).

<h3>SYNOPSIS</h3>

<strong>#include&ltmach/etap.h&gt</strong>

<strong>kern_return_t etap_probe</strong>

<strong>(int</strong> <var>event_id</var>,

<strong>event_id</strong> <var>data_size</var>,

<strong>etap_data_t</strong> <var>etap_data_t</var><strong>);</strong>

<h3>PARAMETERS</h3>

<dt> <var>event_id</var>

A user defined value used to identify the event.

<dt> <var>data_size</var>

The size (in bytes) of the data being passed.

Note: The data size is limited to ETAP_DATA_SIZE,

(defined in <strong>mach/etap.h</strong>).

<dt> <var>data</var>

A pointer to the event data being passed.

<h3>DESCRIPTION</h3>

Application programmers may instrument their applications with

user-level probes, using the

<strong>etap_probe</strong> system call. All

event data passed to the kernel via

<strong>etap_probe</strong> is recorded in the

kernel's ETAP monitored buffer(s). Each record includes a time stamp.

<h3>RETURN VALUES</h3>

<dt> <strong>KERN_SUCCESS</strong>

<dd>

The call was performed successfully.

<dt> <strong>KERN_INVALID_ARGUMENT</strong>

<dd>

The specified data size exceeds ETAP_DATA_SIZE.

<dt> <strong>KERN_NO_ACCESS</strong>

<dd>

The tracing of user events is currently enabled.

<dt> <strong>KERN_FAILURE</strong>

<dd>

ETAP is not configured in the kernel.

<h3>RELATED INFORMATION</h3>

Functions:

<a href="etap_trace_thread.html"><strong>etap_trace_thread</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>.