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 <babeltrace/lib-logging-internal.h>
  25
  26 #include <babeltrace/assert-pre-internal.h>
  27 #include <babeltrace/trace-ir/field-internal.h>
  28 #include <babeltrace/trace-ir/packet-const.h>
  29 #include <babeltrace/trace-ir/packet.h>
  30 #include <babeltrace/trace-ir/packet-internal.h>
  31 #include <babeltrace/trace-ir/field-wrapper-internal.h>
  32 #include <babeltrace/trace-ir/trace.h>
  33 #include <babeltrace/trace-ir/stream-class-internal.h>
  34 #include <babeltrace/trace-ir/stream-class.h>
  35 #include <babeltrace/trace-ir/stream.h>
  36 #include <babeltrace/trace-ir/stream-internal.h>
  37 #include <babeltrace/trace-ir/clock-value-internal.h>
  38 #include <babeltrace/trace-ir/trace-internal.h>
  39 #include <babeltrace/object-internal.h>
  40 #include <babeltrace/assert-internal.h>
  41 #include <inttypes.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_header_field(struct bt_packet *packet)
  59 {
  60         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
  61         return packet->header_field ? packet->header_field->field : NULL;
  62 }
  63
  64 const struct bt_field *bt_packet_borrow_header_field_const(
  65                 const struct bt_packet *packet)
  66 {
  67         return bt_packet_borrow_header_field((void *) packet);
  68 }
  69
  70 struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet)
  71 {
  72         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
  73         return packet->context_field ? packet->context_field->field : NULL;
  74 }
  75
  76 const struct bt_field *bt_packet_borrow_context_field_const(
  77                 const struct bt_packet *packet)
  78 {
  79         return bt_packet_borrow_context_field((void *) packet);
  80 }
  81
  82 BT_HIDDEN
  83 void _bt_packet_set_is_frozen(const struct bt_packet *packet, bool is_frozen)
  84 {
  85         if (!packet) {
  86                 return;
  87         }
  88
  89         BT_LIB_LOGD("Setting packet's frozen state: %![packet-]+a, "
  90                 "is-frozen=%d", packet, is_frozen);
  91
  92         if (packet->header_field) {
  93                 BT_LOGD_STR("Setting packet's header field's frozen state.");
  94                 bt_field_set_is_frozen(packet->header_field->field,
  95                         is_frozen);
  96         }
  97
  98         if (packet->context_field) {
  99                 BT_LOGD_STR("Setting packet's context field's frozen state.");
 100                 bt_field_set_is_frozen(packet->context_field->field,
 101                         is_frozen);
 102         }
 103
 104         ((struct bt_packet *) packet)->frozen = is_frozen;
 105 }
 106
 107 static inline
 108 void reset_counter_snapshots(struct bt_packet *packet)
 109 {
 110         packet->discarded_event_counter_snapshot.base.avail =
 111                 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
 112         packet->packet_counter_snapshot.base.avail =
 113                 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
 114 }
 115
 116 static inline
 117 void reset_packet(struct bt_packet *packet)
 118 {
 119         BT_ASSERT(packet);
 120         BT_LIB_LOGD("Resetting packet: %!+a", packet);
 121         bt_packet_set_is_frozen(packet, false);
 122
 123         if (packet->header_field) {
 124                 bt_field_set_is_frozen(packet->header_field->field, false);
 125                 bt_field_reset(packet->header_field->field);
 126         }
 127
 128         if (packet->context_field) {
 129                 bt_field_set_is_frozen(packet->context_field->field, false);
 130                 bt_field_reset(packet->context_field->field);
 131         }
 132
 133         if (packet->default_beginning_cv) {
 134                 bt_clock_value_reset(packet->default_beginning_cv);
 135         }
 136
 137         if (packet->default_end_cv) {
 138                 bt_clock_value_reset(packet->default_end_cv);
 139         }
 140
 141         reset_counter_snapshots(packet);
 142 }
 143
 144 static
 145 void recycle_header_field(struct bt_field_wrapper *header_field,
 146                 struct bt_trace_class *tc)
 147 {
 148         BT_ASSERT(header_field);
 149         BT_LIB_LOGD("Recycling packet header field: "
 150                 "addr=%p, %![tc-]+T, %![field-]+f", header_field,
 151                 tc, header_field->field);
 152         bt_object_pool_recycle_object(&tc->packet_header_field_pool,
 153                 header_field);
 154 }
 155
 156 static
 157 void recycle_context_field(struct bt_field_wrapper *context_field,
 158                 struct bt_stream_class *stream_class)
 159 {
 160         BT_ASSERT(context_field);
 161         BT_LIB_LOGD("Recycling packet context field: "
 162                 "addr=%p, %![sc-]+S, %![field-]+f", context_field,
 163                 stream_class, context_field->field);
 164         bt_object_pool_recycle_object(&stream_class->packet_context_field_pool,
 165                 context_field);
 166 }
 167
 168 BT_HIDDEN
 169 void bt_packet_recycle(struct bt_packet *packet)
 170 {
 171         struct bt_stream *stream;
 172
 173         BT_ASSERT(packet);
 174         BT_LIB_LOGD("Recycling packet: %!+a", packet);
 175
 176         /*
 177          * Those are the important ordered steps:
 178          *
 179          * 1. Reset the packet object (put any permanent reference it
 180          *    has, unfreeze it and its fields in developer mode, etc.),
 181          *    but do NOT put its stream's reference. This stream
 182          *    contains the pool to which we're about to recycle this
 183          *    packet object, so we must guarantee its existence thanks
 184          *    to this existing reference.
 185          *
 186          * 2. Move the stream reference to our `stream`
 187          *    variable so that we can set the packet's stream member
 188          *    to NULL before recycling it. We CANNOT do this after
 189          *    we put the stream reference because this bt_object_put_ref()
 190          *    could destroy the stream, also destroying its
 191          *    packet pool, thus also destroying our packet object (this
 192          *    would result in an invalid write access).
 193          *
 194          * 3. Recycle the packet object.
 195          *
 196          * 4. Put our stream reference.
 197          */
 198         reset_packet(packet);
 199         stream = packet->stream;
 200         BT_ASSERT(stream);
 201         packet->stream = NULL;
 202         bt_object_pool_recycle_object(&stream->packet_pool, packet);
 203         bt_object_put_no_null_check(&stream->base);
 204 }
 205
 206 BT_HIDDEN
 207 void bt_packet_destroy(struct bt_packet *packet)
 208 {
 209         BT_LIB_LOGD("Destroying packet: %!+a", packet);
 210
 211         if (packet->header_field) {
 212                 if (packet->stream) {
 213                         BT_LOGD_STR("Recycling packet's header field.");
 214                         recycle_header_field(packet->header_field,
 215                                 bt_stream_class_borrow_trace_class_inline(
 216                                         packet->stream->class));
 217                 } else {
 218                         bt_field_wrapper_destroy(packet->header_field);
 219                 }
 220
 221                 packet->header_field = NULL;
 222         }
 223
 224         if (packet->context_field) {
 225                 if (packet->stream) {
 226                         BT_LOGD_STR("Recycling packet's context field.");
 227                         recycle_context_field(packet->context_field,
 228                                 packet->stream->class);
 229                 } else {
 230                         bt_field_wrapper_destroy(packet->context_field);
 231                 }
 232
 233                 packet->context_field = NULL;
 234         }
 235
 236         if (packet->default_beginning_cv) {
 237                 BT_LOGD_STR("Recycling beginning clock value.");
 238                 bt_clock_value_recycle(packet->default_beginning_cv);
 239                 packet->default_beginning_cv = NULL;
 240         }
 241
 242         if (packet->default_end_cv) {
 243                 BT_LOGD_STR("Recycling end clock value.");
 244                 bt_clock_value_recycle(packet->default_end_cv);
 245                 packet->default_end_cv = NULL;
 246         }
 247
 248         BT_LOGD_STR("Putting packet's stream.");
 249         BT_OBJECT_PUT_REF_AND_RESET(packet->stream);
 250         g_free(packet);
 251 }
 252
 253 BT_HIDDEN
 254 struct bt_packet *bt_packet_new(struct bt_stream *stream)
 255 {
 256         struct bt_packet *packet = NULL;
 257         struct bt_trace_class *trace_class = NULL;
 258
 259         BT_ASSERT(stream);
 260         BT_LIB_LOGD("Creating packet object: %![stream-]+s", stream);
 261         packet = g_new0(struct bt_packet, 1);
 262         if (!packet) {
 263                 BT_LOGE_STR("Failed to allocate one packet object.");
 264                 goto error;
 265         }
 266
 267         bt_object_init_shared(&packet->base,
 268                 (bt_object_release_func) bt_packet_recycle);
 269         packet->stream = stream;
 270         bt_object_get_no_null_check(stream);
 271         trace_class = bt_stream_class_borrow_trace_class_inline(stream->class);
 272         BT_ASSERT(trace_class);
 273
 274         if (trace_class->packet_header_fc) {
 275                 BT_LOGD_STR("Creating initial packet header field.");
 276                 packet->header_field = bt_field_wrapper_create(
 277                         &trace_class->packet_header_field_pool,
 278                         trace_class->packet_header_fc);
 279                 if (!packet->header_field) {
 280                         BT_LOGE_STR("Cannot create packet header field wrapper.");
 281                         goto error;
 282                 }
 283         }
 284
 285         if (stream->class->packet_context_fc) {
 286                 BT_LOGD_STR("Creating initial packet context field.");
 287                 packet->context_field = bt_field_wrapper_create(
 288                         &stream->class->packet_context_field_pool,
 289                         stream->class->packet_context_fc);
 290                 if (!packet->context_field) {
 291                         BT_LOGE_STR("Cannot create packet context field wrapper.");
 292                         goto error;
 293                 }
 294         }
 295
 296         if (stream->class->default_clock_class) {
 297                 if (stream->class->packets_have_default_beginning_cv) {
 298                         packet->default_beginning_cv = bt_clock_value_create(
 299                                 stream->class->default_clock_class);
 300                         if (!packet->default_beginning_cv) {
 301                                 /* bt_clock_value_create() logs errors */
 302                                 goto error;
 303                         }
 304                 }
 305
 306                 if (stream->class->packets_have_default_end_cv) {
 307                         packet->default_end_cv = bt_clock_value_create(
 308                                 stream->class->default_clock_class);
 309                         if (!packet->default_end_cv) {
 310                                 /* bt_clock_value_create() logs errors */
 311                                 goto error;
 312                         }
 313                 }
 314         }
 315
 316         reset_counter_snapshots(packet);
 317         BT_LIB_LOGD("Created packet object: %!+a", packet);
 318         goto end;
 319
 320 error:
 321         BT_OBJECT_PUT_REF_AND_RESET(packet);
 322
 323 end:
 324         return packet;
 325 }
 326
 327 struct bt_packet *bt_packet_create(struct bt_stream *stream)
 328 {
 329         struct bt_packet *packet = NULL;
 330
 331         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
 332         packet = bt_object_pool_create_object(&stream->packet_pool);
 333         if (unlikely(!packet)) {
 334                 BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
 335                         "%![stream-]+s", stream);
 336                 goto end;
 337         }
 338
 339         if (likely(!packet->stream)) {
 340                 packet->stream = stream;
 341                 bt_object_get_no_null_check_no_parent_check(
 342                         &packet->stream->base);
 343         }
 344
 345 end:
 346         return (void *) packet;
 347 }
 348
 349 int bt_packet_move_header_field(struct bt_packet *packet,
 350                 struct bt_packet_header_field *header_field)
 351 {
 352         struct bt_trace_class *tc;
 353         struct bt_field_wrapper *field_wrapper = (void *) header_field;
 354
 355         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 356         BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
 357         BT_ASSERT_PRE_PACKET_HOT(packet);
 358         tc = bt_stream_class_borrow_trace_class_inline(packet->stream->class);
 359         BT_ASSERT_PRE(tc->packet_header_fc,
 360                 "Trace class has no packet header field class: %!+T", tc);
 361         BT_ASSERT_PRE(field_wrapper->field->class ==
 362                 tc->packet_header_fc,
 363                 "Unexpected packet header field's class: "
 364                 "%![fc-]+F, %![expected-fc-]+F", field_wrapper->field->class,
 365                 tc->packet_header_fc);
 366
 367         /* Recycle current header field: always exists */
 368         BT_ASSERT(packet->header_field);
 369         recycle_header_field(packet->header_field, tc);
 370
 371         /* Move new field */
 372         packet->header_field = field_wrapper;
 373         return 0;
 374 }
 375
 376 int bt_packet_move_context_field(struct bt_packet *packet,
 377                 struct bt_packet_context_field *context_field)
 378 {
 379         struct bt_stream_class *stream_class;
 380         struct bt_field_wrapper *field_wrapper = (void *) context_field;
 381
 382         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 383         BT_ASSERT_PRE_NON_NULL(field_wrapper, "Context field");
 384         BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
 385         stream_class = packet->stream->class;
 386         BT_ASSERT_PRE(stream_class->packet_context_fc,
 387                 "Stream class has no packet context field class: %!+S",
 388                 stream_class);
 389         BT_ASSERT_PRE(field_wrapper->field->class ==
 390                 stream_class->packet_context_fc,
 391                 "Unexpected packet header field's class: "
 392                 "%![fc-]+F, %![expected-fc-]+F", field_wrapper->field->class,
 393                 stream_class->packet_context_fc);
 394
 395         /* Recycle current context field: always exists */
 396         BT_ASSERT(packet->context_field);
 397         recycle_context_field(packet->context_field, stream_class);
 398
 399         /* Move new field */
 400         packet->context_field = field_wrapper;
 401         return 0;
 402 }
 403
 404 void bt_packet_set_default_beginning_clock_value(struct bt_packet *packet,
 405                 uint64_t value_cycles)
 406 {
 407         struct bt_stream_class *sc;
 408
 409         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 410         BT_ASSERT_PRE_PACKET_HOT(packet);
 411         sc = packet->stream->class;
 412         BT_ASSERT(sc);
 413         BT_ASSERT_PRE(sc->default_clock_class,
 414                 "Packet's stream class has no default clock class: "
 415                 "%![packet-]+a, %![sc-]+S", packet, sc);
 416         BT_ASSERT_PRE(sc->packets_have_default_beginning_cv,
 417                 "Packet's stream class indicates that its packets have "
 418                 "no default beginning clock value: %![packet-]+a, %![sc-]+S",
 419                 packet, sc);
 420         BT_ASSERT(packet->default_beginning_cv);
 421         bt_clock_value_set_value_inline(packet->default_beginning_cv,
 422                 value_cycles);
 423         BT_LIB_LOGV("Set packet's default beginning clock value: "
 424                 "%![packet-]+a, value=%" PRIu64, packet, value_cycles);
 425 }
 426
 427 enum bt_clock_value_status bt_packet_borrow_default_beginning_clock_value(
 428                 const struct bt_packet *packet,
 429                 const struct bt_clock_value **clock_value)
 430 {
 431         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 432         BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
 433         *clock_value = packet->default_beginning_cv;
 434         return BT_CLOCK_VALUE_STATUS_KNOWN;
 435 }
 436
 437 void bt_packet_set_default_end_clock_value(struct bt_packet *packet,
 438                 uint64_t value_cycles)
 439 {
 440         struct bt_stream_class *sc;
 441
 442         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 443         BT_ASSERT_PRE_PACKET_HOT(packet);
 444         sc = packet->stream->class;
 445         BT_ASSERT(sc);
 446         BT_ASSERT_PRE(sc->default_clock_class,
 447                 "Packet's stream class has no default clock class: "
 448                 "%![packet-]+a, %![sc-]+S", packet, sc);
 449         BT_ASSERT_PRE(sc->packets_have_default_end_cv,
 450                 "Packet's stream class indicates that its packets have "
 451                 "no default end clock value: %![packet-]+a, %![sc-]+S",
 452                 packet, sc);
 453         BT_ASSERT(packet->default_end_cv);
 454         bt_clock_value_set_value_inline(packet->default_end_cv, value_cycles);
 455         BT_LIB_LOGV("Set packet's default end clock value: "
 456                 "%![packet-]+a, value=%" PRIu64, packet, value_cycles);
 457 }
 458
 459 enum bt_clock_value_status bt_packet_borrow_default_end_clock_value(
 460                 const struct bt_packet *packet,
 461                 const struct bt_clock_value **clock_value)
 462 {
 463         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 464         BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
 465         *clock_value = packet->default_end_cv;
 466         return BT_CLOCK_VALUE_STATUS_KNOWN;
 467 }
 468
 469 enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
 470                 const struct bt_packet *packet, uint64_t *value)
 471 {
 472         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 473         BT_ASSERT_PRE_NON_NULL(value, "Value (output)");
 474         *value = packet->discarded_event_counter_snapshot.value;
 475         return packet->discarded_event_counter_snapshot.base.avail;
 476 }
 477
 478 void bt_packet_set_discarded_event_counter_snapshot(struct bt_packet *packet,
 479                 uint64_t value)
 480 {
 481         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 482         BT_ASSERT_PRE_PACKET_HOT(packet);
 483         BT_ASSERT_PRE(packet->stream->class->packets_have_discarded_event_counter_snapshot,
 484                 "Packet's stream's discarded event counter is not enabled: "
 485                 "%![packet-]+a", packet);
 486         bt_property_uint_set(&packet->discarded_event_counter_snapshot, value);
 487 }
 488
 489 enum bt_property_availability bt_packet_get_packet_counter_snapshot(
 490                 const struct bt_packet *packet, uint64_t *value)
 491 {
 492         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 493         BT_ASSERT_PRE_NON_NULL(value, "Value (output)");
 494         *value = packet->packet_counter_snapshot.value;
 495         return packet->packet_counter_snapshot.base.avail;
 496 }
 497
 498 void bt_packet_set_packet_counter_snapshot(struct bt_packet *packet,
 499                 uint64_t value)
 500 {
 501         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 502         BT_ASSERT_PRE_PACKET_HOT(packet);
 503         BT_ASSERT_PRE(packet->stream->class->packets_have_packet_counter_snapshot,
 504                 "Packet's stream's packet counter is not enabled: "
 505                 "%![packet-]+a", packet);
 506         bt_property_uint_set(&packet->packet_counter_snapshot, value);
 507 }
 508
 509 void bt_packet_get_ref(const struct bt_packet *packet)
 510 {
 511         bt_object_get_ref(packet);
 512 }
 513
 514 void bt_packet_put_ref(const struct bt_packet *packet)
 515 {
 516         bt_object_put_ref(packet);
 517 }