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 struct bt_stream_common {
  43         struct bt_object base;
  44         int64_t id;
  45         struct bt_stream_class_common *stream_class;
  46         GString *name;
  47 };
  48
  49 struct bt_stream {
  50         struct bt_stream_common common;
  51
  52         /* Pool of `struct bt_packet *` */
  53         struct bt_object_pool packet_pool;
  54 };
  55
  56 BT_HIDDEN
  57 int bt_stream_common_initialize(
  58                 struct bt_stream_common *stream,
  59                 struct bt_stream_class_common *stream_class, const char *name,
  60                 uint64_t id, bt_object_release_func release_func);
  61
  62 BT_HIDDEN
  63 void bt_stream_common_finalize(struct bt_stream_common *stream);
  64
  65 static inline
  66 struct bt_stream_class_common *bt_stream_common_borrow_class(
  67                 struct bt_stream_common *stream)
  68 {
  69         BT_ASSERT(stream);
  70         return stream->stream_class;
  71 }
  72
  73 static inline
  74 const char *bt_stream_common_get_name(struct bt_stream_common *stream)
  75 {
  76         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
  77         return stream->name ? stream->name->str : NULL;
  78 }
  79
  80 static inline
  81 int64_t bt_stream_common_get_id(struct bt_stream_common *stream)
  82 {
  83         int64_t ret;
  84
  85         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
  86         ret = stream->id;
  87         if (ret < 0) {
  88                 BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
  89                         stream, bt_stream_common_get_name(stream));
  90         }
  91
  92         return ret;
  93 }
  94
  95 #endif /* BABELTRACE_CTF_IR_STREAM_INTERNAL_H */