include/babeltrace/graph/notification-internal.h

   1 #ifndef BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H
   2 #define BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Plug-in Notification internal
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/ref-internal.h>
  31 #include <babeltrace/babeltrace-internal.h>
  32 #include <babeltrace/object-internal.h>
  33 #include <babeltrace/graph/notification.h>
  34 #include <babeltrace/ctf-ir/stream.h>
  35 #include <babeltrace/types.h>
  36
  37 typedef struct bt_stream *(*get_stream_func)(
  38                 struct bt_notification *notification);
  39
  40 struct bt_notification {
  41         struct bt_object base;
  42         enum bt_notification_type type;
  43         get_stream_func get_stream;
  44         uint64_t seq_num;
  45         bt_bool frozen;
  46 };
  47
  48 #define BT_ASSERT_PRE_NOTIF_IS_TYPE(_notif, _type)                      \
  49         BT_ASSERT_PRE((_notif)->type == (_type),                        \
  50                 "Notification has the wrong type: expected-type=%s, "   \
  51                 "%![notif-]+n", bt_notification_type_string(_type),     \
  52                 (_notif))
  53
  54 BT_HIDDEN
  55 void bt_notification_init(struct bt_notification *notification,
  56                 enum bt_notification_type type,
  57                 bt_object_release_func release);
  58
  59 static inline void bt_notification_freeze(struct bt_notification *notification)
  60 {
  61         notification->frozen = BT_TRUE;
  62 }
  63
  64 static inline
  65 const char *bt_notification_type_string(enum bt_notification_type type)
  66 {
  67         switch (type) {
  68         case BT_NOTIFICATION_TYPE_UNKNOWN:
  69                 return "BT_NOTIFICATION_TYPE_UNKNOWN";
  70         case BT_NOTIFICATION_TYPE_EVENT:
  71                 return "BT_NOTIFICATION_TYPE_EVENT";
  72         case BT_NOTIFICATION_TYPE_INACTIVITY:
  73                 return "BT_NOTIFICATION_TYPE_INACTIVITY";
  74         case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
  75                 return "BT_NOTIFICATION_TYPE_STREAM_BEGIN";
  76         case BT_NOTIFICATION_TYPE_STREAM_END:
  77                 return "BT_NOTIFICATION_TYPE_STREAM_END";
  78         case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
  79                 return "BT_NOTIFICATION_TYPE_PACKET_BEGIN";
  80         case BT_NOTIFICATION_TYPE_PACKET_END:
  81                 return "BT_NOTIFICATION_TYPE_PACKET_END";
  82         case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
  83                 return "BT_NOTIFICATION_TYPE_DISCARDED_EVENTS";
  84         case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
  85                 return "BT_NOTIFICATION_TYPE_DISCARDED_PACKETS";
  86         default:
  87                 return "(unknown)";
  88         }
  89 }
  90
  91 #endif /* BABELTRACE_COMPONENT_NOTIFICATION_NOTIFICATION_INTERNAL_H */