include/babeltrace2/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 <babeltrace2/lib-logging-internal.h> before including this file.
  30 #endif
  31
  32 #include <babeltrace2/assert-pre-internal.h>
  33 #include <babeltrace2/babeltrace-internal.h>
  34 #include <babeltrace2/value.h>
  35 #include <babeltrace2/trace-ir/stream-class.h>
  36 #include <babeltrace2/trace-ir/stream.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/field.h>
  41 #include <babeltrace2/trace-ir/field-internal.h>
  42 #include <babeltrace2/trace-ir/event-class-internal.h>
  43 #include <babeltrace2/trace-ir/field-wrapper-internal.h>
  44 #include <babeltrace2/object-internal.h>
  45 #include <babeltrace2/assert-internal.h>
  46 #include <glib.h>
  47
  48 #define BT_ASSERT_PRE_EVENT_HOT(_event) \
  49         BT_ASSERT_PRE_HOT(((const struct bt_event *) (_event)),         \
  50                 "Event", ": %!+e", (_event))
  51
  52 struct bt_event {
  53         struct bt_object base;
  54
  55         /* Owned by this */
  56         struct bt_event_class *class;
  57
  58         /* Owned by this */
  59         struct bt_packet *packet;
  60
  61         struct bt_field *common_context_field;
  62         struct bt_field *specific_context_field;
  63         struct bt_field *payload_field;
  64         bool frozen;
  65 };
  66
  67 BT_HIDDEN
  68 void bt_event_destroy(struct bt_event *event);
  69
  70 BT_HIDDEN
  71 struct bt_event *bt_event_new(struct bt_event_class *event_class);
  72
  73 BT_HIDDEN
  74 void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen);
  75
  76 #ifdef BT_DEV_MODE
  77 # define bt_event_set_is_frozen         _bt_event_set_is_frozen
  78 #else
  79 # define bt_event_set_is_frozen(_event, _is_frozen)
  80 #endif
  81
  82 BT_UNUSED
  83 static inline
  84 void _bt_event_reset_dev_mode(struct bt_event *event)
  85 {
  86         BT_ASSERT(event);
  87
  88         if (event->common_context_field) {
  89                 bt_field_set_is_frozen(
  90                         event->common_context_field, false);
  91                 bt_field_reset(
  92                         event->common_context_field);
  93         }
  94
  95         if (event->specific_context_field) {
  96                 bt_field_set_is_frozen(
  97                         event->specific_context_field, false);
  98                 bt_field_reset(event->specific_context_field);
  99         }
 100
 101         if (event->payload_field) {
 102                 bt_field_set_is_frozen(
 103                         event->payload_field, false);
 104                 bt_field_reset(event->payload_field);
 105         }
 106 }
 107
 108 #ifdef BT_DEV_MODE
 109 # define bt_event_reset_dev_mode        _bt_event_reset_dev_mode
 110 #else
 111 # define bt_event_reset_dev_mode(_x)
 112 #endif
 113
 114 static inline
 115 void bt_event_reset(struct bt_event *event)
 116 {
 117         BT_ASSERT(event);
 118         BT_LIB_LOGD("Resetting event: %!+e", event);
 119         bt_event_set_is_frozen(event, false);
 120         bt_object_put_no_null_check(&event->packet->base);
 121         event->packet = NULL;
 122 }
 123
 124 static inline
 125 void bt_event_recycle(struct bt_event *event)
 126 {
 127         struct bt_event_class *event_class;
 128
 129         BT_ASSERT(event);
 130         BT_LIB_LOGD("Recycling event: %!+e", event);
 131
 132         /*
 133          * Those are the important ordered steps:
 134          *
 135          * 1. Reset the event object (put any permanent reference it
 136          *    has, unfreeze it and its fields in developer mode, etc.),
 137          *    but do NOT put its class's reference. This event class
 138          *    contains the pool to which we're about to recycle this
 139          *    event object, so we must guarantee its existence thanks
 140          *    to this existing reference.
 141          *
 142          * 2. Move the event class reference to our `event_class`
 143          *    variable so that we can set the event's class member
 144          *    to NULL before recycling it. We CANNOT do this after
 145          *    we put the event class reference because this bt_object_put_ref()
 146          *    could destroy the event class, also destroying its
 147          *    event pool, thus also destroying our event object (this
 148          *    would result in an invalid write access).
 149          *
 150          * 3. Recycle the event object.
 151          *
 152          * 4. Put our event class reference.
 153          */
 154         bt_event_reset(event);
 155         event_class = event->class;
 156         BT_ASSERT(event_class);
 157         event->class = NULL;
 158         bt_object_pool_recycle_object(&event_class->event_pool, event);
 159         bt_object_put_no_null_check(&event_class->base);
 160 }
 161
 162 static inline
 163 void bt_event_set_packet(struct bt_event *event, struct bt_packet *packet)
 164 {
 165         BT_ASSERT_PRE_NON_NULL(event, "Event");
 166         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 167         BT_ASSERT_PRE_EVENT_HOT(event);
 168         BT_ASSERT_PRE(bt_event_class_borrow_stream_class(
 169                 event->class) == packet->stream->class,
 170                 "Packet's stream class and event's stream class differ: "
 171                 "%![event-]+e, %![packet-]+a", event, packet);
 172
 173         BT_ASSERT(!event->packet);
 174         event->packet = packet;
 175         bt_object_get_no_null_check_no_parent_check(&event->packet->base);
 176         BT_LIB_LOGV("Set event's packet: %![event-]+e, %![packet-]+a",
 177                 event, packet);
 178 }
 179
 180 static inline
 181 struct bt_event *bt_event_create(struct bt_event_class *event_class,
 182                 struct bt_packet *packet)
 183 {
 184         struct bt_event *event = NULL;
 185
 186         BT_ASSERT(event_class);
 187         event = bt_object_pool_create_object(&event_class->event_pool);
 188         if (unlikely(!event)) {
 189                 BT_LIB_LOGE("Cannot allocate one event from event class's event pool: "
 190                         "%![ec-]+E", event_class);
 191                 goto end;
 192         }
 193
 194         if (likely(!event->class)) {
 195                 event->class = event_class;
 196                 bt_object_get_no_null_check(&event_class->base);
 197         }
 198
 199         BT_ASSERT(packet);
 200         bt_event_set_packet(event, packet);
 201         goto end;
 202
 203 end:
 204         return event;
 205 }
 206
 207 #endif /* BABELTRACE_TRACE_IR_EVENT_INTERNAL_H */