src/lib/graph/message/packet.c

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   5  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   6  */
   7
   8 #define BT_LOG_TAG "LIB/MSG-PACKET"
   9 #include "lib/logging.h"
  10
  11 #include <stdbool.h>
  12
  13 #include "lib/assert-cond.h"
  14 #include "compat/compiler.h"
  15 #include <babeltrace2/trace-ir/packet.h>
  16 #include "lib/trace-ir/packet.h"
  17 #include <babeltrace2/trace-ir/stream-class.h>
  18 #include <babeltrace2/trace-ir/stream.h>
  19 #include "lib/trace-ir/stream.h"
  20 #include "lib/trace-ir/stream-class.h"
  21 #include "lib/graph/graph.h"
  22 #include <babeltrace2/graph/message.h>
  23 #include "common/assert.h"
  24 #include "lib/object.h"
  25 #include <inttypes.h>
  26
  27 #include "packet.h"
  28
  29 #define BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(_msg)                 \
  30         BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg),               \
  31                 "packet-beginning", BT_MESSAGE_TYPE_PACKET_BEGINNING)
  32
  33 #define BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(_msg)                       \
  34         BT_ASSERT_PRE_DEV_MSG_HAS_TYPE("message", (_msg),               \
  35                 "packet-end", BT_MESSAGE_TYPE_PACKET_END)
  36
  37 static inline
  38 struct bt_message *new_packet_message(struct bt_graph *graph,
  39                 enum bt_message_type type, bt_object_release_func recycle_func)
  40 {
  41         struct bt_message_packet *message;
  42
  43         message = g_new0(struct bt_message_packet, 1);
  44         if (!message) {
  45                 BT_LIB_LOGE_APPEND_CAUSE(
  46                         "Failed to allocate one packet message.");
  47                 goto error;
  48         }
  49
  50         bt_message_init(&message->parent, type, recycle_func, graph);
  51         goto end;
  52
  53 error:
  54         BT_OBJECT_PUT_REF_AND_RESET(message);
  55
  56 end:
  57         return (void *) message;
  58 }
  59
  60 BT_HIDDEN
  61 struct bt_message *bt_message_packet_beginning_new(struct bt_graph *graph)
  62 {
  63         return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_BEGINNING,
  64                 (bt_object_release_func) bt_message_packet_beginning_recycle);
  65 }
  66
  67 BT_HIDDEN
  68 struct bt_message *bt_message_packet_end_new(struct bt_graph *graph)
  69 {
  70         return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_END,
  71                 (bt_object_release_func) bt_message_packet_end_recycle);
  72 }
  73
  74 static inline
  75 struct bt_message *create_packet_message(
  76                 struct bt_message_iterator *msg_iter,
  77                 struct bt_packet *packet, struct bt_object_pool *pool,
  78                 bool with_cs, uint64_t raw_value, const char *api_func)
  79 {
  80         struct bt_message_packet *message = NULL;
  81         struct bt_stream *stream;
  82         struct bt_stream_class *stream_class;
  83         bool need_cs;
  84
  85         BT_ASSERT(msg_iter);
  86         BT_ASSERT_PRE_PACKET_NON_NULL_FROM_FUNC(api_func, packet);
  87         stream = bt_packet_borrow_stream(packet);
  88         BT_ASSERT(stream);
  89         stream_class = bt_stream_borrow_class(stream);
  90         BT_ASSERT(stream_class);
  91
  92         /*
  93          * It's not possible to create a packet from a stream of which
  94          * the class indicates that packets are not supported.
  95          */
  96         BT_ASSERT(stream_class->supports_packets);
  97
  98         if (pool == &msg_iter->graph->packet_begin_msg_pool) {
  99                 need_cs = stream_class->packets_have_beginning_default_clock_snapshot;
 100         } else {
 101                 need_cs = stream_class->packets_have_end_default_clock_snapshot;
 102         }
 103
 104         /*
 105          * `packet_has_default_clock_snapshot` implies that the stream
 106          * class has a default clock class (precondition).
 107          */
 108         BT_ASSERT_PRE_FROM_FUNC(api_func, "with-default-clock-snapshot",
 109                 need_cs ? with_cs : true,
 110                 "Unexpected stream class configuration when creating "
 111                 "a packet beginning or end message: "
 112                 "a default clock snapshot is needed, but none was provided: "
 113                 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
 114                 "cs-val=%" PRIu64,
 115                 stream, stream_class, with_cs, raw_value);
 116         BT_ASSERT_PRE_FROM_FUNC(api_func, "without-default-clock-snapshot",
 117                 !need_cs ? !with_cs : true,
 118                 "Unexpected stream class configuration when creating "
 119                 "a packet beginning or end message: "
 120                 "no default clock snapshot is needed, but one was provided: "
 121                 "%![stream-]+s, %![sc-]+S, with-cs=%d, "
 122                 "cs-val=%" PRIu64,
 123                 stream, stream_class, with_cs, raw_value);
 124         BT_LIB_LOGD("Creating packet message object: "
 125                 "%![packet-]+a, %![stream-]+s, %![sc-]+S",
 126                 packet, stream, stream_class);
 127         message = (void *) bt_message_create_from_pool(pool, msg_iter->graph);
 128         if (!message) {
 129                 /* bt_message_create_from_pool() logs errors */
 130                 goto end;
 131         }
 132
 133         if (with_cs) {
 134                 BT_ASSERT(stream_class->default_clock_class);
 135                 message->default_cs = bt_clock_snapshot_create(
 136                         stream_class->default_clock_class);
 137                 if (!message->default_cs) {
 138                         bt_object_put_ref_no_null_check(message);
 139                         message = NULL;
 140                         goto end;
 141                 }
 142
 143                 bt_clock_snapshot_set_raw_value(message->default_cs, raw_value);
 144         }
 145
 146         BT_ASSERT(!message->packet);
 147         message->packet = packet;
 148         bt_object_get_ref_no_null_check_no_parent_check(
 149                 &message->packet->base);
 150         bt_packet_set_is_frozen(packet, true);
 151         BT_LIB_LOGD("Created packet message object: "
 152                 "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
 153                 message, packet, stream, stream_class);
 154         goto end;
 155
 156 end:
 157         return (void *) message;
 158 }
 159
 160 struct bt_message *bt_message_packet_beginning_create(
 161                 struct bt_self_message_iterator *self_msg_iter,
 162                 const struct bt_packet *packet)
 163 {
 164         struct bt_message_iterator *msg_iter =
 165                 (void *) self_msg_iter;
 166
 167         BT_ASSERT_PRE_DEV_NO_ERROR();
 168         BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter);
 169         return create_packet_message(msg_iter, (void *) packet,
 170                 &msg_iter->graph->packet_begin_msg_pool, false, 0, __func__);
 171 }
 172
 173 struct bt_message *bt_message_packet_beginning_create_with_default_clock_snapshot(
 174                 struct bt_self_message_iterator *self_msg_iter,
 175                 const struct bt_packet *packet, uint64_t raw_value)
 176 {
 177         struct bt_message_iterator *msg_iter =
 178                 (void *) self_msg_iter;
 179
 180         BT_ASSERT_PRE_DEV_NO_ERROR();
 181         BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter);
 182         return create_packet_message(msg_iter, (void *) packet,
 183                 &msg_iter->graph->packet_begin_msg_pool, true, raw_value,
 184                 __func__);
 185 }
 186
 187 struct bt_message *bt_message_packet_end_create(
 188                 struct bt_self_message_iterator *self_msg_iter,
 189                 const struct bt_packet *packet)
 190 {
 191         struct bt_message_iterator *msg_iter =
 192                 (void *) self_msg_iter;
 193
 194         BT_ASSERT_PRE_DEV_NO_ERROR();
 195         BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter);
 196         return create_packet_message(msg_iter, (void *) packet,
 197                 &msg_iter->graph->packet_end_msg_pool, false, 0, __func__);
 198 }
 199
 200 struct bt_message *bt_message_packet_end_create_with_default_clock_snapshot(
 201                 struct bt_self_message_iterator *self_msg_iter,
 202                 const struct bt_packet *packet, uint64_t raw_value)
 203 {
 204         struct bt_message_iterator *msg_iter =
 205                 (void *) self_msg_iter;
 206
 207         BT_ASSERT_PRE_DEV_NO_ERROR();
 208         BT_ASSERT_PRE_MSG_ITER_NON_NULL(msg_iter);
 209         return create_packet_message(msg_iter, (void *) packet,
 210                 &msg_iter->graph->packet_end_msg_pool, true, raw_value,
 211                 __func__);
 212 }
 213
 214 BT_HIDDEN
 215 void bt_message_packet_destroy(struct bt_message *msg)
 216 {
 217         struct bt_message_packet *packet_msg = (void *) msg;
 218
 219         BT_LIB_LOGD("Destroying packet message: %!+n", msg);
 220         BT_LIB_LOGD("Putting packet: %!+a", packet_msg->packet);
 221         BT_OBJECT_PUT_REF_AND_RESET(packet_msg->packet);
 222
 223         if (packet_msg->default_cs) {
 224                 bt_clock_snapshot_recycle(packet_msg->default_cs);
 225                 packet_msg->default_cs = NULL;
 226         }
 227
 228         g_free(msg);
 229 }
 230
 231 static inline
 232 void recycle_packet_message(struct bt_message *msg, struct bt_object_pool *pool)
 233 {
 234         struct bt_message_packet *packet_msg = (void *) msg;
 235
 236         BT_LIB_LOGD("Recycling packet message: %!+n", msg);
 237         bt_message_reset(msg);
 238         bt_object_put_ref_no_null_check(&packet_msg->packet->base);
 239
 240         if (packet_msg->default_cs) {
 241                 bt_clock_snapshot_recycle(packet_msg->default_cs);
 242                 packet_msg->default_cs = NULL;
 243         }
 244
 245         packet_msg->packet = NULL;
 246         msg->graph = NULL;
 247         bt_object_pool_recycle_object(pool, msg);
 248 }
 249
 250 BT_HIDDEN
 251 void bt_message_packet_beginning_recycle(struct bt_message *msg)
 252 {
 253         BT_ASSERT(msg);
 254
 255         if (G_UNLIKELY(!msg->graph)) {
 256                 bt_message_packet_destroy(msg);
 257                 return;
 258         }
 259
 260         recycle_packet_message(msg, &msg->graph->packet_begin_msg_pool);
 261 }
 262
 263 BT_HIDDEN
 264 void bt_message_packet_end_recycle(struct bt_message *msg)
 265 {
 266         BT_ASSERT(msg);
 267
 268         if (G_UNLIKELY(!msg->graph)) {
 269                 bt_message_packet_destroy(msg);
 270                 return;
 271         }
 272
 273         recycle_packet_message(msg, &msg->graph->packet_end_msg_pool);
 274 }
 275
 276 struct bt_packet *bt_message_packet_beginning_borrow_packet(
 277                 struct bt_message *message)
 278 {
 279         struct bt_message_packet *packet_msg = (void *) message;
 280
 281         BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
 282         BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(message);
 283         return packet_msg->packet;
 284 }
 285
 286 const struct bt_packet *bt_message_packet_beginning_borrow_packet_const(
 287                 const struct bt_message *message)
 288 {
 289         return bt_message_packet_beginning_borrow_packet(
 290                 (void *) message);
 291 }
 292
 293 struct bt_packet *bt_message_packet_end_borrow_packet(
 294                 struct bt_message *message)
 295 {
 296         struct bt_message_packet *packet_msg = (void *) message;
 297
 298         BT_ASSERT_PRE_DEV_MSG_NON_NULL(message);
 299         BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(message);
 300         return packet_msg->packet;
 301 }
 302
 303 const struct bt_packet *bt_message_packet_end_borrow_packet_const(
 304                 const struct bt_message *message)
 305 {
 306         return bt_message_packet_end_borrow_packet(
 307                 (void *) message);
 308 }
 309
 310 #define BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(_msg)                       \
 311         BT_ASSERT_PRE_DEV_MSG_SC_DEF_CLK_CLS((_msg),                    \
 312                 ((struct bt_message_packet *) _msg)->packet->stream->class)
 313
 314 static inline
 315 const struct bt_clock_snapshot *
 316 borrow_packet_message_default_clock_snapshot_const(
 317                 const struct bt_message *message)
 318 {
 319         struct bt_message_packet *packet_msg = (void *) message;
 320
 321         BT_ASSERT_DBG(message);
 322         return packet_msg->default_cs;
 323 }
 324
 325 const struct bt_clock_snapshot *
 326 bt_message_packet_beginning_borrow_default_clock_snapshot_const(
 327                 const struct bt_message *msg)
 328 {
 329         BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
 330         BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(msg);
 331         BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(msg);
 332         return borrow_packet_message_default_clock_snapshot_const(msg);
 333 }
 334
 335 const struct bt_clock_snapshot *
 336 bt_message_packet_end_borrow_default_clock_snapshot_const(
 337                 const struct bt_message *msg)
 338 {
 339         BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
 340         BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(msg);
 341         BT_ASSERT_PRE_DEV_FOR_BORROW_DEF_CS(msg);
 342         return borrow_packet_message_default_clock_snapshot_const(msg);
 343 }
 344
 345 static inline
 346 const struct bt_clock_class *
 347 borrow_packet_message_stream_class_default_clock_class(
 348                 const struct bt_message *msg)
 349 {
 350         struct bt_message_packet *packet_msg = (void *) msg;
 351
 352         BT_ASSERT_DBG(msg);
 353         return packet_msg->packet->stream->class->default_clock_class;
 354 }
 355
 356 const struct bt_clock_class *
 357 bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
 358                 const struct bt_message *msg)
 359 {
 360         BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
 361         BT_ASSERT_PRE_DEV_MSG_IS_PACKET_BEGINNING(msg);
 362         return borrow_packet_message_stream_class_default_clock_class(msg);
 363 }
 364
 365 const struct bt_clock_class *
 366 bt_message_packet_end_borrow_stream_class_default_clock_class_const(
 367                 const struct bt_message *msg)
 368 {
 369         BT_ASSERT_PRE_DEV_MSG_NON_NULL(msg);
 370         BT_ASSERT_PRE_DEV_MSG_IS_PACKET_END(msg);
 371         return borrow_packet_message_stream_class_default_clock_class(msg);
 372 }