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