lib/graph/notification/event.c

   1 /*
   2  * Babeltrace Plug-in Event Notification
   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 #include <babeltrace/compiler-internal.h>
  28 #include <babeltrace/ctf-ir/event.h>
  29 #include <babeltrace/ctf-ir/event-internal.h>
  30 #include <babeltrace/ctf-ir/event-class-internal.h>
  31 #include <babeltrace/ctf-ir/stream-class-internal.h>
  32 #include <babeltrace/ctf-ir/trace.h>
  33 #include <babeltrace/graph/clock-class-priority-map.h>
  34 #include <babeltrace/graph/clock-class-priority-map-internal.h>
  35 #include <babeltrace/graph/notification-event-internal.h>
  36
  37 static
  38 void bt_notification_event_destroy(struct bt_object *obj)
  39 {
  40         struct bt_notification_event *notification =
  41                         (struct bt_notification_event *) obj;
  42
  43         BT_PUT(notification->event);
  44         BT_PUT(notification->cc_prio_map);
  45         g_free(notification);
  46 }
  47
  48 static
  49 bool validate_clock_classes(struct bt_notification_event *notif)
  50 {
  51         /*
  52          * For each clock class found in the notification's clock class
  53          * priority map, make sure the event has a clock value set for
  54          * this clock class. Also make sure that those clock classes
  55          * are part of the trace to which the event belongs.
  56          */
  57         bool is_valid = true;
  58         int trace_cc_count;
  59         int cc_prio_map_cc_count;
  60         size_t cc_prio_map_cc_i, trace_cc_i;
  61         struct bt_ctf_event_class *event_class = NULL;
  62         struct bt_ctf_stream_class *stream_class = NULL;
  63         struct bt_ctf_trace *trace = NULL;
  64
  65         event_class = bt_ctf_event_borrow_event_class(notif->event);
  66         assert(event_class);
  67         stream_class = bt_ctf_event_class_borrow_stream_class(event_class);
  68         assert(stream_class);
  69         trace = bt_ctf_stream_class_borrow_trace(stream_class);
  70         assert(trace);
  71         trace_cc_count = bt_ctf_trace_get_clock_class_count(trace);
  72         assert(trace_cc_count >= 0);
  73         cc_prio_map_cc_count =
  74                 bt_clock_class_priority_map_get_clock_class_count(
  75                         notif->cc_prio_map);
  76         assert(cc_prio_map_cc_count >= 0);
  77
  78         for (cc_prio_map_cc_i = 0; cc_prio_map_cc_i < cc_prio_map_cc_count;
  79                         cc_prio_map_cc_i++) {
  80                 struct bt_ctf_clock_class *clock_class =
  81                         bt_clock_class_priority_map_get_clock_class(
  82                                 notif->cc_prio_map, cc_prio_map_cc_i);
  83                 struct bt_ctf_clock_value *clock_value;
  84                 bool found_in_trace = false;
  85
  86                 assert(clock_class);
  87                 clock_value = bt_ctf_event_get_clock_value(notif->event,
  88                         clock_class);
  89                 if (!clock_value) {
  90                         is_valid = false;
  91                         goto end;
  92                 }
  93
  94                 bt_put(clock_value);
  95
  96                 for (trace_cc_i = 0; trace_cc_i < trace_cc_count;
  97                                 trace_cc_i++) {
  98                         struct bt_ctf_clock_class *trace_clock_class =
  99                                 bt_ctf_trace_get_clock_class(trace, trace_cc_i);
 100
 101                         assert(trace_clock_class);
 102
 103                         if (trace_clock_class == clock_class) {
 104                                 found_in_trace = true;
 105                                 break;
 106                         }
 107                 }
 108
 109                 bt_put(clock_class);
 110
 111                 if (!found_in_trace) {
 112                         is_valid = false;
 113                         goto end;
 114                 }
 115         }
 116
 117 end:
 118         return is_valid;
 119 }
 120
 121 struct bt_notification *bt_notification_event_create(struct bt_ctf_event *event,
 122                 struct bt_clock_class_priority_map *cc_prio_map)
 123 {
 124         struct bt_notification_event *notification = NULL;
 125
 126         if (!event || !cc_prio_map) {
 127                 goto error;
 128         }
 129
 130         if (!bt_ctf_event_borrow_packet(event)) {
 131                 goto error;
 132         }
 133
 134         notification = g_new0(struct bt_notification_event, 1);
 135         if (!notification) {
 136                 goto error;
 137         }
 138         bt_notification_init(&notification->parent,
 139                         BT_NOTIFICATION_TYPE_EVENT,
 140                         bt_notification_event_destroy);
 141         notification->event = bt_get(event);
 142         notification->cc_prio_map = bt_get(cc_prio_map);
 143         if (!validate_clock_classes(notification)) {
 144                 goto error;
 145         }
 146
 147         bt_ctf_event_freeze(notification->event);
 148         bt_clock_class_priority_map_freeze(notification->cc_prio_map);
 149         return &notification->parent;
 150 error:
 151         bt_put(notification);
 152         return NULL;
 153 }
 154
 155 struct bt_ctf_event *bt_notification_event_get_event(
 156                 struct bt_notification *notification)
 157 {
 158         struct bt_ctf_event *event = NULL;
 159         struct bt_notification_event *event_notification;
 160
 161         if (bt_notification_get_type(notification) !=
 162                         BT_NOTIFICATION_TYPE_EVENT) {
 163                 goto end;
 164         }
 165         event_notification = container_of(notification,
 166                         struct bt_notification_event, parent);
 167         event = bt_get(event_notification->event);
 168 end:
 169         return event;
 170 }
 171
 172 extern struct bt_clock_class_priority_map *
 173 bt_notification_event_get_clock_class_priority_map(
 174                 struct bt_notification *notification)
 175 {
 176         struct bt_clock_class_priority_map *cc_prio_map = NULL;
 177         struct bt_notification_event *event_notification;
 178
 179         if (bt_notification_get_type(notification) !=
 180                         BT_NOTIFICATION_TYPE_EVENT) {
 181                 goto end;
 182         }
 183
 184         event_notification = container_of(notification,
 185                         struct bt_notification_event, parent);
 186         cc_prio_map = bt_get(event_notification->cc_prio_map);
 187 end:
 188         return cc_prio_map;
 189 }