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