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

<h2>etap_get_info</h2>\r<hr>\r<p>\r<strong>Function</strong> - Map ETAP buffers and tables into server's address space.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&ltmach/etap.h&gt</strong>\r\r<strong>kern_return_t   etap_get_info</strong>\r                <strong>(host_priv_t</strong>                          <var>priv_port</var>,\r                 <strong>int</strong>                                        <var>int</var>,\r                 <strong>int</strong>                                        <var>int</var>,\r                 <strong>vm_offset_t</strong>                        <var>vm_offset_t</var>,\r                 <strong>vm_offset_t</strong>                        <var>vm_offset_t</var>,\r                 <strong>int</strong>                                        <var>int</var>,\r                 <strong>int</strong>                                        <var>int</var>,\r                 <strong>int</strong>                                        <var>int</var>,\r                 <strong>int</strong>                                        <var>int</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>priv_port</var>\r<dd>\rthe name of the Server's privileged device port (server_device_port),\r     granting the Server access to this service. \r<p>\r<dt> <var>et_entries</var>\r<dd>\rused to return number of entries in the event table.\r<p>\r<dt> <var>st_entries</var>\r<dd>\rused to return number of entries in the subsystem table.\r<p>\r<dt> <var>et_offset</var>\r<dd>\rused to return the event table's page offset.\r<p>\r<dt> <var>st_offset</var>\r<dd>\rused to return the subsystem table's page offset.\r<p>\r<dt> <var>cb_width</var>\r<dd>\rreturns the current cumulative buffer interval width.\r<p>\r<dt> <var>mb_size</var>\r<dd>\rreturns the size of the monitored buffers, \r<p>\r<dt> <var>mb_entries</var>\r<dd>\rreturns the maximum number of entries in a monitored buffer.\r<p>\r<dt> <var>mb_cpus</var>\r<dd>\rreturns the number of allocated monitored buffers (or supported CPUs).\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe  <strong>etap_get_info</strong> interface provides the user space\retap server or daemon with configuration and location information pertaining\rto the kernel's internal ETAP buffers; this information enables the caller\rto properly map the ETAP buffers and tables into its address\rspace. When mapping is successfully completed, the Server displays the\rETAP configuration on the console. The configuration output will\rresemble the following:\r<pre>\r    ETAP configuration [ee:108 se:8 eo:a60 so:acc cw:0 ms:1008008 me:36 mc:1]\r    ETAP event table mapped\r    ETAP subsystem table mapped\r    ETAP monitored buffer #0 mapped\r</pre>\r<p>\rThe values between the brackets correspond with the arguments returned\rby the <strong>etap_get_info</strong> call (listed\rabove). For example, "ee:108" indicates that the event table contains\r108 ETAP event types and "mc:1" indicates that one monitored buffer\rhas been allocated.\r<h3>RETURN VALUES</h3>\r<dl>\r  <dt> <strong>KERN_SUCCESS</strong>\r       <dd>\r	    The call was performed successfully.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="etap_probe.html"><strong>etap_probe</strong></a>,\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_trace_event.html"><strong>etap_get_info</strong></a>.\r