src/lib/trace-ir/packet.c

   1 /*
   2  * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 #define BT_LOG_TAG "PACKET"
  24 #include "lib/lib-logging.h"
  25
  26 #include "lib/assert-pre.h"
  27 #include <babeltrace2/trace-ir/packet-const.h>
  28 #include <babeltrace2/trace-ir/packet.h>
  29 #include <babeltrace2/trace-ir/trace.h>
  30 #include <babeltrace2/trace-ir/stream-class.h>
  31 #include <babeltrace2/trace-ir/stream.h>
  32 #include "lib/object.h"
  33 #include "common/assert.h"
  34 #include <inttypes.h>
  35
  36 #include "field.h"
  37 #include "field-wrapper.h"
  38 #include "packet.h"
  39 #include "stream-class.h"
  40 #include "stream.h"
  41 #include "trace.h"
  42
  43 #define BT_ASSERT_PRE_PACKET_HOT(_packet) \
  44         BT_ASSERT_PRE_HOT((_packet), "Packet", ": %!+a", (_packet))
  45
  46 struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet)
  47 {
  48         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
  49         return packet->stream;
  50 }
  51
  52 const struct bt_stream *bt_packet_borrow_stream_const(
  53                 const struct bt_packet *packet)
  54 {
  55         return bt_packet_borrow_stream((void *) packet);
  56 }
  57
  58 struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet)
  59 {
  60         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
  61         return packet->context_field ? packet->context_field->field : NULL;
  62 }
  63
  64 const struct bt_field *bt_packet_borrow_context_field_const(
  65                 const struct bt_packet *packet)
  66 {
  67         return bt_packet_borrow_context_field((void *) packet);
  68 }
  69
  70 BT_HIDDEN
  71 void _bt_packet_set_is_frozen(const struct bt_packet *packet, bool is_frozen)
  72 {
  73         if (!packet) {
  74                 return;
  75         }
  76
  77         BT_LIB_LOGD("Setting packet's frozen state: %![packet-]+a, "
  78                 "is-frozen=%d", packet, is_frozen);
  79
  80         if (packet->context_field) {
  81                 BT_LOGD_STR("Setting packet's context field's frozen state.");
  82                 bt_field_set_is_frozen(packet->context_field->field,
  83                         is_frozen);
  84         }
  85
  86         ((struct bt_packet *) packet)->frozen = is_frozen;
  87 }
  88
  89 static inline
  90 void reset_packet(struct bt_packet *packet)
  91 {
  92         BT_ASSERT(packet);
  93         BT_LIB_LOGD("Resetting packet: %!+a", packet);
  94         bt_packet_set_is_frozen(packet, false);
  95
  96         if (packet->context_field) {
  97                 bt_field_set_is_frozen(packet->context_field->field, false);
  98                 bt_field_reset(packet->context_field->field);
  99         }
 100 }
 101
 102 static
 103 void recycle_context_field(struct bt_field_wrapper *context_field,
 104                 struct bt_stream_class *stream_class)
 105 {
 106         BT_ASSERT(context_field);
 107         BT_LIB_LOGD("Recycling packet context field: "
 108                 "addr=%p, %![sc-]+S, %![field-]+f", context_field,
 109                 stream_class, context_field->field);
 110         bt_object_pool_recycle_object(&stream_class->packet_context_field_pool,
 111                 context_field);
 112 }
 113
 114 BT_HIDDEN
 115 void bt_packet_recycle(struct bt_packet *packet)
 116 {
 117         struct bt_stream *stream;
 118
 119         BT_ASSERT(packet);
 120         BT_LIB_LOGD("Recycling packet: %!+a", packet);
 121
 122         /*
 123          * Those are the important ordered steps:
 124          *
 125          * 1. Reset the packet object (put any permanent reference it
 126          *    has, unfreeze it and its fields in developer mode, etc.),
 127          *    but do NOT put its stream's reference. This stream
 128          *    contains the pool to which we're about to recycle this
 129          *    packet object, so we must guarantee its existence thanks
 130          *    to this existing reference.
 131          *
 132          * 2. Move the stream reference to our `stream`
 133          *    variable so that we can set the packet's stream member
 134          *    to NULL before recycling it. We CANNOT do this after
 135          *    we put the stream reference because this bt_object_put_ref()
 136          *    could destroy the stream, also destroying its
 137          *    packet pool, thus also destroying our packet object (this
 138          *    would result in an invalid write access).
 139          *
 140          * 3. Recycle the packet object.
 141          *
 142          * 4. Put our stream reference.
 143          */
 144         reset_packet(packet);
 145         stream = packet->stream;
 146         BT_ASSERT(stream);
 147         packet->stream = NULL;
 148         bt_object_pool_recycle_object(&stream->packet_pool, packet);
 149         bt_object_put_no_null_check(&stream->base);
 150 }
 151
 152 BT_HIDDEN
 153 void bt_packet_destroy(struct bt_packet *packet)
 154 {
 155         BT_LIB_LOGD("Destroying packet: %!+a", packet);
 156
 157         if (packet->context_field) {
 158                 if (packet->stream) {
 159                         BT_LOGD_STR("Recycling packet's context field.");
 160                         recycle_context_field(packet->context_field,
 161                                 packet->stream->class);
 162                 } else {
 163                         bt_field_wrapper_destroy(packet->context_field);
 164                 }
 165
 166                 packet->context_field = NULL;
 167         }
 168
 169         BT_LOGD_STR("Putting packet's stream.");
 170         BT_OBJECT_PUT_REF_AND_RESET(packet->stream);
 171         g_free(packet);
 172 }
 173
 174 BT_HIDDEN
 175 struct bt_packet *bt_packet_new(struct bt_stream *stream)
 176 {
 177         struct bt_packet *packet = NULL;
 178         struct bt_trace_class *trace_class = NULL;
 179
 180         BT_ASSERT(stream);
 181         BT_LIB_LOGD("Creating packet object: %![stream-]+s", stream);
 182         packet = g_new0(struct bt_packet, 1);
 183         if (!packet) {
 184                 BT_LOGE_STR("Failed to allocate one packet object.");
 185                 goto error;
 186         }
 187
 188         bt_object_init_shared(&packet->base,
 189                 (bt_object_release_func) bt_packet_recycle);
 190         packet->stream = stream;
 191         bt_object_get_no_null_check(stream);
 192         trace_class = bt_stream_class_borrow_trace_class_inline(stream->class);
 193         BT_ASSERT(trace_class);
 194
 195         if (stream->class->packet_context_fc) {
 196                 BT_LOGD_STR("Creating initial packet context field.");
 197                 packet->context_field = bt_field_wrapper_create(
 198                         &stream->class->packet_context_field_pool,
 199                         stream->class->packet_context_fc);
 200                 if (!packet->context_field) {
 201                         BT_LOGE_STR("Cannot create packet context field wrapper.");
 202                         goto error;
 203                 }
 204         }
 205
 206         BT_LIB_LOGD("Created packet object: %!+a", packet);
 207         goto end;
 208
 209 error:
 210         BT_OBJECT_PUT_REF_AND_RESET(packet);
 211
 212 end:
 213         return packet;
 214 }
 215
 216 struct bt_packet *bt_packet_create(const struct bt_stream *c_stream)
 217 {
 218         struct bt_packet *packet = NULL;
 219         struct bt_stream *stream = (void *) c_stream;
 220
 221         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 222         packet = bt_object_pool_create_object(&stream->packet_pool);
 223         if (unlikely(!packet)) {
 224                 BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
 225                         "%![stream-]+s", stream);
 226                 goto end;
 227         }
 228
 229         if (likely(!packet->stream)) {
 230                 packet->stream = stream;
 231                 bt_object_get_no_null_check_no_parent_check(
 232                         &packet->stream->base);
 233         }
 234
 235 end:
 236         return (void *) packet;
 237 }
 238
 239 enum bt_packet_status bt_packet_move_context_field(struct bt_packet *packet,
 240                 struct bt_packet_context_field *context_field)
 241 {
 242         struct bt_stream_class *stream_class;
 243         struct bt_field_wrapper *field_wrapper = (void *) context_field;
 244
 245         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 246         BT_ASSERT_PRE_NON_NULL(field_wrapper, "Context field");
 247         BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
 248         stream_class = packet->stream->class;
 249         BT_ASSERT_PRE(stream_class->packet_context_fc,
 250                 "Stream class has no packet context field class: %!+S",
 251                 stream_class);
 252         BT_ASSERT_PRE(field_wrapper->field->class ==
 253                 stream_class->packet_context_fc,
 254                 "Unexpected packet context field's class: "
 255                 "%![fc-]+F, %![expected-fc-]+F", field_wrapper->field->class,
 256                 stream_class->packet_context_fc);
 257
 258         /* Recycle current context field: always exists */
 259         BT_ASSERT(packet->context_field);
 260         recycle_context_field(packet->context_field, stream_class);
 261
 262         /* Move new field */
 263         packet->context_field = field_wrapper;
 264         return BT_PACKET_STATUS_OK;
 265 }
 266
 267 void bt_packet_get_ref(const struct bt_packet *packet)
 268 {
 269         bt_object_get_ref(packet);
 270 }
 271
 272 void bt_packet_put_ref(const struct bt_packet *packet)
 273 {
 274         bt_object_put_ref(packet);
 275 }