Commit | Line | Data |
---|---|---|
0d884c50 JG |
1 | /* |
2 | * sink.c | |
3 | * | |
47e5a032 | 4 | * Babeltrace Sink Component |
0d884c50 JG |
5 | * |
6 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
29 | #include <babeltrace/compiler.h> | |
30 | #include <babeltrace/plugin/sink-internal.h> | |
31 | #include <babeltrace/plugin/component-internal.h> | |
30d619df | 32 | #include <babeltrace/plugin/notification/notification.h> |
0d884c50 | 33 | |
7c7c0433 JG |
34 | BT_HIDDEN |
35 | enum bt_component_status bt_component_sink_validate( | |
36 | struct bt_component *component) | |
37 | { | |
9defb2e2 JG |
38 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
39 | struct bt_component_sink *sink; | |
40 | ||
41 | sink = container_of(component, struct bt_component_sink, parent); | |
42 | if (sink->registered_notifications_mask == 0) { | |
43 | /* | |
44 | * A sink must be registered to at least one notification type. | |
45 | */ | |
46 | printf_error("Invalid sink component; not registered to any notification"); | |
47 | ret = BT_COMPONENT_STATUS_INVALID; | |
48 | goto end; | |
49 | } | |
50 | ||
51 | if (!sink->handle_notification) { | |
52 | printf_error("Invalid sink component; no notification handling callback defined."); | |
53 | ret = BT_COMPONENT_STATUS_INVALID; | |
54 | goto end; | |
55 | } | |
56 | end: | |
57 | return ret; | |
0d884c50 JG |
58 | } |
59 | ||
8738a040 | 60 | BT_HIDDEN |
fb2dcc52 | 61 | struct bt_component *bt_component_sink_create( |
7c7c0433 | 62 | struct bt_component_class *class, struct bt_value *params) |
0d884c50 JG |
63 | { |
64 | struct bt_component_sink *sink = NULL; | |
65 | enum bt_component_status ret; | |
66 | ||
0d884c50 JG |
67 | sink = g_new0(struct bt_component_sink, 1); |
68 | if (!sink) { | |
69 | goto end; | |
70 | } | |
71 | ||
7c7c0433 | 72 | ret = bt_component_init(&sink->parent, bt_component_sink_destroy); |
0d884c50 | 73 | if (ret != BT_COMPONENT_STATUS_OK) { |
38b48196 | 74 | BT_PUT(sink); |
0d884c50 JG |
75 | goto end; |
76 | } | |
0d884c50 JG |
77 | end: |
78 | return sink ? &sink->parent : NULL; | |
79 | } | |
fa55ed98 JG |
80 | |
81 | enum bt_component_status bt_component_sink_handle_notification( | |
82 | struct bt_component *component, | |
83 | struct bt_notification *notification) | |
84 | { | |
85 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
86 | struct bt_component_sink *sink = NULL; | |
87 | ||
88 | if (!component || !notification) { | |
30d619df | 89 | ret = BT_COMPONENT_STATUS_INVALID; |
fa55ed98 JG |
90 | goto end; |
91 | } | |
92 | ||
93 | if (bt_component_get_type(component) != BT_COMPONENT_TYPE_SINK) { | |
94 | ret = BT_COMPONENT_STATUS_UNSUPPORTED; | |
95 | goto end; | |
96 | } | |
97 | ||
98 | sink = container_of(component, struct bt_component_sink, parent); | |
99 | assert(sink->handle_notification); | |
100 | ret = sink->handle_notification(component, notification); | |
101 | end: | |
102 | return ret; | |
103 | } | |
30d619df JG |
104 | |
105 | enum bt_component_status bt_component_sink_register_notification_type( | |
106 | struct bt_component *component, enum bt_notification_type type) | |
107 | { | |
108 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
109 | struct bt_component_sink *sink = NULL; | |
110 | ||
111 | if (!component) { | |
112 | ret = BT_COMPONENT_STATUS_INVALID; | |
113 | goto end; | |
114 | } | |
115 | ||
116 | if (bt_component_get_type(component) != BT_COMPONENT_TYPE_SINK) { | |
117 | ret = BT_COMPONENT_STATUS_UNSUPPORTED; | |
118 | goto end; | |
119 | } | |
120 | ||
121 | if (type <= BT_NOTIFICATION_TYPE_UNKNOWN || | |
122 | type >= BT_NOTIFICATION_TYPE_NR) { | |
123 | ret = BT_COMPONENT_STATUS_INVALID; | |
124 | goto end; | |
125 | } | |
126 | sink = container_of(component, struct bt_component_sink, parent); | |
127 | if (type == BT_NOTIFICATION_TYPE_ALL) { | |
128 | sink->registered_notifications_mask = ~(notification_mask_t) 0; | |
129 | } else { | |
130 | sink->registered_notifications_mask |= | |
131 | (notification_mask_t) 1 << type; | |
132 | } | |
133 | end: | |
134 | return ret; | |
135 | } |