src/lib/trace-ir/event-class.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2013, 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/EVENT-CLASS"
  25 #include "lib/logging.h"
  26
  27 #include "lib/assert-pre.h"
  28 #include <babeltrace2/trace-ir/field-class.h>
  29 #include <babeltrace2/trace-ir/event-class.h>
  30 #include <babeltrace2/trace-ir/event-class-const.h>
  31 #include <babeltrace2/trace-ir/stream-class.h>
  32 #include "compat/compiler.h"
  33 #include "compat/endian.h"
  34 #include <babeltrace2/types.h>
  35 #include "lib/value.h"
  36 #include "common/assert.h"
  37 #include <inttypes.h>
  38 #include <stdlib.h>
  39
  40 #include "attributes.h"
  41 #include "clock-snapshot.h"
  42 #include "event-class.h"
  43 #include "event.h"
  44 #include "field-class.h"
  45 #include "field.h"
  46 #include "resolve-field-path.h"
  47 #include "stream-class.h"
  48 #include "trace.h"
  49 #include "utils.h"
  50 #include "lib/func-status.h"
  51
  52 #define BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(_ec) \
  53         BT_ASSERT_PRE_DEV_HOT(((const struct bt_event_class *) (_ec)),  \
  54                 "Event class", ": %!+E", (_ec))
  55
  56 static
  57 void destroy_event_class(struct bt_object *obj)
  58 {
  59         struct bt_event_class *event_class = (void *) obj;
  60
  61         BT_LIB_LOGD("Destroying event class: %!+E", event_class);
  62         BT_OBJECT_PUT_REF_AND_RESET(event_class->user_attributes);
  63
  64         if (event_class->name.str) {
  65                 g_string_free(event_class->name.str, TRUE);
  66                 event_class->name.str = NULL;
  67         }
  68
  69         if (event_class->emf_uri.str) {
  70                 g_string_free(event_class->emf_uri.str, TRUE);
  71                 event_class->emf_uri.str = NULL;
  72         }
  73
  74         BT_LOGD_STR("Putting context field class.");
  75         BT_OBJECT_PUT_REF_AND_RESET(event_class->specific_context_fc);
  76         BT_LOGD_STR("Putting payload field class.");
  77         BT_OBJECT_PUT_REF_AND_RESET(event_class->payload_fc);
  78         bt_object_pool_finalize(&event_class->event_pool);
  79         g_free(obj);
  80 }
  81
  82 static
  83 void free_event(struct bt_event *event,
  84                 struct bt_event_class *event_class)
  85 {
  86         bt_event_destroy(event);
  87 }
  88
  89 static
  90 bool event_class_id_is_unique(const struct bt_stream_class *stream_class,
  91                 uint64_t id)
  92 {
  93         uint64_t i;
  94         bool is_unique = true;
  95
  96         for (i = 0; i < stream_class->event_classes->len; i++) {
  97                 const struct bt_event_class *ec =
  98                         stream_class->event_classes->pdata[i];
  99
 100                 if (ec->id == id) {
 101                         is_unique = false;
 102                         goto end;
 103                 }
 104         }
 105
 106 end:
 107         return is_unique;
 108 }
 109
 110 static
 111 struct bt_event_class *create_event_class_with_id(
 112                 struct bt_stream_class *stream_class, uint64_t id)
 113 {
 114         int ret;
 115         struct bt_event_class *event_class;
 116
 117         BT_ASSERT(stream_class);
 118         BT_ASSERT_PRE(event_class_id_is_unique(stream_class, id),
 119                 "Duplicate event class ID: %![sc-]+S, id=%" PRIu64,
 120                 stream_class, id);
 121         BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64,
 122                 stream_class, id);
 123         event_class = g_new0(struct bt_event_class, 1);
 124         if (!event_class) {
 125                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one event class.");
 126                 goto error;
 127         }
 128
 129         bt_object_init_shared_with_parent(&event_class->base,
 130                 destroy_event_class);
 131         event_class->user_attributes = bt_value_map_create();
 132         if (!event_class->user_attributes) {
 133                 BT_LIB_LOGE_APPEND_CAUSE(
 134                         "Failed to create a map value object.");
 135                 goto error;
 136         }
 137
 138         event_class->id = id;
 139         bt_property_uint_init(&event_class->log_level,
 140                         BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0);
 141         event_class->name.str = g_string_new(NULL);
 142         if (!event_class->name.str) {
 143                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
 144                 goto error;
 145         }
 146
 147         event_class->emf_uri.str = g_string_new(NULL);
 148         if (!event_class->emf_uri.str) {
 149                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
 150                 goto error;
 151         }
 152
 153         ret = bt_object_pool_initialize(&event_class->event_pool,
 154                 (bt_object_pool_new_object_func) bt_event_new,
 155                 (bt_object_pool_destroy_object_func) free_event,
 156                 event_class);
 157         if (ret) {
 158                 BT_LIB_LOGE_APPEND_CAUSE(
 159                         "Failed to initialize event pool: ret=%d",
 160                         ret);
 161                 goto error;
 162         }
 163
 164         bt_object_set_parent(&event_class->base, &stream_class->base);
 165         g_ptr_array_add(stream_class->event_classes, event_class);
 166         bt_stream_class_freeze(stream_class);
 167         BT_LIB_LOGD("Created event class object: %!+E", event_class);
 168         goto end;
 169
 170 error:
 171         BT_OBJECT_PUT_REF_AND_RESET(event_class);
 172
 173 end:
 174         return event_class;
 175 }
 176
 177 struct bt_event_class *bt_event_class_create(
 178                 struct bt_stream_class *stream_class)
 179 {
 180         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
 181         BT_ASSERT_PRE(stream_class->assigns_automatic_event_class_id,
 182                 "Stream class does not automatically assigns event class IDs: "
 183                 "%![sc-]+S", stream_class);
 184         return create_event_class_with_id(stream_class,
 185                 (uint64_t) stream_class->event_classes->len);
 186 }
 187
 188 struct bt_event_class *bt_event_class_create_with_id(
 189                 struct bt_stream_class *stream_class, uint64_t id)
 190 {
 191         BT_ASSERT_PRE(!stream_class->assigns_automatic_event_class_id,
 192                 "Stream class automatically assigns event class IDs: "
 193                 "%![sc-]+S", stream_class);
 194         return create_event_class_with_id(stream_class, id);
 195 }
 196
 197 const char *bt_event_class_get_name(const struct bt_event_class *event_class)
 198 {
 199         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 200         return event_class->name.value;
 201 }
 202
 203 enum bt_event_class_set_name_status bt_event_class_set_name(
 204                 struct bt_event_class *event_class, const char *name)
 205 {
 206         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 207         BT_ASSERT_PRE_NON_NULL(name, "Name");
 208         BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
 209         g_string_assign(event_class->name.str, name);
 210         event_class->name.value = event_class->name.str->str;
 211         BT_LIB_LOGD("Set event class's name: %!+E", event_class);
 212         return BT_FUNC_STATUS_OK;
 213 }
 214
 215 uint64_t bt_event_class_get_id(const struct bt_event_class *event_class)
 216 {
 217         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 218         return event_class->id;
 219 }
 220
 221 enum bt_property_availability bt_event_class_get_log_level(
 222                 const struct bt_event_class *event_class,
 223                 enum bt_event_class_log_level *log_level)
 224 {
 225         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 226         BT_ASSERT_PRE_DEV_NON_NULL(log_level, "Log level (output)");
 227         *log_level = (enum bt_event_class_log_level)
 228                 event_class->log_level.value;
 229         return event_class->log_level.base.avail;
 230 }
 231
 232 void bt_event_class_set_log_level(
 233                 struct bt_event_class *event_class,
 234                 enum bt_event_class_log_level log_level)
 235 {
 236         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 237         BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
 238         bt_property_uint_set(&event_class->log_level,
 239                 (uint64_t) log_level);
 240         BT_LIB_LOGD("Set event class's log level: %!+E", event_class);
 241 }
 242
 243 const char *bt_event_class_get_emf_uri(const struct bt_event_class *event_class)
 244 {
 245         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 246         return event_class->emf_uri.value;
 247 }
 248
 249 enum bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri(
 250                 struct bt_event_class *event_class,
 251                 const char *emf_uri)
 252 {
 253         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 254         BT_ASSERT_PRE_NON_NULL(emf_uri, "EMF URI");
 255         BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
 256         g_string_assign(event_class->emf_uri.str, emf_uri);
 257         event_class->emf_uri.value = event_class->emf_uri.str->str;
 258         BT_LIB_LOGD("Set event class's EMF URI: %!+E", event_class);
 259         return BT_FUNC_STATUS_OK;
 260 }
 261
 262 struct bt_stream_class *bt_event_class_borrow_stream_class(
 263                 struct bt_event_class *event_class)
 264 {
 265         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 266         return bt_event_class_borrow_stream_class_inline(event_class);
 267 }
 268
 269 const struct bt_stream_class *
 270 bt_event_class_borrow_stream_class_const(
 271                 const struct bt_event_class *event_class)
 272 {
 273         return bt_event_class_borrow_stream_class((void *) event_class);
 274 }
 275
 276 const struct bt_field_class *
 277 bt_event_class_borrow_specific_context_field_class_const(
 278                 const struct bt_event_class *event_class)
 279 {
 280         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 281         return event_class->specific_context_fc;
 282 }
 283
 284 struct bt_field_class *
 285 bt_event_class_borrow_specific_context_field_class(
 286                 struct bt_event_class *event_class)
 287 {
 288         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 289         return event_class->specific_context_fc;
 290 }
 291
 292 enum bt_event_class_set_field_class_status
 293 bt_event_class_set_specific_context_field_class(
 294                 struct bt_event_class *event_class,
 295                 struct bt_field_class *field_class)
 296 {
 297         int ret;
 298         struct bt_stream_class *stream_class;
 299         struct bt_resolve_field_path_context resolve_ctx = {
 300                 .packet_context = NULL,
 301                 .event_common_context = NULL,
 302                 .event_specific_context = field_class,
 303                 .event_payload = NULL,
 304         };
 305
 306         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 307         BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
 308         BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
 309         BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
 310                 BT_FIELD_CLASS_TYPE_STRUCTURE,
 311                 "Specific context field class is not a structure field class: "
 312                 "%!+F", field_class);
 313         stream_class = bt_event_class_borrow_stream_class_inline(
 314                 event_class);
 315         resolve_ctx.packet_context = stream_class->packet_context_fc;
 316         resolve_ctx.event_common_context =
 317                 stream_class->event_common_context_fc;
 318
 319         ret = bt_resolve_field_paths(field_class, &resolve_ctx);
 320         if (ret) {
 321                 /*
 322                  * This is the only reason for which
 323                  * bt_resolve_field_paths() can fail: anything else
 324                  * would be because a precondition is not satisfied.
 325                  */
 326                 ret = BT_FUNC_STATUS_MEMORY_ERROR;
 327                 goto end;
 328         }
 329
 330         bt_field_class_make_part_of_trace_class(field_class);
 331         bt_object_put_ref(event_class->specific_context_fc);
 332         event_class->specific_context_fc = field_class;
 333         bt_object_get_ref_no_null_check(event_class->specific_context_fc);
 334         bt_field_class_freeze(field_class);
 335         BT_LIB_LOGD("Set event class's specific context field class: %!+E",
 336                 event_class);
 337
 338 end:
 339         return ret;
 340 }
 341
 342 const struct bt_field_class *bt_event_class_borrow_payload_field_class_const(
 343                 const struct bt_event_class *event_class)
 344 {
 345         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 346         return event_class->payload_fc;
 347 }
 348
 349 struct bt_field_class *bt_event_class_borrow_payload_field_class(
 350                 struct bt_event_class *event_class)
 351 {
 352         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 353         return event_class->payload_fc;
 354 }
 355
 356 enum bt_event_class_set_field_class_status
 357 bt_event_class_set_payload_field_class(
 358                 struct bt_event_class *event_class,
 359                 struct bt_field_class *field_class)
 360 {
 361         int ret;
 362         struct bt_stream_class *stream_class;
 363         struct bt_resolve_field_path_context resolve_ctx = {
 364                 .packet_context = NULL,
 365                 .event_common_context = NULL,
 366                 .event_specific_context = NULL,
 367                 .event_payload = field_class,
 368         };
 369
 370         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 371         BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
 372         BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
 373         BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
 374                 BT_FIELD_CLASS_TYPE_STRUCTURE,
 375                 "Payload field class is not a structure field class: %!+F",
 376                 field_class);
 377         stream_class = bt_event_class_borrow_stream_class_inline(
 378                 event_class);
 379         resolve_ctx.packet_context = stream_class->packet_context_fc;
 380         resolve_ctx.event_common_context =
 381                 stream_class->event_common_context_fc;
 382         resolve_ctx.event_specific_context = event_class->specific_context_fc;
 383
 384         ret = bt_resolve_field_paths(field_class, &resolve_ctx);
 385         if (ret) {
 386                 /*
 387                  * This is the only reason for which
 388                  * bt_resolve_field_paths() can fail: anything else
 389                  * would be because a precondition is not satisfied.
 390                  */
 391                 ret = BT_FUNC_STATUS_MEMORY_ERROR;
 392                 goto end;
 393         }
 394
 395         bt_field_class_make_part_of_trace_class(field_class);
 396         bt_object_put_ref(event_class->payload_fc);
 397         event_class->payload_fc = field_class;
 398         bt_object_get_ref_no_null_check(event_class->payload_fc);
 399         bt_field_class_freeze(field_class);
 400         BT_LIB_LOGD("Set event class's payload field class: %!+E", event_class);
 401
 402 end:
 403         return ret;
 404 }
 405
 406 BT_HIDDEN
 407 void _bt_event_class_freeze(const struct bt_event_class *event_class)
 408 {
 409         /* The field classes are already frozen */
 410         BT_ASSERT(event_class);
 411         BT_LIB_LOGD("Freezing event class's user attributes: %!+v",
 412                 event_class->user_attributes);
 413         bt_value_freeze(event_class->user_attributes);
 414         BT_LIB_LOGD("Freezing event class: %!+E", event_class);
 415         ((struct bt_event_class *) event_class)->frozen = true;
 416 }
 417
 418 const struct bt_value *bt_event_class_borrow_user_attributes_const(
 419                 const struct bt_event_class *event_class)
 420 {
 421         BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
 422         return event_class->user_attributes;
 423 }
 424
 425 struct bt_value *bt_event_class_borrow_user_attributes(
 426                 struct bt_event_class *event_class)
 427 {
 428         return (void *) bt_event_class_borrow_user_attributes_const(
 429                 (void *) event_class);
 430 }
 431
 432 void bt_event_class_set_user_attributes(
 433                 struct bt_event_class *event_class,
 434                 const struct bt_value *user_attributes)
 435 {
 436         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 437         BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
 438         BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
 439                 "User attributes object is not a map value object.");
 440         BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
 441         bt_object_put_ref_no_null_check(event_class->user_attributes);
 442         event_class->user_attributes = (void *) user_attributes;
 443         bt_object_get_ref_no_null_check(event_class->user_attributes);
 444 }
 445
 446 void bt_event_class_get_ref(const struct bt_event_class *event_class)
 447 {
 448         bt_object_get_ref(event_class);
 449 }
 450
 451 void bt_event_class_put_ref(const struct bt_event_class *event_class)
 452 {
 453         bt_object_put_ref(event_class);
 454 }