* Input parameter to the lttng_rotate_session command.
*
* An immediate rotation is performed as soon as possible by the tracers.
- *
- * The lttng_rotation_immediate_attr object is opaque to the user. Use the
- * helper functions below to access it.
*/
struct lttng_rotation_immediate_attr;
+/*
+ * Input parameter to the lttng_rotate_schedule command.
+ */
+struct lttng_rotation_schedule_attr;
+
/*
* Handle used to represent a specific rotation.
- *
- * This object is opaque to the user. Use the helper functions below to access
- * it.
*/
struct lttng_rotation_handle;
extern struct lttng_rotation_immediate_attr *
lttng_rotation_immediate_attr_create(void);
+/*
+ * Return a newly allocated scheduled rotate session descriptor object or NULL
+ * on error.
+ */
+extern struct lttng_rotation_schedule_attr *
+lttng_rotation_schedule_attr_create(void);
+
/*
* Destroy a given immediate session rotation descriptor object.
*/
extern void lttng_rotation_immediate_attr_destroy(
struct lttng_rotation_immediate_attr *attr);
+/*
+ * Destroy a given scheduled rotate session descriptor object.
+ */
+extern void lttng_rotation_schedule_attr_destroy(
+ struct lttng_rotation_schedule_attr *attr);
+
/*
* Set the name of the session to rotate immediately.
*
struct lttng_rotation_immediate_attr *attr,
const char *session_name);
+/*
+ * Set the name of the session to rotate automatically.
+ *
+ * The session_name parameter is copied to the immediate session rotation
+ * attributes.
+ */
+extern enum lttng_rotation_status lttng_rotation_schedule_attr_set_session_name(
+ struct lttng_rotation_schedule_attr *attr,
+ const char *session_name);
+
+/*
+ * Set the timer to periodically rotate the session (µs, -1ULL to disable).
+ */
+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 current state of the rotation referenced by the handle.
*
extern int lttng_rotate_session(struct lttng_rotation_immediate_attr *attr,
struct lttng_rotation_handle **rotation_handle);
+/*
+ * Configure a session to rotate periodically or based on the size written.
+ */
+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