update compat

[lttv.git] / ltt / branches / poly / doc / developer / format.html

diff --git a/ltt/branches/poly/doc/developer/format.html b/ltt/branches/poly/doc/developer/format.html
index 0fa8c4a57a96bc41c5aa866dc4ac6ef4ecb4aad9..254700af8f61cc5bf013073da06dc5a356dc9b19 100644 (file)
--- a/ltt/branches/poly/doc/developer/format.html
+++ b/ltt/branches/poly/doc/developer/format.html
@@ -24,7 +24,7 @@ foo/
 |-- eventdefs
 |   |-- core.xml
 |   |-- fs.xml
-|              |-- ipc.xml
+|   |-- ipc.xml
 |   |-- kernel.xml
 |   |-- memory.xml
 |   |-- network.xml
@@ -125,24 +125,16 @@ The block start/end header
 <PRE><TT>
 begin
        * the beginning of buffer information
-       timestamp
-               * Used only when no TSC is available.
-               uint32 seconds
-               uint32 microseconds
        uint64 cycle_count
                * TSC at the beginning of the buffer
        uint64 freq
                * frequency of the CPUs at the beginning of the buffer.
 end
        * the end of buffer information
-       timestamp
-               * Used only when no TSC is available.
-               uint32 seconds
-               uint32 microseconds
        uint64 cycle_count
                * TSC at the beginning of the buffer
        uint64 freq
-               * frequency of the CPUs at the beginning of the buffer.
+               * frequency of the CPUs at the end of the buffer.
 uint32 lost_size
        * number of bytes of padding at the end of the buffer.
 uint32 buf_size
@@ -181,15 +173,9 @@ uint8 has_alignment
        * Is the information in this trace aligned ?
                Yes (1) -> aligned on min(arch size, atomic data size).
                No (0) -> data is packed.
-uint8 has_tsc
-       * Does the traced machine has a working TSC ?
-               Yes (1) -> event time is calculated from :
-                       trace_start_time + ((event_tsc - trace_start_tsc) * freq)
-               No (0) -> event time is calculated from :
-                       trace_start_time 
-                       + (buffer start timestamp - trace start_monotonic) 
-                       + (event_time_delta)
-                       (not supported)
+uint32 freq_scale
+               event time is always calculated from :
+                       trace_start_time + ((event_tsc - trace_start_tsc) * (freq / freq_scale))
 uint64 start_freq
        * CPUs clock frequency at the beginnig of the trace.
 uint64 start_tsc
@@ -222,9 +208,6 @@ Event header :
        uint64 timestamp }
        * if has_heartbeat : 32 LSB of the cycle counter at the event record time.
        * else : 64 bits complete cycle counter.
-       * note : if there is no working TSC (has_tsc == 0), then this field contains
-         either the complete monotonically increasing time or the time delta from the
-               previous heartbeat event. (unsupported)
 uint8 facility_id
        * Numerical ID of the facility corresponding to the event. See the facility
          tracefile to know which facility ID matches which facility name and
@@ -373,10 +356,10 @@ Finally the type structure may be defined by referencing a named type.
 &lt;typeref name=type_name/&gt;
 </PRE></TT>
 
-<H2>Builtin events</H2>
+<H2>Core events</H2>
 
 <P>
-The facility named "builtin" is always present and contains at least the
+The facility named "core" is always present and contains at least the
 following event types.
 
 <PRE><TT>
@@ -385,18 +368,27 @@ following event types.
   &lt;struct&gt;
     &lt;field name="name"&gt;&lt;string/&gt;&lt;/field&gt;
     &lt;field name="checksum"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
-    &lt;field name="base_code"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="id"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="int_size"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="long_size"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="pointer_size"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="size_t_size"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="has_alignment"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
   &lt;/struct&gt;
 &lt;/event&gt;
 
-&lt;event name=block_start&gt;
-  &lt;description&gt;Block start timestamp&lt;/description&gt;
-  &lt;typeref name=block_timestamp/&gt;
-&lt;/event&gt;
-
-&lt;event name=block_end&gt;
-  &lt;description&gt;Block end timestamp&lt;/description&gt;
-  &lt;typeref name=block_timestamp/&gt;
+&lt;event name=state_dump_facility_load&gt;
+  &lt;description&gt;Facility used in the trace&lt;/description&gt;
+  &lt;struct&gt;
+    &lt;field name="name"&gt;&lt;string/&gt;&lt;/field&gt;
+    &lt;field name="checksum"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="id"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="int_size"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="long_size"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="pointer_size"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="size_t_size"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="has_alignment"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+  &lt;/struct&gt;
 &lt;/event&gt;
 
 &lt;event name=time_heartbeat&gt;
@@ -407,26 +399,14 @@ following event types.
   &lt;typeref name=timestamp/&gt;
 &lt;/event&gt;
 
-&lt;type name=block_timestamp&gt;
-  &lt;struct&gt;
-    &lt;field name=timestamp&gt;&lt;typeref name=timestamp&gt;&lt;/field&gt;
-    &lt;field name=block_id&gt;&lt;uint size=4/&gt;&lt;/field&gt;
-  &lt;/struct&gt;
-&lt;/type&gt;
-
 &lt;type name=timestamp&gt;
   &lt;struct&gt;
-    &lt;field name=time&gt;&lt;typeref name=timespec/&gt;&lt;/event&gt;
+    &lt;field name="seconds"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
+    &lt;field name="nanoseconds"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
     &lt;field name="cycle_count"&gt;&lt;uint size=8/&gt;&lt;/field&gt;
   &lt;/struct&gt;
 &lt;/event&gt;
 
-&lt;type name=timespec&gt;
-  &lt;struct&gt;
-    &lt;field name="seconds"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
-    &lt;field name="nanoseconds"&gt;&lt;uint size=4/&gt;&lt;/field&gt;
-  &lt;/struct&gt;
-&lt;/type&gt;
 </TT></PRE>
 
 <H2>Control files</H2>