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 <babeltrace/lib-logging-internal.h>
  26
  27 #include <babeltrace/assert-pre-internal.h>
  28 #include <babeltrace/trace-ir/field-internal.h>
  29 #include <babeltrace/trace-ir/field-class-internal.h>
  30 #include <babeltrace/trace-ir/clock-class.h>
  31 #include <babeltrace/trace-ir/clock-snapshot-const.h>
  32 #include <babeltrace/trace-ir/clock-snapshot-internal.h>
  33 #include <babeltrace/trace-ir/clock-class-internal.h>
  34 #include <babeltrace/trace-ir/event-const.h>
  35 #include <babeltrace/trace-ir/event-internal.h>
  36 #include <babeltrace/trace-ir/event-class.h>
  37 #include <babeltrace/trace-ir/event-class-internal.h>
  38 #include <babeltrace/trace-ir/stream-class.h>
  39 #include <babeltrace/trace-ir/stream-class-const.h>
  40 #include <babeltrace/trace-ir/stream-class-internal.h>
  41 #include <babeltrace/trace-ir/stream-internal.h>
  42 #include <babeltrace/trace-ir/packet.h>
  43 #include <babeltrace/trace-ir/packet-internal.h>
  44 #include <babeltrace/trace-ir/trace.h>
  45 #include <babeltrace/trace-ir/trace-internal.h>
  46 #include <babeltrace/trace-ir/packet-internal.h>
  47 #include <babeltrace/trace-ir/attributes-internal.h>
  48 #include <babeltrace/assert-internal.h>
  49 #include <babeltrace/compiler-internal.h>
  50 #include <inttypes.h>
  51
  52 BT_HIDDEN
  53 void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen)
  54 {
  55         BT_ASSERT(event);
  56         BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
  57                 event, is_frozen);
  58
  59         if (event->common_context_field) {
  60                 BT_LOGD_STR("Setting event's common context field's frozen state.");
  61                 bt_field_set_is_frozen(
  62                         event->common_context_field, is_frozen);
  63         }
  64
  65         if (event->specific_context_field) {
  66                 BT_LOGD_STR("Setting event's specific context field's frozen state.");
  67                 bt_field_set_is_frozen(event->specific_context_field,
  68                         is_frozen);
  69         }
  70
  71         if (event->payload_field) {
  72                 BT_LOGD_STR("Setting event's payload field's frozen state.");
  73                 bt_field_set_is_frozen(event->payload_field,
  74                         is_frozen);
  75         }
  76
  77         ((struct bt_event *) event)->frozen = is_frozen;
  78         BT_LOGD_STR("Setting event's packet's frozen state.");
  79         bt_packet_set_is_frozen(event->packet, is_frozen);
  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_LOGE_STR("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         if (stream_class->default_clock_class) {
 127                 event->default_cs = bt_clock_snapshot_create(
 128                         stream_class->default_clock_class);
 129                 if (!event->default_cs) {
 130                         /* bt_clock_snapshot_create() logs errors */
 131                         goto error;
 132                 }
 133         }
 134
 135         goto end;
 136
 137 error:
 138         if (event) {
 139                 bt_event_destroy(event);
 140                 event = NULL;
 141         }
 142
 143 end:
 144         return event;
 145 }
 146
 147 struct bt_event_class *bt_event_borrow_class(struct bt_event *event)
 148 {
 149         BT_ASSERT_PRE_NON_NULL(event, "Event");
 150         return event->class;
 151 }
 152
 153 const struct bt_event_class *bt_event_borrow_class_const(
 154                 const struct bt_event *event)
 155 {
 156         return bt_event_borrow_class((void *) event);
 157 }
 158
 159 struct bt_stream *bt_event_borrow_stream(struct bt_event *event)
 160 {
 161         BT_ASSERT_PRE_NON_NULL(event, "Event");
 162         return event->packet ? event->packet->stream : NULL;
 163 }
 164
 165 const struct bt_stream *bt_event_borrow_stream_const(
 166                 const struct bt_event *event)
 167 {
 168         return bt_event_borrow_stream((void *) event);
 169 }
 170
 171 struct bt_field *bt_event_borrow_common_context_field(struct bt_event *event)
 172 {
 173         BT_ASSERT_PRE_NON_NULL(event, "Event");
 174         return event->common_context_field;
 175 }
 176
 177 const struct bt_field *bt_event_borrow_common_context_field_const(
 178                 const struct bt_event *event)
 179 {
 180         BT_ASSERT_PRE_NON_NULL(event, "Event");
 181         return event->common_context_field;
 182 }
 183
 184 struct bt_field *bt_event_borrow_specific_context_field(struct bt_event *event)
 185 {
 186         BT_ASSERT_PRE_NON_NULL(event, "Event");
 187         return event->specific_context_field;
 188 }
 189
 190 const struct bt_field *bt_event_borrow_specific_context_field_const(
 191                 const struct bt_event *event)
 192 {
 193         BT_ASSERT_PRE_NON_NULL(event, "Event");
 194         return event->specific_context_field;
 195 }
 196
 197 struct bt_field *bt_event_borrow_payload_field(struct bt_event *event)
 198 {
 199         BT_ASSERT_PRE_NON_NULL(event, "Event");
 200         return event->payload_field;
 201 }
 202
 203 const struct bt_field *bt_event_borrow_payload_field_const(
 204                 const struct bt_event *event)
 205 {
 206         BT_ASSERT_PRE_NON_NULL(event, "Event");
 207         return event->payload_field;
 208 }
 209
 210 BT_HIDDEN
 211 void bt_event_destroy(struct bt_event *event)
 212 {
 213         BT_ASSERT(event);
 214         BT_LIB_LOGD("Destroying event: %!+e", event);
 215
 216         if (event->common_context_field) {
 217                 BT_LOGD_STR("Destroying event's stream event context field.");
 218                 bt_field_destroy(event->common_context_field);
 219                 event->common_context_field = NULL;
 220         }
 221
 222         if (event->specific_context_field) {
 223                 BT_LOGD_STR("Destroying event's context field.");
 224                 bt_field_destroy(event->specific_context_field);
 225                 event->specific_context_field = NULL;
 226         }
 227
 228         if (event->payload_field) {
 229                 BT_LOGD_STR("Destroying event's payload field.");
 230                 bt_field_destroy(event->payload_field);
 231                 event->payload_field = NULL;
 232         }
 233
 234         BT_LOGD_STR("Putting event's class.");
 235         bt_object_put_ref(event->class);
 236
 237         if (event->default_cs) {
 238                 bt_clock_snapshot_recycle(event->default_cs);
 239                 event->default_cs = NULL;
 240         }
 241
 242         BT_LOGD_STR("Putting event's packet.");
 243         BT_OBJECT_PUT_REF_AND_RESET(event->packet);
 244         g_free(event);
 245 }
 246
 247 void bt_event_set_default_clock_snapshot(struct bt_event *event,
 248                 uint64_t value_cycles)
 249 {
 250         struct bt_stream_class *sc;
 251
 252         BT_ASSERT_PRE_NON_NULL(event, "Event");
 253         BT_ASSERT_PRE_EVENT_HOT(event);
 254         sc = bt_event_class_borrow_stream_class_inline(event->class);
 255         BT_ASSERT(sc);
 256         BT_ASSERT_PRE(sc->default_clock_class,
 257                 "Event's stream class has no default clock class: "
 258                 "%![ev-]+e, %![sc-]+S", event, sc);
 259         BT_ASSERT(event->default_cs);
 260         bt_clock_snapshot_set_value_inline(event->default_cs, value_cycles);
 261         BT_LIB_LOGV("Set event's default clock snapshot: %![event-]+e, "
 262                 "value=%" PRIu64, event, value_cycles);
 263 }
 264
 265 enum bt_clock_snapshot_state bt_event_borrow_default_clock_snapshot_const(
 266                 const struct bt_event *event,
 267                 const struct bt_clock_snapshot **clock_snapshot)
 268 {
 269         BT_ASSERT_PRE_NON_NULL(event, "Event");
 270         BT_ASSERT_PRE_NON_NULL(clock_snapshot, "Clock snapshot (output)");
 271         *clock_snapshot = event->default_cs;
 272         return BT_CLOCK_SNAPSHOT_STATE_KNOWN;
 273 }
 274
 275 struct bt_packet *bt_event_borrow_packet(struct bt_event *event)
 276 {
 277         BT_ASSERT_PRE_NON_NULL(event, "Event");
 278         return event->packet;
 279 }
 280
 281 const struct bt_packet *bt_event_borrow_packet_const(
 282                 const struct bt_event *event)
 283 {
 284         return bt_event_borrow_packet((void *) event);
 285 }