Namespace the struct mmap_stream
[babeltrace.git] / include / babeltrace / format.h
index 7162c0ea0822cbb2320317407aa1be87d0020f5e..8d4ac4b290a794af51af64006e029c80343015f2 100644 (file)
@@ -6,7 +6,9 @@
  *
  * Trace Format Header
  *
- * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
+ *
+ * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
+#include <babeltrace/list.h>
+#include <babeltrace/clock-types.h>
 #include <stdint.h>
-#include <glib.h>
+#include <stdio.h>
 
-struct format {
-       GQuark name;
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef int bt_intern_str;
+
+/* forward declaration */
+struct bt_stream_pos;
+struct bt_context;
+struct bt_trace_handle;
 
-       uint64_t (*uint_read)(struct stream_pos *pos,
-                       const struct type_class_integer *int_class);
-       int64_t (*int_read)(struct stream_pos *pos,
-                       const struct type_class_integer *int_class);
-       void (*uint_write)(struct stream_pos *pos,
-                          const struct type_class_integer *int_class,
-                          uint64_t v);
-       void (*int_write)(struct stream_pos *pos,
-                         const struct type_class_integer *int_class,
-                         int64_t v);
+/* Parent trace descriptor */
+struct bt_trace_descriptor {
+};
 
-       void (*float_copy)(struct stream_pos *dest,
-                          struct stream_pos *src,
-                          const struct type_class_float *src);
-       double (*double_read)(struct stream_pos *pos,
-                             const struct type_class_float *float_class);
-       void (*double_write)(struct stream_pos *pos,
-                            const struct type_class_float *float_class,
-                            double v);
+struct bt_mmap_stream {
+       int fd;
+       struct bt_list_head list;
+};
 
-       void (*string_copy)(struct stream_pos *dest, struct stream_pos *src,
-                           const struct type_class_string *string_class);
-       void (*string_read)(unsigned char **dest, struct stream_pos *src,
-                           const struct type_class_string *string_class);
-       void (*string_write)(struct stream_pos *dest, const unsigned char *src,
-                            const struct type_class_string *string_class);
-       void (*string_free_temp)(unsigned char *string);
+struct bt_mmap_stream_list {
+       struct bt_list_head head;
+};
+
+struct format {
+       bt_intern_str name;
 
-       GQuark (*enum_read)(struct stream_pos *pos,
-                           const struct type_class_enum *src);
-       void (*enum_write)(struct stream_pos *pos,
-                          const struct type_class_enum *dest,
-                          GQuark q);
-       void (*struct_begin)(struct stream_pos *pos,
-                            const struct type_class_struct *struct_class);
-       void (*struct_end)(struct stream_pos *pos,
-                          const struct type_class_struct *struct_class);
-       void (*array_begin)(struct stream_pos *pos,
-                            const struct type_class_array *array_class);
-       void (*array_end)(struct stream_pos *pos,
-                          const struct type_class_array *array_class);
-       void (*sequence_begin)(struct stream_pos *pos,
-                            const struct type_class_sequence *sequence_class);
-       void (*sequence_end)(struct stream_pos *pos,
-                          const struct type_class_sequence *sequence_class);
+       struct bt_trace_descriptor *(*open_trace)(const char *path, int flags,
+                       void (*packet_seek)(struct bt_stream_pos *pos,
+                               size_t index, int whence),
+                       FILE *metadata_fp);
+       struct bt_trace_descriptor *(*open_mmap_trace)(
+                       struct bt_mmap_stream_list *mmap_list,
+                       void (*packet_seek)(struct bt_stream_pos *pos,
+                               size_t index, int whence),
+                       FILE *metadata_fp);
+       int (*close_trace)(struct bt_trace_descriptor *descriptor);
+       void (*set_context)(struct bt_trace_descriptor *descriptor,
+                       struct bt_context *ctx);
+       void (*set_handle)(struct bt_trace_descriptor *descriptor,
+                       struct bt_trace_handle *handle);
+       uint64_t (*timestamp_begin)(struct bt_trace_descriptor *descriptor,
+                       struct bt_trace_handle *handle, enum bt_clock_type type);
+       uint64_t (*timestamp_end)(struct bt_trace_descriptor *descriptor,
+                       struct bt_trace_handle *handle, enum bt_clock_type type);
+       int (*convert_index_timestamp)(struct bt_trace_descriptor *descriptor);
 };
 
-struct format *bt_lookup_format(GQuark qname);
-int bt_register_format(const struct format *format);
+extern struct format *bt_lookup_format(bt_intern_str qname);
+extern void bt_fprintf_format_list(FILE *fp);
+extern int bt_register_format(struct format *format);
+extern void bt_unregister_format(struct format *format);
 
-/* TBD: format unregistration */
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* _BABELTRACE_FORMAT_H */
This page took 0.023781 seconds and 4 git commands to generate.