Namespace the struct mmap_stream
[babeltrace.git] / include / babeltrace / format.h
index 4981f122f4f69ba66cabe5703c5f13b375ec8029..8d4ac4b290a794af51af64006e029c80343015f2 100644 (file)
@@ -6,62 +6,89 @@
  *
  * Trace Format Header
  *
- * Copyright (c) 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
  *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
+ * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Lesser General Public License for more details.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * 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
 
-       uint64_t (*uint_read)(const uint8_t *ptr, size_t len, int byte_order);
-       int64_t (*int_read)(const uint8_t *ptr, size_t len, int byte_order);
-       size_t (*uint_write)(uint8_t *ptr, size_t len, int byte_order, uint64_t v);
-       size_t (*int_write)(uint8_t *ptr, size_t len, int byte_order, int64_t v);
+typedef int bt_intern_str;
 
-       uint64_t (*bitfield_unsigned_read)(const unsigned char *ptr,
-                                           unsigned long start, unsigned long len,
-                                           int byte_order);
-       int64_t (*bitfield_signed_read)(const unsigned char *ptr,
-                                        unsigned long start, unsigned long len,
-                                        int byte_order);
-       size_t (*bitfield_unsigned_write)(unsigned char *ptr,
-                                          unsigned long start, unsigned long len,
-                                          int byte_order, uint64_t v);
-       size_t (*bitfield_signed_write)(unsigned char *ptr,
-                                        unsigned long start, unsigned long len,
-                                        int byte_order, int64_t v);
+/* forward declaration */
+struct bt_stream_pos;
+struct bt_context;
+struct bt_trace_handle;
 
+/* Parent trace descriptor */
+struct bt_trace_descriptor {
+};
 
-       void (*float_copy)(unsigned char *destp, const struct type_class_float *dest,
-                   const unsigned char *srcp, const struct type_class_float *src);
+struct bt_mmap_stream {
+       int fd;
+       struct bt_list_head list;
+};
 
-       size_t (*string_copy)(unsigned char *dest, const unsigned char *src);
+struct bt_mmap_stream_list {
+       struct bt_list_head head;
+};
+
+struct format {
+       bt_intern_str name;
 
-       GQuark (*enum_uint_to_quark)(const struct enum_table *table, uint64_t v);
-       GQuark (*enum_int_to_quark)(const struct enum_table *table, uint64_t v);
-       uint64_t (*enum_quark_to_uint)(size_t len, int byte_order, GQuark q);
-       int64_t (*enum_quark_to_int)(size_t len, int byte_order, GQuark q);
+       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.023566 seconds and 4 git commands to generate.