Introduce contexts

[babeltrace.git] / include / babeltrace / format.h

diff --git a/include/babeltrace/format.h b/include/babeltrace/format.h
index ac03dba78f48ab798c23e05f3e1196de83ca2ac9..93d1e25146495920c40537b942d556b54541391c 100644 (file)
--- a/include/babeltrace/format.h
+++ b/include/babeltrace/format.h
@@ -6,74 +6,59 @@
  *
  * 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.
  */
 
+#include <babeltrace/types.h>
 #include <stdint.h>
+#include <stdio.h>
 #include <glib.h>
 
-struct format {
-       GQuark name;
+/* forward declaration */
+struct ctf_stream_pos;
 
-       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);
-
-       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);
+/* Parent trace descriptor */
+struct trace_descriptor {
+};
 
-       void (*float_copy)(unsigned char *destp,
-                          const struct type_class_float *dest,
-                          const unsigned char *srcp,
-                           const struct type_class_float *src);
-       double (*double_read)(const unsigned char *ptr,
-                             const struct type_class_float *src);
-       size_t (*double_write)(unsigned char *ptr,
-                              const struct type_class_float *dest,
-                              double v);
+struct mmap_stream {
+       int fd;
+       struct cds_list_head list;
+};
 
-       size_t (*string_copy)(unsigned char *dest, const unsigned char *src);
+struct mmap_stream_list {
+       struct cds_list_head head;
+};
 
-       GQuark (*enum_read)(const unsigned char *ptr,
-                           const struct type_class_enum *src);
-       size_t (*enum_write)(unsigned char *ptr,
-                            const struct type_class_enum *dest,
-                            GQuark q);
+struct format {
+       GQuark name;
 
+       struct trace_descriptor *(*open_trace)(const char *collection_path,
+                       const char *path, int flags,
+                       void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+                               int whence), FILE *metadata_fp);
+       struct trace_descriptor *(*open_mmap_trace)(
+                       struct mmap_stream_list *mmap_list,
+                       void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
+                               int whence), FILE *metadata_fp);
+       void (*close_trace)(struct trace_descriptor *descriptor);
 };
 
-struct format *bt_lookup_format(GQuark qname);
-int bt_register_format(const struct format *format);
+extern struct format *bt_lookup_format(GQuark qname);
+extern void bt_fprintf_format_list(FILE *fp);
+extern int bt_register_format(struct format *format);
 
 /* TBD: format unregistration */