2 * Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #include <common/error.hpp>
9 #include <common/macros.hpp>
10 #include <common/mi-lttng.hpp>
11 #include <lttng/action/action-internal.hpp>
12 #include <lttng/action/rate-policy-internal.hpp>
13 #include <lttng/action/rate-policy.h>
14 #include <lttng/action/rotate-session-internal.hpp>
15 #include <lttng/action/rotate-session.h>
17 #define IS_ROTATE_SESSION_ACTION(action) \
18 (lttng_action_get_type(action) == LTTNG_ACTION_TYPE_ROTATE_SESSION)
21 struct lttng_action_rotate_session
{
22 struct lttng_action parent
;
26 struct lttng_rate_policy
*policy
;
29 struct lttng_action_rotate_session_comm
{
30 /* Includes the trailing \0. */
31 uint32_t session_name_len
;
36 * - session name (null terminated)
43 static const struct lttng_rate_policy
*
44 lttng_action_rotate_session_internal_get_rate_policy(
45 const struct lttng_action
*action
);
47 static struct lttng_action_rotate_session
*action_rotate_session_from_action(
48 struct lttng_action
*action
)
52 return container_of(action
, struct lttng_action_rotate_session
, parent
);
55 static const struct lttng_action_rotate_session
*
56 action_rotate_session_from_action_const(const struct lttng_action
*action
)
60 return container_of(action
, struct lttng_action_rotate_session
, parent
);
63 static bool lttng_action_rotate_session_validate(struct lttng_action
*action
)
66 struct lttng_action_rotate_session
*action_rotate_session
;
73 action_rotate_session
= action_rotate_session_from_action(action
);
75 /* A non-empty session name is mandatory. */
76 if (!action_rotate_session
->session_name
||
77 strlen(action_rotate_session
->session_name
) == 0) {
87 static bool lttng_action_rotate_session_is_equal(
88 const struct lttng_action
*_a
, const struct lttng_action
*_b
)
90 bool is_equal
= false;
91 const struct lttng_action_rotate_session
*a
, *b
;
93 a
= action_rotate_session_from_action_const(_a
);
94 b
= action_rotate_session_from_action_const(_b
);
96 /* Action is not valid if this is not true. */
97 LTTNG_ASSERT(a
->session_name
);
98 LTTNG_ASSERT(b
->session_name
);
99 if (strcmp(a
->session_name
, b
->session_name
)) {
103 is_equal
= lttng_rate_policy_is_equal(a
->policy
, b
->policy
);
107 static int lttng_action_rotate_session_serialize(
108 struct lttng_action
*action
, struct lttng_payload
*payload
)
110 struct lttng_action_rotate_session
*action_rotate_session
;
111 struct lttng_action_rotate_session_comm comm
;
112 size_t session_name_len
;
115 LTTNG_ASSERT(action
);
116 LTTNG_ASSERT(payload
);
118 action_rotate_session
= action_rotate_session_from_action(action
);
120 LTTNG_ASSERT(action_rotate_session
->session_name
);
122 DBG("Serializing rotate session action: session-name: %s",
123 action_rotate_session
->session_name
);
125 session_name_len
= strlen(action_rotate_session
->session_name
) + 1;
126 comm
.session_name_len
= session_name_len
;
128 ret
= lttng_dynamic_buffer_append(
129 &payload
->buffer
, &comm
, sizeof(comm
));
135 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
136 action_rotate_session
->session_name
, session_name_len
);
142 ret
= lttng_rate_policy_serialize(
143 action_rotate_session
->policy
, payload
);
152 static void lttng_action_rotate_session_destroy(struct lttng_action
*action
)
154 struct lttng_action_rotate_session
*action_rotate_session
;
160 action_rotate_session
= action_rotate_session_from_action(action
);
162 lttng_rate_policy_destroy(action_rotate_session
->policy
);
163 free(action_rotate_session
->session_name
);
164 free(action_rotate_session
);
170 ssize_t
lttng_action_rotate_session_create_from_payload(
171 struct lttng_payload_view
*view
,
172 struct lttng_action
**p_action
)
174 ssize_t consumed_len
, ret
;
175 const struct lttng_action_rotate_session_comm
*comm
;
176 const char *session_name
;
177 struct lttng_action
*action
;
178 enum lttng_action_status status
;
179 struct lttng_rate_policy
*policy
= NULL
;
181 action
= lttng_action_rotate_session_create();
187 comm
= (typeof(comm
)) view
->buffer
.data
;
188 session_name
= (const char *) &comm
->data
;
190 if (!lttng_buffer_view_contains_string(
191 &view
->buffer
, session_name
, comm
->session_name_len
)) {
195 consumed_len
= sizeof(*comm
) + comm
->session_name_len
;
199 struct lttng_payload_view policy_view
=
200 lttng_payload_view_from_view(
201 view
, consumed_len
, -1);
202 ret
= lttng_rate_policy_create_from_payload(
203 &policy_view
, &policy
);
211 status
= lttng_action_rotate_session_set_session_name(
212 action
, session_name
);
213 if (status
!= LTTNG_ACTION_STATUS_OK
) {
218 LTTNG_ASSERT(policy
);
219 status
= lttng_action_rotate_session_set_rate_policy(action
, policy
);
220 if (status
!= LTTNG_ACTION_STATUS_OK
) {
229 lttng_rate_policy_destroy(policy
);
230 lttng_action_rotate_session_destroy(action
);
235 static enum lttng_error_code
lttng_action_rotate_session_mi_serialize(
236 const struct lttng_action
*action
, struct mi_writer
*writer
)
239 enum lttng_error_code ret_code
;
240 enum lttng_action_status status
;
241 const char *session_name
= NULL
;
242 const struct lttng_rate_policy
*policy
= NULL
;
244 LTTNG_ASSERT(action
);
245 LTTNG_ASSERT(IS_ROTATE_SESSION_ACTION(action
));
247 status
= lttng_action_rotate_session_get_session_name(
248 action
, &session_name
);
249 LTTNG_ASSERT(status
== LTTNG_ACTION_STATUS_OK
);
250 LTTNG_ASSERT(session_name
!= NULL
);
252 status
= lttng_action_notify_get_rate_policy(action
, &policy
);
253 LTTNG_ASSERT(status
== LTTNG_ACTION_STATUS_OK
);
254 LTTNG_ASSERT(policy
!= NULL
);
256 /* Open action rotate session element. */
257 ret
= mi_lttng_writer_open_element(
258 writer
, mi_lttng_element_action_rotate_session
);
264 ret
= mi_lttng_writer_write_element_string(
265 writer
, mi_lttng_element_session_name
, session_name
);
271 ret_code
= lttng_rate_policy_mi_serialize(policy
, writer
);
272 if (ret_code
!= LTTNG_OK
) {
276 /* Close action rotate session element. */
277 ret
= mi_lttng_writer_close_element(writer
);
286 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
291 struct lttng_action
*lttng_action_rotate_session_create(void)
293 struct lttng_action_rotate_session
*action_rotate
= NULL
;
294 struct lttng_rate_policy
*policy
= NULL
;
295 enum lttng_action_status status
;
297 /* Create a every N = 1 rate policy. */
298 policy
= lttng_rate_policy_every_n_create(1);
303 action_rotate
= zmalloc
<lttng_action_rotate_session
>();
304 if (!action_rotate
) {
308 lttng_action_init(&action_rotate
->parent
,
309 LTTNG_ACTION_TYPE_ROTATE_SESSION
,
310 lttng_action_rotate_session_validate
,
311 lttng_action_rotate_session_serialize
,
312 lttng_action_rotate_session_is_equal
,
313 lttng_action_rotate_session_destroy
,
314 lttng_action_rotate_session_internal_get_rate_policy
,
315 lttng_action_generic_add_error_query_results
,
316 lttng_action_rotate_session_mi_serialize
);
318 status
= lttng_action_rotate_session_set_rate_policy(
319 &action_rotate
->parent
, policy
);
320 if (status
!= LTTNG_ACTION_STATUS_OK
) {
321 lttng_action_destroy(&action_rotate
->parent
);
322 action_rotate
= NULL
;
327 lttng_rate_policy_destroy(policy
);
328 return action_rotate
? &action_rotate
->parent
: nullptr;
331 enum lttng_action_status
lttng_action_rotate_session_set_session_name(
332 struct lttng_action
*action
, const char *session_name
)
334 struct lttng_action_rotate_session
*action_rotate_session
;
335 enum lttng_action_status status
;
337 if (!action
|| !IS_ROTATE_SESSION_ACTION(action
) || !session_name
||
338 strlen(session_name
) == 0) {
339 status
= LTTNG_ACTION_STATUS_INVALID
;
343 action_rotate_session
= action_rotate_session_from_action(action
);
345 free(action_rotate_session
->session_name
);
347 action_rotate_session
->session_name
= strdup(session_name
);
348 if (!action_rotate_session
->session_name
) {
349 status
= LTTNG_ACTION_STATUS_ERROR
;
353 status
= LTTNG_ACTION_STATUS_OK
;
358 enum lttng_action_status
lttng_action_rotate_session_get_session_name(
359 const struct lttng_action
*action
, const char **session_name
)
361 const struct lttng_action_rotate_session
*action_rotate_session
;
362 enum lttng_action_status status
;
364 if (!action
|| !IS_ROTATE_SESSION_ACTION(action
) || !session_name
) {
365 status
= LTTNG_ACTION_STATUS_INVALID
;
369 action_rotate_session
= action_rotate_session_from_action_const(action
);
371 *session_name
= action_rotate_session
->session_name
;
373 status
= LTTNG_ACTION_STATUS_OK
;
378 enum lttng_action_status
lttng_action_rotate_session_set_rate_policy(
379 struct lttng_action
*action
,
380 const struct lttng_rate_policy
*policy
)
382 enum lttng_action_status status
;
383 struct lttng_action_rotate_session
*rotate_session_action
;
384 struct lttng_rate_policy
*copy
= NULL
;
386 if (!action
|| !policy
|| !IS_ROTATE_SESSION_ACTION(action
)) {
387 status
= LTTNG_ACTION_STATUS_INVALID
;
391 copy
= lttng_rate_policy_copy(policy
);
393 status
= LTTNG_ACTION_STATUS_ERROR
;
397 rotate_session_action
= action_rotate_session_from_action(action
);
399 /* Free the previous rate policy .*/
400 lttng_rate_policy_destroy(rotate_session_action
->policy
);
402 /* Assign the policy. */
403 rotate_session_action
->policy
= copy
;
404 status
= LTTNG_ACTION_STATUS_OK
;
408 lttng_rate_policy_destroy(copy
);
412 enum lttng_action_status
lttng_action_rotate_session_get_rate_policy(
413 const struct lttng_action
*action
,
414 const struct lttng_rate_policy
**policy
)
416 enum lttng_action_status status
;
417 const struct lttng_action_rotate_session
*rotate_session_action
;
419 if (!action
|| !policy
|| !IS_ROTATE_SESSION_ACTION(action
)) {
420 status
= LTTNG_ACTION_STATUS_INVALID
;
424 rotate_session_action
= action_rotate_session_from_action_const(action
);
426 *policy
= rotate_session_action
->policy
;
427 status
= LTTNG_ACTION_STATUS_OK
;
432 static const struct lttng_rate_policy
*
433 lttng_action_rotate_session_internal_get_rate_policy(
434 const struct lttng_action
*action
)
436 const struct lttng_action_rotate_session
*_action
;
437 _action
= action_rotate_session_from_action_const(action
);
439 return _action
->policy
;