src/lib/trace-ir/stream.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "LIB/STREAM"
  25 #include "lib/logging.h"
  26
  27 #include "lib/assert-pre.h"
  28 #include <babeltrace2/trace-ir/stream-const.h>
  29 #include <babeltrace2/trace-ir/stream.h>
  30 #include <babeltrace2/trace-ir/stream-class.h>
  31 #include <babeltrace2/trace-ir/trace.h>
  32 #include "compat/compiler.h"
  33 #include "common/align.h"
  34 #include "common/assert.h"
  35 #include "lib/property.h"
  36 #include <inttypes.h>
  37 #include <unistd.h>
  38
  39 #include "packet.h"
  40 #include "stream-class.h"
  41 #include "stream.h"
  42 #include "trace.h"
  43
  44 #define BT_ASSERT_PRE_STREAM_HOT(_stream) \
  45         BT_ASSERT_PRE_HOT((_stream), "Stream", ": %!+s", (_stream))
  46
  47 static
  48 void destroy_stream(struct bt_object *obj)
  49 {
  50         struct bt_stream *stream = (void *) obj;
  51
  52         BT_LIB_LOGD("Destroying stream object: %!+s", stream);
  53
  54         if (stream->name.str) {
  55                 g_string_free(stream->name.str, TRUE);
  56                 stream->name.str = NULL;
  57                 stream->name.value = NULL;
  58         }
  59
  60         BT_LOGD_STR("Putting stream's class.");
  61         bt_object_put_ref(stream->class);
  62         bt_object_pool_finalize(&stream->packet_pool);
  63         g_free(stream);
  64 }
  65
  66 static
  67 void bt_stream_free_packet(struct bt_packet *packet, struct bt_stream *stream)
  68 {
  69         bt_packet_destroy(packet);
  70 }
  71
  72 BT_ASSERT_PRE_FUNC
  73 static inline
  74 bool stream_id_is_unique(struct bt_trace *trace,
  75                 struct bt_stream_class *stream_class, uint64_t id)
  76 {
  77         uint64_t i;
  78         bool is_unique = true;
  79
  80         for (i = 0; i < trace->streams->len; i++) {
  81                 struct bt_stream *stream = trace->streams->pdata[i];
  82
  83                 if (stream->class != stream_class) {
  84                         continue;
  85                 }
  86
  87                 if (stream->id == id) {
  88                         is_unique = false;
  89                         goto end;
  90                 }
  91         }
  92
  93 end:
  94         return is_unique;
  95 }
  96
  97 static
  98 struct bt_stream *create_stream_with_id(struct bt_stream_class *stream_class,
  99                 struct bt_trace *trace, uint64_t id)
 100 {
 101         int ret;
 102         struct bt_stream *stream;
 103
 104         BT_ASSERT(stream_class);
 105         BT_ASSERT(trace);
 106         BT_ASSERT_PRE(trace->class ==
 107                 bt_stream_class_borrow_trace_class_inline(stream_class),
 108                 "Trace's class is different from stream class's parent trace class: "
 109                 "%![sc-]+S, %![trace-]+t", stream_class, trace);
 110         BT_ASSERT_PRE(stream_id_is_unique(trace, stream_class, id),
 111                 "Duplicate stream ID: %![trace-]+t, id=%" PRIu64, trace, id);
 112         BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64,
 113                 trace, id);
 114         stream = g_new0(struct bt_stream, 1);
 115         if (!stream) {
 116                 BT_LOGE_STR("Failed to allocate one stream.");
 117                 goto error;
 118         }
 119
 120         bt_object_init_shared_with_parent(&stream->base, destroy_stream);
 121         stream->name.str = g_string_new(NULL);
 122         if (!stream->name.str) {
 123                 BT_LOGE_STR("Failed to allocate a GString.");
 124                 goto error;
 125         }
 126
 127         stream->id = id;
 128         ret = bt_object_pool_initialize(&stream->packet_pool,
 129                 (bt_object_pool_new_object_func) bt_packet_new,
 130                 (bt_object_pool_destroy_object_func) bt_stream_free_packet,
 131                 stream);
 132         if (ret) {
 133                 BT_LOGE("Failed to initialize packet pool: ret=%d", ret);
 134                 goto error;
 135         }
 136
 137         stream->class = stream_class;
 138         bt_object_get_no_null_check(stream_class);
 139
 140         /* bt_trace_add_stream() sets the parent trace, and freezes the trace */
 141         bt_trace_add_stream(trace, stream);
 142
 143         bt_stream_class_freeze(stream_class);
 144         BT_LIB_LOGD("Created stream object: %!+s", stream);
 145         goto end;
 146
 147 error:
 148         BT_OBJECT_PUT_REF_AND_RESET(stream);
 149
 150 end:
 151         return stream;
 152 }
 153
 154 struct bt_stream *bt_stream_create(struct bt_stream_class *stream_class,
 155                 struct bt_trace *trace)
 156 {
 157         uint64_t id;
 158
 159         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
 160         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 161         BT_ASSERT_PRE(stream_class->assigns_automatic_stream_id,
 162                 "Stream class does not automatically assigns stream IDs: "
 163                 "%![sc-]+S", stream_class);
 164         id = bt_trace_get_automatic_stream_id(trace, stream_class);
 165         return create_stream_with_id(stream_class, trace, id);
 166 }
 167
 168 struct bt_stream *bt_stream_create_with_id(struct bt_stream_class *stream_class,
 169                 struct bt_trace *trace, uint64_t id)
 170 {
 171         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
 172         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 173         BT_ASSERT_PRE(!stream_class->assigns_automatic_stream_id,
 174                 "Stream class automatically assigns stream IDs: "
 175                 "%![sc-]+S", stream_class);
 176         return create_stream_with_id(stream_class, trace, id);
 177 }
 178
 179 struct bt_stream_class *bt_stream_borrow_class(struct bt_stream *stream)
 180 {
 181         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 182         return stream->class;
 183 }
 184
 185 const struct bt_stream_class *bt_stream_borrow_class_const(
 186                 const struct bt_stream *stream)
 187 {
 188         return bt_stream_borrow_class((void *) stream);
 189 }
 190
 191 struct bt_trace *bt_stream_borrow_trace(struct bt_stream *stream)
 192 {
 193         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 194         return bt_stream_borrow_trace_inline(stream);
 195 }
 196
 197 const struct bt_trace *bt_stream_borrow_trace_const(
 198                 const struct bt_stream *stream)
 199 {
 200         return bt_stream_borrow_trace((void *) stream);
 201 }
 202
 203 const char *bt_stream_get_name(const struct bt_stream *stream)
 204 {
 205         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 206         return stream->name.value;
 207 }
 208
 209 enum bt_stream_status bt_stream_set_name(struct bt_stream *stream,
 210                 const char *name)
 211 {
 212         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 213         BT_ASSERT_PRE_NON_NULL(name, "Name");
 214         BT_ASSERT_PRE_STREAM_HOT(stream);
 215         g_string_assign(stream->name.str, name);
 216         stream->name.value = stream->name.str->str;
 217         BT_LIB_LOGD("Set stream's name: %!+s", stream);
 218         return BT_STREAM_STATUS_OK;
 219 }
 220
 221 uint64_t bt_stream_get_id(const struct bt_stream *stream)
 222 {
 223         BT_ASSERT_PRE_NON_NULL(stream, "Stream class");
 224         return stream->id;
 225 }
 226
 227 BT_HIDDEN
 228 void _bt_stream_freeze(const struct bt_stream *stream)
 229 {
 230         BT_ASSERT(stream);
 231         BT_LIB_LOGD("Freezing stream: %!+s", stream);
 232         ((struct bt_stream *) stream)->frozen = true;
 233 }
 234
 235 void bt_stream_get_ref(const struct bt_stream *stream)
 236 {
 237         bt_object_get_ref(stream);
 238 }
 239
 240 void bt_stream_put_ref(const struct bt_stream *stream)
 241 {
 242         bt_object_put_ref(stream);
 243 }