2 * Copyright (C) 2017 - Julien Desfossez <jdesfossez@efficios.com>
4 * This library is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License, version 2.1 only,
6 * as published by the Free Software Foundation.
8 * This library is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
13 * You should have received a copy of the GNU Lesser General Public License
14 * along with this library; if not, write to the Free Software Foundation,
15 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 #ifndef LTTNG_ROTATE_INTERNAL_ABI_H
19 #define LTTNG_ROTATE_INTERNAL_ABI_H
25 #include <lttng/constant.h>
26 #include <lttng/rotation.h>
27 #include <common/macros.h>
30 * Object used as input parameter to the rotate session API for immediate
32 * This is opaque to the public library.
34 struct lttng_rotation_immediate_attr
{
35 /* Session name to rotate. */
36 char session_name
[LTTNG_NAME_MAX
];
37 /* For the rotate pending request. */
42 * Object used as input parameter to the lttng_rotate_schedule API for
43 * automatic rotations.
44 * This is opaque to the public library.
46 struct lttng_rotation_schedule_attr
{
47 /* Session name to rotate. */
48 char session_name
[LTTNG_NAME_MAX
];
49 /* > 0 if a timer is set. */
51 /* > 0 if the session should rotate when it has written that many bytes. */
56 * Object returned by the rotate session API.
57 * This is opaque to the public library.
59 struct lttng_rotation_handle
{
60 char session_name
[LTTNG_NAME_MAX
];
62 * ID of the rotate command.
63 * This matches the session->rotate_count, so the handle is valid until
64 * the next rotate command. After that, the rotation_get_state command
65 * returns the "expired" state.
69 * Where the rotated (readable) trace has been stored when the
70 * rotation is completed.
74 char path
[LTTNG_PATH_MAX
];
79 * Internal objects between lttng-ctl and the session daemon, the values
80 * are then copied to the user's lttng_rotation_handle object.
83 /* For the LTTNG_ROTATE_SESSION command. */
84 struct lttng_rotate_session_return
{
88 /* For the LTTNG_ROTATION_GET_INFO command. */
89 struct lttng_rotation_get_info_return
{
90 /* Represents values defined in enum lttng_rotation_state. */
92 char path
[LTTNG_PATH_MAX
];
95 /* For the LTTNG_SESSION_GET_CURRENT_OUTPUT command. */
96 struct lttng_session_get_current_output_return
{
97 char path
[LTTNG_PATH_MAX
];
100 /* For the LTTNG_ROTATION_SCHEDULE_GET_TIMER_PERIOD command. */
101 struct lttng_rotation_schedule_get_timer_period
{
102 uint64_t rotate_timer
;
105 /* For the LTTNG_ROTATION_SCHEDULE_GET_SIZE command. */
106 struct lttng_rotation_schedule_get_size
{
107 uint64_t rotate_size
;
110 #endif /* LTTNG_ROTATE_INTERNAL_ABI_H */