lib/trace-ir/event.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"
  26 #include <babeltrace/lib-logging-internal.h>
  27
  28 #include <babeltrace/assert-pre-internal.h>
  29 #include <babeltrace/trace-ir/fields-internal.h>
  30 #include <babeltrace/trace-ir/field-classes-internal.h>
  31 #include <babeltrace/trace-ir/clock-class.h>
  32 #include <babeltrace/trace-ir/clock-value-const.h>
  33 #include <babeltrace/trace-ir/clock-value-internal.h>
  34 #include <babeltrace/trace-ir/clock-class-internal.h>
  35 #include <babeltrace/trace-ir/event-const.h>
  36 #include <babeltrace/trace-ir/event-internal.h>
  37 #include <babeltrace/trace-ir/event-class.h>
  38 #include <babeltrace/trace-ir/event-class-internal.h>
  39 #include <babeltrace/trace-ir/stream-class.h>
  40 #include <babeltrace/trace-ir/stream-class-const.h>
  41 #include <babeltrace/trace-ir/stream-class-internal.h>
  42 #include <babeltrace/trace-ir/stream-internal.h>
  43 #include <babeltrace/trace-ir/packet.h>
  44 #include <babeltrace/trace-ir/packet-internal.h>
  45 #include <babeltrace/trace-ir/trace.h>
  46 #include <babeltrace/trace-ir/trace-internal.h>
  47 #include <babeltrace/trace-ir/packet-internal.h>
  48 #include <babeltrace/object.h>
  49 #include <babeltrace/trace-ir/attributes-internal.h>
  50 #include <babeltrace/compiler-internal.h>
  51 #include <babeltrace/assert-internal.h>
  52 #include <inttypes.h>
  53
  54 BT_HIDDEN
  55 void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen)
  56 {
  57         BT_ASSERT(event);
  58         BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
  59                 event, is_frozen);
  60
  61         if (event->header_field) {
  62                 BT_LOGD_STR("Setting event's header field's frozen state.");
  63                 bt_field_set_is_frozen(
  64                         event->header_field->field, is_frozen);
  65         }
  66
  67         if (event->common_context_field) {
  68                 BT_LOGD_STR("Setting event's common context field's frozen state.");
  69                 bt_field_set_is_frozen(
  70                         event->common_context_field, is_frozen);
  71         }
  72
  73         if (event->specific_context_field) {
  74                 BT_LOGD_STR("Setting event's specific context field's frozen state.");
  75                 bt_field_set_is_frozen(event->specific_context_field,
  76                         is_frozen);
  77         }
  78
  79         if (event->payload_field) {
  80                 BT_LOGD_STR("Setting event's payload field's frozen state.");
  81                 bt_field_set_is_frozen(event->payload_field,
  82                         is_frozen);
  83         }
  84
  85         ((struct bt_event *) event)->frozen = is_frozen;
  86         BT_LOGD_STR("Setting event's packet's frozen state.");
  87         bt_packet_set_is_frozen(event->packet, is_frozen);
  88 }
  89
  90 static
  91 void recycle_event_header_field(struct bt_field_wrapper *field_wrapper,
  92                 struct bt_stream_class *stream_class)
  93 {
  94         BT_ASSERT(field_wrapper);
  95         BT_LIB_LOGD("Recycling event header field: "
  96                 "addr=%p, %![sc-]+S, %![field-]+f", field_wrapper,
  97                 stream_class, field_wrapper->field);
  98         bt_object_pool_recycle_object(
  99                 &stream_class->event_header_field_pool,
 100                 field_wrapper);
 101 }
 102
 103 static inline
 104 struct bt_field_wrapper *create_event_header_field(
 105                 struct bt_stream_class *stream_class)
 106 {
 107         struct bt_field_wrapper *field_wrapper = NULL;
 108
 109         field_wrapper = bt_field_wrapper_create(
 110                 &stream_class->event_header_field_pool,
 111                 stream_class->event_header_fc);
 112         if (!field_wrapper) {
 113                 goto error;
 114         }
 115
 116         goto end;
 117
 118 error:
 119         if (field_wrapper) {
 120                 recycle_event_header_field(field_wrapper, stream_class);
 121                 field_wrapper = NULL;
 122         }
 123
 124 end:
 125         return field_wrapper;
 126 }
 127
 128 BT_HIDDEN
 129 struct bt_event *bt_event_new(struct bt_event_class *event_class)
 130 {
 131         struct bt_event *event = NULL;
 132         struct bt_stream_class *stream_class;
 133         struct bt_field_class *fc;
 134
 135         BT_ASSERT(event_class);
 136         event = g_new0(struct bt_event, 1);
 137         if (!event) {
 138                 BT_LOGE_STR("Failed to allocate one event.");
 139                 goto error;
 140         }
 141
 142         bt_object_init_unique(&event->base);
 143         stream_class = bt_event_class_borrow_stream_class(event_class);
 144         BT_ASSERT(stream_class);
 145
 146         if (stream_class->event_header_fc) {
 147                 event->header_field = create_event_header_field(stream_class);
 148                 if (!event->header_field) {
 149                         BT_LOGE_STR("Cannot create event header field.");
 150                         goto error;
 151                 }
 152         }
 153
 154         fc = stream_class->event_common_context_fc;
 155         if (fc) {
 156                 event->common_context_field = bt_field_create(fc);
 157                 if (!event->common_context_field) {
 158                         /* bt_field_create() logs errors */
 159                         goto error;
 160                 }
 161         }
 162
 163         fc = event_class->specific_context_fc;
 164         if (fc) {
 165                 event->specific_context_field = bt_field_create(fc);
 166                 if (!event->specific_context_field) {
 167                         /* bt_field_create() logs errors */
 168                         goto error;
 169                 }
 170         }
 171
 172         fc = event_class->payload_fc;
 173         if (fc) {
 174                 event->payload_field = bt_field_create(fc);
 175                 if (!event->payload_field) {
 176                         /* bt_field_create() logs errors */
 177                         goto error;
 178                 }
 179         }
 180
 181         if (stream_class->default_clock_class) {
 182                 event->default_cv = bt_clock_value_create(
 183                         stream_class->default_clock_class);
 184                 if (!event->default_cv) {
 185                         /* bt_clock_value_create() logs errors */
 186                         goto error;
 187                 }
 188         }
 189
 190         goto end;
 191
 192 error:
 193         if (event) {
 194                 bt_event_destroy(event);
 195                 event = NULL;
 196         }
 197
 198 end:
 199         return event;
 200 }
 201
 202 struct bt_event_class *bt_event_borrow_class(struct bt_event *event)
 203 {
 204         BT_ASSERT_PRE_NON_NULL(event, "Event");
 205         return event->class;
 206 }
 207
 208 const struct bt_event_class *bt_event_borrow_class_const(
 209                 const struct bt_event *event)
 210 {
 211         return bt_event_borrow_class((void *) event);
 212 }
 213
 214 struct bt_stream *bt_event_borrow_stream(struct bt_event *event)
 215 {
 216         BT_ASSERT_PRE_NON_NULL(event, "Event");
 217         return event->packet ? event->packet->stream : NULL;
 218 }
 219
 220 const struct bt_stream *bt_event_borrow_stream_const(
 221                 const struct bt_event *event)
 222 {
 223         return bt_event_borrow_stream((void *) event);
 224 }
 225
 226 struct bt_field *bt_event_borrow_header_field(struct bt_event *event)
 227 {
 228         BT_ASSERT_PRE_NON_NULL(event, "Event");
 229         return event->header_field ? event->header_field->field : NULL;
 230 }
 231
 232 const struct bt_field *bt_event_borrow_header_field_const(
 233                 const struct bt_event *event)
 234 {
 235         BT_ASSERT_PRE_NON_NULL(event, "Event");
 236         return event->header_field ? event->header_field->field : NULL;
 237 }
 238
 239 struct bt_field *bt_event_borrow_common_context_field(struct bt_event *event)
 240 {
 241         BT_ASSERT_PRE_NON_NULL(event, "Event");
 242         return event->common_context_field;
 243 }
 244
 245 const struct bt_field *bt_event_borrow_common_context_field_const(
 246                 const struct bt_event *event)
 247 {
 248         BT_ASSERT_PRE_NON_NULL(event, "Event");
 249         return event->common_context_field;
 250 }
 251
 252 struct bt_field *bt_event_borrow_specific_context_field(struct bt_event *event)
 253 {
 254         BT_ASSERT_PRE_NON_NULL(event, "Event");
 255         return event->specific_context_field;
 256 }
 257
 258 const struct bt_field *bt_event_borrow_specific_context_field_const(
 259                 const struct bt_event *event)
 260 {
 261         BT_ASSERT_PRE_NON_NULL(event, "Event");
 262         return event->specific_context_field;
 263 }
 264
 265 struct bt_field *bt_event_borrow_payload_field(struct bt_event *event)
 266 {
 267         BT_ASSERT_PRE_NON_NULL(event, "Event");
 268         return event->payload_field;
 269 }
 270
 271 const struct bt_field *bt_event_borrow_payload_field_const(
 272                 const struct bt_event *event)
 273 {
 274         BT_ASSERT_PRE_NON_NULL(event, "Event");
 275         return event->payload_field;
 276 }
 277
 278 static
 279 void release_event_header_field(struct bt_field_wrapper *field_wrapper,
 280                 struct bt_event *event)
 281 {
 282         if (!event->class) {
 283                 bt_field_wrapper_destroy(field_wrapper);
 284         } else {
 285                 struct bt_stream_class *stream_class =
 286                         bt_event_class_borrow_stream_class(event->class);
 287
 288                 BT_ASSERT(stream_class);
 289                 recycle_event_header_field(field_wrapper, stream_class);
 290         }
 291 }
 292
 293 BT_HIDDEN
 294 void bt_event_destroy(struct bt_event *event)
 295 {
 296         BT_ASSERT(event);
 297         BT_LIB_LOGD("Destroying event: %!+e", event);
 298
 299         if (event->header_field) {
 300                 BT_LOGD_STR("Releasing event's header field.");
 301                 release_event_header_field(event->header_field, event);
 302                 event->header_field = NULL;
 303         }
 304
 305         if (event->common_context_field) {
 306                 BT_LOGD_STR("Destroying event's stream event context field.");
 307                 bt_field_destroy(event->common_context_field);
 308                 event->common_context_field = NULL;
 309         }
 310
 311         if (event->specific_context_field) {
 312                 BT_LOGD_STR("Destroying event's context field.");
 313                 bt_field_destroy(event->specific_context_field);
 314                 event->specific_context_field = NULL;
 315         }
 316
 317         if (event->payload_field) {
 318                 BT_LOGD_STR("Destroying event's payload field.");
 319                 bt_field_destroy(event->payload_field);
 320                 event->payload_field = NULL;
 321         }
 322
 323         BT_LOGD_STR("Putting event's class.");
 324         bt_object_put_ref(event->class);
 325
 326         if (event->default_cv) {
 327                 bt_clock_value_recycle(event->default_cv);
 328                 event->default_cv = NULL;
 329         }
 330
 331         BT_LOGD_STR("Putting event's packet.");
 332         BT_OBJECT_PUT_REF_AND_RESET(event->packet);
 333         g_free(event);
 334 }
 335
 336 void bt_event_set_default_clock_value(struct bt_event *event,
 337                 uint64_t value_cycles)
 338 {
 339         struct bt_stream_class *sc;
 340
 341         BT_ASSERT_PRE_NON_NULL(event, "Event");
 342         BT_ASSERT_PRE_EVENT_HOT(event);
 343         sc = bt_event_class_borrow_stream_class_inline(event->class);
 344         BT_ASSERT(sc);
 345         BT_ASSERT_PRE(sc->default_clock_class,
 346                 "Event's stream class has no default clock class: "
 347                 "%![ev-]+e, %![sc-]+S", event, sc);
 348         BT_ASSERT(event->default_cv);
 349         bt_clock_value_set_value_inline(event->default_cv, value_cycles);
 350         BT_LIB_LOGV("Set event's default clock value: %![event-]+e, "
 351                 "value=%" PRIu64, event, value_cycles);
 352 }
 353
 354 enum bt_clock_value_status bt_event_borrow_default_clock_value_const(
 355                 const struct bt_event *event,
 356                 const struct bt_clock_value **clock_value)
 357 {
 358         BT_ASSERT_PRE_NON_NULL(event, "Event");
 359         BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
 360         *clock_value = event->default_cv;
 361         return BT_CLOCK_VALUE_STATUS_KNOWN;
 362 }
 363
 364 struct bt_packet *bt_event_borrow_packet(struct bt_event *event)
 365 {
 366         BT_ASSERT_PRE_NON_NULL(event, "Event");
 367         return event->packet;
 368 }
 369
 370 const struct bt_packet *bt_event_borrow_packet_const(
 371                 const struct bt_event *event)
 372 {
 373         return bt_event_borrow_packet((void *) event);
 374 }
 375
 376 int bt_event_move_header_field(struct bt_event *event,
 377                 struct bt_event_header_field *header_field)
 378 {
 379         struct bt_stream_class *stream_class;
 380         struct bt_field_wrapper *field_wrapper = (void *) header_field;
 381
 382         BT_ASSERT_PRE_NON_NULL(event, "Event");
 383         BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
 384         BT_ASSERT_PRE_EVENT_HOT(event);
 385         stream_class = bt_event_class_borrow_stream_class_inline(event->class);
 386         BT_ASSERT_PRE(stream_class->event_header_fc,
 387                 "Stream class has no event header field classe: %!+S",
 388                 stream_class);
 389
 390         /* Recycle current header field: always exists */
 391         BT_ASSERT(event->header_field);
 392         recycle_event_header_field(event->header_field, stream_class);
 393
 394         /* Move new field */
 395         event->header_field = field_wrapper;
 396         return 0;
 397 }