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