actions: introduce action group
[lttng-tools.git] / src / common / actions / action.c
CommitLineData
a58c490f 1/*
ab5be9fa 2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
a58c490f 3 *
ab5be9fa 4 * SPDX-License-Identifier: LGPL-2.1-only
a58c490f 5 *
a58c490f
JG
6 */
7
14ec7e87
JR
8#include <assert.h>
9#include <common/error.h>
a58c490f 10#include <lttng/action/action-internal.h>
0c51e8f3 11#include <lttng/action/group-internal.h>
a58c490f 12#include <lttng/action/notify-internal.h>
bfb2ec6a 13#include <lttng/action/rotate-session-internal.h>
757c48a2 14#include <lttng/action/snapshot-session-internal.h>
58397d0d 15#include <lttng/action/start-session-internal.h>
931bdbaa 16#include <lttng/action/stop-session-internal.h>
a58c490f 17
2666d352
SM
18static const char *lttng_action_type_string(enum lttng_action_type action_type)
19{
20 switch (action_type) {
21 case LTTNG_ACTION_TYPE_UNKNOWN:
22 return "UNKNOWN";
0c51e8f3
SM
23 case LTTNG_ACTION_TYPE_GROUP:
24 return "GROUP";
2666d352
SM
25 case LTTNG_ACTION_TYPE_NOTIFY:
26 return "NOTIFY";
bfb2ec6a
SM
27 case LTTNG_ACTION_TYPE_ROTATE_SESSION:
28 return "ROTATE_SESSION";
757c48a2
SM
29 case LTTNG_ACTION_TYPE_SNAPSHOT_SESSION:
30 return "SNAPSHOT_SESSION";
58397d0d
SM
31 case LTTNG_ACTION_TYPE_START_SESSION:
32 return "START_SESSION";
931bdbaa
SM
33 case LTTNG_ACTION_TYPE_STOP_SESSION:
34 return "STOP_SESSION";
2666d352
SM
35 default:
36 return "???";
37 }
38}
39
a58c490f
JG
40enum lttng_action_type lttng_action_get_type(struct lttng_action *action)
41{
42 return action ? action->type : LTTNG_ACTION_TYPE_UNKNOWN;
43}
44
9b63a4aa
JG
45LTTNG_HIDDEN
46enum lttng_action_type lttng_action_get_type_const(
47 const struct lttng_action *action)
48{
49 return action->type;
50}
51
6acb3f46
SM
52LTTNG_HIDDEN
53void lttng_action_init(
54 struct lttng_action *action,
55 enum lttng_action_type type,
56 action_validate_cb validate,
57 action_serialize_cb serialize,
3dd04a6a 58 action_equal_cb equal,
6acb3f46
SM
59 action_destroy_cb destroy)
60{
c852ce4e 61 urcu_ref_init(&action->ref);
6acb3f46
SM
62 action->type = type;
63 action->validate = validate;
64 action->serialize = serialize;
3dd04a6a 65 action->equal = equal;
6acb3f46
SM
66 action->destroy = destroy;
67}
68
c852ce4e
JG
69static
70void action_destroy_ref(struct urcu_ref *ref)
71{
72 struct lttng_action *action =
73 container_of(ref, struct lttng_action, ref);
74
75 action->destroy(action);
76}
77
78LTTNG_HIDDEN
79void lttng_action_get(struct lttng_action *action)
80{
81 urcu_ref_get(&action->ref);
82}
83
84LTTNG_HIDDEN
85void lttng_action_put(struct lttng_action *action)
a58c490f
JG
86{
87 if (!action) {
88 return;
89 }
90
91 assert(action->destroy);
c852ce4e
JG
92 urcu_ref_put(&action->ref, action_destroy_ref);
93}
94
95void lttng_action_destroy(struct lttng_action *action)
96{
97 lttng_action_put(action);
a58c490f
JG
98}
99
100LTTNG_HIDDEN
101bool lttng_action_validate(struct lttng_action *action)
102{
103 bool valid;
104
105 if (!action) {
106 valid = false;
107 goto end;
108 }
109
110 if (!action->validate) {
111 /* Sub-class guarantees that it can never be invalid. */
112 valid = true;
113 goto end;
114 }
115
116 valid = action->validate(action);
117end:
118 return valid;
119}
120
121LTTNG_HIDDEN
3647288f 122int lttng_action_serialize(struct lttng_action *action,
c0a66c84 123 struct lttng_payload *payload)
a58c490f 124{
3647288f
JG
125 int ret;
126 struct lttng_action_comm action_comm = {
127 .action_type = (int8_t) action->type,
128 };
129
c0a66c84 130 ret = lttng_dynamic_buffer_append(&payload->buffer, &action_comm,
3647288f
JG
131 sizeof(action_comm));
132 if (ret) {
a58c490f
JG
133 goto end;
134 }
135
c0a66c84 136 ret = action->serialize(action, payload);
3647288f 137 if (ret) {
a58c490f
JG
138 goto end;
139 }
a58c490f
JG
140end:
141 return ret;
142}
143
144LTTNG_HIDDEN
c0a66c84 145ssize_t lttng_action_create_from_payload(struct lttng_payload_view *view,
869a3c2d 146 struct lttng_action **action)
a58c490f 147{
869a3c2d 148 ssize_t consumed_len, specific_action_consumed_len;
a58c490f 149 const struct lttng_action_comm *action_comm;
c0a66c84 150 action_create_from_payload_cb create_from_payload_cb;
a58c490f 151
869a3c2d
SM
152 if (!view || !action) {
153 consumed_len = -1;
a58c490f
JG
154 goto end;
155 }
156
c0a66c84 157 action_comm = (const struct lttng_action_comm *) view->buffer.data;
869a3c2d 158
c0a66c84 159 DBG("Create action from payload: action-type=%s",
2666d352
SM
160 lttng_action_type_string(action_comm->action_type));
161
a58c490f
JG
162 switch (action_comm->action_type) {
163 case LTTNG_ACTION_TYPE_NOTIFY:
c0a66c84 164 create_from_payload_cb = lttng_action_notify_create_from_payload;
a58c490f 165 break;
bfb2ec6a 166 case LTTNG_ACTION_TYPE_ROTATE_SESSION:
c0a66c84
JG
167 create_from_payload_cb =
168 lttng_action_rotate_session_create_from_payload;
bfb2ec6a 169 break;
757c48a2
SM
170 case LTTNG_ACTION_TYPE_SNAPSHOT_SESSION:
171 create_from_payload_cb =
172 lttng_action_snapshot_session_create_from_payload;
173 break;
58397d0d 174 case LTTNG_ACTION_TYPE_START_SESSION:
c0a66c84
JG
175 create_from_payload_cb =
176 lttng_action_start_session_create_from_payload;
58397d0d 177 break;
931bdbaa 178 case LTTNG_ACTION_TYPE_STOP_SESSION:
c0a66c84
JG
179 create_from_payload_cb =
180 lttng_action_stop_session_create_from_payload;
931bdbaa 181 break;
0c51e8f3
SM
182 case LTTNG_ACTION_TYPE_GROUP:
183 create_from_payload_cb = lttng_action_group_create_from_payload;
184 break;
a58c490f 185 default:
c0a66c84 186 ERR("Failed to create action from payload, unhandled action type: action-type=%u (%s)",
2666d352
SM
187 action_comm->action_type,
188 lttng_action_type_string(
189 action_comm->action_type));
869a3c2d 190 consumed_len = -1;
a58c490f
JG
191 goto end;
192 }
193
c0a66c84
JG
194 {
195 /* Create buffer view for the action-type-specific data. */
196 struct lttng_payload_view specific_action_view =
197 lttng_payload_view_from_view(view,
198 sizeof(struct lttng_action_comm),
199 -1);
869a3c2d 200
c0a66c84
JG
201 specific_action_consumed_len = create_from_payload_cb(
202 &specific_action_view, action);
203 }
869a3c2d
SM
204 if (specific_action_consumed_len < 0) {
205 ERR("Failed to create specific action from buffer.");
206 consumed_len = -1;
a58c490f
JG
207 goto end;
208 }
869a3c2d
SM
209
210 assert(*action);
211
212 consumed_len = sizeof(struct lttng_action_comm) +
213 specific_action_consumed_len;
214
a58c490f 215end:
869a3c2d 216 return consumed_len;
a58c490f 217}
3dd04a6a
JR
218
219LTTNG_HIDDEN
220bool lttng_action_is_equal(const struct lttng_action *a,
221 const struct lttng_action *b)
222{
223 bool is_equal = false;
224
225 if (!a || !b) {
226 goto end;
227 }
228
229 if (a->type != b->type) {
230 goto end;
231 }
232
233 if (a == b) {
234 is_equal = true;
235 goto end;
236 }
237
238 assert(a->equal);
239 is_equal = a->equal(a, b);
240end:
241 return is_equal;
242}
This page took 0.074416 seconds and 4 git commands to generate.