Add a common, internal CTF serialization library; make CTF writer use it

[babeltrace.git] / include / babeltrace / ctf-writer / stream-internal.h

diff --git a/include/babeltrace/ctf-writer/stream-internal.h b/include/babeltrace/ctf-writer/stream-internal.h
index f1cb27c237257efebb7cc237216531b22b629d42..565d53f24438def98ea186fa9e471158e17fe150 100644 (file)
--- a/include/babeltrace/ctf-writer/stream-internal.h
+++ b/include/babeltrace/ctf-writer/stream-internal.h
@@ -2,9 +2,7 @@
 #define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
 
 /*
- * BabelTrace - CTF Writer: Stream internal
- *
- * Copyright 2013 EfficiOS Inc.
+ * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -25,44 +23,85 @@
  * 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.
+ *
+ * The Common Trace Format (CTF) Specification is available at
+ * http://www.efficios.com/ctf
  */
 
-#include <babeltrace/ctf-writer/ref-internal.h>
-#include <babeltrace/ctf-writer/clock.h>
-#include <babeltrace/ctf-writer/event-fields.h>
-#include <babeltrace/ctf-writer/event-types.h>
+#include <babeltrace/assert-internal.h>
+#include <babeltrace/assert-pre-internal.h>
 #include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/ctf/types.h>
-#include <glib.h>
+#include <babeltrace/ctf-writer/stream-internal.h>
+#include <babeltrace/ctf-writer/stream.h>
+#include <babeltrace/ctf-writer/utils-internal.h>
+#include <babeltrace/ctf-writer/object-internal.h>
+#include <babeltrace/ctfser-internal.h>
+#include <stdint.h>
 
-typedef void(*flush_func)(struct bt_ctf_stream *, void *);
+struct bt_ctf_stream_common;
 
-struct flush_callback {
-       flush_func func;
-       void *data;
+struct bt_ctf_stream_common {
+       struct bt_ctf_object base;
+       int64_t id;
+       struct bt_ctf_stream_class_common *stream_class;
+       GString *name;
 };
 
+BT_HIDDEN
+int bt_ctf_stream_common_initialize(
+               struct bt_ctf_stream_common *stream,
+               struct bt_ctf_stream_class_common *stream_class, const char *name,
+               uint64_t id, bt_ctf_object_release_func release_func);
+
+BT_HIDDEN
+void bt_ctf_stream_common_finalize(struct bt_ctf_stream_common *stream);
+
+static inline
+struct bt_ctf_stream_class_common *bt_ctf_stream_common_borrow_class(
+               struct bt_ctf_stream_common *stream)
+{
+       BT_ASSERT(stream);
+       return stream->stream_class;
+}
+
+static inline
+const char *bt_ctf_stream_common_get_name(struct bt_ctf_stream_common *stream)
+{
+       BT_ASSERT_PRE_NON_NULL(stream, "Stream");
+       return stream->name ? stream->name->str : NULL;
+}
+
+static inline
+int64_t bt_ctf_stream_common_get_id(struct bt_ctf_stream_common *stream)
+{
+       int64_t ret;
+
+       BT_ASSERT_PRE_NON_NULL(stream, "Stream");
+       ret = stream->id;
+       if (ret < 0) {
+               BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
+                       stream, bt_ctf_stream_common_get_name(stream));
+       }
+
+       return ret;
+}
+
 struct bt_ctf_stream {
-       struct bt_ctf_ref ref_count;
-       uint32_t id;
-       struct bt_ctf_stream_class *stream_class;
-       struct flush_callback flush;
+       struct bt_ctf_stream_common common;
+       struct bt_ctf_field *packet_header;
+       struct bt_ctf_field *packet_context;
+
        /* Array of pointers to bt_ctf_event for the current packet */
        GPtrArray *events;
-       struct ctf_stream_pos pos;
+       struct bt_ctfser ctfser;
        unsigned int flushed_packet_count;
-       uint64_t events_discarded;
+       uint64_t discarded_events;
+       uint64_t last_ts_end;
 };
 
 BT_HIDDEN
-struct bt_ctf_stream *bt_ctf_stream_create(
-               struct bt_ctf_stream_class *stream_class);
-
-BT_HIDDEN
-int bt_ctf_stream_set_flush_callback(struct bt_ctf_stream *stream,
-               flush_func callback, void *data);
-
-BT_HIDDEN
-int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd);
+struct bt_ctf_stream *bt_ctf_stream_create_with_id(
+               struct bt_ctf_stream_class *stream_class,
+               const char *name, uint64_t id);
 
 #endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */