1<h2>etap_get_info</h2>
2<hr>
3<p>
4<strong>Function</strong> - Map ETAP buffers and tables into server's address space.
5<h3>SYNOPSIS</h3>
6<pre>
7<strong>#include&ltmach/etap.h&gt</strong>
8
9<strong>kern_return_t   etap_get_info</strong>
10                <strong>(host_priv_t</strong>                          <var>priv_port</var>,
11                 <strong>int</strong>                                        <var>int</var>,
12                 <strong>int</strong>                                        <var>int</var>,
13                 <strong>vm_offset_t</strong>                        <var>vm_offset_t</var>,
14                 <strong>vm_offset_t</strong>                        <var>vm_offset_t</var>,
15                 <strong>int</strong>                                        <var>int</var>,
16                 <strong>int</strong>                                        <var>int</var>,
17                 <strong>int</strong>                                        <var>int</var>,
18                 <strong>int</strong>                                        <var>int</var><strong>);</strong>
19</pre>
20<h3>PARAMETERS</h3>
21<dl>
22<p>
23<dt> <var>priv_port</var>
24<dd>
25the name of the Server's privileged device port (server_device_port),
26     granting the Server access to this service. 
27<p>
28<dt> <var>et_entries</var>
29<dd>
30used to return number of entries in the event table.
31<p>
32<dt> <var>st_entries</var>
33<dd>
34used to return number of entries in the subsystem table.
35<p>
36<dt> <var>et_offset</var>
37<dd>
38used to return the event table's page offset.
39<p>
40<dt> <var>st_offset</var>
41<dd>
42used to return the subsystem table's page offset.
43<p>
44<dt> <var>cb_width</var>
45<dd>
46returns the current cumulative buffer interval width.
47<p>
48<dt> <var>mb_size</var>
49<dd>
50returns the size of the monitored buffers, 
51<p>
52<dt> <var>mb_entries</var>
53<dd>
54returns the maximum number of entries in a monitored buffer.
55<p>
56<dt> <var>mb_cpus</var>
57<dd>
58returns the number of allocated monitored buffers (or supported CPUs).
59</dl>
60<h3>DESCRIPTION</h3>
61<p>
62The  <strong>etap_get_info</strong> interface provides the user space
63etap server or daemon with configuration and location information pertaining
64to the kernel's internal ETAP buffers; this information enables the caller
65to properly map the ETAP buffers and tables into its address
66space. When mapping is successfully completed, the Server displays the
67ETAP configuration on the console. The configuration output will
68resemble the following:
69<pre>
70    ETAP configuration [ee:108 se:8 eo:a60 so:acc cw:0 ms:1008008 me:36 mc:1]
71    ETAP event table mapped
72    ETAP subsystem table mapped
73    ETAP monitored buffer #0 mapped
74</pre>
75<p>
76The values between the brackets correspond with the arguments returned
77by the <strong>etap_get_info</strong> call (listed
78above). For example, "ee:108" indicates that the event table contains
79108 ETAP event types and "mc:1" indicates that one monitored buffer
80has been allocated.
81<h3>RETURN VALUES</h3>
82<dl>
83  <dt> <strong>KERN_SUCCESS</strong>
84       <dd>
85	    The call was performed successfully.
86</dl>
87<h3>RELATED INFORMATION</h3>
88<p>
89Functions:
90<a href="etap_probe.html"><strong>etap_probe</strong></a>,
91<a href="etap_trace_thread.html"><strong>etap_trace_thread</strong></a>,
92<a href="etap_trace_event.html"><strong>etap_trace_event</strong></a>,
93<a href="etap_trace_event.html"><strong>etap_get_info</strong></a>.
94