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_EVENT_CLASS_HOT(_ec) \
  53         BT_ASSERT_PRE_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
  63         if (event_class->name.str) {
  64                 g_string_free(event_class->name.str, TRUE);
  65                 event_class->name.str = NULL;
  66         }
  67
  68         if (event_class->emf_uri.str) {
  69                 g_string_free(event_class->emf_uri.str, TRUE);
  70                 event_class->emf_uri.str = NULL;
  71         }
  72
  73         BT_LOGD_STR("Putting context field class.");
  74         BT_OBJECT_PUT_REF_AND_RESET(event_class->specific_context_fc);
  75         BT_LOGD_STR("Putting payload field class.");
  76         BT_OBJECT_PUT_REF_AND_RESET(event_class->payload_fc);
  77         bt_object_pool_finalize(&event_class->event_pool);
  78         g_free(obj);
  79 }
  80
  81 static
  82 void free_event(struct bt_event *event,
  83                 struct bt_event_class *event_class)
  84 {
  85         bt_event_destroy(event);
  86 }
  87
  88 BT_ASSERT_PRE_FUNC
  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_LOGE_STR("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->id = id;
 132         bt_property_uint_init(&event_class->log_level,
 133                         BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0);
 134         event_class->name.str = g_string_new(NULL);
 135         if (!event_class->name.str) {
 136                 BT_LOGE_STR("Failed to allocate a GString.");
 137                 ret = -1;
 138                 goto end;
 139         }
 140
 141         event_class->emf_uri.str = g_string_new(NULL);
 142         if (!event_class->emf_uri.str) {
 143                 BT_LOGE_STR("Failed to allocate a GString.");
 144                 ret = -1;
 145                 goto end;
 146         }
 147
 148         ret = bt_object_pool_initialize(&event_class->event_pool,
 149                 (bt_object_pool_new_object_func) bt_event_new,
 150                 (bt_object_pool_destroy_object_func) free_event,
 151                 event_class);
 152         if (ret) {
 153                 BT_LOGE("Failed to initialize event pool: ret=%d",
 154                         ret);
 155                 goto error;
 156         }
 157
 158         bt_object_set_parent(&event_class->base, &stream_class->base);
 159         g_ptr_array_add(stream_class->event_classes, event_class);
 160         bt_stream_class_freeze(stream_class);
 161         BT_LIB_LOGD("Created event class object: %!+E", event_class);
 162         goto end;
 163
 164 error:
 165         BT_OBJECT_PUT_REF_AND_RESET(event_class);
 166
 167 end:
 168         return event_class;
 169 }
 170
 171 struct bt_event_class *bt_event_class_create(
 172                 struct bt_stream_class *stream_class)
 173 {
 174         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
 175         BT_ASSERT_PRE(stream_class->assigns_automatic_event_class_id,
 176                 "Stream class does not automatically assigns event class IDs: "
 177                 "%![sc-]+S", stream_class);
 178         return create_event_class_with_id(stream_class,
 179                 (uint64_t) stream_class->event_classes->len);
 180 }
 181
 182 struct bt_event_class *bt_event_class_create_with_id(
 183                 struct bt_stream_class *stream_class, uint64_t id)
 184 {
 185         BT_ASSERT_PRE(!stream_class->assigns_automatic_event_class_id,
 186                 "Stream class automatically assigns event class IDs: "
 187                 "%![sc-]+S", stream_class);
 188         return create_event_class_with_id(stream_class, id);
 189 }
 190
 191 const char *bt_event_class_get_name(const struct bt_event_class *event_class)
 192 {
 193         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 194         return event_class->name.value;
 195 }
 196
 197 enum bt_event_class_set_name_status bt_event_class_set_name(
 198                 struct bt_event_class *event_class, const char *name)
 199 {
 200         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 201         BT_ASSERT_PRE_NON_NULL(name, "Name");
 202         BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
 203         g_string_assign(event_class->name.str, name);
 204         event_class->name.value = event_class->name.str->str;
 205         BT_LIB_LOGD("Set event class's name: %!+E", event_class);
 206         return BT_FUNC_STATUS_OK;
 207 }
 208
 209 uint64_t bt_event_class_get_id(const struct bt_event_class *event_class)
 210 {
 211         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 212         return event_class->id;
 213 }
 214
 215 enum bt_property_availability bt_event_class_get_log_level(
 216                 const struct bt_event_class *event_class,
 217                 enum bt_event_class_log_level *log_level)
 218 {
 219         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 220         BT_ASSERT_PRE_NON_NULL(log_level, "Log level (output)");
 221         *log_level = (enum bt_event_class_log_level)
 222                 event_class->log_level.value;
 223         return event_class->log_level.base.avail;
 224 }
 225
 226 void bt_event_class_set_log_level(
 227                 struct bt_event_class *event_class,
 228                 enum bt_event_class_log_level log_level)
 229 {
 230         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 231         BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
 232         bt_property_uint_set(&event_class->log_level,
 233                 (uint64_t) log_level);
 234         BT_LIB_LOGD("Set event class's log level: %!+E", event_class);
 235 }
 236
 237 const char *bt_event_class_get_emf_uri(const struct bt_event_class *event_class)
 238 {
 239         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 240         return event_class->emf_uri.value;
 241 }
 242
 243 enum bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri(
 244                 struct bt_event_class *event_class,
 245                 const char *emf_uri)
 246 {
 247         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 248         BT_ASSERT_PRE_NON_NULL(emf_uri, "EMF URI");
 249         BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
 250         g_string_assign(event_class->emf_uri.str, emf_uri);
 251         event_class->emf_uri.value = event_class->emf_uri.str->str;
 252         BT_LIB_LOGD("Set event class's EMF URI: %!+E", event_class);
 253         return BT_FUNC_STATUS_OK;
 254 }
 255
 256 struct bt_stream_class *bt_event_class_borrow_stream_class(
 257                 struct bt_event_class *event_class)
 258 {
 259         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 260         return bt_event_class_borrow_stream_class_inline(event_class);
 261 }
 262
 263 const struct bt_stream_class *
 264 bt_event_class_borrow_stream_class_const(
 265                 const struct bt_event_class *event_class)
 266 {
 267         return bt_event_class_borrow_stream_class((void *) event_class);
 268 }
 269
 270 const struct bt_field_class *
 271 bt_event_class_borrow_specific_context_field_class_const(
 272                 const struct bt_event_class *event_class)
 273 {
 274         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 275         return event_class->specific_context_fc;
 276 }
 277
 278 struct bt_field_class *
 279 bt_event_class_borrow_specific_context_field_class(
 280                 struct bt_event_class *event_class)
 281 {
 282         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 283         return event_class->specific_context_fc;
 284 }
 285
 286 enum bt_event_class_set_field_class_status
 287 bt_event_class_set_specific_context_field_class(
 288                 struct bt_event_class *event_class,
 289                 struct bt_field_class *field_class)
 290 {
 291         int ret;
 292         struct bt_stream_class *stream_class;
 293         struct bt_resolve_field_path_context resolve_ctx = {
 294                 .packet_context = NULL,
 295                 .event_common_context = NULL,
 296                 .event_specific_context = field_class,
 297                 .event_payload = NULL,
 298         };
 299
 300         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 301         BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
 302         BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
 303         BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
 304                 BT_FIELD_CLASS_TYPE_STRUCTURE,
 305                 "Specific context field class is not a structure field class: "
 306                 "%!+F", field_class);
 307         stream_class = bt_event_class_borrow_stream_class_inline(
 308                 event_class);
 309         resolve_ctx.packet_context = stream_class->packet_context_fc;
 310         resolve_ctx.event_common_context =
 311                 stream_class->event_common_context_fc;
 312
 313         ret = bt_resolve_field_paths(field_class, &resolve_ctx);
 314         if (ret) {
 315                 /*
 316                  * This is the only reason for which
 317                  * bt_resolve_field_paths() can fail: anything else
 318                  * would be because a precondition is not satisfied.
 319                  */
 320                 ret = BT_FUNC_STATUS_MEMORY_ERROR;
 321                 goto end;
 322         }
 323
 324         bt_field_class_make_part_of_trace_class(field_class);
 325         bt_object_put_ref(event_class->specific_context_fc);
 326         event_class->specific_context_fc = field_class;
 327         bt_object_get_no_null_check(event_class->specific_context_fc);
 328         bt_field_class_freeze(field_class);
 329         BT_LIB_LOGD("Set event class's specific context field class: %!+E",
 330                 event_class);
 331
 332 end:
 333         return ret;
 334 }
 335
 336 const struct bt_field_class *bt_event_class_borrow_payload_field_class_const(
 337                 const struct bt_event_class *event_class)
 338 {
 339         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 340         return event_class->payload_fc;
 341 }
 342
 343 struct bt_field_class *bt_event_class_borrow_payload_field_class(
 344                 struct bt_event_class *event_class)
 345 {
 346         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 347         return event_class->payload_fc;
 348 }
 349
 350 enum bt_event_class_set_field_class_status
 351 bt_event_class_set_payload_field_class(
 352                 struct bt_event_class *event_class,
 353                 struct bt_field_class *field_class)
 354 {
 355         int ret;
 356         struct bt_stream_class *stream_class;
 357         struct bt_resolve_field_path_context resolve_ctx = {
 358                 .packet_context = NULL,
 359                 .event_common_context = NULL,
 360                 .event_specific_context = NULL,
 361                 .event_payload = field_class,
 362         };
 363
 364         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 365         BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
 366         BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
 367         BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
 368                 BT_FIELD_CLASS_TYPE_STRUCTURE,
 369                 "Payload field class is not a structure field class: %!+F",
 370                 field_class);
 371         stream_class = bt_event_class_borrow_stream_class_inline(
 372                 event_class);
 373         resolve_ctx.packet_context = stream_class->packet_context_fc;
 374         resolve_ctx.event_common_context =
 375                 stream_class->event_common_context_fc;
 376         resolve_ctx.event_specific_context = event_class->specific_context_fc;
 377
 378         ret = bt_resolve_field_paths(field_class, &resolve_ctx);
 379         if (ret) {
 380                 /*
 381                  * This is the only reason for which
 382                  * bt_resolve_field_paths() can fail: anything else
 383                  * would be because a precondition is not satisfied.
 384                  */
 385                 ret = BT_FUNC_STATUS_MEMORY_ERROR;
 386                 goto end;
 387         }
 388
 389         bt_field_class_make_part_of_trace_class(field_class);
 390         bt_object_put_ref(event_class->payload_fc);
 391         event_class->payload_fc = field_class;
 392         bt_object_get_no_null_check(event_class->payload_fc);
 393         bt_field_class_freeze(field_class);
 394         BT_LIB_LOGD("Set event class's payload field class: %!+E", event_class);
 395
 396 end:
 397         return ret;
 398 }
 399
 400 BT_HIDDEN
 401 void _bt_event_class_freeze(const struct bt_event_class *event_class)
 402 {
 403         /* The field classes are already frozen */
 404         BT_ASSERT(event_class);
 405         BT_LIB_LOGD("Freezing event class: %!+E", event_class);
 406         ((struct bt_event_class *) event_class)->frozen = true;
 407 }
 408
 409 void bt_event_class_get_ref(const struct bt_event_class *event_class)
 410 {
 411         bt_object_get_ref(event_class);
 412 }
 413
 414 void bt_event_class_put_ref(const struct bt_event_class *event_class)
 415 {
 416         bt_object_put_ref(event_class);
 417 }