2 * Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #include <common/error.h>
9 #include <common/macros.h>
10 #include <common/mi-lttng.h>
11 #include <lttng/action/action-internal.h>
12 #include <lttng/action/rate-policy-internal.h>
13 #include <lttng/action/rate-policy.h>
14 #include <lttng/action/stop-session-internal.h>
15 #include <lttng/action/stop-session.h>
17 #define IS_STOP_SESSION_ACTION(action) \
18 (lttng_action_get_type(action) == LTTNG_ACTION_TYPE_STOP_SESSION)
20 struct lttng_action_stop_session
{
21 struct lttng_action parent
;
25 struct lttng_rate_policy
*policy
;
28 struct lttng_action_stop_session_comm
{
29 /* Includes the trailing \0. */
30 uint32_t session_name_len
;
35 * - session name (null terminated)
41 static const struct lttng_rate_policy
*
42 lttng_action_stop_session_internal_get_rate_policy(
43 const struct lttng_action
*action
);
45 static struct lttng_action_stop_session
*action_stop_session_from_action(
46 struct lttng_action
*action
)
50 return container_of(action
, struct lttng_action_stop_session
, parent
);
53 static const struct lttng_action_stop_session
*
54 action_stop_session_from_action_const(const struct lttng_action
*action
)
58 return container_of(action
, struct lttng_action_stop_session
, parent
);
61 static bool lttng_action_stop_session_validate(struct lttng_action
*action
)
64 struct lttng_action_stop_session
*action_stop_session
;
71 action_stop_session
= action_stop_session_from_action(action
);
73 /* A non-empty session name is mandatory. */
74 if (!action_stop_session
->session_name
||
75 strlen(action_stop_session
->session_name
) == 0) {
85 static bool lttng_action_stop_session_is_equal(
86 const struct lttng_action
*_a
, const struct lttng_action
*_b
)
88 bool is_equal
= false;
89 const struct lttng_action_stop_session
*a
, *b
;
91 a
= action_stop_session_from_action_const(_a
);
92 b
= action_stop_session_from_action_const(_b
);
94 /* Action is not valid if this is not true. */
95 LTTNG_ASSERT(a
->session_name
);
96 LTTNG_ASSERT(b
->session_name
);
97 if (strcmp(a
->session_name
, b
->session_name
)) {
101 is_equal
= lttng_rate_policy_is_equal(a
->policy
, b
->policy
);
106 static int lttng_action_stop_session_serialize(
107 struct lttng_action
*action
, struct lttng_payload
*payload
)
109 struct lttng_action_stop_session
*action_stop_session
;
110 struct lttng_action_stop_session_comm comm
;
111 size_t session_name_len
;
114 LTTNG_ASSERT(action
);
115 LTTNG_ASSERT(payload
);
117 action_stop_session
= action_stop_session_from_action(action
);
119 LTTNG_ASSERT(action_stop_session
->session_name
);
121 DBG("Serializing stop session action: session-name: %s",
122 action_stop_session
->session_name
);
124 session_name_len
= strlen(action_stop_session
->session_name
) + 1;
125 comm
.session_name_len
= session_name_len
;
127 ret
= lttng_dynamic_buffer_append(
128 &payload
->buffer
, &comm
, sizeof(comm
));
134 ret
= lttng_dynamic_buffer_append(&payload
->buffer
,
135 action_stop_session
->session_name
, session_name_len
);
141 ret
= lttng_rate_policy_serialize(action_stop_session
->policy
, payload
);
152 static void lttng_action_stop_session_destroy(struct lttng_action
*action
)
154 struct lttng_action_stop_session
*action_stop_session
;
160 action_stop_session
= action_stop_session_from_action(action
);
162 lttng_rate_policy_destroy(action_stop_session
->policy
);
163 free(action_stop_session
->session_name
);
164 free(action_stop_session
);
170 ssize_t
lttng_action_stop_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_stop_session_comm
*comm
;
176 const char *session_name
;
177 struct lttng_action
*action
= NULL
;
178 enum lttng_action_status status
;
179 struct lttng_rate_policy
*policy
= NULL
;
181 comm
= (typeof(comm
)) view
->buffer
.data
;
182 session_name
= (const char *) &comm
->data
;
185 if (!lttng_buffer_view_contains_string(
186 &view
->buffer
, session_name
, comm
->session_name_len
)) {
190 consumed_len
= sizeof(*comm
) + comm
->session_name_len
;
194 struct lttng_payload_view policy_view
=
195 lttng_payload_view_from_view(
196 view
, consumed_len
, -1);
197 ret
= lttng_rate_policy_create_from_payload(
198 &policy_view
, &policy
);
206 action
= lttng_action_stop_session_create();
212 status
= lttng_action_stop_session_set_session_name(
213 action
, session_name
);
214 if (status
!= LTTNG_ACTION_STATUS_OK
) {
219 LTTNG_ASSERT(policy
);
220 status
= lttng_action_stop_session_set_rate_policy(action
, policy
);
221 if (status
!= LTTNG_ACTION_STATUS_OK
) {
230 lttng_rate_policy_destroy(policy
);
231 lttng_action_stop_session_destroy(action
);
236 static enum lttng_error_code
lttng_action_stop_session_mi_serialize(
237 const struct lttng_action
*action
, struct mi_writer
*writer
)
240 enum lttng_error_code ret_code
;
241 enum lttng_action_status status
;
242 const char *session_name
= NULL
;
243 const struct lttng_rate_policy
*policy
= NULL
;
245 LTTNG_ASSERT(action
);
246 LTTNG_ASSERT(IS_STOP_SESSION_ACTION(action
));
248 status
= lttng_action_stop_session_get_session_name(
249 action
, &session_name
);
250 LTTNG_ASSERT(status
== LTTNG_ACTION_STATUS_OK
);
251 LTTNG_ASSERT(session_name
!= NULL
);
253 status
= lttng_action_stop_session_get_rate_policy(action
, &policy
);
254 LTTNG_ASSERT(status
== LTTNG_ACTION_STATUS_OK
);
255 LTTNG_ASSERT(policy
!= NULL
);
257 /* Open action stop session. */
258 ret
= mi_lttng_writer_open_element(
259 writer
, mi_lttng_element_action_start_session
);
265 ret
= mi_lttng_writer_write_element_string(
266 writer
, mi_lttng_element_session_name
, session_name
);
272 ret_code
= lttng_rate_policy_mi_serialize(policy
, writer
);
273 if (ret_code
!= LTTNG_OK
) {
277 /* Close action stop session element. */
278 ret
= mi_lttng_writer_close_element(writer
);
287 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
292 struct lttng_action
*lttng_action_stop_session_create(void)
294 struct lttng_action
*action
= NULL
;
295 struct lttng_rate_policy
*policy
= NULL
;
296 enum lttng_action_status status
;
298 /* Create a every N = 1 rate policy. */
299 policy
= lttng_rate_policy_every_n_create(1);
304 action
= (lttng_action
*) zmalloc(sizeof(struct lttng_action_stop_session
));
309 lttng_action_init(action
, LTTNG_ACTION_TYPE_STOP_SESSION
,
310 lttng_action_stop_session_validate
,
311 lttng_action_stop_session_serialize
,
312 lttng_action_stop_session_is_equal
,
313 lttng_action_stop_session_destroy
,
314 lttng_action_stop_session_internal_get_rate_policy
,
315 lttng_action_generic_add_error_query_results
,
316 lttng_action_stop_session_mi_serialize
);
318 status
= lttng_action_stop_session_set_rate_policy(action
, policy
);
319 if (status
!= LTTNG_ACTION_STATUS_OK
) {
326 lttng_rate_policy_destroy(policy
);
330 enum lttng_action_status
lttng_action_stop_session_set_session_name(
331 struct lttng_action
*action
, const char *session_name
)
333 struct lttng_action_stop_session
*action_stop_session
;
334 enum lttng_action_status status
;
336 if (!action
|| !IS_STOP_SESSION_ACTION(action
) || !session_name
||
337 strlen(session_name
) == 0) {
338 status
= LTTNG_ACTION_STATUS_INVALID
;
342 action_stop_session
= action_stop_session_from_action(action
);
344 free(action_stop_session
->session_name
);
346 action_stop_session
->session_name
= strdup(session_name
);
347 if (!action_stop_session
->session_name
) {
348 status
= LTTNG_ACTION_STATUS_ERROR
;
352 status
= LTTNG_ACTION_STATUS_OK
;
357 enum lttng_action_status
lttng_action_stop_session_get_session_name(
358 const struct lttng_action
*action
, const char **session_name
)
360 const struct lttng_action_stop_session
*action_stop_session
;
361 enum lttng_action_status status
;
363 if (!action
|| !IS_STOP_SESSION_ACTION(action
) || !session_name
) {
364 status
= LTTNG_ACTION_STATUS_INVALID
;
368 action_stop_session
= action_stop_session_from_action_const(action
);
370 *session_name
= action_stop_session
->session_name
;
372 status
= LTTNG_ACTION_STATUS_OK
;
377 enum lttng_action_status
lttng_action_stop_session_set_rate_policy(
378 struct lttng_action
*action
,
379 const struct lttng_rate_policy
*policy
)
381 enum lttng_action_status status
;
382 struct lttng_action_stop_session
*stop_session_action
;
383 struct lttng_rate_policy
*copy
= NULL
;
385 if (!action
|| !policy
|| !IS_STOP_SESSION_ACTION(action
)) {
386 status
= LTTNG_ACTION_STATUS_INVALID
;
390 copy
= lttng_rate_policy_copy(policy
);
392 status
= LTTNG_ACTION_STATUS_ERROR
;
395 stop_session_action
= action_stop_session_from_action(action
);
397 /* Free the previous rate policy .*/
398 lttng_rate_policy_destroy(stop_session_action
->policy
);
400 stop_session_action
->policy
= copy
;
401 status
= LTTNG_ACTION_STATUS_OK
;
405 lttng_rate_policy_destroy(copy
);
409 enum lttng_action_status
lttng_action_stop_session_get_rate_policy(
410 const struct lttng_action
*action
,
411 const struct lttng_rate_policy
**policy
)
413 enum lttng_action_status status
;
414 const struct lttng_action_stop_session
*stop_session_action
;
416 if (!action
|| !policy
|| !IS_STOP_SESSION_ACTION(action
)) {
417 status
= LTTNG_ACTION_STATUS_INVALID
;
421 stop_session_action
= action_stop_session_from_action_const(action
);
423 *policy
= stop_session_action
->policy
;
424 status
= LTTNG_ACTION_STATUS_OK
;
429 static const struct lttng_rate_policy
*
430 lttng_action_stop_session_internal_get_rate_policy(
431 const struct lttng_action
*action
)
433 const struct lttng_action_stop_session
*_action
;
434 _action
= action_stop_session_from_action_const(action
);
436 return _action
->policy
;