2 * Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
9 #include <common/error.h>
10 #include <common/macros.h>
11 #include <common/snapshot.h>
12 #include <common/sessiond-comm/payload.h>
13 #include <common/sessiond-comm/payload-view.h>
14 #include <lttng/action/action-internal.h>
15 #include <lttng/action/snapshot-session-internal.h>
16 #include <lttng/action/snapshot-session.h>
17 #include <lttng/snapshot.h>
18 #include <lttng/snapshot-internal.h>
21 #define IS_SNAPSHOT_SESSION_ACTION(action) \
22 (lttng_action_get_type_const(action) == LTTNG_ACTION_TYPE_SNAPSHOT_SESSION)
24 struct lttng_action_snapshot_session
{
25 struct lttng_action parent
;
31 * When non-NULL, use this custom output when taking the snapshot,
32 * rather than the session's registered snapshot output.
36 struct lttng_snapshot_output
*output
;
39 struct lttng_action_snapshot_session_comm
{
40 /* All string lengths include the trailing \0. */
41 uint32_t session_name_len
;
42 uint32_t snapshot_output_len
;
45 * Variable data (all strings are null-terminated):
47 * - session name string
48 * - snapshot output object
54 static struct lttng_action_snapshot_session
*
55 action_snapshot_session_from_action(struct lttng_action
*action
)
60 action
, struct lttng_action_snapshot_session
, parent
);
63 static const struct lttng_action_snapshot_session
*
64 action_snapshot_session_from_action_const(const struct lttng_action
*action
)
69 action
, struct lttng_action_snapshot_session
, parent
);
72 static bool lttng_action_snapshot_session_validate(struct lttng_action
*action
)
75 struct lttng_action_snapshot_session
*action_snapshot_session
;
81 action_snapshot_session
= action_snapshot_session_from_action(action
);
83 /* A non-empty session name is mandatory. */
84 if (!action_snapshot_session
->session_name
||
85 strlen(action_snapshot_session
->session_name
) == 0) {
89 if (action_snapshot_session
->output
&&
90 !lttng_snapshot_output_validate(action_snapshot_session
->output
)) {
99 static bool lttng_action_snapshot_session_is_equal(
100 const struct lttng_action
*_a
, const struct lttng_action
*_b
)
102 bool is_equal
= false;
103 const struct lttng_action_snapshot_session
*a
, *b
;
105 a
= action_snapshot_session_from_action_const(_a
);
106 b
= action_snapshot_session_from_action_const(_b
);
108 /* Action is not valid if this is not true. */
109 assert(a
->session_name
);
110 assert(b
->session_name
);
111 if (strcmp(a
->session_name
, b
->session_name
)) {
115 if (a
->output
&& b
->output
&&
116 !lttng_snapshot_output_is_equal(a
->output
, b
->output
)) {
118 } else if (!!a
->output
!= !!b
->output
) {
127 static size_t serialize_strlen(const char *s
)
139 static int lttng_action_snapshot_session_serialize(
140 struct lttng_action
*action
, struct lttng_payload
*payload
)
142 struct lttng_action_snapshot_session
*action_snapshot_session
;
143 struct lttng_action_snapshot_session_comm comm
= {};
145 size_t size_before_comm
;
150 size_before_comm
= payload
->buffer
.size
;
151 size_before_comm
= size_before_comm
+ sizeof(comm
);
153 action_snapshot_session
= action_snapshot_session_from_action(action
);
154 comm
.session_name_len
=
155 serialize_strlen(action_snapshot_session
->session_name
);
158 ret
= lttng_dynamic_buffer_append(
159 &payload
->buffer
, &comm
, sizeof(comm
));
164 assert(action_snapshot_session
->session_name
);
165 DBG("Serializing snapshot session action: session-name: %s",
166 action_snapshot_session
->session_name
);
168 /* Add session name. */
169 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
170 action_snapshot_session
->session_name
,
171 comm
.session_name_len
);
176 /* Serialize the snapshot output object, if any. */
177 if (action_snapshot_session
->output
) {
178 const size_t size_before_output
= payload
->buffer
.size
;
179 struct lttng_action_snapshot_session_comm
*comm_in_payload
;
181 ret
= lttng_snapshot_output_serialize(
182 action_snapshot_session
->output
,
188 /* Adjust action length in header. */
189 comm_in_payload
= (typeof(comm_in_payload
))(
190 payload
->buffer
.data
+ size_before_comm
);
191 comm_in_payload
->snapshot_output_len
=
192 payload
->buffer
.size
- size_before_output
;
199 static void lttng_action_snapshot_session_destroy(struct lttng_action
*action
)
201 struct lttng_action_snapshot_session
*action_snapshot_session
;
207 action_snapshot_session
= action_snapshot_session_from_action(action
);
209 free(action_snapshot_session
->session_name
);
210 lttng_snapshot_output_destroy(action_snapshot_session
->output
);
211 free(action_snapshot_session
);
217 ssize_t
lttng_action_snapshot_session_create_from_payload(
218 struct lttng_payload_view
*view
,
219 struct lttng_action
**p_action
)
221 ssize_t consumed_len
;
222 const struct lttng_action_snapshot_session_comm
*comm
;
223 const char *variable_data
;
224 struct lttng_action
*action
;
225 enum lttng_action_status status
;
226 struct lttng_snapshot_output
*snapshot_output
= NULL
;
228 action
= lttng_action_snapshot_session_create();
233 comm
= (typeof(comm
)) view
->buffer
.data
;
234 variable_data
= (const char *) &comm
->data
;
236 consumed_len
= sizeof(struct lttng_action_snapshot_session_comm
);
238 if (!lttng_buffer_view_contains_string(
239 &view
->buffer
, variable_data
, comm
->session_name_len
)) {
243 status
= lttng_action_snapshot_session_set_session_name(
244 action
, variable_data
);
245 if (status
!= LTTNG_ACTION_STATUS_OK
) {
249 variable_data
+= comm
->session_name_len
;
250 consumed_len
+= comm
->session_name_len
;
252 /* If there is a snapshot output object, deserialize it. */
253 if (comm
->snapshot_output_len
> 0) {
254 ssize_t snapshot_output_consumed_len
;
255 enum lttng_action_status action_status
;
256 struct lttng_payload_view snapshot_output_buffer_view
=
257 lttng_payload_view_from_view(view
, consumed_len
,
258 comm
->snapshot_output_len
);
260 if (!snapshot_output_buffer_view
.buffer
.data
) {
261 fprintf(stderr
, "Failed to create buffer view for snapshot output.\n");
265 snapshot_output_consumed_len
=
266 lttng_snapshot_output_create_from_payload(
267 &snapshot_output_buffer_view
,
269 if (snapshot_output_consumed_len
!= comm
->snapshot_output_len
) {
271 "Failed to deserialize snapshot output object: "
272 "consumed-len: %zd, expected-len: %" PRIu32
,
273 snapshot_output_consumed_len
,
274 comm
->snapshot_output_len
);
278 action_status
= lttng_action_snapshot_session_set_output(
279 action
, snapshot_output
);
280 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
284 /* Ownership has been transferred to the action. */
285 snapshot_output
= NULL
;
288 variable_data
+= comm
->snapshot_output_len
;
289 consumed_len
+= comm
->snapshot_output_len
;
299 lttng_action_snapshot_session_destroy(action
);
300 lttng_snapshot_output_destroy(snapshot_output
);
305 struct lttng_action
*lttng_action_snapshot_session_create(void)
307 struct lttng_action
*action
;
309 action
= zmalloc(sizeof(struct lttng_action_snapshot_session
));
314 lttng_action_init(action
, LTTNG_ACTION_TYPE_SNAPSHOT_SESSION
,
315 lttng_action_snapshot_session_validate
,
316 lttng_action_snapshot_session_serialize
,
317 lttng_action_snapshot_session_is_equal
,
318 lttng_action_snapshot_session_destroy
);
324 enum lttng_action_status
lttng_action_snapshot_session_set_session_name(
325 struct lttng_action
*action
, const char *session_name
)
327 struct lttng_action_snapshot_session
*action_snapshot_session
;
328 enum lttng_action_status status
;
330 if (!action
|| !IS_SNAPSHOT_SESSION_ACTION(action
) || !session_name
||
331 strlen(session_name
) == 0) {
332 status
= LTTNG_ACTION_STATUS_INVALID
;
336 action_snapshot_session
= action_snapshot_session_from_action(action
);
338 free(action_snapshot_session
->session_name
);
340 action_snapshot_session
->session_name
= strdup(session_name
);
341 if (!action_snapshot_session
->session_name
) {
342 status
= LTTNG_ACTION_STATUS_ERROR
;
346 status
= LTTNG_ACTION_STATUS_OK
;
351 enum lttng_action_status
lttng_action_snapshot_session_get_session_name(
352 const struct lttng_action
*action
, const char **session_name
)
354 const struct lttng_action_snapshot_session
*action_snapshot_session
;
355 enum lttng_action_status status
;
357 if (!action
|| !IS_SNAPSHOT_SESSION_ACTION(action
) || !session_name
) {
358 status
= LTTNG_ACTION_STATUS_INVALID
;
362 action_snapshot_session
= action_snapshot_session_from_action_const(action
);
364 if (action_snapshot_session
->session_name
) {
365 *session_name
= action_snapshot_session
->session_name
;
366 status
= LTTNG_ACTION_STATUS_OK
;
368 status
= LTTNG_ACTION_STATUS_UNSET
;
376 enum lttng_action_status
lttng_action_snapshot_session_set_output(
377 struct lttng_action
*action
,
378 struct lttng_snapshot_output
*output
)
380 struct lttng_action_snapshot_session
*action_snapshot_session
;
381 enum lttng_action_status status
;
383 if (!action
|| !IS_SNAPSHOT_SESSION_ACTION(action
) || !output
) {
384 status
= LTTNG_ACTION_STATUS_INVALID
;
388 action_snapshot_session
= action_snapshot_session_from_action(action
);
390 lttng_snapshot_output_destroy(action_snapshot_session
->output
);
391 action_snapshot_session
->output
= output
;
393 status
= LTTNG_ACTION_STATUS_OK
;
399 enum lttng_action_status
lttng_action_snapshot_session_get_output(
400 const struct lttng_action
*action
,
401 const struct lttng_snapshot_output
**output
)
403 const struct lttng_action_snapshot_session
*action_snapshot_session
;
404 enum lttng_action_status status
;
406 if (!action
|| !IS_SNAPSHOT_SESSION_ACTION(action
)|| !output
) {
407 status
= LTTNG_ACTION_STATUS_INVALID
;
411 action_snapshot_session
= action_snapshot_session_from_action_const(action
);
413 if (action_snapshot_session
->output
) {
414 *output
= action_snapshot_session
->output
;
415 status
= LTTNG_ACTION_STATUS_OK
;
417 status
= LTTNG_ACTION_STATUS_UNSET
;