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/mi-lttng.h>
12 #include <lttng/action/action-internal.h>
13 #include <lttng/action/rate-policy-internal.h>
14 #include <lttng/action/rate-policy.h>
15 #include <lttng/action/stop-session-internal.h>
16 #include <lttng/action/stop-session.h>
18 #define IS_STOP_SESSION_ACTION(action) \
19 (lttng_action_get_type(action) == LTTNG_ACTION_TYPE_STOP_SESSION)
21 struct lttng_action_stop_session
{
22 struct lttng_action parent
;
26 struct lttng_rate_policy
*policy
;
29 struct lttng_action_stop_session_comm
{
30 /* Includes the trailing \0. */
31 uint32_t session_name_len
;
36 * - session name (null terminated)
42 static const struct lttng_rate_policy
*
43 lttng_action_stop_session_internal_get_rate_policy(
44 const struct lttng_action
*action
);
46 static struct lttng_action_stop_session
*action_stop_session_from_action(
47 struct lttng_action
*action
)
51 return container_of(action
, struct lttng_action_stop_session
, parent
);
54 static const struct lttng_action_stop_session
*
55 action_stop_session_from_action_const(const struct lttng_action
*action
)
59 return container_of(action
, struct lttng_action_stop_session
, parent
);
62 static bool lttng_action_stop_session_validate(struct lttng_action
*action
)
65 struct lttng_action_stop_session
*action_stop_session
;
72 action_stop_session
= action_stop_session_from_action(action
);
74 /* A non-empty session name is mandatory. */
75 if (!action_stop_session
->session_name
||
76 strlen(action_stop_session
->session_name
) == 0) {
86 static bool lttng_action_stop_session_is_equal(
87 const struct lttng_action
*_a
, const struct lttng_action
*_b
)
89 bool is_equal
= false;
90 const struct lttng_action_stop_session
*a
, *b
;
92 a
= action_stop_session_from_action_const(_a
);
93 b
= action_stop_session_from_action_const(_b
);
95 /* Action is not valid if this is not true. */
96 assert(a
->session_name
);
97 assert(b
->session_name
);
98 if (strcmp(a
->session_name
, b
->session_name
)) {
102 is_equal
= lttng_rate_policy_is_equal(a
->policy
, b
->policy
);
107 static int lttng_action_stop_session_serialize(
108 struct lttng_action
*action
, struct lttng_payload
*payload
)
110 struct lttng_action_stop_session
*action_stop_session
;
111 struct lttng_action_stop_session_comm comm
;
112 size_t session_name_len
;
118 action_stop_session
= action_stop_session_from_action(action
);
120 assert(action_stop_session
->session_name
);
122 DBG("Serializing stop session action: session-name: %s",
123 action_stop_session
->session_name
);
125 session_name_len
= strlen(action_stop_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_stop_session
->session_name
, session_name_len
);
142 ret
= lttng_rate_policy_serialize(action_stop_session
->policy
, payload
);
153 static void lttng_action_stop_session_destroy(struct lttng_action
*action
)
155 struct lttng_action_stop_session
*action_stop_session
;
161 action_stop_session
= action_stop_session_from_action(action
);
163 lttng_rate_policy_destroy(action_stop_session
->policy
);
164 free(action_stop_session
->session_name
);
165 free(action_stop_session
);
171 ssize_t
lttng_action_stop_session_create_from_payload(
172 struct lttng_payload_view
*view
,
173 struct lttng_action
**p_action
)
175 ssize_t consumed_len
, ret
;
176 const struct lttng_action_stop_session_comm
*comm
;
177 const char *session_name
;
178 struct lttng_action
*action
= NULL
;
179 enum lttng_action_status status
;
180 struct lttng_rate_policy
*policy
= NULL
;
182 comm
= (typeof(comm
)) view
->buffer
.data
;
183 session_name
= (const char *) &comm
->data
;
186 if (!lttng_buffer_view_contains_string(
187 &view
->buffer
, session_name
, comm
->session_name_len
)) {
191 consumed_len
= sizeof(*comm
) + comm
->session_name_len
;
195 struct lttng_payload_view policy_view
=
196 lttng_payload_view_from_view(
197 view
, consumed_len
, -1);
198 ret
= lttng_rate_policy_create_from_payload(
199 &policy_view
, &policy
);
207 action
= lttng_action_stop_session_create();
213 status
= lttng_action_stop_session_set_session_name(
214 action
, session_name
);
215 if (status
!= LTTNG_ACTION_STATUS_OK
) {
221 status
= lttng_action_stop_session_set_rate_policy(action
, policy
);
222 if (status
!= LTTNG_ACTION_STATUS_OK
) {
231 lttng_rate_policy_destroy(policy
);
232 lttng_action_stop_session_destroy(action
);
237 static enum lttng_error_code
lttng_action_stop_session_mi_serialize(
238 const struct lttng_action
*action
, struct mi_writer
*writer
)
241 enum lttng_error_code ret_code
;
242 enum lttng_action_status status
;
243 const char *session_name
= NULL
;
244 const struct lttng_rate_policy
*policy
= NULL
;
247 assert(IS_STOP_SESSION_ACTION(action
));
249 status
= lttng_action_stop_session_get_session_name(
250 action
, &session_name
);
251 assert(status
== LTTNG_ACTION_STATUS_OK
);
252 assert(session_name
!= NULL
);
254 status
= lttng_action_stop_session_get_rate_policy(action
, &policy
);
255 assert(status
== LTTNG_ACTION_STATUS_OK
);
256 assert(policy
!= NULL
);
258 /* Open action stop session. */
259 ret
= mi_lttng_writer_open_element(
260 writer
, mi_lttng_element_action_start_session
);
266 ret
= mi_lttng_writer_write_element_string(
267 writer
, mi_lttng_element_session_name
, session_name
);
273 ret_code
= lttng_rate_policy_mi_serialize(policy
, writer
);
274 if (ret_code
!= LTTNG_OK
) {
278 /* Close action stop session element. */
279 ret
= mi_lttng_writer_close_element(writer
);
288 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
293 struct lttng_action
*lttng_action_stop_session_create(void)
295 struct lttng_action
*action
= NULL
;
296 struct lttng_rate_policy
*policy
= NULL
;
297 enum lttng_action_status status
;
299 /* Create a every N = 1 rate policy. */
300 policy
= lttng_rate_policy_every_n_create(1);
305 action
= zmalloc(sizeof(struct lttng_action_stop_session
));
310 lttng_action_init(action
, LTTNG_ACTION_TYPE_STOP_SESSION
,
311 lttng_action_stop_session_validate
,
312 lttng_action_stop_session_serialize
,
313 lttng_action_stop_session_is_equal
,
314 lttng_action_stop_session_destroy
,
315 lttng_action_stop_session_internal_get_rate_policy
,
316 lttng_action_generic_add_error_query_results
,
317 lttng_action_stop_session_mi_serialize
);
319 status
= lttng_action_stop_session_set_rate_policy(action
, policy
);
320 if (status
!= LTTNG_ACTION_STATUS_OK
) {
327 lttng_rate_policy_destroy(policy
);
331 enum lttng_action_status
lttng_action_stop_session_set_session_name(
332 struct lttng_action
*action
, const char *session_name
)
334 struct lttng_action_stop_session
*action_stop_session
;
335 enum lttng_action_status status
;
337 if (!action
|| !IS_STOP_SESSION_ACTION(action
) || !session_name
||
338 strlen(session_name
) == 0) {
339 status
= LTTNG_ACTION_STATUS_INVALID
;
343 action_stop_session
= action_stop_session_from_action(action
);
345 free(action_stop_session
->session_name
);
347 action_stop_session
->session_name
= strdup(session_name
);
348 if (!action_stop_session
->session_name
) {
349 status
= LTTNG_ACTION_STATUS_ERROR
;
353 status
= LTTNG_ACTION_STATUS_OK
;
358 enum lttng_action_status
lttng_action_stop_session_get_session_name(
359 const struct lttng_action
*action
, const char **session_name
)
361 const struct lttng_action_stop_session
*action_stop_session
;
362 enum lttng_action_status status
;
364 if (!action
|| !IS_STOP_SESSION_ACTION(action
) || !session_name
) {
365 status
= LTTNG_ACTION_STATUS_INVALID
;
369 action_stop_session
= action_stop_session_from_action_const(action
);
371 *session_name
= action_stop_session
->session_name
;
373 status
= LTTNG_ACTION_STATUS_OK
;
378 enum lttng_action_status
lttng_action_stop_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_stop_session
*stop_session_action
;
384 struct lttng_rate_policy
*copy
= NULL
;
386 if (!action
|| !policy
|| !IS_STOP_SESSION_ACTION(action
)) {
387 status
= LTTNG_ACTION_STATUS_INVALID
;
391 copy
= lttng_rate_policy_copy(policy
);
393 status
= LTTNG_ACTION_STATUS_ERROR
;
396 stop_session_action
= action_stop_session_from_action(action
);
398 /* Free the previous rate policy .*/
399 lttng_rate_policy_destroy(stop_session_action
->policy
);
401 stop_session_action
->policy
= copy
;
402 status
= LTTNG_ACTION_STATUS_OK
;
406 lttng_rate_policy_destroy(copy
);
410 enum lttng_action_status
lttng_action_stop_session_get_rate_policy(
411 const struct lttng_action
*action
,
412 const struct lttng_rate_policy
**policy
)
414 enum lttng_action_status status
;
415 const struct lttng_action_stop_session
*stop_session_action
;
417 if (!action
|| !policy
|| !IS_STOP_SESSION_ACTION(action
)) {
418 status
= LTTNG_ACTION_STATUS_INVALID
;
422 stop_session_action
= action_stop_session_from_action_const(action
);
424 *policy
= stop_session_action
->policy
;
425 status
= LTTNG_ACTION_STATUS_OK
;
430 static const struct lttng_rate_policy
*
431 lttng_action_stop_session_internal_get_rate_policy(
432 const struct lttng_action
*action
)
434 const struct lttng_action_stop_session
*_action
;
435 _action
= action_stop_session_from_action_const(action
);
437 return _action
->policy
;