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 /* For the rotate pending request. */
40 * Object used as input parameter to the lttng_rotate_schedule API for
41 * automatic rotations.
42 * This is opaque to the public library.
44 struct lttng_rotation_schedule_attr
{
45 /* > 0 if a timer is set. */
47 /* > 0 if the session should rotate when it has written that many bytes. */
52 * Object returned by the rotate session API.
53 * This is opaque to the public library.
55 struct lttng_rotation_handle
{
56 char session_name
[LTTNG_NAME_MAX
];
58 * ID of the rotate command.
59 * This matches the session->rotate_count, so the handle is valid until
60 * the next rotate command. After that, the rotation_get_state command
61 * returns the "expired" state.
65 * Where the rotated (readable) trace has been stored when the
66 * rotation is completed.
68 struct lttng_trace_archive_location
*archive_location
;
72 * Internal objects between lttng-ctl and the session daemon, the values
73 * are then copied to the user's lttng_rotation_handle object.
76 /* For the LTTNG_ROTATE_SESSION command. */
77 struct lttng_rotate_session_return
{
81 /* For the LTTNG_ROTATION_GET_INFO command. */
82 struct lttng_rotation_get_info_return
{
83 /* Represents values defined in enum lttng_rotation_state. */
85 /* Represents values defined in enum lttng_rotation_state. */
89 char absolute_path
[LTTNG_PATH_MAX
];
92 char host
[LTTNG_HOST_NAME_MAX
];
94 * Represents values defined in
95 * enum lttng_trace_archive_location_relay_protocol_type.
101 } LTTNG_PACKED ports
;
102 char relative_path
[LTTNG_PATH_MAX
];
103 } LTTNG_PACKED relay
;
107 /* For the LTTNG_SESSION_GET_CURRENT_OUTPUT command. */
108 struct lttng_session_get_current_output_return
{
109 char path
[LTTNG_PATH_MAX
];
112 /* For the LTTNG_ROTATION_SCHEDULE_GET_TIMER_PERIOD command. */
113 struct lttng_rotation_schedule_get_timer_period
{
114 uint64_t rotate_timer
;
117 /* For the LTTNG_ROTATION_SCHEDULE_GET_SIZE command. */
118 struct lttng_rotation_schedule_get_size
{
119 uint64_t rotate_size
;
122 #endif /* LTTNG_ROTATE_INTERNAL_ABI_H */