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