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/object-pool-internal.h>
  36 #include <babeltrace/babeltrace-internal.h>
  37 #include <glib.h>
  38
  39 struct bt_stream_class;
  40 struct bt_stream_common;
  41
  42 typedef void (*bt_stream_common_destroy_listener_func)(
  43                 struct bt_stream_common *stream, void *data);
  44
  45 struct bt_stream_common_destroy_listener {
  46         bt_stream_common_destroy_listener_func func;
  47         void *data;
  48 };
  49
  50 struct bt_stream_common {
  51         struct bt_object base;
  52         int64_t id;
  53         struct bt_stream_class_common *stream_class;
  54         GString *name;
  55
  56         /* Array of struct bt_stream_common_destroy_listener */
  57         GArray *destroy_listeners;
  58 };
  59
  60 struct bt_stream {
  61         struct bt_stream_common common;
  62
  63         /* Pool of `struct bt_packet *` */
  64         struct bt_object_pool packet_pool;
  65 };
  66
  67 BT_HIDDEN
  68 void bt_stream_common_add_destroy_listener(struct bt_stream_common *stream,
  69                 bt_stream_common_destroy_listener_func func, void *data);
  70
  71 BT_HIDDEN
  72 void bt_stream_common_remove_destroy_listener(struct bt_stream_common *stream,
  73                 bt_stream_common_destroy_listener_func func, void *data);
  74
  75 BT_HIDDEN
  76 int bt_stream_common_initialize(
  77                 struct bt_stream_common *stream,
  78                 struct bt_stream_class_common *stream_class, const char *name,
  79                 uint64_t id, bt_object_release_func release_func);
  80
  81 BT_HIDDEN
  82 void bt_stream_common_finalize(struct bt_stream_common *stream);
  83
  84 static inline
  85 struct bt_stream_class_common *bt_stream_common_borrow_class(
  86                 struct bt_stream_common *stream)
  87 {
  88         BT_ASSERT(stream);
  89         return stream->stream_class;
  90 }
  91
  92 static inline
  93 const char *bt_stream_common_get_name(struct bt_stream_common *stream)
  94 {
  95         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
  96         return stream->name ? stream->name->str : NULL;
  97 }
  98
  99 static inline
 100 int64_t bt_stream_common_get_id(struct bt_stream_common *stream)
 101 {
 102         int64_t ret;
 103
 104         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 105         ret = stream->id;
 106         if (ret < 0) {
 107                 BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
 108                         stream, bt_stream_common_get_name(stream));
 109         }
 110
 111         return ret;
 112 }
 113
 114 #endif /* BABELTRACE_CTF_IR_STREAM_INTERNAL_H */