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.h>
  29 #include <babeltrace2/trace-ir/stream-class.h>
  30 #include <babeltrace2/trace-ir/trace.h>
  31 #include "compat/compiler.h"
  32 #include "common/align.h"
  33 #include "common/assert.h"
  34 #include "lib/property.h"
  35 #include <inttypes.h>
  36 #include <stdbool.h>
  37 #include <unistd.h>
  38
  39 #include "packet.h"
  40 #include "stream-class.h"
  41 #include "stream.h"
  42 #include "trace.h"
  43 #include "lib/value.h"
  44 #include "lib/func-status.h"
  45
  46 #define BT_ASSERT_PRE_DEV_STREAM_HOT(_stream) \
  47         BT_ASSERT_PRE_DEV_HOT((_stream), "Stream", ": %!+s", (_stream))
  48
  49 static
  50 void destroy_stream(struct bt_object *obj)
  51 {
  52         struct bt_stream *stream = (void *) obj;
  53
  54         BT_LIB_LOGD("Destroying stream object: %!+s", stream);
  55         BT_OBJECT_PUT_REF_AND_RESET(stream->user_attributes);
  56
  57         if (stream->name.str) {
  58                 g_string_free(stream->name.str, TRUE);
  59                 stream->name.str = NULL;
  60                 stream->name.value = NULL;
  61         }
  62
  63         BT_LOGD_STR("Putting stream's class.");
  64         bt_object_put_ref(stream->class);
  65         bt_object_pool_finalize(&stream->packet_pool);
  66         g_free(stream);
  67 }
  68
  69 static
  70 void bt_stream_free_packet(struct bt_packet *packet, struct bt_stream *stream)
  71 {
  72         bt_packet_destroy(packet);
  73 }
  74
  75 static inline
  76 bool stream_id_is_unique(struct bt_trace *trace,
  77                 struct bt_stream_class *stream_class, uint64_t id)
  78 {
  79         uint64_t i;
  80         bool is_unique = true;
  81
  82         for (i = 0; i < trace->streams->len; i++) {
  83                 struct bt_stream *stream = trace->streams->pdata[i];
  84
  85                 if (stream->class != stream_class) {
  86                         continue;
  87                 }
  88
  89                 if (stream->id == id) {
  90                         is_unique = false;
  91                         goto end;
  92                 }
  93         }
  94
  95 end:
  96         return is_unique;
  97 }
  98
  99 static
 100 struct bt_stream *create_stream_with_id(struct bt_stream_class *stream_class,
 101                 struct bt_trace *trace, uint64_t id)
 102 {
 103         int ret;
 104         struct bt_stream *stream;
 105
 106         BT_ASSERT(stream_class);
 107         BT_ASSERT(trace);
 108         BT_ASSERT_PRE(trace->class ==
 109                 bt_stream_class_borrow_trace_class_inline(stream_class),
 110                 "Trace's class is different from stream class's parent trace class: "
 111                 "%![sc-]+S, %![trace-]+t", stream_class, trace);
 112         BT_ASSERT_PRE(stream_id_is_unique(trace, stream_class, id),
 113                 "Duplicate stream ID: %![trace-]+t, id=%" PRIu64, trace, id);
 114         BT_LIB_LOGD("Creating stream object: %![trace-]+t, id=%" PRIu64,
 115                 trace, id);
 116         stream = g_new0(struct bt_stream, 1);
 117         if (!stream) {
 118                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one stream.");
 119                 goto error;
 120         }
 121
 122         bt_object_init_shared_with_parent(&stream->base, destroy_stream);
 123         stream->user_attributes = bt_value_map_create();
 124         if (!stream->user_attributes) {
 125                 BT_LIB_LOGE_APPEND_CAUSE(
 126                         "Failed to create a map value object.");
 127                 goto error;
 128         }
 129
 130         stream->name.str = g_string_new(NULL);
 131         if (!stream->name.str) {
 132                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
 133                 goto error;
 134         }
 135
 136         stream->id = id;
 137         ret = bt_object_pool_initialize(&stream->packet_pool,
 138                 (bt_object_pool_new_object_func) bt_packet_new,
 139                 (bt_object_pool_destroy_object_func) bt_stream_free_packet,
 140                 stream);
 141         if (ret) {
 142                 BT_LIB_LOGE_APPEND_CAUSE(
 143                         "Failed to initialize packet pool: ret=%d", ret);
 144                 goto error;
 145         }
 146
 147         stream->class = stream_class;
 148         bt_object_get_ref_no_null_check(stream_class);
 149
 150         /* bt_trace_add_stream() sets the parent trace, and freezes the trace */
 151         bt_trace_add_stream(trace, stream);
 152
 153         bt_stream_class_freeze(stream_class);
 154         BT_LIB_LOGD("Created stream object: %!+s", stream);
 155         goto end;
 156
 157 error:
 158         BT_OBJECT_PUT_REF_AND_RESET(stream);
 159
 160 end:
 161         return stream;
 162 }
 163
 164 struct bt_stream *bt_stream_create(struct bt_stream_class *stream_class,
 165                 struct bt_trace *trace)
 166 {
 167         uint64_t id;
 168
 169         BT_ASSERT_PRE_NO_ERROR();
 170         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
 171         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 172         BT_ASSERT_PRE(stream_class->assigns_automatic_stream_id,
 173                 "Stream class does not automatically assigns stream IDs: "
 174                 "%![sc-]+S", stream_class);
 175         id = bt_trace_get_automatic_stream_id(trace, stream_class);
 176         return create_stream_with_id(stream_class, trace, id);
 177 }
 178
 179 struct bt_stream *bt_stream_create_with_id(struct bt_stream_class *stream_class,
 180                 struct bt_trace *trace, uint64_t id)
 181 {
 182         BT_ASSERT_PRE_NO_ERROR();
 183         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
 184         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 185         BT_ASSERT_PRE(!stream_class->assigns_automatic_stream_id,
 186                 "Stream class automatically assigns stream IDs: "
 187                 "%![sc-]+S", stream_class);
 188         return create_stream_with_id(stream_class, trace, id);
 189 }
 190
 191 struct bt_stream_class *bt_stream_borrow_class(struct bt_stream *stream)
 192 {
 193         BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream");
 194         return stream->class;
 195 }
 196
 197 const struct bt_stream_class *bt_stream_borrow_class_const(
 198                 const struct bt_stream *stream)
 199 {
 200         return bt_stream_borrow_class((void *) stream);
 201 }
 202
 203 struct bt_trace *bt_stream_borrow_trace(struct bt_stream *stream)
 204 {
 205         BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream");
 206         return bt_stream_borrow_trace_inline(stream);
 207 }
 208
 209 const struct bt_trace *bt_stream_borrow_trace_const(
 210                 const struct bt_stream *stream)
 211 {
 212         return bt_stream_borrow_trace((void *) stream);
 213 }
 214
 215 const char *bt_stream_get_name(const struct bt_stream *stream)
 216 {
 217         BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream");
 218         return stream->name.value;
 219 }
 220
 221 enum bt_stream_set_name_status bt_stream_set_name(struct bt_stream *stream,
 222                 const char *name)
 223 {
 224         BT_ASSERT_PRE_NO_ERROR();
 225         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 226         BT_ASSERT_PRE_NON_NULL(name, "Name");
 227         BT_ASSERT_PRE_DEV_STREAM_HOT(stream);
 228         g_string_assign(stream->name.str, name);
 229         stream->name.value = stream->name.str->str;
 230         BT_LIB_LOGD("Set stream's name: %!+s", stream);
 231         return BT_FUNC_STATUS_OK;
 232 }
 233
 234 uint64_t bt_stream_get_id(const struct bt_stream *stream)
 235 {
 236         BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream class");
 237         return stream->id;
 238 }
 239
 240 BT_HIDDEN
 241 void _bt_stream_freeze(const struct bt_stream *stream)
 242 {
 243         BT_ASSERT(stream);
 244         BT_LIB_LOGD("Freezing stream's user attributes: %!+v",
 245                 stream->user_attributes);
 246         bt_value_freeze(stream->user_attributes);
 247         BT_LIB_LOGD("Freezing stream: %!+s", stream);
 248         ((struct bt_stream *) stream)->frozen = true;
 249 }
 250
 251 const struct bt_value *bt_stream_borrow_user_attributes_const(
 252                 const struct bt_stream *stream)
 253 {
 254         BT_ASSERT_PRE_DEV_NON_NULL(stream, "Stream");
 255         return stream->user_attributes;
 256 }
 257
 258 struct bt_value *bt_stream_borrow_user_attributes(struct bt_stream *stream)
 259 {
 260         return (void *) bt_stream_borrow_user_attributes_const((void *) stream);
 261 }
 262
 263 void bt_stream_set_user_attributes(struct bt_stream *stream,
 264                 const struct bt_value *user_attributes)
 265 {
 266         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 267         BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
 268         BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
 269                 "User attributes object is not a map value object.");
 270         BT_ASSERT_PRE_DEV_STREAM_HOT(stream);
 271         bt_object_put_ref_no_null_check(stream->user_attributes);
 272         stream->user_attributes = (void *) user_attributes;
 273         bt_object_get_ref_no_null_check(stream->user_attributes);
 274 }
 275
 276 void bt_stream_get_ref(const struct bt_stream *stream)
 277 {
 278         bt_object_get_ref(stream);
 279 }
 280
 281 void bt_stream_put_ref(const struct bt_stream *stream)
 282 {
 283         bt_object_put_ref(stream);
 284 }