include/lttng/rotate-internal.h

   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         /* > 0 if the session should rotate when it has written that many bytes. */
  52         uint64_t size;
  53 } LTTNG_PACKED;
  54
  55 /*
  56  * Object returned by the rotate session API.
  57  * This is opaque to the public library.
  58  */
  59 struct lttng_rotation_handle {
  60         char session_name[LTTNG_NAME_MAX];
  61         /*
  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.
  66          */
  67         uint64_t rotation_id;
  68         /*
  69          * Where the rotated (readable) trace has been stored when the
  70          * rotation is completed.
  71          */
  72         struct lttng_trace_archive_location *archive_location;
  73 };
  74
  75 /*
  76  * Internal objects between lttng-ctl and the session daemon, the values
  77  * are then copied to the user's lttng_rotation_handle object.
  78  */
  79
  80 /* For the LTTNG_ROTATE_SESSION command. */
  81 struct lttng_rotate_session_return {
  82         uint64_t rotation_id;
  83 } LTTNG_PACKED;
  84
  85 /* For the LTTNG_ROTATION_GET_INFO command. */
  86 struct lttng_rotation_get_info_return {
  87         /* Represents values defined in enum lttng_rotation_state. */
  88         int32_t status;
  89         /* Represents values defined in enum lttng_rotation_state. */
  90         int8_t location_type;
  91         union {
  92                 struct {
  93                         char absolute_path[LTTNG_PATH_MAX];
  94                 } LTTNG_PACKED local;
  95                 struct {
  96                         char host[LTTNG_HOST_NAME_MAX];
  97                         /*
  98                          * Represents values defined in
  99                          * enum lttng_trace_archive_location_relay_protocol_type.
 100                          */
 101                         int8_t protocol;
 102                         struct {
 103                                 uint16_t control;
 104                                 uint16_t data;
 105                         } LTTNG_PACKED ports;
 106                         char relative_path[LTTNG_PATH_MAX];
 107                 } LTTNG_PACKED relay;
 108         } location;
 109 } LTTNG_PACKED;
 110
 111 /* For the LTTNG_SESSION_GET_CURRENT_OUTPUT command. */
 112 struct lttng_session_get_current_output_return {
 113         char path[LTTNG_PATH_MAX];
 114 } LTTNG_PACKED;
 115
 116 /* For the LTTNG_ROTATION_SCHEDULE_GET_TIMER_PERIOD command. */
 117 struct lttng_rotation_schedule_get_timer_period {
 118         uint64_t rotate_timer;
 119 } LTTNG_PACKED;
 120
 121 /* For the LTTNG_ROTATION_SCHEDULE_GET_SIZE command. */
 122 struct lttng_rotation_schedule_get_size {
 123         uint64_t rotate_size;
 124 } LTTNG_PACKED;
 125
 126 #endif /* LTTNG_ROTATE_INTERNAL_ABI_H */