include/babeltrace/ctf-ir/stream-internal.h

   1 #ifndef BABELTRACE_CTF_IR_STREAM_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_STREAM_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF Writer: Stream internal
   6  *
   7  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/assert-pre-internal.h>
  31 #include <babeltrace/assert-internal.h>
  32 #include <babeltrace/ctf-ir/stream.h>
  33 #include <babeltrace/ctf-ir/utils-internal.h>
  34 #include <babeltrace/object-internal.h>
  35 #include <babeltrace/babeltrace-internal.h>
  36 #include <glib.h>
  37
  38 struct bt_stream_class;
  39 struct bt_stream_common;
  40
  41 typedef void (*bt_stream_common_destroy_listener_func)(
  42                 struct bt_stream_common *stream, void *data);
  43
  44 struct bt_stream_common_destroy_listener {
  45         bt_stream_common_destroy_listener_func func;
  46         void *data;
  47 };
  48
  49 struct bt_stream_common {
  50         struct bt_object base;
  51         int64_t id;
  52         struct bt_stream_class_common *stream_class;
  53         GString *name;
  54
  55         /* Array of struct bt_stream_common_destroy_listener */
  56         GArray *destroy_listeners;
  57 };
  58
  59 struct bt_stream {
  60         struct bt_stream_common common;
  61 };
  62
  63 BT_HIDDEN
  64 void bt_stream_common_add_destroy_listener(struct bt_stream_common *stream,
  65                 bt_stream_common_destroy_listener_func func, void *data);
  66
  67 BT_HIDDEN
  68 void bt_stream_common_remove_destroy_listener(struct bt_stream_common *stream,
  69                 bt_stream_common_destroy_listener_func func, void *data);
  70
  71 BT_HIDDEN
  72 int bt_stream_common_initialize(
  73                 struct bt_stream_common *stream,
  74                 struct bt_stream_class_common *stream_class, const char *name,
  75                 uint64_t id, bt_object_release_func release_func);
  76
  77 BT_HIDDEN
  78 void bt_stream_common_finalize(struct bt_stream_common *stream);
  79
  80 static inline
  81 struct bt_stream_class_common *bt_stream_common_borrow_class(
  82                 struct bt_stream_common *stream)
  83 {
  84         BT_ASSERT(stream);
  85         return stream->stream_class;
  86 }
  87
  88 static inline
  89 struct bt_stream_class *bt_stream_borrow_class(struct bt_stream *stream)
  90 {
  91         BT_ASSERT(stream);
  92         return BT_FROM_COMMON(bt_stream_common_borrow_class(BT_TO_COMMON(stream)));
  93 }
  94
  95 static inline
  96 struct bt_stream_class_common *bt_stream_common_get_class(
  97                 struct bt_stream_common *stream)
  98 {
  99         return bt_get(bt_stream_common_borrow_class(stream));
 100 }
 101
 102 static inline
 103 const char *bt_stream_common_get_name(struct bt_stream_common *stream)
 104 {
 105         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 106         return stream->name ? stream->name->str : NULL;
 107 }
 108
 109 static inline
 110 int64_t bt_stream_common_get_id(struct bt_stream_common *stream)
 111 {
 112         int64_t ret;
 113
 114         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 115         ret = stream->id;
 116         if (ret < 0) {
 117                 BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
 118                         stream, bt_stream_common_get_name(stream));
 119         }
 120
 121         return ret;
 122 }
 123
 124 #endif /* BABELTRACE_CTF_IR_STREAM_INTERNAL_H */