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