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