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
  24 #include <lttng/constant.h>
  25 #include <lttng/rotate.h>
  26 #include <common/macros.h>
  27
  28 /*
  29  * Object used as input parameter to the rotate session API.
  30  * This is opaque to the public library.
  31  */
  32 struct lttng_rotate_session_attr {
  33         /*
  34          * Session name to rotate.
  35          */
  36         char session_name[LTTNG_NAME_MAX];
  37         /*
  38          * For the rotate pending request.
  39          */
  40         uint64_t rotate_id;
  41 } LTTNG_PACKED;
  42
  43 /*
  44  * Object returned by the rotate session API.
  45  * This is opaque to the public library.
  46  */
  47 struct lttng_rotate_session_handle {
  48         char session_name[LTTNG_NAME_MAX];
  49         /*
  50          * ID of the rotate command.
  51          * This matches the session->rotate_count, so the handle is valid until
  52          * the next rotate command. After that, the rotate_pending command
  53          * returns the expired state.
  54          */
  55         uint64_t rotate_id;
  56         /*
  57          * Where the rotated (readable) trace has been stored when the
  58          * rotation is completed.
  59          */
  60         char output_path[PATH_MAX];
  61         /*
  62          * The state of the rotation.
  63          */
  64         enum lttng_rotate_status status;
  65 } LTTNG_PACKED;
  66
  67 /*
  68  * Internal objects between lttng-ctl and the session daemon, the values
  69  * are then copied to the user's lttng_rotate_session_handle object.
  70  */
  71 /* For the LTTNG_ROTATE_SESSION command. */
  72 struct lttng_rotate_session_return {
  73         uint64_t rotate_id;
  74         enum lttng_rotate_status status;
  75 } LTTNG_PACKED;
  76
  77 /* For the LTTNG_ROTATE_PENDING command. */
  78 struct lttng_rotate_pending_return {
  79         enum lttng_rotate_status status;
  80         char output_path[PATH_MAX];
  81 } LTTNG_PACKED;
  82
  83 #endif /* LTTNG_ROTATE_INTERNAL_ABI_H */