src/lib/trace-ir/event.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"
  25 #include "lib/logging.h"
  26
  27 #include "lib/assert-pre.h"
  28 #include <babeltrace2/trace-ir/event-const.h>
  29 #include <babeltrace2/trace-ir/event-class.h>
  30 #include <babeltrace2/trace-ir/stream-class.h>
  31 #include <babeltrace2/trace-ir/stream-class-const.h>
  32 #include <babeltrace2/trace-ir/packet.h>
  33 #include <babeltrace2/trace-ir/trace.h>
  34 #include "common/assert.h"
  35 #include "compat/compiler.h"
  36 #include <inttypes.h>
  37 #include <stdbool.h>
  38
  39 #include "field.h"
  40 #include "field-class.h"
  41 #include "event.h"
  42 #include "stream-class.h"
  43 #include "stream.h"
  44 #include "packet.h"
  45 #include "trace.h"
  46 #include "packet.h"
  47 #include "attributes.h"
  48 #include "event-class.h"
  49
  50 BT_HIDDEN
  51 void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen)
  52 {
  53         BT_ASSERT_DBG(event);
  54         BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
  55                 event, is_frozen);
  56
  57         if (event->common_context_field) {
  58                 BT_LOGD_STR("Setting event's common context field's frozen state.");
  59                 bt_field_set_is_frozen(
  60                         event->common_context_field, is_frozen);
  61         }
  62
  63         if (event->specific_context_field) {
  64                 BT_LOGD_STR("Setting event's specific context field's frozen state.");
  65                 bt_field_set_is_frozen(event->specific_context_field,
  66                         is_frozen);
  67         }
  68
  69         if (event->payload_field) {
  70                 BT_LOGD_STR("Setting event's payload field's frozen state.");
  71                 bt_field_set_is_frozen(event->payload_field,
  72                         is_frozen);
  73         }
  74
  75         ((struct bt_event *) event)->frozen = is_frozen;
  76
  77         if (event->packet) {
  78                 BT_LOGD_STR("Setting event's packet's frozen state.");
  79                 bt_packet_set_is_frozen(event->packet, is_frozen);
  80         }
  81 }
  82
  83 BT_HIDDEN
  84 struct bt_event *bt_event_new(struct bt_event_class *event_class)
  85 {
  86         struct bt_event *event = NULL;
  87         struct bt_stream_class *stream_class;
  88         struct bt_field_class *fc;
  89
  90         BT_ASSERT(event_class);
  91         event = g_new0(struct bt_event, 1);
  92         if (!event) {
  93                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one event.");
  94                 goto error;
  95         }
  96
  97         bt_object_init_unique(&event->base);
  98         stream_class = bt_event_class_borrow_stream_class(event_class);
  99         BT_ASSERT(stream_class);
 100         fc = stream_class->event_common_context_fc;
 101         if (fc) {
 102                 event->common_context_field = bt_field_create(fc);
 103                 if (!event->common_context_field) {
 104                         /* bt_field_create() logs errors */
 105                         goto error;
 106                 }
 107         }
 108
 109         fc = event_class->specific_context_fc;
 110         if (fc) {
 111                 event->specific_context_field = bt_field_create(fc);
 112                 if (!event->specific_context_field) {
 113                         /* bt_field_create() logs errors */
 114                         goto error;
 115                 }
 116         }
 117
 118         fc = event_class->payload_fc;
 119         if (fc) {
 120                 event->payload_field = bt_field_create(fc);
 121                 if (!event->payload_field) {
 122                         /* bt_field_create() logs errors */
 123                         goto error;
 124                 }
 125         }
 126
 127         goto end;
 128
 129 error:
 130         if (event) {
 131                 bt_event_destroy(event);
 132                 event = NULL;
 133         }
 134
 135 end:
 136         return event;
 137 }
 138
 139 struct bt_event_class *bt_event_borrow_class(struct bt_event *event)
 140 {
 141         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 142         return event->class;
 143 }
 144
 145 const struct bt_event_class *bt_event_borrow_class_const(
 146                 const struct bt_event *event)
 147 {
 148         return bt_event_borrow_class((void *) event);
 149 }
 150
 151 struct bt_stream *bt_event_borrow_stream(struct bt_event *event)
 152 {
 153         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 154         return event->stream;
 155 }
 156
 157 const struct bt_stream *bt_event_borrow_stream_const(
 158                 const struct bt_event *event)
 159 {
 160         return bt_event_borrow_stream((void *) event);
 161 }
 162
 163 struct bt_field *bt_event_borrow_common_context_field(struct bt_event *event)
 164 {
 165         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 166         return event->common_context_field;
 167 }
 168
 169 const struct bt_field *bt_event_borrow_common_context_field_const(
 170                 const struct bt_event *event)
 171 {
 172         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 173         return event->common_context_field;
 174 }
 175
 176 struct bt_field *bt_event_borrow_specific_context_field(struct bt_event *event)
 177 {
 178         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 179         return event->specific_context_field;
 180 }
 181
 182 const struct bt_field *bt_event_borrow_specific_context_field_const(
 183                 const struct bt_event *event)
 184 {
 185         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 186         return event->specific_context_field;
 187 }
 188
 189 struct bt_field *bt_event_borrow_payload_field(struct bt_event *event)
 190 {
 191         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 192         return event->payload_field;
 193 }
 194
 195 const struct bt_field *bt_event_borrow_payload_field_const(
 196                 const struct bt_event *event)
 197 {
 198         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 199         return event->payload_field;
 200 }
 201
 202 BT_HIDDEN
 203 void bt_event_destroy(struct bt_event *event)
 204 {
 205         BT_ASSERT(event);
 206         BT_LIB_LOGD("Destroying event: %!+e", event);
 207
 208         if (event->common_context_field) {
 209                 BT_LOGD_STR("Destroying event's stream event context field.");
 210                 bt_field_destroy(event->common_context_field);
 211                 event->common_context_field = NULL;
 212         }
 213
 214         if (event->specific_context_field) {
 215                 BT_LOGD_STR("Destroying event's context field.");
 216                 bt_field_destroy(event->specific_context_field);
 217                 event->specific_context_field = NULL;
 218         }
 219
 220         if (event->payload_field) {
 221                 BT_LOGD_STR("Destroying event's payload field.");
 222                 bt_field_destroy(event->payload_field);
 223                 event->payload_field = NULL;
 224         }
 225
 226         BT_LOGD_STR("Putting event's class.");
 227         bt_object_put_ref(event->class);
 228         BT_LOGD_STR("Putting event's packet.");
 229         BT_OBJECT_PUT_REF_AND_RESET(event->packet);
 230         BT_LOGD_STR("Putting event's stream.");
 231         BT_OBJECT_PUT_REF_AND_RESET(event->stream);
 232         g_free(event);
 233 }
 234
 235 struct bt_packet *bt_event_borrow_packet(struct bt_event *event)
 236 {
 237         BT_ASSERT_PRE_DEV_NON_NULL(event, "Event");
 238         return event->packet;
 239 }
 240
 241 const struct bt_packet *bt_event_borrow_packet_const(
 242                 const struct bt_event *event)
 243 {
 244         return bt_event_borrow_packet((void *) event);
 245 }