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