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>
12 #include <lttng/action/action-internal.hpp>
13 #include <lttng/action/rate-policy-internal.hpp>
14 #include <lttng/action/rate-policy.h>
15 #include <lttng/action/rotate-session-internal.hpp>
16 #include <lttng/action/rotate-session.h>
18 #define IS_ROTATE_SESSION_ACTION(action) \
19 (lttng_action_get_type(action) == LTTNG_ACTION_TYPE_ROTATE_SESSION)
22 struct lttng_action_rotate_session
{
23 struct lttng_action parent
;
27 struct lttng_rate_policy
*policy
;
30 struct lttng_action_rotate_session_comm
{
31 /* Includes the trailing \0. */
32 uint32_t session_name_len
;
37 * - session name (null terminated)
44 static const struct lttng_rate_policy
*
45 lttng_action_rotate_session_internal_get_rate_policy(const struct lttng_action
*action
);
47 static struct lttng_action_rotate_session
*
48 action_rotate_session_from_action(struct lttng_action
*action
)
52 return lttng::utils::container_of(action
, <tng_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 lttng::utils::container_of(action
, <tng_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(const struct lttng_action
*_a
,
88 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
) != 0) {
103 is_equal
= lttng_rate_policy_is_equal(a
->policy
, b
->policy
);
107 static int lttng_action_rotate_session_serialize(struct lttng_action
*action
,
108 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(&payload
->buffer
, &comm
, sizeof(comm
));
134 ret
= lttng_dynamic_buffer_append(
135 &payload
->buffer
, action_rotate_session
->session_name
, session_name_len
);
141 ret
= lttng_rate_policy_serialize(action_rotate_session
->policy
, payload
);
150 static void lttng_action_rotate_session_destroy(struct lttng_action
*action
)
152 struct lttng_action_rotate_session
*action_rotate_session
;
158 action_rotate_session
= action_rotate_session_from_action(action
);
160 lttng_rate_policy_destroy(action_rotate_session
->policy
);
161 free(action_rotate_session
->session_name
);
162 free(action_rotate_session
);
168 ssize_t
lttng_action_rotate_session_create_from_payload(struct lttng_payload_view
*view
,
169 struct lttng_action
**p_action
)
171 ssize_t consumed_len
, ret
;
172 const struct lttng_action_rotate_session_comm
*comm
;
173 const char *session_name
;
174 struct lttng_action
*action
;
175 enum lttng_action_status status
;
176 struct lttng_rate_policy
*policy
= nullptr;
178 action
= lttng_action_rotate_session_create();
184 comm
= (typeof(comm
)) view
->buffer
.data
;
185 session_name
= (const char *) &comm
->data
;
187 if (!lttng_buffer_view_contains_string(
188 &view
->buffer
, session_name
, comm
->session_name_len
)) {
192 consumed_len
= sizeof(*comm
) + comm
->session_name_len
;
196 struct lttng_payload_view policy_view
=
197 lttng_payload_view_from_view(view
, consumed_len
, -1);
198 ret
= lttng_rate_policy_create_from_payload(&policy_view
, &policy
);
206 status
= lttng_action_rotate_session_set_session_name(action
, session_name
);
207 if (status
!= LTTNG_ACTION_STATUS_OK
) {
212 LTTNG_ASSERT(policy
);
213 status
= lttng_action_rotate_session_set_rate_policy(action
, policy
);
214 if (status
!= LTTNG_ACTION_STATUS_OK
) {
223 lttng_rate_policy_destroy(policy
);
224 lttng_action_rotate_session_destroy(action
);
229 static enum lttng_error_code
230 lttng_action_rotate_session_mi_serialize(const struct lttng_action
*action
,
231 struct mi_writer
*writer
)
234 enum lttng_error_code ret_code
;
235 enum lttng_action_status status
;
236 const char *session_name
= nullptr;
237 const struct lttng_rate_policy
*policy
= nullptr;
239 LTTNG_ASSERT(action
);
240 LTTNG_ASSERT(IS_ROTATE_SESSION_ACTION(action
));
242 status
= lttng_action_rotate_session_get_session_name(action
, &session_name
);
243 LTTNG_ASSERT(status
== LTTNG_ACTION_STATUS_OK
);
244 LTTNG_ASSERT(session_name
!= nullptr);
246 status
= lttng_action_notify_get_rate_policy(action
, &policy
);
247 LTTNG_ASSERT(status
== LTTNG_ACTION_STATUS_OK
);
248 LTTNG_ASSERT(policy
!= nullptr);
250 /* Open action rotate session element. */
251 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_action_rotate_session
);
257 ret
= mi_lttng_writer_write_element_string(
258 writer
, mi_lttng_element_session_name
, session_name
);
264 ret_code
= lttng_rate_policy_mi_serialize(policy
, writer
);
265 if (ret_code
!= LTTNG_OK
) {
269 /* Close action rotate session element. */
270 ret
= mi_lttng_writer_close_element(writer
);
279 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
284 struct lttng_action
*lttng_action_rotate_session_create(void)
286 struct lttng_action_rotate_session
*action_rotate
= nullptr;
287 struct lttng_rate_policy
*policy
= nullptr;
288 enum lttng_action_status status
;
290 /* Create a every N = 1 rate policy. */
291 policy
= lttng_rate_policy_every_n_create(1);
296 action_rotate
= zmalloc
<lttng_action_rotate_session
>();
297 if (!action_rotate
) {
301 lttng_action_init(&action_rotate
->parent
,
302 LTTNG_ACTION_TYPE_ROTATE_SESSION
,
303 lttng_action_rotate_session_validate
,
304 lttng_action_rotate_session_serialize
,
305 lttng_action_rotate_session_is_equal
,
306 lttng_action_rotate_session_destroy
,
307 lttng_action_rotate_session_internal_get_rate_policy
,
308 lttng_action_generic_add_error_query_results
,
309 lttng_action_rotate_session_mi_serialize
);
311 status
= lttng_action_rotate_session_set_rate_policy(&action_rotate
->parent
, policy
);
312 if (status
!= LTTNG_ACTION_STATUS_OK
) {
313 lttng_action_destroy(&action_rotate
->parent
);
314 action_rotate
= nullptr;
319 lttng_rate_policy_destroy(policy
);
320 return action_rotate
? &action_rotate
->parent
: nullptr;
323 enum lttng_action_status
lttng_action_rotate_session_set_session_name(struct lttng_action
*action
,
324 const char *session_name
)
326 struct lttng_action_rotate_session
*action_rotate_session
;
327 enum lttng_action_status status
;
329 if (!action
|| !IS_ROTATE_SESSION_ACTION(action
) || !session_name
||
330 strlen(session_name
) == 0) {
331 status
= LTTNG_ACTION_STATUS_INVALID
;
335 action_rotate_session
= action_rotate_session_from_action(action
);
337 free(action_rotate_session
->session_name
);
339 action_rotate_session
->session_name
= strdup(session_name
);
340 if (!action_rotate_session
->session_name
) {
341 status
= LTTNG_ACTION_STATUS_ERROR
;
345 status
= LTTNG_ACTION_STATUS_OK
;
350 enum lttng_action_status
351 lttng_action_rotate_session_get_session_name(const struct lttng_action
*action
,
352 const char **session_name
)
354 const struct lttng_action_rotate_session
*action_rotate_session
;
355 enum lttng_action_status status
;
357 if (!action
|| !IS_ROTATE_SESSION_ACTION(action
) || !session_name
) {
358 status
= LTTNG_ACTION_STATUS_INVALID
;
362 action_rotate_session
= action_rotate_session_from_action_const(action
);
364 *session_name
= action_rotate_session
->session_name
;
366 status
= LTTNG_ACTION_STATUS_OK
;
371 enum lttng_action_status
372 lttng_action_rotate_session_set_rate_policy(struct lttng_action
*action
,
373 const struct lttng_rate_policy
*policy
)
375 enum lttng_action_status status
;
376 struct lttng_action_rotate_session
*rotate_session_action
;
377 struct lttng_rate_policy
*copy
= nullptr;
379 if (!action
|| !policy
|| !IS_ROTATE_SESSION_ACTION(action
)) {
380 status
= LTTNG_ACTION_STATUS_INVALID
;
384 copy
= lttng_rate_policy_copy(policy
);
386 status
= LTTNG_ACTION_STATUS_ERROR
;
390 rotate_session_action
= action_rotate_session_from_action(action
);
392 /* Free the previous rate policy .*/
393 lttng_rate_policy_destroy(rotate_session_action
->policy
);
395 /* Assign the policy. */
396 rotate_session_action
->policy
= copy
;
397 status
= LTTNG_ACTION_STATUS_OK
;
401 lttng_rate_policy_destroy(copy
);
405 enum lttng_action_status
406 lttng_action_rotate_session_get_rate_policy(const struct lttng_action
*action
,
407 const struct lttng_rate_policy
**policy
)
409 enum lttng_action_status status
;
410 const struct lttng_action_rotate_session
*rotate_session_action
;
412 if (!action
|| !policy
|| !IS_ROTATE_SESSION_ACTION(action
)) {
413 status
= LTTNG_ACTION_STATUS_INVALID
;
417 rotate_session_action
= action_rotate_session_from_action_const(action
);
419 *policy
= rotate_session_action
->policy
;
420 status
= LTTNG_ACTION_STATUS_OK
;
425 static const struct lttng_rate_policy
*
426 lttng_action_rotate_session_internal_get_rate_policy(const struct lttng_action
*action
)
428 const struct lttng_action_rotate_session
*_action
;
429 _action
= action_rotate_session_from_action_const(action
);
431 return _action
->policy
;