2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_CONDITION_SESSION_ROTATION_H
9 #define LTTNG_CONDITION_SESSION_ROTATION_H
11 #include <lttng/condition/evaluation.h>
12 #include <lttng/condition/condition.h>
14 #include <lttng/domain.h>
15 #include <lttng/location.h>
16 #include <lttng/lttng-export.h>
23 * Session rotation conditions allow an action to be taken whenever a
24 * session rotation is ongoing or completed.
26 * Session rotation conditions have the following properties:
27 * - the exact name of the session to be monitored for rotations
29 * Wildcards, regular expressions or other globbing mechanisms are not supported
30 * in session rotation condition properties.
34 * Create a newly allocated session rotation in progress condition.
36 * A session rotation ongoing condition evaluates to true whenever a rotation
37 * is ongoing for a given session.
39 * Returns a new condition on success, NULL on failure. This condition must be
40 * destroyed using lttng_condition_destroy().
42 LTTNG_EXPORT
extern struct lttng_condition
*
43 lttng_condition_session_rotation_ongoing_create(void);
46 * Create a newly allocated session rotation completion condition.
48 * A session rotation completed condition evaluates to true whenever a rotation
49 * is completed for a given session. This condition is not evaluated on
50 * subscription or registration of a trigger. This means that a trigger
51 * using this condition will only fire when the next session rotation completes.
52 * Previously completed rotations will have no effect.
54 * Returns a new condition on success, NULL on failure. This condition must be
55 * destroyed using lttng_condition_destroy().
57 LTTNG_EXPORT
extern struct lttng_condition
*
58 lttng_condition_session_rotation_completed_create(void);
61 * Get the session name property of a session rotation condition.
63 * The caller does not assume the ownership of the returned session name. The
64 * session name shall only only be used for the duration of the condition's
65 * lifetime, or before a different session name is set.
67 * Returns LTTNG_CONDITION_STATUS_OK and a pointer to the condition's session
68 * name on success, LTTNG_CONDITION_STATUS_INVALID if an invalid
69 * parameter is passed, or LTTNG_CONDITION_STATUS_UNSET if a session name
70 * was not set prior to this call.
72 LTTNG_EXPORT
extern enum lttng_condition_status
73 lttng_condition_session_rotation_get_session_name(
74 const struct lttng_condition
*condition
,
75 const char **session_name
);
78 * Set the session name property of a session rotation condition.
80 * The passed session name parameter will be copied to the condition.
82 * Returns LTTNG_CONDITION_STATUS_OK on success, LTTNG_CONDITION_STATUS_INVALID
83 * if invalid paramenters are passed.
85 LTTNG_EXPORT
extern enum lttng_condition_status
86 lttng_condition_session_rotation_set_session_name(
87 struct lttng_condition
*condition
,
88 const char *session_name
);
91 * lttng_evaluation_session_rotation are specialised lttng_evaluations
92 * which allow users to query a number of properties resulting from the
93 * evaluation of a condition which evaluated to true.
97 * Get the session rotation id property of a session rotation evaluation.
99 * Returns LTTNG_EVALUATION_STATUS_OK on success and the id of the session
100 * rotation, or LTTNG_EVALUATION_STATUS_INVALID if an invalid parameter is
103 LTTNG_EXPORT
extern enum lttng_evaluation_status
104 lttng_evaluation_session_rotation_get_id(
105 const struct lttng_evaluation
*evaluation
, uint64_t *id
);
108 * Get the session rotation location property of a session rotation completed
111 * The caller does not assume the ownership of the returned location. The
112 * location shall only only be used for the duration of the evaluation's
115 * Returns LTTNG_EVALUATION_STATUS_OK and set location on success.
116 * A NULL location may be returned if a rotation chunk's location
119 * LTTNG_EVALUATION_STATUS_INVALID is returned if an invalid parameter is
122 LTTNG_EXPORT
extern enum lttng_evaluation_status
123 lttng_evaluation_session_rotation_completed_get_location(
124 const struct lttng_evaluation
*evaluation
,
125 const struct lttng_trace_archive_location
**location
);
131 #endif /* LTTNG_CONDITION_SESSION_ROTATION_H */