Introduce contexts

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

diff --git a/include/babeltrace/format.h b/include/babeltrace/format.h
index 9478dcf4943cbe8aa4a19db7ea2636849bc5a52b..93d1e25146495920c40537b942d556b54541391c 100644 (file)
--- a/include/babeltrace/format.h
+++ b/include/babeltrace/format.h
@@ -6,78 +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;
+
+/* Parent trace descriptor */
+struct trace_descriptor {
+};
 
-       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);
+struct mmap_stream {
+       int fd;
+       struct cds_list_head list;
+};
 
-       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 mmap_stream_list {
+       struct cds_list_head head;
+};
 
-       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 format {
+       GQuark 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 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 */