lib/graph/notification/packet.c

   1 /*
   2  * Babeltrace Plug-in Packet-related Notifications
   3  *
   4  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  *
   6  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #define BT_LOG_TAG "NOTIF-PACKET"
  28 #include <babeltrace/lib-logging-internal.h>
  29
  30 #include <babeltrace/compiler-internal.h>
  31 #include <babeltrace/ctf-ir/packet.h>
  32 #include <babeltrace/ctf-ir/packet-internal.h>
  33 #include <babeltrace/ctf-ir/stream-class.h>
  34 #include <babeltrace/ctf-ir/stream.h>
  35 #include <babeltrace/ctf-ir/stream-internal.h>
  36 #include <babeltrace/graph/graph-internal.h>
  37 #include <babeltrace/graph/notification-packet-internal.h>
  38 #include <babeltrace/assert-internal.h>
  39 #include <babeltrace/assert-pre-internal.h>
  40 #include <babeltrace/object-internal.h>
  41 #include <inttypes.h>
  42
  43 BT_HIDDEN
  44 struct bt_notification *bt_notification_packet_begin_new(struct bt_graph *graph)
  45 {
  46         struct bt_notification_packet_begin *notification;
  47
  48         notification = g_new0(struct bt_notification_packet_begin, 1);
  49         if (!notification) {
  50                 BT_LOGE_STR("Failed to allocate one packet beginning notification.");
  51                 goto error;
  52         }
  53
  54         bt_notification_init(&notification->parent,
  55                         BT_NOTIFICATION_TYPE_PACKET_BEGIN,
  56                         (bt_object_release_func) bt_notification_packet_begin_recycle,
  57                         graph);
  58         goto end;
  59
  60 error:
  61         BT_PUT(notification);
  62
  63 end:
  64         return (void *) notification;
  65 }
  66
  67 struct bt_notification *bt_notification_packet_begin_create(
  68                 struct bt_graph *graph, struct bt_packet *packet)
  69 {
  70         struct bt_notification_packet_begin *notification;
  71         struct bt_stream *stream;
  72         struct bt_stream_class *stream_class;
  73
  74         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
  75         stream = bt_packet_borrow_stream(packet);
  76         BT_ASSERT(stream);
  77         stream_class = bt_stream_borrow_class(stream);
  78         BT_ASSERT(stream_class);
  79         BT_LOGD("Creating packet beginning notification object: "
  80                 "packet-addr=%p, stream-addr=%p, stream-name=\"%s\", "
  81                 "stream-class-addr=%p, stream-class-name=\"%s\", "
  82                 "stream-class-id=%" PRId64,
  83                 packet, stream, bt_stream_get_name(stream),
  84                 stream_class,
  85                 bt_stream_class_get_name(stream_class),
  86                 bt_stream_class_get_id(stream_class));
  87         notification = (void *) bt_notification_create_from_pool(
  88                 &graph->packet_begin_notif_pool, graph);
  89         if (!notification) {
  90                 /* bt_notification_create_from_pool() logs errors */
  91                 goto end;
  92         }
  93
  94         BT_ASSERT(!notification->packet);
  95         notification->packet = packet;
  96         bt_object_get_no_null_check_no_parent_check(
  97                 &notification->packet->base);
  98         BT_LOGD("Created packet beginning notification object: "
  99                 "packet-addr=%p, stream-addr=%p, stream-name=\"%s\", "
 100                 "stream-class-addr=%p, stream-class-name=\"%s\", "
 101                 "stream-class-id=%" PRId64 ", addr=%p",
 102                 packet, stream, bt_stream_get_name(stream),
 103                 stream_class,
 104                 bt_stream_class_get_name(stream_class),
 105                 bt_stream_class_get_id(stream_class), notification);
 106         goto end;
 107
 108 end:
 109         return (void *) notification;
 110 }
 111
 112 BT_HIDDEN
 113 void bt_notification_packet_begin_destroy(struct bt_notification *notif)
 114 {
 115         struct bt_notification_packet_begin *packet_begin_notif = (void *) notif;
 116
 117         BT_LOGD("Destroying packet beginning notification: addr=%p", notif);
 118         BT_LOGD_STR("Putting packet.");
 119         BT_PUT(packet_begin_notif->packet);
 120         g_free(notif);
 121 }
 122
 123 BT_HIDDEN
 124 void bt_notification_packet_begin_recycle(struct bt_notification *notif)
 125 {
 126         struct bt_notification_packet_begin *packet_begin_notif = (void *) notif;
 127         struct bt_graph *graph;
 128
 129         BT_ASSERT(packet_begin_notif);
 130
 131         if (unlikely(!notif->graph)) {
 132                 bt_notification_packet_begin_destroy(notif);
 133                 return;
 134         }
 135
 136         BT_LOGD("Recycling packet beginning notification: addr=%p", notif);
 137         bt_notification_reset(notif);
 138         bt_object_put_no_null_check(&packet_begin_notif->packet->base);
 139         packet_begin_notif->packet = NULL;
 140         graph = notif->graph;
 141         notif->graph = NULL;
 142         bt_object_pool_recycle_object(&graph->packet_begin_notif_pool, notif);
 143 }
 144
 145 struct bt_packet *bt_notification_packet_begin_borrow_packet(
 146                 struct bt_notification *notification)
 147 {
 148         struct bt_notification_packet_begin *packet_begin;
 149
 150         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
 151         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
 152                 BT_NOTIFICATION_TYPE_PACKET_BEGIN);
 153         packet_begin = container_of(notification,
 154                         struct bt_notification_packet_begin, parent);
 155         return packet_begin->packet;
 156 }
 157
 158 BT_HIDDEN
 159 struct bt_notification *bt_notification_packet_end_new(struct bt_graph *graph)
 160 {
 161         struct bt_notification_packet_end *notification;
 162
 163         notification = g_new0(struct bt_notification_packet_end, 1);
 164         if (!notification) {
 165                 BT_LOGE_STR("Failed to allocate one packet end notification.");
 166                 goto error;
 167         }
 168
 169         bt_notification_init(&notification->parent,
 170                         BT_NOTIFICATION_TYPE_PACKET_END,
 171                         (bt_object_release_func) bt_notification_packet_end_recycle,
 172                         graph);
 173         goto end;
 174
 175 error:
 176         BT_PUT(notification);
 177
 178 end:
 179         return (void *) notification;
 180 }
 181
 182 struct bt_notification *bt_notification_packet_end_create(
 183                 struct bt_graph *graph, struct bt_packet *packet)
 184 {
 185         struct bt_notification_packet_end *notification;
 186         struct bt_stream *stream;
 187         struct bt_stream_class *stream_class;
 188
 189         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 190         stream = bt_packet_borrow_stream(packet);
 191         BT_ASSERT(stream);
 192         stream_class = bt_stream_borrow_class(stream);
 193         BT_ASSERT(stream_class);
 194         BT_LOGD("Creating packet end notification object: "
 195                 "packet-addr=%p, stream-addr=%p, stream-name=\"%s\", "
 196                 "stream-class-addr=%p, stream-class-name=\"%s\", "
 197                 "stream-class-id=%" PRId64,
 198                 packet, stream, bt_stream_get_name(stream),
 199                 stream_class,
 200                 bt_stream_class_get_name(stream_class),
 201                 bt_stream_class_get_id(stream_class));
 202         notification = (void *) bt_notification_create_from_pool(
 203                 &graph->packet_end_notif_pool, graph);
 204         if (!notification) {
 205                 /* bt_notification_create_from_pool() logs errors */
 206                 goto end;
 207         }
 208
 209         BT_ASSERT(!notification->packet);
 210         notification->packet = packet;
 211         bt_object_get_no_null_check_no_parent_check(
 212                 &notification->packet->base);
 213         BT_LOGD("Created packet end notification object: "
 214                 "packet-addr=%p, stream-addr=%p, stream-name=\"%s\", "
 215                 "stream-class-addr=%p, stream-class-name=\"%s\", "
 216                 "stream-class-id=%" PRId64 ", addr=%p",
 217                 packet, stream, bt_stream_get_name(stream),
 218                 stream_class,
 219                 bt_stream_class_get_name(stream_class),
 220                 bt_stream_class_get_id(stream_class), notification);
 221         goto end;
 222
 223 end:
 224         return (void *) notification;
 225 }
 226
 227 BT_HIDDEN
 228 void bt_notification_packet_end_destroy(struct bt_notification *notif)
 229 {
 230         struct bt_notification_packet_end *packet_end_notif = (void *) notif;
 231
 232         BT_LOGD("Destroying packet end notification: addr=%p", notif);
 233         BT_LOGD_STR("Putting packet.");
 234         BT_PUT(packet_end_notif->packet);
 235         g_free(notif);
 236 }
 237
 238 BT_HIDDEN
 239 void bt_notification_packet_end_recycle(struct bt_notification *notif)
 240 {
 241         struct bt_notification_packet_end *packet_end_notif = (void *) notif;
 242         struct bt_graph *graph;
 243
 244         BT_ASSERT(packet_end_notif);
 245
 246         if (!notif->graph) {
 247                 bt_notification_packet_end_destroy(notif);
 248                 return;
 249         }
 250
 251         BT_LOGD("Recycling packet end notification: addr=%p", notif);
 252         bt_notification_reset(notif);
 253         BT_PUT(packet_end_notif->packet);
 254         graph = notif->graph;
 255         notif->graph = NULL;
 256         bt_object_pool_recycle_object(&graph->packet_end_notif_pool, notif);
 257 }
 258
 259 struct bt_packet *bt_notification_packet_end_borrow_packet(
 260                 struct bt_notification *notification)
 261 {
 262         struct bt_notification_packet_end *packet_end;
 263
 264         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
 265         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
 266                 BT_NOTIFICATION_TYPE_PACKET_END);
 267         packet_end = container_of(notification,
 268                         struct bt_notification_packet_end, parent);
 269         return packet_end->packet;
 270 }