2 * Copyright (C) 2017 - Julien Desfossez <jdesfossez@efficios.com>
3 * Copyright (C) 2018 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This library is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser General Public License, version 2.1 only,
7 * as published by the Free Software Foundation.
9 * This library is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this library; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 #ifndef LTTNG_ROTATION_H
20 #define LTTNG_ROTATION_H
29 * Return codes for lttng_rotation_handle_get_state()
31 enum lttng_rotation_state
{
33 * Session has not been rotated.
35 LTTNG_ROTATION_STATE_NO_ROTATION
= 0,
37 * Rotation is ongoing, but has not been completed yet.
39 LTTNG_ROTATION_STATE_ONGOING
= 1,
41 * Rotation has been completed and the resulting chunk
42 * can now safely be read.
44 LTTNG_ROTATION_STATE_COMPLETED
= 2,
46 * The rotation has expired.
48 * The information associated with a given rotation is eventually
49 * purged by the session daemon. In such a case, the attributes of
50 * the rotation, such as its path, may no longer be available.
52 * Note that this state does not guarantee the the rotation was
53 * completed successfully.
55 LTTNG_ROTATION_STATE_EXPIRED
= 3,
57 * The rotation could not be completed due to an error.
59 LTTNG_ROTATION_STATE_ERROR
= 4,
62 enum lttng_rotation_status
{
63 LTTNG_ROTATION_STATUS_OK
= 0,
64 /* Information not available. */
65 LTTNG_ROTATION_STATUS_UNAVAILABLE
= 1,
67 LTTNG_ROTATION_STATUS_ERROR
= -1,
68 /* Invalid parameters provided. */
69 LTTNG_ROTATION_STATUS_INVALID
= -2,
73 * Input parameter to the lttng_rotate_session command.
75 * An immediate rotation is performed as soon as possible by the tracers.
77 struct lttng_rotation_immediate_attr
;
80 * Input parameter to the lttng_rotate_schedule command.
82 struct lttng_rotation_schedule_attr
;
85 * Handle used to represent a specific rotation.
87 struct lttng_rotation_handle
;
90 * Return a newly allocated immediate session rotation descriptor object or NULL
93 extern struct lttng_rotation_immediate_attr
*
94 lttng_rotation_immediate_attr_create(void);
97 * Return a newly allocated scheduled rotate session descriptor object or NULL
100 extern struct lttng_rotation_schedule_attr
*
101 lttng_rotation_schedule_attr_create(void);
104 * Destroy a given immediate session rotation descriptor object.
106 extern void lttng_rotation_immediate_attr_destroy(
107 struct lttng_rotation_immediate_attr
*attr
);
110 * Destroy a given scheduled rotate session descriptor object.
112 extern void lttng_rotation_schedule_attr_destroy(
113 struct lttng_rotation_schedule_attr
*attr
);
116 * Set the name of the session to rotate immediately.
118 * The session_name parameter is copied to the immediate session rotation
121 extern enum lttng_rotation_status
lttng_rotation_immediate_attr_set_session_name(
122 struct lttng_rotation_immediate_attr
*attr
,
123 const char *session_name
);
126 * Set the name of the session to rotate automatically.
128 * The session_name parameter is copied to the immediate session rotation
131 extern enum lttng_rotation_status
lttng_rotation_schedule_attr_set_session_name(
132 struct lttng_rotation_schedule_attr
*attr
,
133 const char *session_name
);
136 * Set the timer to periodically rotate the session (µs, -1ULL to disable).
138 extern enum lttng_rotation_status
lttng_rotation_schedule_attr_set_timer_period(
139 struct lttng_rotation_schedule_attr
*attr
, uint64_t timer
);
142 * Set the size to rotate the session (bytes, -1ULL to disable).
144 void lttng_rotation_schedule_attr_set_size(
145 struct lttng_rotation_schedule_attr
*attr
, uint64_t size
);
148 * lttng rotate session handle functions.
152 * Get the current state of the rotation referenced by the handle.
154 * This will issue a request to the session daemon on every call. Hence,
155 * the result of this call may change over time.
157 extern enum lttng_rotation_status
lttng_rotation_handle_get_state(
158 struct lttng_rotation_handle
*rotation_handle
,
159 enum lttng_rotation_state
*rotation_state
);
162 * Get the location of the rotation's resulting archive.
164 * The rotation must be completed in order for this call to succeed.
165 * The path returned is owned by the rotation handle.
167 * Note that path will not be set in case of error, or if the session
168 * rotation has expired.
170 * FIXME: Return an lttng_location object instead of a path.
172 extern enum lttng_rotation_status
lttng_rotation_handle_get_completed_archive_location(
173 struct lttng_rotation_handle
*rotation_handle
,
177 * Destroy an lttng_rotate_session handle.
179 extern void lttng_rotation_handle_destroy(
180 struct lttng_rotation_handle
*rotation_handle
);
183 * Rotate the output folder of the session
185 * On success, handle is allocated and can be used to monitor the progress
186 * of the rotation with lttng_rotation_get_state(). The handle must be freed
187 * by the caller with lttng_rotation_handle_destroy().
189 * Return 0 if the rotate action was successfully launched or a negative
190 * LTTng error code on error.
192 extern int lttng_rotate_session(struct lttng_rotation_immediate_attr
*attr
,
193 struct lttng_rotation_handle
**rotation_handle
);
196 * Configure a session to rotate periodically or based on the size written.
198 extern int lttng_rotation_set_schedule(
199 struct lttng_rotation_schedule_attr
*attr
);
202 * Ask the sessiond for the value of the rotate timer (in micro-seconds) of the
205 * On success, return 0 and set the value or rotate_timer, on error return a
208 extern int lttng_rotation_schedule_get_timer_period(const char *session_name
,
209 uint64_t *rotate_timer
);
212 * Ask the sessiond for the value of the rotate size (in micro-seconds) of the
215 * On success, return 0 and set the value or rotate_size, on error return
218 extern int lttng_rotation_schedule_get_size(const char *session_name
,
219 uint64_t *rotate_size
);
225 #endif /* LTTNG_ROTATION_H */