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