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