lib/graph/message/packet.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "MSG-PACKET"
  25 #include <babeltrace/lib-logging-internal.h>
  26
  27 #include <babeltrace/compiler-internal.h>
  28 #include <babeltrace/trace-ir/packet.h>
  29 #include <babeltrace/trace-ir/packet-internal.h>
  30 #include <babeltrace/trace-ir/stream-class.h>
  31 #include <babeltrace/trace-ir/stream.h>
  32 #include <babeltrace/trace-ir/stream-internal.h>
  33 #include <babeltrace/graph/graph-internal.h>
  34 #include <babeltrace/graph/message-packet-beginning-const.h>
  35 #include <babeltrace/graph/message-packet-end-const.h>
  36 #include <babeltrace/graph/message-packet-beginning.h>
  37 #include <babeltrace/graph/message-packet-end.h>
  38 #include <babeltrace/graph/message-packet-internal.h>
  39 #include <babeltrace/assert-internal.h>
  40 #include <babeltrace/assert-pre-internal.h>
  41 #include <babeltrace/object-internal.h>
  42 #include <inttypes.h>
  43
  44 static inline
  45 struct bt_message *new_packet_message(struct bt_graph *graph,
  46                 enum bt_message_type type, bt_object_release_func recycle_func)
  47 {
  48         struct bt_message_packet *message;
  49
  50         message = g_new0(struct bt_message_packet, 1);
  51         if (!message) {
  52                 BT_LOGE_STR("Failed to allocate one packet message.");
  53                 goto error;
  54         }
  55
  56         bt_message_init(&message->parent, type, recycle_func, graph);
  57         goto end;
  58
  59 error:
  60         BT_OBJECT_PUT_REF_AND_RESET(message);
  61
  62 end:
  63         return (void *) message;
  64 }
  65
  66 BT_HIDDEN
  67 struct bt_message *bt_message_packet_beginning_new(struct bt_graph *graph)
  68 {
  69         return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_BEGINNING,
  70                 (bt_object_release_func) bt_message_packet_beginning_recycle);
  71 }
  72
  73 BT_HIDDEN
  74 struct bt_message *bt_message_packet_end_new(struct bt_graph *graph)
  75 {
  76         return new_packet_message(graph, BT_MESSAGE_TYPE_PACKET_END,
  77                 (bt_object_release_func) bt_message_packet_end_recycle);
  78 }
  79
  80 static inline
  81 struct bt_message *bt_message_packet_create(
  82                 struct bt_self_component_port_input_message_iterator *msg_iter,
  83                 struct bt_packet *packet, struct bt_object_pool *pool)
  84 {
  85         struct bt_message_packet *message = NULL;
  86         struct bt_stream *stream;
  87         struct bt_stream_class *stream_class;
  88
  89         BT_ASSERT(msg_iter);
  90         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
  91         stream = bt_packet_borrow_stream(packet);
  92         BT_ASSERT(stream);
  93         stream_class = bt_stream_borrow_class(stream);
  94         BT_ASSERT(stream_class);
  95         BT_LIB_LOGD("Creating packet message object: "
  96                 "%![packet-]+a, %![stream-]+s, %![sc-]+S",
  97                 packet, stream, stream_class);
  98         message = (void *) bt_message_create_from_pool(pool, msg_iter->graph);
  99         if (!message) {
 100                 /* bt_message_create_from_pool() logs errors */
 101                 goto end;
 102         }
 103
 104         BT_ASSERT(!message->packet);
 105         message->packet = packet;
 106         bt_object_get_no_null_check_no_parent_check(
 107                 &message->packet->base);
 108         bt_packet_set_is_frozen(packet, true);
 109         BT_LIB_LOGD("Created packet message object: "
 110                 "%![msg-]+n, %![packet-]+a, %![stream-]+s, %![sc-]+S",
 111                 message, packet, stream, stream_class);
 112         goto end;
 113
 114 end:
 115         return (void *) message;
 116 }
 117
 118 struct bt_message *bt_message_packet_beginning_create(
 119                 struct bt_self_message_iterator *self_msg_iter,
 120                 struct bt_packet *packet)
 121 {
 122         struct bt_self_component_port_input_message_iterator *msg_iter =
 123                 (void *) self_msg_iter;
 124
 125         BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
 126         return bt_message_packet_create(msg_iter, packet,
 127                 &msg_iter->graph->packet_begin_msg_pool);
 128 }
 129
 130 struct bt_message *bt_message_packet_end_create(
 131                 struct bt_self_message_iterator *self_msg_iter,
 132                 struct bt_packet *packet)
 133 {
 134         struct bt_self_component_port_input_message_iterator *msg_iter =
 135                 (void *) self_msg_iter;
 136
 137         BT_ASSERT_PRE_NON_NULL(msg_iter, "Message iterator");
 138         return bt_message_packet_create(msg_iter, packet,
 139                 &msg_iter->graph->packet_end_msg_pool);
 140 }
 141
 142 BT_HIDDEN
 143 void bt_message_packet_destroy(struct bt_message *msg)
 144 {
 145         struct bt_message_packet *packet_msg = (void *) msg;
 146
 147         BT_LIB_LOGD("Destroying packet message: %!+n", msg);
 148         BT_LIB_LOGD("Putting packet: %!+a", packet_msg->packet);
 149         BT_OBJECT_PUT_REF_AND_RESET(packet_msg->packet);
 150         g_free(msg);
 151 }
 152
 153 static inline
 154 void recycle_packet_message(struct bt_message *msg, struct bt_object_pool *pool)
 155 {
 156         struct bt_message_packet *packet_msg = (void *) msg;
 157
 158         BT_LIB_LOGD("Recycling packet message: %!+n", msg);
 159         bt_message_reset(msg);
 160         bt_object_put_no_null_check(&packet_msg->packet->base);
 161         packet_msg->packet = NULL;
 162         msg->graph = NULL;
 163         bt_object_pool_recycle_object(pool, msg);
 164 }
 165
 166 BT_HIDDEN
 167 void bt_message_packet_beginning_recycle(struct bt_message *msg)
 168 {
 169         BT_ASSERT(msg);
 170
 171         if (unlikely(!msg->graph)) {
 172                 bt_message_packet_destroy(msg);
 173                 return;
 174         }
 175
 176         recycle_packet_message(msg, &msg->graph->packet_begin_msg_pool);
 177 }
 178
 179 BT_HIDDEN
 180 void bt_message_packet_end_recycle(struct bt_message *msg)
 181 {
 182         BT_ASSERT(msg);
 183
 184         if (unlikely(!msg->graph)) {
 185                 bt_message_packet_destroy(msg);
 186                 return;
 187         }
 188
 189         recycle_packet_message(msg, &msg->graph->packet_end_msg_pool);
 190 }
 191
 192 struct bt_packet *bt_message_packet_beginning_borrow_packet(
 193                 struct bt_message *message)
 194 {
 195         struct bt_message_packet *packet_msg = (void *) message;
 196
 197         BT_ASSERT_PRE_NON_NULL(message, "Message");
 198         BT_ASSERT_PRE_MSG_IS_TYPE(message,
 199                 BT_MESSAGE_TYPE_PACKET_BEGINNING);
 200         return packet_msg->packet;
 201 }
 202
 203 const struct bt_packet *bt_message_packet_beginning_borrow_packet_const(
 204                 const struct bt_message *message)
 205 {
 206         return bt_message_packet_beginning_borrow_packet(
 207                 (void *) message);
 208 }
 209
 210 struct bt_packet *bt_message_packet_end_borrow_packet(
 211                 struct bt_message *message)
 212 {
 213         struct bt_message_packet *packet_msg = (void *) message;
 214
 215         BT_ASSERT_PRE_NON_NULL(message, "Message");
 216         BT_ASSERT_PRE_MSG_IS_TYPE(message,
 217                 BT_MESSAGE_TYPE_PACKET_END);
 218         return packet_msg->packet;
 219 }
 220
 221 const struct bt_packet *bt_message_packet_end_borrow_packet_const(
 222                 const struct bt_message *message)
 223 {
 224         return bt_message_packet_end_borrow_packet(
 225                 (void *) message);
 226 }