#define LTTNG_ROTATION_H
#include <stdint.h>
+#include <lttng/location.h>
#ifdef __cplusplus
extern "C" {
* Return codes for lttng_rotation_handle_get_state()
*/
enum lttng_rotation_state {
+ /*
+ * Session has not been rotated.
+ */
+ LTTNG_ROTATION_STATE_NO_ROTATION = 0,
/*
* Rotation is ongoing, but has not been completed yet.
*/
- LTTNG_ROTATION_STATE_ONGOING = 0,
+ LTTNG_ROTATION_STATE_ONGOING = 1,
/*
* Rotation has been completed and the resulting chunk
* can now safely be read.
*/
- LTTNG_ROTATION_STATE_COMPLETED = 1,
+ LTTNG_ROTATION_STATE_COMPLETED = 2,
/*
* The rotation has expired.
*
* Note that this state does not guarantee the the rotation was
* completed successfully.
*/
- LTTNG_ROTATION_STATE_EXPIRED = 2,
+ LTTNG_ROTATION_STATE_EXPIRED = 3,
/*
* The rotation could not be completed due to an error.
*/
- LTTNG_ROTATION_STATE_ERROR = 3,
+ LTTNG_ROTATION_STATE_ERROR = 4,
};
enum lttng_rotation_status {
extern enum lttng_rotation_status lttng_rotation_schedule_attr_set_timer_period(
struct lttng_rotation_schedule_attr *attr, uint64_t timer);
+/*
+ * Set the size to rotate the session (bytes, -1ULL to disable).
+ */
+void lttng_rotation_schedule_attr_set_size(
+ struct lttng_rotation_schedule_attr *attr, uint64_t size);
+
/*
* lttng rotate session handle functions.
*/
* Get the location of the rotation's resulting archive.
*
* The rotation must be completed in order for this call to succeed.
- * The path returned is owned by the rotation handle.
- *
- * Note that path will not be set in case of error, or if the session
- * rotation has expired.
+ * The location returned remains owned by the rotation handle.
*
- * FIXME: Return an lttng_location object instead of a path.
+ * Note that location will not be set in case of error, or if the session
+ * rotation handle has expired.
*/
-extern enum lttng_rotation_status lttng_rotation_handle_get_completed_archive_location(
+extern enum lttng_rotation_status lttng_rotation_handle_get_archive_location(
struct lttng_rotation_handle *rotation_handle,
- const char **path);
+ const struct lttng_trace_archive_location **location);
/*
* Destroy an lttng_rotate_session handle.
extern int lttng_rotation_set_schedule(
struct lttng_rotation_schedule_attr *attr);
+/*
+ * Ask the sessiond for the value of the rotate timer (in micro-seconds) of the
+ * session.
+ *
+ * On success, return 0 and set the value or rotate_timer, on error return a
+ * negative value.
+ */
+extern int lttng_rotation_schedule_get_timer_period(const char *session_name,
+ uint64_t *rotate_timer);
+
+/*
+ * Ask the sessiond for the value of the rotate size (in micro-seconds) of the
+ * session.
+ *
+ * On success, return 0 and set the value or rotate_size, on error return
+ * a negative value.
+ */
+extern int lttng_rotation_schedule_get_size(const char *session_name,
+ uint64_t *rotate_size);
+
#ifdef __cplusplus
}
#endif