2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@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/condition/condition-internal.hpp>
13 #include <lttng/condition/session-rotation-internal.hpp>
14 #include <lttng/location-internal.hpp>
18 static bool lttng_condition_session_rotation_validate(const struct lttng_condition
*condition
);
19 static int lttng_condition_session_rotation_serialize(const struct lttng_condition
*condition
,
20 struct lttng_payload
*payload
);
21 static bool lttng_condition_session_rotation_is_equal(const struct lttng_condition
*_a
,
22 const struct lttng_condition
*_b
);
23 static void lttng_condition_session_rotation_destroy(struct lttng_condition
*condition
);
25 static enum lttng_error_code
26 lttng_condition_session_rotation_mi_serialize(const struct lttng_condition
*condition
,
27 struct mi_writer
*writer
);
29 static const struct lttng_condition rotation_condition_template
= {
31 LTTNG_CONDITION_TYPE_UNKNOWN
, /* type unset, shall be set on creation. */
32 lttng_condition_session_rotation_validate
,
33 lttng_condition_session_rotation_serialize
,
34 lttng_condition_session_rotation_is_equal
,
35 lttng_condition_session_rotation_destroy
,
36 lttng_condition_session_rotation_mi_serialize
,
39 static int lttng_evaluation_session_rotation_serialize(const struct lttng_evaluation
*evaluation
,
40 struct lttng_payload
*payload
);
41 static void lttng_evaluation_session_rotation_destroy(struct lttng_evaluation
*evaluation
);
43 static const struct lttng_evaluation rotation_evaluation_template
= {
44 LTTNG_CONDITION_TYPE_UNKNOWN
, /* type unset, shall be set on creation. */
45 lttng_evaluation_session_rotation_serialize
,
46 lttng_evaluation_session_rotation_destroy
,
49 static bool is_rotation_condition(const struct lttng_condition
*condition
)
51 enum lttng_condition_type type
= lttng_condition_get_type(condition
);
53 return type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
||
54 type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
;
57 static bool is_rotation_evaluation(const struct lttng_evaluation
*evaluation
)
59 enum lttng_condition_type type
= lttng_evaluation_get_type(evaluation
);
61 return type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
||
62 type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
;
65 static bool lttng_condition_session_rotation_validate(const struct lttng_condition
*condition
)
68 struct lttng_condition_session_rotation
*rotation
;
74 rotation
= lttng::utils::container_of(condition
, <tng_condition_session_rotation::parent
);
75 if (!rotation
->session_name
) {
76 ERR("Invalid session rotation condition: a target session name must be set.");
85 static int lttng_condition_session_rotation_serialize(const struct lttng_condition
*condition
,
86 struct lttng_payload
*payload
)
89 size_t session_name_len
;
90 struct lttng_condition_session_rotation
*rotation
;
91 struct lttng_condition_session_rotation_comm rotation_comm
;
93 if (!condition
|| !is_rotation_condition(condition
)) {
98 DBG("Serializing session rotation condition");
99 rotation
= lttng::utils::container_of(condition
, <tng_condition_session_rotation::parent
);
101 session_name_len
= strlen(rotation
->session_name
) + 1;
102 if (session_name_len
> LTTNG_NAME_MAX
) {
107 rotation_comm
.session_name_len
= session_name_len
;
108 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, &rotation_comm
, sizeof(rotation_comm
));
112 ret
= lttng_dynamic_buffer_append(
113 &payload
->buffer
, rotation
->session_name
, session_name_len
);
121 static bool lttng_condition_session_rotation_is_equal(const struct lttng_condition
*_a
,
122 const struct lttng_condition
*_b
)
124 bool is_equal
= false;
125 struct lttng_condition_session_rotation
*a
, *b
;
127 a
= lttng::utils::container_of(_a
, <tng_condition_session_rotation::parent
);
128 b
= lttng::utils::container_of(_b
, <tng_condition_session_rotation::parent
);
130 /* Both session names must be set or both must be unset. */
131 if ((a
->session_name
&& !b
->session_name
) || (!a
->session_name
&& b
->session_name
)) {
132 WARN("Comparing session rotation conditions with uninitialized session names.");
136 if (a
->session_name
&& b
->session_name
&& strcmp(a
->session_name
, b
->session_name
) != 0) {
145 static void lttng_condition_session_rotation_destroy(struct lttng_condition
*condition
)
147 struct lttng_condition_session_rotation
*rotation
;
149 rotation
= lttng::utils::container_of(condition
, <tng_condition_session_rotation::parent
);
151 free(rotation
->session_name
);
155 static struct lttng_condition
*
156 lttng_condition_session_rotation_create(enum lttng_condition_type type
)
158 struct lttng_condition_session_rotation
*condition
;
160 condition
= zmalloc
<lttng_condition_session_rotation
>();
165 memcpy(&condition
->parent
, &rotation_condition_template
, sizeof(condition
->parent
));
166 lttng_condition_init(&condition
->parent
, type
);
167 return &condition
->parent
;
170 struct lttng_condition
*lttng_condition_session_rotation_ongoing_create(void)
172 return lttng_condition_session_rotation_create(
173 LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
);
176 struct lttng_condition
*lttng_condition_session_rotation_completed_create(void)
178 return lttng_condition_session_rotation_create(
179 LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
);
182 static ssize_t
init_condition_from_payload(struct lttng_condition
*condition
,
183 struct lttng_payload_view
*src_view
)
185 ssize_t ret
, condition_size
;
186 enum lttng_condition_status status
;
187 const char *session_name
;
188 struct lttng_buffer_view name_view
;
189 const struct lttng_condition_session_rotation_comm
*condition_comm
;
190 struct lttng_payload_view condition_comm_view
=
191 lttng_payload_view_from_view(src_view
, 0, sizeof(*condition_comm
));
193 if (!lttng_payload_view_is_valid(&condition_comm_view
)) {
194 ERR("Failed to initialize from malformed condition buffer: buffer too short to contain header");
199 condition_comm
= (typeof(condition_comm
)) src_view
->buffer
.data
;
200 name_view
= lttng_buffer_view_from_view(
201 &src_view
->buffer
, sizeof(*condition_comm
), condition_comm
->session_name_len
);
203 if (!lttng_buffer_view_is_valid(&name_view
)) {
204 ERR("Failed to initialize from malformed condition buffer: buffer too short to contain session name");
209 if (condition_comm
->session_name_len
> LTTNG_NAME_MAX
) {
210 ERR("Failed to initialize from malformed condition buffer: name exceeds LTTNG_MAX_NAME");
215 session_name
= name_view
.data
;
216 if (*(session_name
+ condition_comm
->session_name_len
- 1) != '\0') {
217 ERR("Malformed session name encountered in condition buffer");
222 status
= lttng_condition_session_rotation_set_session_name(condition
, session_name
);
223 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
224 ERR("Failed to set buffer consumed session name");
229 if (!lttng_condition_validate(condition
)) {
234 condition_size
= sizeof(*condition_comm
) + (ssize_t
) condition_comm
->session_name_len
;
235 ret
= condition_size
;
241 lttng_condition_session_rotation_create_from_payload(struct lttng_payload_view
*view
,
242 struct lttng_condition
**_condition
,
243 enum lttng_condition_type type
)
246 struct lttng_condition
*condition
= nullptr;
249 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
250 condition
= lttng_condition_session_rotation_ongoing_create();
252 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
253 condition
= lttng_condition_session_rotation_completed_create();
260 if (!_condition
|| !condition
) {
265 ret
= init_condition_from_payload(condition
, view
);
270 *_condition
= condition
;
273 lttng_condition_destroy(condition
);
278 lttng_condition_session_rotation_ongoing_create_from_payload(struct lttng_payload_view
*view
,
279 struct lttng_condition
**condition
)
281 return lttng_condition_session_rotation_create_from_payload(
282 view
, condition
, LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
);
286 lttng_condition_session_rotation_completed_create_from_payload(struct lttng_payload_view
*view
,
287 struct lttng_condition
**condition
)
289 return lttng_condition_session_rotation_create_from_payload(
290 view
, condition
, LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
);
293 static struct lttng_evaluation
*lttng_evaluation_session_rotation_create(
294 enum lttng_condition_type type
, uint64_t id
, struct lttng_trace_archive_location
*location
)
296 struct lttng_evaluation_session_rotation
*evaluation
;
298 evaluation
= zmalloc
<lttng_evaluation_session_rotation
>();
303 memcpy(&evaluation
->parent
, &rotation_evaluation_template
, sizeof(evaluation
->parent
));
304 lttng_evaluation_init(&evaluation
->parent
, type
);
307 lttng_trace_archive_location_get(location
);
309 evaluation
->location
= location
;
310 return &evaluation
->parent
;
313 static ssize_t
create_evaluation_from_payload(enum lttng_condition_type type
,
314 struct lttng_payload_view
*view
,
315 struct lttng_evaluation
**_evaluation
)
318 struct lttng_evaluation
*evaluation
= nullptr;
319 struct lttng_trace_archive_location
*location
= nullptr;
320 const struct lttng_evaluation_session_rotation_comm
*comm
;
321 struct lttng_payload_view comm_view
= lttng_payload_view_from_view(view
, 0, sizeof(*comm
));
323 if (!lttng_payload_view_is_valid(&comm_view
)) {
327 comm
= (typeof(comm
)) comm_view
.buffer
.data
;
328 size
= sizeof(*comm
);
329 if (comm
->has_location
) {
330 const struct lttng_buffer_view location_view
=
331 lttng_buffer_view_from_view(&view
->buffer
, sizeof(*comm
), -1);
333 if (!lttng_buffer_view_is_valid(&location_view
)) {
337 ret
= lttng_trace_archive_location_create_from_buffer(&location_view
, &location
);
344 evaluation
= lttng_evaluation_session_rotation_create(type
, comm
->id
, location
);
349 lttng_trace_archive_location_put(location
);
351 *_evaluation
= evaluation
;
354 lttng_trace_archive_location_put(location
);
355 evaluation
= nullptr;
360 lttng_evaluation_session_rotation_create_from_payload(enum lttng_condition_type type
,
361 struct lttng_payload_view
*view
,
362 struct lttng_evaluation
**_evaluation
)
365 struct lttng_evaluation
*evaluation
= nullptr;
372 ret
= create_evaluation_from_payload(type
, view
, &evaluation
);
377 *_evaluation
= evaluation
;
380 lttng_evaluation_destroy(evaluation
);
385 lttng_evaluation_session_rotation_ongoing_create_from_payload(struct lttng_payload_view
*view
,
386 struct lttng_evaluation
**evaluation
)
388 return lttng_evaluation_session_rotation_create_from_payload(
389 LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
, view
, evaluation
);
392 ssize_t
lttng_evaluation_session_rotation_completed_create_from_payload(
393 struct lttng_payload_view
*view
, struct lttng_evaluation
**evaluation
)
395 return lttng_evaluation_session_rotation_create_from_payload(
396 LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
, view
, evaluation
);
399 struct lttng_evaluation
*lttng_evaluation_session_rotation_ongoing_create(uint64_t id
)
401 return lttng_evaluation_session_rotation_create(
402 LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
, id
, nullptr);
405 struct lttng_evaluation
*
406 lttng_evaluation_session_rotation_completed_create(uint64_t id
,
407 struct lttng_trace_archive_location
*location
)
409 return lttng_evaluation_session_rotation_create(
410 LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
, id
, location
);
413 enum lttng_condition_status
414 lttng_condition_session_rotation_get_session_name(const struct lttng_condition
*condition
,
415 const char **session_name
)
417 struct lttng_condition_session_rotation
*rotation
;
418 enum lttng_condition_status status
= LTTNG_CONDITION_STATUS_OK
;
420 if (!condition
|| !is_rotation_condition(condition
) || !session_name
) {
421 status
= LTTNG_CONDITION_STATUS_INVALID
;
425 rotation
= lttng::utils::container_of(condition
, <tng_condition_session_rotation::parent
);
426 if (!rotation
->session_name
) {
427 status
= LTTNG_CONDITION_STATUS_UNSET
;
430 *session_name
= rotation
->session_name
;
435 enum lttng_condition_status
436 lttng_condition_session_rotation_set_session_name(struct lttng_condition
*condition
,
437 const char *session_name
)
439 char *session_name_copy
;
440 struct lttng_condition_session_rotation
*rotation
;
441 enum lttng_condition_status status
= LTTNG_CONDITION_STATUS_OK
;
443 if (!condition
|| !is_rotation_condition(condition
) || !session_name
||
444 strlen(session_name
) == 0) {
445 status
= LTTNG_CONDITION_STATUS_INVALID
;
449 rotation
= lttng::utils::container_of(condition
, <tng_condition_session_rotation::parent
);
450 session_name_copy
= strdup(session_name
);
451 if (!session_name_copy
) {
452 status
= LTTNG_CONDITION_STATUS_ERROR
;
456 free(rotation
->session_name
);
457 rotation
->session_name
= session_name_copy
;
462 static int lttng_evaluation_session_rotation_serialize(const struct lttng_evaluation
*evaluation
,
463 struct lttng_payload
*payload
)
466 struct lttng_evaluation_session_rotation
*rotation
;
467 struct lttng_evaluation_session_rotation_comm comm
= {};
470 lttng::utils::container_of(evaluation
, <tng_evaluation_session_rotation::parent
);
471 comm
.id
= rotation
->id
;
472 comm
.has_location
= !!rotation
->location
;
473 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, &comm
, sizeof(comm
));
477 if (!rotation
->location
) {
480 ret
= lttng_trace_archive_location_serialize(rotation
->location
, &payload
->buffer
);
485 static void lttng_evaluation_session_rotation_destroy(struct lttng_evaluation
*evaluation
)
487 struct lttng_evaluation_session_rotation
*rotation
;
490 lttng::utils::container_of(evaluation
, <tng_evaluation_session_rotation::parent
);
491 lttng_trace_archive_location_put(rotation
->location
);
495 enum lttng_evaluation_status
496 lttng_evaluation_session_rotation_get_id(const struct lttng_evaluation
*evaluation
, uint64_t *id
)
498 const struct lttng_evaluation_session_rotation
*rotation
;
499 enum lttng_evaluation_status status
= LTTNG_EVALUATION_STATUS_OK
;
501 if (!evaluation
|| !id
|| !is_rotation_evaluation(evaluation
)) {
502 status
= LTTNG_EVALUATION_STATUS_INVALID
;
507 lttng::utils::container_of(evaluation
, <tng_evaluation_session_rotation::parent
);
514 * The public API assumes that trace archive locations are always provided as
515 * "constant". This means that the user of liblttng-ctl never has to destroy a
516 * trace archive location. Hence, users of liblttng-ctl have no visibility of
517 * the reference counting of archive locations.
519 enum lttng_evaluation_status
lttng_evaluation_session_rotation_completed_get_location(
520 const struct lttng_evaluation
*evaluation
,
521 const struct lttng_trace_archive_location
**location
)
523 const struct lttng_evaluation_session_rotation
*rotation
;
524 enum lttng_evaluation_status status
= LTTNG_EVALUATION_STATUS_OK
;
526 if (!evaluation
|| !location
||
527 evaluation
->type
!= LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
) {
528 status
= LTTNG_EVALUATION_STATUS_INVALID
;
533 lttng::utils::container_of(evaluation
, <tng_evaluation_session_rotation::parent
);
534 *location
= rotation
->location
;
539 static enum lttng_error_code
540 lttng_condition_session_rotation_mi_serialize(const struct lttng_condition
*condition
,
541 struct mi_writer
*writer
)
544 enum lttng_error_code ret_code
;
545 enum lttng_condition_status status
;
546 const char *session_name
= nullptr;
547 const char *type_element_str
= nullptr;
549 LTTNG_ASSERT(condition
);
550 LTTNG_ASSERT(writer
);
551 LTTNG_ASSERT(is_rotation_condition(condition
));
553 switch (lttng_condition_get_type(condition
)) {
554 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
555 type_element_str
= mi_lttng_element_condition_session_rotation_completed
;
557 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
558 type_element_str
= mi_lttng_element_condition_session_rotation_ongoing
;
565 status
= lttng_condition_session_rotation_get_session_name(condition
, &session_name
);
566 LTTNG_ASSERT(status
== LTTNG_CONDITION_STATUS_OK
);
567 LTTNG_ASSERT(session_name
);
569 /* Open condition session rotation_* element. */
570 ret
= mi_lttng_writer_open_element(writer
, type_element_str
);
576 ret
= mi_lttng_writer_write_element_string(
577 writer
, mi_lttng_element_session_name
, session_name
);
582 /* Close condition session rotation element. */
583 ret
= mi_lttng_writer_close_element(writer
);
592 ret_code
= LTTNG_ERR_MI_IO_FAIL
;