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