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

<h2>etap_probe</h2>\r<hr>\r<p>\r<strong>System Trap</strong> - Record event data in the kernel's\rETAP buffer(s).\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&ltmach/etap.h&gt</strong>\r\r<strong>kern_return_t   etap_probe</strong>\r                <strong>(int</strong>                                   <var>event_id</var>,\r                 <strong>event_id</strong>                             <var>data_size</var>,\r                 <strong>etap_data_t</strong>                        <var>etap_data_t</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>event_id</var>\r<dd>\rA user defined value used to identify the event. \r<p>\r<dt> <var>data_size</var>\r<dd>\rThe size (in bytes) of the data being passed.\rNote: The data size is limited to ETAP_DATA_SIZE,\r(defined in <strong>mach/etap.h</strong>).\r<p>\r<dt> <var>data</var>\r<dd>\rA pointer to the event data being passed.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rApplication programmers may instrument their applications with\ruser-level probes, using the\r<strong>etap_probe</strong> system call. All\revent data passed to the kernel via\r<strong>etap_probe</strong> is recorded in the\rkernel's ETAP monitored buffer(s).  Each record includes a time stamp.\r<h3>RETURN VALUES</h3>\r<dl>\r  <dt> <strong>KERN_SUCCESS</strong>\r       <dd>\r	    The call was performed successfully.\r<p>\r  <dt> <strong>KERN_INVALID_ARGUMENT</strong>\r       <dd>\r	    The specified data size exceeds ETAP_DATA_SIZE.\r<p>\r  <dt> <strong>KERN_NO_ACCESS</strong>\r       <dd>\r	    The tracing of user events is currently enabled.\r<p>\r  <dt> <strong>KERN_FAILURE</strong>\r       <dd>\r	    ETAP is not configured in the kernel.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="etap_trace_thread.html"><strong>etap_trace_thread</strong></a>,\r<a href="etap_trace_event.html"><strong>etap_trace_event</strong></a>,\r<a href="etap_get_info.html"><strong>etap_get_info</strong></a>.\r