src/lib/trace-ir/trace.c

   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 "LIB/TRACE"
  25 #include "lib/logging.h"
  26
  27 #include "lib/assert-pre.h"
  28 #include "lib/assert-post.h"
  29 #include <babeltrace2/trace-ir/trace.h>
  30 #include <babeltrace2/trace-ir/trace-const.h>
  31 #include <babeltrace2/trace-ir/event-class.h>
  32 #include "ctf-writer/functor.h"
  33 #include "ctf-writer/clock.h"
  34 #include "compat/compiler.h"
  35 #include <babeltrace2/value.h>
  36 #include <babeltrace2/value-const.h>
  37 #include "lib/value.h"
  38 #include <babeltrace2/types.h>
  39 #include "compat/endian.h"
  40 #include "common/assert.h"
  41 #include "compat/glib.h"
  42 #include <inttypes.h>
  43 #include <stdint.h>
  44 #include <string.h>
  45 #include <stdbool.h>
  46 #include <stdlib.h>
  47
  48 #include "attributes.h"
  49 #include "clock-class.h"
  50 #include "event-class.h"
  51 #include "event.h"
  52 #include "field-class.h"
  53 #include "field-wrapper.h"
  54 #include "resolve-field-path.h"
  55 #include "stream-class.h"
  56 #include "stream.h"
  57 #include "trace-class.h"
  58 #include "trace.h"
  59 #include "utils.h"
  60 #include "lib/value.h"
  61 #include "lib/func-status.h"
  62
  63 struct bt_trace_destruction_listener_elem {
  64         bt_trace_destruction_listener_func func;
  65         void *data;
  66 };
  67
  68 #define BT_ASSERT_PRE_DEV_TRACE_HOT(_trace) \
  69         BT_ASSERT_PRE_DEV_HOT((_trace), "Trace", ": %!+t", (_trace))
  70
  71 static
  72 void destroy_trace(struct bt_object *obj)
  73 {
  74         struct bt_trace *trace = (void *) obj;
  75
  76         BT_LIB_LOGD("Destroying trace object: %!+t", trace);
  77         BT_OBJECT_PUT_REF_AND_RESET(trace->user_attributes);
  78
  79         /*
  80          * Call destruction listener functions so that everything else
  81          * still exists in the trace.
  82          */
  83         if (trace->destruction_listeners) {
  84                 uint64_t i;
  85                 const struct bt_error *saved_error;
  86
  87                 BT_LIB_LOGD("Calling trace destruction listener(s): %!+t", trace);
  88
  89                 /*
  90                 * The trace's reference count is 0 if we're here. Increment
  91                 * it to avoid a double-destroy (possibly infinitely recursive).
  92                 * This could happen for example if a destruction listener did
  93                 * bt_object_get_ref() (or anything that causes
  94                 * bt_object_get_ref() to be called) on the trace (ref.
  95                 * count goes from 0 to 1), and then bt_object_put_ref(): the
  96                 * reference count would go from 1 to 0 again and this function
  97                 * would be called again.
  98                 */
  99                 trace->base.ref_count++;
 100
 101                 saved_error = bt_current_thread_take_error();
 102
 103                 /* Call all the trace destruction listeners */
 104                 for (i = 0; i < trace->destruction_listeners->len; i++) {
 105                         struct bt_trace_destruction_listener_elem elem =
 106                                 g_array_index(trace->destruction_listeners,
 107                                                 struct bt_trace_destruction_listener_elem, i);
 108
 109                         if (elem.func) {
 110                                 elem.func(trace, elem.data);
 111                                 BT_ASSERT_POST_NO_ERROR();
 112                         }
 113
 114                         /*
 115                          * The destruction listener should not have kept a
 116                          * reference to the trace.
 117                          */
 118                         BT_ASSERT_POST(trace->base.ref_count == 1, "Destruction listener kept a reference to the trace being destroyed: %![trace-]+t", trace);
 119                 }
 120                 g_array_free(trace->destruction_listeners, TRUE);
 121                 trace->destruction_listeners = NULL;
 122
 123                 if (saved_error) {
 124                         BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error);
 125                 }
 126         }
 127
 128         if (trace->name.str) {
 129                 g_string_free(trace->name.str, TRUE);
 130                 trace->name.str = NULL;
 131                 trace->name.value = NULL;
 132         }
 133
 134         if (trace->environment) {
 135                 BT_LOGD_STR("Destroying environment attributes.");
 136                 bt_attributes_destroy(trace->environment);
 137                 trace->environment = NULL;
 138         }
 139
 140         if (trace->streams) {
 141                 BT_LOGD_STR("Destroying streams.");
 142                 g_ptr_array_free(trace->streams, TRUE);
 143                 trace->streams = NULL;
 144         }
 145
 146         if (trace->stream_classes_stream_count) {
 147                 g_hash_table_destroy(trace->stream_classes_stream_count);
 148                 trace->stream_classes_stream_count = NULL;
 149         }
 150
 151         BT_LOGD_STR("Putting trace's class.");
 152         bt_object_put_ref(trace->class);
 153         trace->class = NULL;
 154         g_free(trace);
 155 }
 156
 157 struct bt_trace *bt_trace_create(struct bt_trace_class *tc)
 158 {
 159         struct bt_trace *trace = NULL;
 160
 161         BT_ASSERT_PRE_NO_ERROR();
 162
 163         BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc);
 164         trace = g_new0(struct bt_trace, 1);
 165         if (!trace) {
 166                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace.");
 167                 goto error;
 168         }
 169
 170         bt_object_init_shared(&trace->base, destroy_trace);
 171         trace->user_attributes = bt_value_map_create();
 172         if (!trace->user_attributes) {
 173                 BT_LIB_LOGE_APPEND_CAUSE(
 174                         "Failed to create a map value object.");
 175                 goto error;
 176         }
 177
 178         trace->streams = g_ptr_array_new_with_free_func(
 179                 (GDestroyNotify) bt_object_try_spec_release);
 180         if (!trace->streams) {
 181                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
 182                 goto error;
 183         }
 184
 185         trace->stream_classes_stream_count = g_hash_table_new(g_direct_hash,
 186                 g_direct_equal);
 187         if (!trace->stream_classes_stream_count) {
 188                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GHashTable.");
 189                 goto error;
 190         }
 191
 192         trace->name.str = g_string_new(NULL);
 193         if (!trace->name.str) {
 194                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
 195                 goto error;
 196         }
 197
 198         trace->environment = bt_attributes_create();
 199         if (!trace->environment) {
 200                 BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty attributes object.");
 201                 goto error;
 202         }
 203
 204         trace->destruction_listeners = g_array_new(FALSE, TRUE,
 205                 sizeof(struct bt_trace_destruction_listener_elem));
 206         if (!trace->destruction_listeners) {
 207                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
 208                 goto error;
 209         }
 210
 211         trace->class = tc;
 212         bt_object_get_ref_no_null_check(trace->class);
 213         BT_LIB_LOGD("Created trace object: %!+t", trace);
 214         goto end;
 215
 216 error:
 217         BT_OBJECT_PUT_REF_AND_RESET(trace);
 218
 219 end:
 220         return trace;
 221 }
 222
 223 const char *bt_trace_get_name(const struct bt_trace *trace)
 224 {
 225         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 226         return trace->name.value;
 227 }
 228
 229 enum bt_trace_set_name_status bt_trace_set_name(struct bt_trace *trace,
 230                 const char *name)
 231 {
 232         BT_ASSERT_PRE_NO_ERROR();
 233         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 234         BT_ASSERT_PRE_NON_NULL(name, "Name");
 235         BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
 236         g_string_assign(trace->name.str, name);
 237         trace->name.value = trace->name.str->str;
 238         BT_LIB_LOGD("Set trace's name: %!+t", trace);
 239         return BT_FUNC_STATUS_OK;
 240 }
 241
 242 bt_uuid bt_trace_get_uuid(const struct bt_trace *trace)
 243 {
 244         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 245         return trace->uuid.value;
 246 }
 247
 248 void bt_trace_set_uuid(struct bt_trace *trace, bt_uuid uuid)
 249 {
 250         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 251         BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
 252         BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
 253         bt_uuid_copy(trace->uuid.uuid, uuid);
 254         trace->uuid.value = trace->uuid.uuid;
 255         BT_LIB_LOGD("Set trace's UUID: %!+t", trace);
 256 }
 257
 258 static
 259 bool trace_has_environment_entry(const struct bt_trace *trace, const char *name)
 260 {
 261         BT_ASSERT(trace);
 262
 263         return bt_attributes_borrow_field_value_by_name(
 264                 trace->environment, name);
 265 }
 266
 267 static
 268 enum bt_trace_set_environment_entry_status set_environment_entry(
 269                 struct bt_trace *trace,
 270                 const char *name, struct bt_value *value)
 271 {
 272         int ret;
 273
 274         BT_ASSERT(trace);
 275         BT_ASSERT(name);
 276         BT_ASSERT(value);
 277         BT_ASSERT_PRE(!trace->frozen ||
 278                 !trace_has_environment_entry(trace, name),
 279                 "Trace is frozen: cannot replace environment entry: "
 280                 "%![trace-]+t, entry-name=\"%s\"", trace, name);
 281         ret = bt_attributes_set_field_value(trace->environment, name,
 282                 value);
 283         if (ret) {
 284                 ret = BT_FUNC_STATUS_MEMORY_ERROR;
 285                 BT_LIB_LOGE_APPEND_CAUSE(
 286                         "Cannot set trace's environment entry: "
 287                         "%![trace-]+t, entry-name=\"%s\"", trace, name);
 288         } else {
 289                 bt_value_freeze(value);
 290                 BT_LIB_LOGD("Set trace's environment entry: "
 291                         "%![trace-]+t, entry-name=\"%s\"", trace, name);
 292         }
 293
 294         return ret;
 295 }
 296
 297 enum bt_trace_set_environment_entry_status
 298 bt_trace_set_environment_entry_string(
 299                 struct bt_trace *trace, const char *name, const char *value)
 300 {
 301         int ret;
 302         struct bt_value *value_obj;
 303
 304         BT_ASSERT_PRE_NO_ERROR();
 305         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 306         BT_ASSERT_PRE_NON_NULL(name, "Name");
 307         BT_ASSERT_PRE_NON_NULL(value, "Value");
 308
 309         value_obj = bt_value_string_create_init(value);
 310         if (!value_obj) {
 311                 BT_LIB_LOGE_APPEND_CAUSE(
 312                         "Cannot create a string value object.");
 313                 ret = -1;
 314                 goto end;
 315         }
 316
 317         /* set_environment_entry() logs errors */
 318         ret = set_environment_entry(trace, name, value_obj);
 319
 320 end:
 321         bt_object_put_ref(value_obj);
 322         return ret;
 323 }
 324
 325 enum bt_trace_set_environment_entry_status
 326 bt_trace_set_environment_entry_integer(
 327                 struct bt_trace *trace, const char *name, int64_t value)
 328 {
 329         int ret;
 330         struct bt_value *value_obj;
 331
 332         BT_ASSERT_PRE_NO_ERROR();
 333         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 334         BT_ASSERT_PRE_NON_NULL(name, "Name");
 335
 336         value_obj = bt_value_integer_signed_create_init(value);
 337         if (!value_obj) {
 338                 BT_LIB_LOGE_APPEND_CAUSE(
 339                         "Cannot create an integer value object.");
 340                 ret = BT_FUNC_STATUS_MEMORY_ERROR;
 341                 goto end;
 342         }
 343
 344         /* set_environment_entry() logs errors */
 345         ret = set_environment_entry(trace, name, value_obj);
 346
 347 end:
 348         bt_object_put_ref(value_obj);
 349         return ret;
 350 }
 351
 352 uint64_t bt_trace_get_environment_entry_count(const struct bt_trace *trace)
 353 {
 354         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 355         return bt_attributes_get_count(trace->environment);
 356 }
 357
 358 void bt_trace_borrow_environment_entry_by_index_const(
 359                 const struct bt_trace *trace, uint64_t index,
 360                 const char **name, const struct bt_value **value)
 361 {
 362         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 363         BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
 364         BT_ASSERT_PRE_DEV_NON_NULL(value, "Value");
 365         BT_ASSERT_PRE_DEV_VALID_INDEX(index,
 366                 bt_attributes_get_count(trace->environment));
 367         *value = bt_attributes_borrow_field_value(trace->environment, index);
 368         BT_ASSERT(*value);
 369         *name = bt_attributes_get_field_name(trace->environment, index);
 370         BT_ASSERT(*name);
 371 }
 372
 373 const struct bt_value *bt_trace_borrow_environment_entry_value_by_name_const(
 374                 const struct bt_trace *trace, const char *name)
 375 {
 376         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 377         BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
 378         return bt_attributes_borrow_field_value_by_name(trace->environment,
 379                 name);
 380 }
 381
 382 uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
 383 {
 384         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 385         return (uint64_t) trace->streams->len;
 386 }
 387
 388 struct bt_stream *bt_trace_borrow_stream_by_index(
 389                 struct bt_trace *trace, uint64_t index)
 390 {
 391         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 392         BT_ASSERT_PRE_DEV_VALID_INDEX(index, trace->streams->len);
 393         return g_ptr_array_index(trace->streams, index);
 394 }
 395
 396 const struct bt_stream *bt_trace_borrow_stream_by_index_const(
 397                 const struct bt_trace *trace, uint64_t index)
 398 {
 399         return bt_trace_borrow_stream_by_index((void *) trace, index);
 400 }
 401
 402 struct bt_stream *bt_trace_borrow_stream_by_id(struct bt_trace *trace,
 403                 uint64_t id)
 404 {
 405         struct bt_stream *stream = NULL;
 406         uint64_t i;
 407
 408         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 409
 410         for (i = 0; i < trace->streams->len; i++) {
 411                 struct bt_stream *stream_candidate =
 412                         g_ptr_array_index(trace->streams, i);
 413
 414                 if (stream_candidate->id == id) {
 415                         stream = stream_candidate;
 416                         goto end;
 417                 }
 418         }
 419
 420 end:
 421         return stream;
 422 }
 423
 424 const struct bt_stream *bt_trace_borrow_stream_by_id_const(
 425                 const struct bt_trace *trace, uint64_t id)
 426 {
 427         return bt_trace_borrow_stream_by_id((void *) trace, id);
 428 }
 429
 430 enum bt_trace_add_listener_status bt_trace_add_destruction_listener(
 431                 const struct bt_trace *c_trace,
 432                 bt_trace_destruction_listener_func listener,
 433                 void *data, bt_listener_id *listener_id)
 434 {
 435         struct bt_trace *trace = (void *) c_trace;
 436         uint64_t i;
 437         struct bt_trace_destruction_listener_elem new_elem = {
 438                 .func = listener,
 439                 .data = data,
 440         };
 441
 442         BT_ASSERT_PRE_NO_ERROR();
 443         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 444         BT_ASSERT_PRE_NON_NULL(listener, "Listener");
 445
 446         /* Find the next available spot */
 447         for (i = 0; i < trace->destruction_listeners->len; i++) {
 448                 struct bt_trace_destruction_listener_elem elem =
 449                         g_array_index(trace->destruction_listeners,
 450                                 struct bt_trace_destruction_listener_elem, i);
 451
 452                 if (!elem.func) {
 453                         break;
 454                 }
 455         }
 456
 457         if (i == trace->destruction_listeners->len) {
 458                 g_array_append_val(trace->destruction_listeners, new_elem);
 459         } else {
 460                 g_array_insert_val(trace->destruction_listeners, i, new_elem);
 461         }
 462
 463         if (listener_id) {
 464                 *listener_id = i;
 465         }
 466
 467         BT_LIB_LOGD("Added destruction listener: " "%![trace-]+t, "
 468                         "listener-id=%" PRIu64, trace, i);
 469         return BT_FUNC_STATUS_OK;
 470 }
 471
 472 static
 473 bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id)
 474 {
 475         BT_ASSERT(listener_id < trace->destruction_listeners->len);
 476         return (&g_array_index(trace->destruction_listeners,
 477                         struct bt_trace_destruction_listener_elem,
 478                         listener_id))->func;
 479 }
 480
 481 enum bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
 482                 const struct bt_trace *c_trace, bt_listener_id listener_id)
 483 {
 484         struct bt_trace *trace = (void *) c_trace;
 485         struct bt_trace_destruction_listener_elem *elem;
 486
 487         BT_ASSERT_PRE_NO_ERROR();
 488         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 489         BT_ASSERT_PRE(has_listener_id(trace, listener_id),
 490                 "Trace has no such trace destruction listener ID: "
 491                 "%![trace-]+t, %" PRIu64, trace, listener_id);
 492         elem = &g_array_index(trace->destruction_listeners,
 493                         struct bt_trace_destruction_listener_elem,
 494                         listener_id);
 495         BT_ASSERT(elem->func);
 496
 497         elem->func = NULL;
 498         elem->data = NULL;
 499         BT_LIB_LOGD("Removed \"trace destruction listener: "
 500                 "%![trace-]+t, listener-id=%" PRIu64,
 501                 trace, listener_id);
 502         return BT_FUNC_STATUS_OK;
 503 }
 504
 505 BT_HIDDEN
 506 void _bt_trace_freeze(const struct bt_trace *trace)
 507 {
 508         BT_ASSERT(trace);
 509         BT_LIB_LOGD("Freezing trace's class: %!+T", trace->class);
 510         bt_trace_class_freeze(trace->class);
 511         BT_LIB_LOGD("Freezing trace's user attributes: %!+v",
 512                 trace->user_attributes);
 513         bt_value_freeze(trace->user_attributes);
 514         BT_LIB_LOGD("Freezing trace: %!+t", trace);
 515         ((struct bt_trace *) trace)->frozen = true;
 516 }
 517
 518 BT_HIDDEN
 519 void bt_trace_add_stream(struct bt_trace *trace, struct bt_stream *stream)
 520 {
 521         guint count = 0;
 522
 523         bt_object_set_parent(&stream->base, &trace->base);
 524         g_ptr_array_add(trace->streams, stream);
 525         bt_trace_freeze(trace);
 526
 527         if (bt_g_hash_table_contains(trace->stream_classes_stream_count,
 528                         stream->class)) {
 529                 count = GPOINTER_TO_UINT(g_hash_table_lookup(
 530                         trace->stream_classes_stream_count, stream->class));
 531         }
 532
 533         g_hash_table_insert(trace->stream_classes_stream_count,
 534                 stream->class, GUINT_TO_POINTER(count + 1));
 535 }
 536
 537 BT_HIDDEN
 538 uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
 539                 const struct bt_stream_class *stream_class)
 540 {
 541         gpointer orig_key;
 542         gpointer value;
 543         uint64_t id = 0;
 544
 545         BT_ASSERT(stream_class);
 546         BT_ASSERT(trace);
 547         if (g_hash_table_lookup_extended(trace->stream_classes_stream_count,
 548                         stream_class, &orig_key, &value)) {
 549                 id = (uint64_t) GPOINTER_TO_UINT(value);
 550         }
 551
 552         return id;
 553 }
 554
 555 struct bt_trace_class *bt_trace_borrow_class(struct bt_trace *trace)
 556 {
 557         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 558         return trace->class;
 559 }
 560
 561 const struct bt_trace_class *bt_trace_borrow_class_const(
 562                 const struct bt_trace *trace)
 563 {
 564         return bt_trace_borrow_class((void *) trace);
 565 }
 566
 567 const struct bt_value *bt_trace_borrow_user_attributes_const(
 568                 const struct bt_trace *trace)
 569 {
 570         BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 571         return trace->user_attributes;
 572 }
 573
 574 struct bt_value *bt_trace_borrow_user_attributes(struct bt_trace *trace)
 575 {
 576         return (void *) bt_trace_borrow_user_attributes_const((void *) trace);
 577 }
 578
 579 void bt_trace_set_user_attributes(
 580                 struct bt_trace *trace,
 581                 const struct bt_value *user_attributes)
 582 {
 583         BT_ASSERT_PRE_NON_NULL(trace, "Trace");
 584         BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
 585         BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
 586                 "User attributes object is not a map value object.");
 587         BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
 588         bt_object_put_ref_no_null_check(trace->user_attributes);
 589         trace->user_attributes = (void *) user_attributes;
 590         bt_object_get_ref_no_null_check(trace->user_attributes);
 591 }
 592
 593 void bt_trace_get_ref(const struct bt_trace *trace)
 594 {
 595         bt_object_get_ref(trace);
 596 }
 597
 598 void bt_trace_put_ref(const struct bt_trace *trace)
 599 {
 600         bt_object_put_ref(trace);
 601 }