| 1 | /* |
| 2 | * Copyright (C) 2017 - Julien Desfossez <jdesfossez@efficios.com> |
| 3 | * |
| 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. |
| 7 | * |
| 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 |
| 11 | * for more details. |
| 12 | * |
| 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 |
| 16 | */ |
| 17 | |
| 18 | #ifndef LTTNG_ROTATE_INTERNAL_ABI_H |
| 19 | #define LTTNG_ROTATE_INTERNAL_ABI_H |
| 20 | |
| 21 | #include <limits.h> |
| 22 | #include <stdint.h> |
| 23 | #include <stdbool.h> |
| 24 | |
| 25 | #include <lttng/constant.h> |
| 26 | #include <lttng/rotation.h> |
| 27 | #include <common/macros.h> |
| 28 | |
| 29 | /* |
| 30 | * Object used as input parameter to the rotate session API for immediate |
| 31 | * rotations. |
| 32 | * This is opaque to the public library. |
| 33 | */ |
| 34 | struct lttng_rotation_immediate_attr { |
| 35 | /* Session name to rotate. */ |
| 36 | char session_name[LTTNG_NAME_MAX]; |
| 37 | /* For the rotate pending request. */ |
| 38 | uint64_t rotate_id; |
| 39 | }; |
| 40 | |
| 41 | /* |
| 42 | * Object used as input parameter to the lttng_rotate_schedule API for |
| 43 | * automatic rotations. |
| 44 | * This is opaque to the public library. |
| 45 | */ |
| 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. */ |
| 50 | uint64_t timer_us; |
| 51 | } LTTNG_PACKED; |
| 52 | |
| 53 | /* |
| 54 | * Object returned by the rotate session API. |
| 55 | * This is opaque to the public library. |
| 56 | */ |
| 57 | struct lttng_rotation_handle { |
| 58 | char session_name[LTTNG_NAME_MAX]; |
| 59 | /* |
| 60 | * ID of the rotate command. |
| 61 | * This matches the session->rotate_count, so the handle is valid until |
| 62 | * the next rotate command. After that, the rotation_get_state command |
| 63 | * returns the "expired" state. |
| 64 | */ |
| 65 | uint64_t rotation_id; |
| 66 | /* |
| 67 | * Where the rotated (readable) trace has been stored when the |
| 68 | * rotation is completed. |
| 69 | */ |
| 70 | struct { |
| 71 | bool is_set; |
| 72 | char path[LTTNG_PATH_MAX]; |
| 73 | } archive_location; |
| 74 | }; |
| 75 | |
| 76 | /* |
| 77 | * Internal objects between lttng-ctl and the session daemon, the values |
| 78 | * are then copied to the user's lttng_rotation_handle object. |
| 79 | */ |
| 80 | |
| 81 | /* For the LTTNG_ROTATE_SESSION command. */ |
| 82 | struct lttng_rotate_session_return { |
| 83 | uint64_t rotation_id; |
| 84 | } LTTNG_PACKED; |
| 85 | |
| 86 | /* For the LTTNG_ROTATION_GET_INFO command. */ |
| 87 | struct lttng_rotation_get_info_return { |
| 88 | /* Represents values defined in enum lttng_rotation_state. */ |
| 89 | int32_t status; |
| 90 | char path[LTTNG_PATH_MAX]; |
| 91 | } LTTNG_PACKED; |
| 92 | |
| 93 | /* For the LTTNG_SESSION_GET_CURRENT_OUTPUT command. */ |
| 94 | struct lttng_session_get_current_output_return { |
| 95 | char path[LTTNG_PATH_MAX]; |
| 96 | } LTTNG_PACKED; |
| 97 | |
| 98 | #endif /* LTTNG_ROTATE_INTERNAL_ABI_H */ |