include/babeltrace/trace-ir/event-internal.h

   1 #ifndef BABELTRACE_TRACE_IR_EVENT_INTERNAL_H
   2 #define BABELTRACE_TRACE_IR_EVENT_INTERNAL_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 /* Protection: this file uses BT_LIB_LOG*() macros directly */
  28 #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
  29 # error Please define include <babeltrace/lib-logging-internal.h> before including this file.
  30 #endif
  31
  32 #include <babeltrace/assert-pre-internal.h>
  33 #include <babeltrace/babeltrace-internal.h>
  34 #include <babeltrace/value.h>
  35 #include <babeltrace/trace-ir/clock-snapshot-internal.h>
  36 #include <babeltrace/trace-ir/stream-class.h>
  37 #include <babeltrace/trace-ir/stream.h>
  38 #include <babeltrace/trace-ir/stream-internal.h>
  39 #include <babeltrace/trace-ir/packet.h>
  40 #include <babeltrace/trace-ir/packet-internal.h>
  41 #include <babeltrace/trace-ir/field.h>
  42 #include <babeltrace/trace-ir/field-internal.h>
  43 #include <babeltrace/trace-ir/event-class-internal.h>
  44 #include <babeltrace/trace-ir/field-wrapper-internal.h>
  45 #include <babeltrace/object-internal.h>
  46 #include <babeltrace/assert-internal.h>
  47 #include <glib.h>
  48
  49 #define BT_ASSERT_PRE_EVENT_HOT(_event) \
  50         BT_ASSERT_PRE_HOT(((const struct bt_event *) (_event)),         \
  51                 "Event", ": %!+e", (_event))
  52
  53 struct bt_event {
  54         struct bt_object base;
  55
  56         /* Owned by this */
  57         struct bt_event_class *class;
  58
  59         /* Owned by this */
  60         struct bt_packet *packet;
  61
  62         struct bt_field *common_context_field;
  63         struct bt_field *specific_context_field;
  64         struct bt_field *payload_field;
  65         struct bt_clock_snapshot *default_cs;
  66         bool frozen;
  67 };
  68
  69 BT_HIDDEN
  70 void bt_event_destroy(struct bt_event *event);
  71
  72 BT_HIDDEN
  73 struct bt_event *bt_event_new(struct bt_event_class *event_class);
  74
  75 BT_HIDDEN
  76 void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen);
  77
  78 #ifdef BT_DEV_MODE
  79 # define bt_event_set_is_frozen         _bt_event_set_is_frozen
  80 #else
  81 # define bt_event_set_is_frozen(_event, _is_frozen)
  82 #endif
  83
  84 BT_UNUSED
  85 static inline
  86 void _bt_event_reset_dev_mode(struct bt_event *event)
  87 {
  88         BT_ASSERT(event);
  89
  90         if (event->common_context_field) {
  91                 bt_field_set_is_frozen(
  92                         event->common_context_field, false);
  93                 bt_field_reset(
  94                         event->common_context_field);
  95         }
  96
  97         if (event->specific_context_field) {
  98                 bt_field_set_is_frozen(
  99                         event->specific_context_field, false);
 100                 bt_field_reset(event->specific_context_field);
 101         }
 102
 103         if (event->payload_field) {
 104                 bt_field_set_is_frozen(
 105                         event->payload_field, false);
 106                 bt_field_reset(event->payload_field);
 107         }
 108 }
 109
 110 #ifdef BT_DEV_MODE
 111 # define bt_event_reset_dev_mode        _bt_event_reset_dev_mode
 112 #else
 113 # define bt_event_reset_dev_mode(_x)
 114 #endif
 115
 116 static inline
 117 void bt_event_reset(struct bt_event *event)
 118 {
 119         BT_ASSERT(event);
 120         BT_LIB_LOGD("Resetting event: %!+e", event);
 121         bt_event_set_is_frozen(event, false);
 122
 123         if (event->default_cs) {
 124                 bt_clock_snapshot_reset(event->default_cs);
 125         }
 126
 127         bt_object_put_no_null_check(&event->packet->base);
 128         event->packet = NULL;
 129 }
 130
 131 static inline
 132 void bt_event_recycle(struct bt_event *event)
 133 {
 134         struct bt_event_class *event_class;
 135
 136         BT_ASSERT(event);
 137         BT_LIB_LOGD("Recycling event: %!+e", event);
 138
 139         /*
 140          * Those are the important ordered steps:
 141          *
 142          * 1. Reset the event object (put any permanent reference it
 143          *    has, unfreeze it and its fields in developer mode, etc.),
 144          *    but do NOT put its class's reference. This event class
 145          *    contains the pool to which we're about to recycle this
 146          *    event object, so we must guarantee its existence thanks
 147          *    to this existing reference.
 148          *
 149          * 2. Move the event class reference to our `event_class`
 150          *    variable so that we can set the event's class member
 151          *    to NULL before recycling it. We CANNOT do this after
 152          *    we put the event class reference because this bt_object_put_ref()
 153          *    could destroy the event class, also destroying its
 154          *    event pool, thus also destroying our event object (this
 155          *    would result in an invalid write access).
 156          *
 157          * 3. Recycle the event object.
 158          *
 159          * 4. Put our event class reference.
 160          */
 161         bt_event_reset(event);
 162         event_class = event->class;
 163         BT_ASSERT(event_class);
 164         event->class = NULL;
 165         bt_object_pool_recycle_object(&event_class->event_pool, event);
 166         bt_object_put_no_null_check(&event_class->base);
 167 }
 168
 169 static inline
 170 void bt_event_set_packet(struct bt_event *event, struct bt_packet *packet)
 171 {
 172         BT_ASSERT_PRE_NON_NULL(event, "Event");
 173         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 174         BT_ASSERT_PRE_EVENT_HOT(event);
 175         BT_ASSERT_PRE(bt_event_class_borrow_stream_class(
 176                 event->class) == packet->stream->class,
 177                 "Packet's stream class and event's stream class differ: "
 178                 "%![event-]+e, %![packet-]+a", event, packet);
 179
 180         BT_ASSERT(!event->packet);
 181         event->packet = packet;
 182         bt_object_get_no_null_check_no_parent_check(&event->packet->base);
 183         BT_LIB_LOGV("Set event's packet: %![event-]+e, %![packet-]+a",
 184                 event, packet);
 185 }
 186
 187 static inline
 188 struct bt_event *bt_event_create(struct bt_event_class *event_class,
 189                 struct bt_packet *packet)
 190 {
 191         struct bt_event *event = NULL;
 192
 193         BT_ASSERT(event_class);
 194         event = bt_object_pool_create_object(&event_class->event_pool);
 195         if (unlikely(!event)) {
 196                 BT_LIB_LOGE("Cannot allocate one event from event class's event pool: "
 197                         "%![ec-]+E", event_class);
 198                 goto end;
 199         }
 200
 201         if (likely(!event->class)) {
 202                 event->class = event_class;
 203                 bt_object_get_no_null_check(&event_class->base);
 204         }
 205
 206         BT_ASSERT(packet);
 207         bt_event_set_packet(event, packet);
 208         goto end;
 209
 210 end:
 211         return event;
 212 }
 213
 214 #endif /* BABELTRACE_TRACE_IR_EVENT_INTERNAL_H */