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 returned by the rotate session API.
  31  * This is opaque to the public library.
  32  */
  33 struct lttng_rotation_handle {
  34         char session_name[LTTNG_NAME_MAX];
  35         /*
  36          * ID of the rotate command.
  37          * This matches the session->rotate_count, so the handle is valid until
  38          * the next rotate command. After that, the rotation_get_state command
  39          * returns the "expired" state.
  40          */
  41         uint64_t rotation_id;
  42         /*
  43          * Where the rotated (readable) trace has been stored when the
  44          * rotation is completed.
  45          */
  46         struct lttng_trace_archive_location *archive_location;
  47 };
  48
  49 struct lttng_rotation_schedule {
  50         enum lttng_rotation_schedule_type type;
  51 };
  52
  53 struct lttng_rotation_schedule_size_threshold {
  54         struct lttng_rotation_schedule parent;
  55         struct {
  56                 bool set;
  57                 uint64_t bytes;
  58         } size;
  59 };
  60
  61 struct lttng_rotation_schedule_periodic {
  62         struct lttng_rotation_schedule parent;
  63         struct {
  64                 bool set;
  65                 uint64_t us;
  66         } period;
  67 };
  68
  69 struct lttng_rotation_schedules {
  70         /*
  71          * Only one rotation schedule per type is supported for now.
  72          * Schedules are owned by this object.
  73          */
  74         unsigned int count;
  75         struct lttng_rotation_schedule *schedules[2];
  76 };
  77
  78 /*
  79  * Internal objects between lttng-ctl and the session daemon, the values
  80  * are then copied to the user's lttng_rotation_handle object.
  81  */
  82
  83 /* For the LTTNG_ROTATE_SESSION command. */
  84 struct lttng_rotate_session_return {
  85         uint64_t rotation_id;
  86 } LTTNG_PACKED;
  87
  88 /* For the LTTNG_ROTATION_GET_INFO command. */
  89 struct lttng_rotation_get_info_return {
  90         /* Represents values defined in enum lttng_rotation_state. */
  91         int32_t status;
  92         /*
  93          * Represents values defined in enum lttng_trace_archive_location_type.
  94          */
  95         int8_t location_type;
  96         union {
  97                 struct {
  98                         char absolute_path[LTTNG_PATH_MAX];
  99                 } LTTNG_PACKED local;
 100                 struct {
 101                         char host[LTTNG_HOST_NAME_MAX];
 102                         /*
 103                          * Represents values defined in
 104                          * enum lttng_trace_archive_location_relay_protocol_type.
 105                          */
 106                         int8_t protocol;
 107                         struct {
 108                                 uint16_t control;
 109                                 uint16_t data;
 110                         } LTTNG_PACKED ports;
 111                         char relative_path[LTTNG_PATH_MAX];
 112                 } LTTNG_PACKED relay;
 113         } location;
 114 } LTTNG_PACKED;
 115
 116 /* For the LTTNG_SESSION_LIST_SCHEDULES command. */
 117 struct lttng_session_list_schedules_return {
 118         struct {
 119                 uint8_t set;
 120                 uint64_t value;
 121         } periodic;
 122         struct {
 123                 uint8_t set;
 124                 uint64_t value;
 125         } size;
 126 } LTTNG_PACKED;
 127
 128 #endif /* LTTNG_ROTATE_INTERNAL_ABI_H */