| 1 | /* |
| 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
| 3 | * Copyright 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 "TRACE" |
| 25 | #include <babeltrace/lib-logging-internal.h> |
| 26 | |
| 27 | #include <babeltrace/assert-pre-internal.h> |
| 28 | #include <babeltrace/trace-ir/trace.h> |
| 29 | #include <babeltrace/trace-ir/trace-class-internal.h> |
| 30 | #include <babeltrace/trace-ir/trace-const.h> |
| 31 | #include <babeltrace/trace-ir/trace-internal.h> |
| 32 | #include <babeltrace/trace-ir/clock-class-internal.h> |
| 33 | #include <babeltrace/trace-ir/stream-internal.h> |
| 34 | #include <babeltrace/trace-ir/stream-class-internal.h> |
| 35 | #include <babeltrace/trace-ir/event-internal.h> |
| 36 | #include <babeltrace/trace-ir/event-class.h> |
| 37 | #include <babeltrace/trace-ir/event-class-internal.h> |
| 38 | #include <babeltrace/ctf-writer/functor-internal.h> |
| 39 | #include <babeltrace/ctf-writer/clock-internal.h> |
| 40 | #include <babeltrace/trace-ir/field-wrapper-internal.h> |
| 41 | #include <babeltrace/trace-ir/field-class-internal.h> |
| 42 | #include <babeltrace/trace-ir/attributes-internal.h> |
| 43 | #include <babeltrace/trace-ir/utils-internal.h> |
| 44 | #include <babeltrace/trace-ir/resolve-field-path-internal.h> |
| 45 | #include <babeltrace/compiler-internal.h> |
| 46 | #include <babeltrace/value.h> |
| 47 | #include <babeltrace/value-const.h> |
| 48 | #include <babeltrace/value-internal.h> |
| 49 | #include <babeltrace/types.h> |
| 50 | #include <babeltrace/endian-internal.h> |
| 51 | #include <babeltrace/assert-internal.h> |
| 52 | #include <babeltrace/compat/glib-internal.h> |
| 53 | #include <inttypes.h> |
| 54 | #include <stdint.h> |
| 55 | #include <string.h> |
| 56 | #include <stdlib.h> |
| 57 | |
| 58 | struct bt_trace_is_static_listener_elem { |
| 59 | bt_trace_is_static_listener_func func; |
| 60 | bt_trace_listener_removed_func removed; |
| 61 | void *data; |
| 62 | }; |
| 63 | |
| 64 | #define BT_ASSERT_PRE_TRACE_HOT(_trace) \ |
| 65 | BT_ASSERT_PRE_HOT((_trace), "Trace", ": %!+t", (_trace)) |
| 66 | |
| 67 | static |
| 68 | void destroy_trace(struct bt_object *obj) |
| 69 | { |
| 70 | struct bt_trace *trace = (void *) obj; |
| 71 | |
| 72 | BT_LIB_LOGD("Destroying trace object: %!+t", trace); |
| 73 | |
| 74 | /* |
| 75 | * Call remove listeners first so that everything else still |
| 76 | * exists in the trace. |
| 77 | */ |
| 78 | if (trace->is_static_listeners) { |
| 79 | size_t i; |
| 80 | |
| 81 | for (i = 0; i < trace->is_static_listeners->len; i++) { |
| 82 | struct bt_trace_is_static_listener_elem elem = |
| 83 | g_array_index(trace->is_static_listeners, |
| 84 | struct bt_trace_is_static_listener_elem, i); |
| 85 | |
| 86 | if (elem.removed) { |
| 87 | elem.removed((void *) trace, elem.data); |
| 88 | } |
| 89 | } |
| 90 | |
| 91 | g_array_free(trace->is_static_listeners, TRUE); |
| 92 | trace->is_static_listeners = NULL; |
| 93 | } |
| 94 | |
| 95 | if (trace->name.str) { |
| 96 | g_string_free(trace->name.str, TRUE); |
| 97 | trace->name.str = NULL; |
| 98 | trace->name.value = NULL; |
| 99 | } |
| 100 | |
| 101 | if (trace->streams) { |
| 102 | BT_LOGD_STR("Destroying streams."); |
| 103 | g_ptr_array_free(trace->streams, TRUE); |
| 104 | trace->streams = NULL; |
| 105 | } |
| 106 | |
| 107 | if (trace->stream_classes_stream_count) { |
| 108 | g_hash_table_destroy(trace->stream_classes_stream_count); |
| 109 | trace->stream_classes_stream_count = NULL; |
| 110 | } |
| 111 | |
| 112 | BT_LOGD_STR("Putting trace's class."); |
| 113 | bt_object_put_ref(trace->class); |
| 114 | trace->class = NULL; |
| 115 | g_free(trace); |
| 116 | } |
| 117 | |
| 118 | struct bt_trace *bt_trace_create(struct bt_trace_class *tc) |
| 119 | { |
| 120 | struct bt_trace *trace = NULL; |
| 121 | |
| 122 | BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc); |
| 123 | trace = g_new0(struct bt_trace, 1); |
| 124 | if (!trace) { |
| 125 | BT_LOGE_STR("Failed to allocate one trace."); |
| 126 | goto error; |
| 127 | } |
| 128 | |
| 129 | bt_object_init_shared(&trace->base, destroy_trace); |
| 130 | trace->streams = g_ptr_array_new_with_free_func( |
| 131 | (GDestroyNotify) bt_object_try_spec_release); |
| 132 | if (!trace->streams) { |
| 133 | BT_LOGE_STR("Failed to allocate one GPtrArray."); |
| 134 | goto error; |
| 135 | } |
| 136 | |
| 137 | trace->stream_classes_stream_count = g_hash_table_new(g_direct_hash, |
| 138 | g_direct_equal); |
| 139 | if (!trace->stream_classes_stream_count) { |
| 140 | BT_LOGE_STR("Failed to allocate one GHashTable."); |
| 141 | goto error; |
| 142 | } |
| 143 | |
| 144 | trace->name.str = g_string_new(NULL); |
| 145 | if (!trace->name.str) { |
| 146 | BT_LOGE_STR("Failed to allocate one GString."); |
| 147 | goto error; |
| 148 | } |
| 149 | |
| 150 | trace->is_static_listeners = g_array_new(FALSE, TRUE, |
| 151 | sizeof(struct bt_trace_is_static_listener_elem)); |
| 152 | if (!trace->is_static_listeners) { |
| 153 | BT_LOGE_STR("Failed to allocate one GArray."); |
| 154 | goto error; |
| 155 | } |
| 156 | |
| 157 | trace->class = tc; |
| 158 | bt_object_get_no_null_check(trace->class); |
| 159 | BT_LIB_LOGD("Created trace object: %!+t", trace); |
| 160 | goto end; |
| 161 | |
| 162 | error: |
| 163 | BT_OBJECT_PUT_REF_AND_RESET(trace); |
| 164 | |
| 165 | end: |
| 166 | return trace; |
| 167 | } |
| 168 | |
| 169 | const char *bt_trace_get_name(const struct bt_trace *trace) |
| 170 | { |
| 171 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 172 | return trace->name.value; |
| 173 | } |
| 174 | |
| 175 | enum bt_trace_status bt_trace_set_name(struct bt_trace *trace, const char *name) |
| 176 | { |
| 177 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 178 | BT_ASSERT_PRE_NON_NULL(name, "Name"); |
| 179 | BT_ASSERT_PRE_TRACE_HOT(trace); |
| 180 | g_string_assign(trace->name.str, name); |
| 181 | trace->name.value = trace->name.str->str; |
| 182 | BT_LIB_LOGV("Set trace's name: %!+t", trace); |
| 183 | return BT_TRACE_STATUS_OK; |
| 184 | } |
| 185 | |
| 186 | uint64_t bt_trace_get_stream_count(const struct bt_trace *trace) |
| 187 | { |
| 188 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 189 | return (uint64_t) trace->streams->len; |
| 190 | } |
| 191 | |
| 192 | struct bt_stream *bt_trace_borrow_stream_by_index( |
| 193 | struct bt_trace *trace, uint64_t index) |
| 194 | { |
| 195 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 196 | BT_ASSERT_PRE_VALID_INDEX(index, trace->streams->len); |
| 197 | return g_ptr_array_index(trace->streams, index); |
| 198 | } |
| 199 | |
| 200 | const struct bt_stream *bt_trace_borrow_stream_by_index_const( |
| 201 | const struct bt_trace *trace, uint64_t index) |
| 202 | { |
| 203 | return bt_trace_borrow_stream_by_index((void *) trace, index); |
| 204 | } |
| 205 | |
| 206 | struct bt_stream *bt_trace_borrow_stream_by_id(struct bt_trace *trace, |
| 207 | uint64_t id) |
| 208 | { |
| 209 | struct bt_stream *stream = NULL; |
| 210 | uint64_t i; |
| 211 | |
| 212 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 213 | |
| 214 | for (i = 0; i < trace->streams->len; i++) { |
| 215 | struct bt_stream *stream_candidate = |
| 216 | g_ptr_array_index(trace->streams, i); |
| 217 | |
| 218 | if (stream_candidate->id == id) { |
| 219 | stream = stream_candidate; |
| 220 | goto end; |
| 221 | } |
| 222 | } |
| 223 | |
| 224 | end: |
| 225 | return stream; |
| 226 | } |
| 227 | |
| 228 | const struct bt_stream *bt_trace_borrow_stream_by_id_const( |
| 229 | const struct bt_trace *trace, uint64_t id) |
| 230 | { |
| 231 | return bt_trace_borrow_stream_by_id((void *) trace, id); |
| 232 | } |
| 233 | |
| 234 | bt_bool bt_trace_is_static(const struct bt_trace *trace) |
| 235 | { |
| 236 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 237 | return (bt_bool) trace->is_static; |
| 238 | } |
| 239 | |
| 240 | enum bt_trace_status bt_trace_make_static(struct bt_trace *trace) |
| 241 | { uint64_t i; |
| 242 | |
| 243 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 244 | trace->is_static = true; |
| 245 | bt_trace_freeze(trace); |
| 246 | BT_LIB_LOGV("Trace is now static: %!+t", trace); |
| 247 | |
| 248 | /* Call all the "trace is static" listeners */ |
| 249 | for (i = 0; i < trace->is_static_listeners->len; i++) { |
| 250 | struct bt_trace_is_static_listener_elem elem = |
| 251 | g_array_index(trace->is_static_listeners, |
| 252 | struct bt_trace_is_static_listener_elem, i); |
| 253 | |
| 254 | if (elem.func) { |
| 255 | elem.func((void *) trace, elem.data); |
| 256 | } |
| 257 | } |
| 258 | |
| 259 | return BT_TRACE_STATUS_OK; |
| 260 | } |
| 261 | |
| 262 | enum bt_trace_status bt_trace_add_is_static_listener( |
| 263 | const struct bt_trace *c_trace, |
| 264 | bt_trace_is_static_listener_func listener, |
| 265 | bt_trace_listener_removed_func listener_removed, void *data, |
| 266 | uint64_t *listener_id) |
| 267 | { |
| 268 | struct bt_trace *trace = (void *) c_trace; |
| 269 | uint64_t i; |
| 270 | struct bt_trace_is_static_listener_elem new_elem = { |
| 271 | .func = listener, |
| 272 | .removed = listener_removed, |
| 273 | .data = data, |
| 274 | }; |
| 275 | |
| 276 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 277 | BT_ASSERT_PRE_NON_NULL(listener, "Listener"); |
| 278 | BT_ASSERT_PRE(!trace->is_static, |
| 279 | "Trace is already static: %!+t", trace); |
| 280 | BT_ASSERT_PRE(trace->in_remove_listener, |
| 281 | "Cannot call this function while executing a " |
| 282 | "remove listener: %!+t", trace); |
| 283 | |
| 284 | /* Find the next available spot */ |
| 285 | for (i = 0; i < trace->is_static_listeners->len; i++) { |
| 286 | struct bt_trace_is_static_listener_elem elem = |
| 287 | g_array_index(trace->is_static_listeners, |
| 288 | struct bt_trace_is_static_listener_elem, i); |
| 289 | |
| 290 | if (!elem.func) { |
| 291 | break; |
| 292 | } |
| 293 | } |
| 294 | |
| 295 | if (i == trace->is_static_listeners->len) { |
| 296 | g_array_append_val(trace->is_static_listeners, new_elem); |
| 297 | } else { |
| 298 | g_array_insert_val(trace->is_static_listeners, i, new_elem); |
| 299 | } |
| 300 | |
| 301 | if (listener_id) { |
| 302 | *listener_id = i; |
| 303 | } |
| 304 | |
| 305 | BT_LIB_LOGV("Added \"trace is static\" listener: " |
| 306 | "%![trace-]+t, listener-id=%" PRIu64, trace, i); |
| 307 | return BT_TRACE_STATUS_OK; |
| 308 | } |
| 309 | |
| 310 | BT_ASSERT_PRE_FUNC |
| 311 | static |
| 312 | bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id) |
| 313 | { |
| 314 | BT_ASSERT(listener_id < trace->is_static_listeners->len); |
| 315 | return (&g_array_index(trace->is_static_listeners, |
| 316 | struct bt_trace_is_static_listener_elem, |
| 317 | listener_id))->func != NULL; |
| 318 | } |
| 319 | |
| 320 | enum bt_trace_status bt_trace_remove_is_static_listener( |
| 321 | const struct bt_trace *c_trace, uint64_t listener_id) |
| 322 | { |
| 323 | struct bt_trace *trace = (void *) c_trace; |
| 324 | struct bt_trace_is_static_listener_elem *elem; |
| 325 | |
| 326 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 327 | BT_ASSERT_PRE(!trace->is_static, |
| 328 | "Trace is already static: %!+t", trace); |
| 329 | BT_ASSERT_PRE(trace->in_remove_listener, |
| 330 | "Cannot call this function while executing a " |
| 331 | "remove listener: %!+t", trace); |
| 332 | BT_ASSERT_PRE(has_listener_id(trace, listener_id), |
| 333 | "Trace has no such \"trace is static\" listener ID: " |
| 334 | "%![trace-]+t, %" PRIu64, trace, listener_id); |
| 335 | elem = &g_array_index(trace->is_static_listeners, |
| 336 | struct bt_trace_is_static_listener_elem, |
| 337 | listener_id); |
| 338 | BT_ASSERT(elem->func); |
| 339 | |
| 340 | if (elem->removed) { |
| 341 | /* Call remove listener */ |
| 342 | BT_LIB_LOGV("Calling remove listener: " |
| 343 | "%![trace-]+t, listener-id=%" PRIu64, |
| 344 | trace, listener_id); |
| 345 | trace->in_remove_listener = true; |
| 346 | elem->removed((void *) trace, elem->data); |
| 347 | trace->in_remove_listener = false; |
| 348 | } |
| 349 | |
| 350 | elem->func = NULL; |
| 351 | elem->removed = NULL; |
| 352 | elem->data = NULL; |
| 353 | BT_LIB_LOGV("Removed \"trace is static\" listener: " |
| 354 | "%![trace-]+t, listener-id=%" PRIu64, |
| 355 | trace, listener_id); |
| 356 | return BT_TRACE_STATUS_OK; |
| 357 | } |
| 358 | |
| 359 | BT_HIDDEN |
| 360 | void _bt_trace_freeze(const struct bt_trace *trace) |
| 361 | { |
| 362 | BT_ASSERT(trace); |
| 363 | BT_LIB_LOGD("Freezing trace's class: %!+T", trace->class); |
| 364 | bt_trace_class_freeze(trace->class); |
| 365 | BT_LIB_LOGD("Freezing trace: %!+t", trace); |
| 366 | ((struct bt_trace *) trace)->frozen = true; |
| 367 | } |
| 368 | |
| 369 | BT_HIDDEN |
| 370 | void bt_trace_add_stream(struct bt_trace *trace, struct bt_stream *stream) |
| 371 | { |
| 372 | guint count = 0; |
| 373 | |
| 374 | bt_object_set_parent(&stream->base, &trace->base); |
| 375 | g_ptr_array_add(trace->streams, stream); |
| 376 | bt_trace_freeze(trace); |
| 377 | |
| 378 | if (bt_g_hash_table_contains(trace->stream_classes_stream_count, |
| 379 | stream->class)) { |
| 380 | count = GPOINTER_TO_UINT(g_hash_table_lookup( |
| 381 | trace->stream_classes_stream_count, stream->class)); |
| 382 | } |
| 383 | |
| 384 | g_hash_table_insert(trace->stream_classes_stream_count, |
| 385 | stream->class, GUINT_TO_POINTER(count + 1)); |
| 386 | } |
| 387 | |
| 388 | BT_HIDDEN |
| 389 | uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace, |
| 390 | const struct bt_stream_class *stream_class) |
| 391 | { |
| 392 | gpointer orig_key; |
| 393 | gpointer value; |
| 394 | uint64_t id = 0; |
| 395 | |
| 396 | BT_ASSERT(stream_class); |
| 397 | BT_ASSERT(trace); |
| 398 | if (g_hash_table_lookup_extended(trace->stream_classes_stream_count, |
| 399 | stream_class, &orig_key, &value)) { |
| 400 | id = (uint64_t) GPOINTER_TO_UINT(value); |
| 401 | } |
| 402 | |
| 403 | return id; |
| 404 | } |
| 405 | |
| 406 | struct bt_trace_class *bt_trace_borrow_class(struct bt_trace *trace) |
| 407 | { |
| 408 | BT_ASSERT_PRE_NON_NULL(trace, "Trace"); |
| 409 | return trace->class; |
| 410 | } |
| 411 | |
| 412 | const struct bt_trace_class *bt_trace_borrow_class_const( |
| 413 | const struct bt_trace *trace) |
| 414 | { |
| 415 | return bt_trace_borrow_class((void *) trace); |
| 416 | } |
| 417 | |
| 418 | void bt_trace_get_ref(const struct bt_trace *trace) |
| 419 | { |
| 420 | bt_object_get_ref(trace); |
| 421 | } |
| 422 | |
| 423 | void bt_trace_put_ref(const struct bt_trace *trace) |
| 424 | { |
| 425 | bt_object_put_ref(trace); |
| 426 | } |