lib/trace-ir/event-class.c

   1 /*
   2  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24
  25 #define BT_LOG_TAG "EVENT-CLASS"
  26 #include <babeltrace/lib-logging-internal.h>
  27
  28 #include <babeltrace/assert-pre-internal.h>
  29 #include <babeltrace/trace-ir/clock-value-internal.h>
  30 #include <babeltrace/trace-ir/fields-internal.h>
  31 #include <babeltrace/trace-ir/field-classes.h>
  32 #include <babeltrace/trace-ir/field-classes-internal.h>
  33 #include <babeltrace/trace-ir/event-class.h>
  34 #include <babeltrace/trace-ir/event-class-const.h>
  35 #include <babeltrace/trace-ir/event-class-internal.h>
  36 #include <babeltrace/trace-ir/event-internal.h>
  37 #include <babeltrace/trace-ir/stream-class.h>
  38 #include <babeltrace/trace-ir/stream-class-internal.h>
  39 #include <babeltrace/trace-ir/trace-internal.h>
  40 #include <babeltrace/trace-ir/utils-internal.h>
  41 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
  42 #include <babeltrace/object.h>
  43 #include <babeltrace/trace-ir/attributes-internal.h>
  44 #include <babeltrace/compiler-internal.h>
  45 #include <babeltrace/endian-internal.h>
  46 #include <babeltrace/types.h>
  47 #include <babeltrace/values-internal.h>
  48 #include <babeltrace/assert-internal.h>
  49 #include <inttypes.h>
  50 #include <stdlib.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 classe.");
  74         BT_OBJECT_PUT_REF_AND_RESET(event_class->specific_context_fc);
  75         BT_LOGD_STR("Putting payload field classe.");
  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 int bt_event_class_set_name(struct bt_event_class *event_class,
 198                 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_LOGV("Set event class's name: %!+E", event_class);
 206         return 0;
 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_LOGV("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 int 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_LOGV("Set event class's EMF URI: %!+E", event_class);
 253         return 0;
 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 int bt_event_class_set_specific_context_field_class(
 279                 struct bt_event_class *event_class,
 280                 struct bt_field_class *field_class)
 281 {
 282         int ret;
 283         struct bt_stream_class *stream_class;
 284         struct bt_trace *trace;
 285         struct bt_resolve_field_path_context resolve_ctx = {
 286                 .packet_header = NULL,
 287                 .packet_context = NULL,
 288                 .event_header = NULL,
 289                 .event_common_context = NULL,
 290                 .event_specific_context = field_class,
 291                 .event_payload = NULL,
 292         };
 293
 294         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 295         BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
 296         BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
 297         BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
 298                 BT_FIELD_CLASS_TYPE_STRUCTURE,
 299                 "Specific context field classe is not a structure field classe: "
 300                 "%!+F", field_class);
 301         stream_class = bt_event_class_borrow_stream_class_inline(
 302                 event_class);
 303         trace = bt_stream_class_borrow_trace_inline(stream_class);
 304         resolve_ctx.packet_header = trace->packet_header_fc;
 305         resolve_ctx.packet_context = stream_class->packet_context_fc;
 306         resolve_ctx.event_header = stream_class->event_header_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                 goto end;
 313         }
 314
 315         bt_field_class_make_part_of_trace(field_class);
 316         bt_object_put_ref(event_class->specific_context_fc);
 317         event_class->specific_context_fc = field_class;
 318         bt_object_get_no_null_check(event_class->specific_context_fc);
 319         bt_field_class_freeze(field_class);
 320         BT_LIB_LOGV("Set event class's specific context field classe: %!+E",
 321                 event_class);
 322
 323 end:
 324         return ret;
 325 }
 326
 327 const struct bt_field_class *bt_event_class_borrow_payload_field_class_const(
 328                 const struct bt_event_class *event_class)
 329 {
 330         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 331         return event_class->payload_fc;
 332 }
 333
 334 int bt_event_class_set_payload_field_class(
 335                 struct bt_event_class *event_class,
 336                 struct bt_field_class *field_class)
 337 {
 338         int ret;
 339         struct bt_stream_class *stream_class;
 340         struct bt_trace *trace;
 341         struct bt_resolve_field_path_context resolve_ctx = {
 342                 .packet_header = NULL,
 343                 .packet_context = NULL,
 344                 .event_header = NULL,
 345                 .event_common_context = NULL,
 346                 .event_specific_context = NULL,
 347                 .event_payload = field_class,
 348         };
 349
 350         BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
 351         BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
 352         BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
 353         BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
 354                 BT_FIELD_CLASS_TYPE_STRUCTURE,
 355                 "Payload field classe is not a structure field classe: %!+F",
 356                 field_class);
 357         stream_class = bt_event_class_borrow_stream_class_inline(
 358                 event_class);
 359         trace = bt_stream_class_borrow_trace_inline(stream_class);
 360         resolve_ctx.packet_header = trace->packet_header_fc;
 361         resolve_ctx.packet_context = stream_class->packet_context_fc;
 362         resolve_ctx.event_header = stream_class->event_header_fc;
 363         resolve_ctx.event_common_context =
 364                 stream_class->event_common_context_fc;
 365         resolve_ctx.event_specific_context = event_class->specific_context_fc;
 366
 367         ret = bt_resolve_field_paths(field_class, &resolve_ctx);
 368         if (ret) {
 369                 goto end;
 370         }
 371
 372         bt_field_class_make_part_of_trace(field_class);
 373         bt_object_put_ref(event_class->payload_fc);
 374         event_class->payload_fc = field_class;
 375         bt_object_get_no_null_check(event_class->payload_fc);
 376         bt_field_class_freeze(field_class);
 377         BT_LIB_LOGV("Set event class's payload field classe: %!+E", event_class);
 378
 379 end:
 380         return ret;
 381 }
 382
 383 BT_HIDDEN
 384 void _bt_event_class_freeze(const struct bt_event_class *event_class)
 385 {
 386         /* The field classes are already frozen */
 387         BT_ASSERT(event_class);
 388         BT_LIB_LOGD("Freezing event class: %!+E", event_class);
 389         ((struct bt_event_class *) event_class)->frozen = true;
 390 }