xnu-4903.221.2.tar.gz

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

<h2>etap_get_info</h2>
<hr>
<p>
<strong>Function</strong> - Map ETAP buffers and tables into server's address space.
<h3>SYNOPSIS</h3>
<pre>
<strong>#include&ltmach/etap.h&gt</strong>

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