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