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