include/lttng/snapshot-internal.hpp

   1 /*
   2  * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef LTTNG_SNAPSHOT_INTERNAL_ABI_H
   9 #define LTTNG_SNAPSHOT_INTERNAL_ABI_H
  10
  11 #include <limits.h>
  12 #include <stdint.h>
  13 #include <lttng/constant.h>
  14 #include <common/macros.hpp>
  15
  16 /*
  17  * Object used for the snapshot API. This is opaque to the public library.
  18  */
  19 struct lttng_snapshot_output {
  20         /*
  21          * ID of the snapshot output. This is only used when they are listed. It is
  22          * assigned by the session daemon so when adding an output, this value will
  23          * not be used.
  24          */
  25         uint32_t id;
  26         /*
  27          * Maximum size in bytes of the snapshot meaning the total size of all
  28          * stream combined. A value of 0 is unlimited.
  29          */
  30         uint64_t max_size;
  31         /* Name of the output so it can be recognized easily when listing them. */
  32         char name[LTTNG_NAME_MAX];
  33         /* Destination of the output. See lttng(1) for URL format. */
  34         char ctrl_url[PATH_MAX];
  35         /* Destination of the output. See lttng(1) for URL format. */
  36         char data_url[PATH_MAX];
  37 } LTTNG_PACKED;
  38
  39 /*
  40  * Snapshot output list object opaque to the user.
  41  */
  42 struct lttng_snapshot_output_list {
  43         /*
  44          * The position in the output array. This is changed by a get_next call.
  45          */
  46         int index;
  47
  48         /*
  49          * Number of element in the array.
  50          */
  51         size_t count;
  52
  53         /*
  54          * Contains snapshot output object.
  55          */
  56         struct lttng_snapshot_output *array;
  57 };
  58
  59 #endif /* LTTNG_SNAPSHOT_INTERNAL_ABI_H */