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/notification-packet-internal.h>
  37 #include <babeltrace/assert-internal.h>
  38 #include <babeltrace/assert-pre-internal.h>
  39 #include <inttypes.h>
  40
  41 static
  42 void bt_notification_packet_begin_destroy(struct bt_object *obj)
  43 {
  44         struct bt_notification_packet_begin *notification =
  45                         (struct bt_notification_packet_begin *) obj;
  46
  47         BT_LOGD("Destroying packet beginning notification: addr=%p",
  48                 notification);
  49         BT_LOGD_STR("Putting packet.");
  50         BT_PUT(notification->packet);
  51         g_free(notification);
  52 }
  53
  54 static
  55 void bt_notification_packet_end_destroy(struct bt_object *obj)
  56 {
  57         struct bt_notification_packet_end *notification =
  58                         (struct bt_notification_packet_end *) obj;
  59
  60         BT_LOGD("Destroying packet end notification: addr=%p",
  61                 notification);
  62         BT_LOGD_STR("Putting packet.");
  63         BT_PUT(notification->packet);
  64         g_free(notification);
  65 }
  66
  67 struct bt_notification *bt_notification_packet_begin_create(
  68                 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 = g_new0(struct bt_notification_packet_begin, 1);
  88         if (!notification) {
  89                 BT_LOGE_STR("Failed to allocate one packet beginning notification.");
  90                 goto error;
  91         }
  92
  93         bt_notification_init(&notification->parent,
  94                         BT_NOTIFICATION_TYPE_PACKET_BEGIN,
  95                         bt_notification_packet_begin_destroy);
  96         notification->packet = bt_get(packet);
  97         BT_LOGD("Created packet beginning notification object: "
  98                 "packet-addr=%p, stream-addr=%p, stream-name=\"%s\", "
  99                 "stream-class-addr=%p, stream-class-name=\"%s\", "
 100                 "stream-class-id=%" PRId64 ", addr=%p",
 101                 packet, stream, bt_stream_get_name(stream),
 102                 stream_class,
 103                 bt_stream_class_get_name(stream_class),
 104                 bt_stream_class_get_id(stream_class), notification);
 105         return &notification->parent;
 106 error:
 107         return NULL;
 108 }
 109
 110 struct bt_packet *bt_notification_packet_begin_get_packet(
 111                 struct bt_notification *notification)
 112 {
 113         struct bt_notification_packet_begin *packet_begin;
 114
 115         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
 116         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
 117                 BT_NOTIFICATION_TYPE_PACKET_BEGIN);
 118         packet_begin = container_of(notification,
 119                         struct bt_notification_packet_begin, parent);
 120         return bt_get(packet_begin->packet);
 121 }
 122
 123 struct bt_notification *bt_notification_packet_end_create(
 124                 struct bt_packet *packet)
 125 {
 126         struct bt_notification_packet_end *notification;
 127         struct bt_stream *stream;
 128         struct bt_stream_class *stream_class;
 129
 130         BT_ASSERT_PRE_NON_NULL(packet, "Packet");
 131         stream = bt_packet_borrow_stream(packet);
 132         BT_ASSERT(stream);
 133         stream_class = bt_stream_borrow_class(stream);
 134         BT_ASSERT(stream_class);
 135         BT_LOGD("Creating packet end notification object: "
 136                 "packet-addr=%p, stream-addr=%p, stream-name=\"%s\", "
 137                 "stream-class-addr=%p, stream-class-name=\"%s\", "
 138                 "stream-class-id=%" PRId64,
 139                 packet, stream, bt_stream_get_name(stream),
 140                 stream_class,
 141                 bt_stream_class_get_name(stream_class),
 142                 bt_stream_class_get_id(stream_class));
 143         notification = g_new0(struct bt_notification_packet_end, 1);
 144         if (!notification) {
 145                 BT_LOGE_STR("Failed to allocate one packet end notification.");
 146                 goto error;
 147         }
 148
 149         bt_notification_init(&notification->parent,
 150                         BT_NOTIFICATION_TYPE_PACKET_END,
 151                         bt_notification_packet_end_destroy);
 152         notification->packet = bt_get(packet);
 153         BT_LOGD("Created packet end notification object: "
 154                 "packet-addr=%p, stream-addr=%p, stream-name=\"%s\", "
 155                 "stream-class-addr=%p, stream-class-name=\"%s\", "
 156                 "stream-class-id=%" PRId64 ", addr=%p",
 157                 packet, stream, bt_stream_get_name(stream),
 158                 stream_class,
 159                 bt_stream_class_get_name(stream_class),
 160                 bt_stream_class_get_id(stream_class), notification);
 161         return &notification->parent;
 162 error:
 163         return NULL;
 164 }
 165
 166 struct bt_packet *bt_notification_packet_end_get_packet(
 167                 struct bt_notification *notification)
 168 {
 169         struct bt_notification_packet_end *packet_end;
 170
 171         BT_ASSERT_PRE_NON_NULL(notification, "Notification");
 172         BT_ASSERT_PRE_NOTIF_IS_TYPE(notification,
 173                 BT_NOTIFICATION_TYPE_PACKET_END);
 174         packet_end = container_of(notification,
 175                         struct bt_notification_packet_end, parent);
 176         return bt_get(packet_end->packet);
 177 }