include/lttng/snapshot-internal.h

   1 /*
   2  * Copyright (C) 2013 - David Goulet <dgoulet@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_SNAPSHOT_INTERNAL_ABI_H
  19 #define LTTNG_SNAPSHOT_INTERNAL_ABI_H
  20
  21 #include <limits.h>
  22 #include <stdint.h>
  23
  24 /*
  25  * Object used for the snapshot API. This is opaque to the public library.
  26  */
  27 struct lttng_snapshot_output {
  28         /*
  29          * ID of the snapshot output. This is only used when they are listed. It is
  30          * assigned by the session daemon so when adding an output, this value will
  31          * not be used.
  32          */
  33         uint32_t id;
  34         /*
  35          * Maximum size in bytes of the snapshot meaning the total size of all
  36          * stream combined. A value of 0 is unlimited.
  37          */
  38         uint64_t max_size;
  39         /* Name of the output so it can be recognized easily when listing them. */
  40         char name[NAME_MAX];
  41         /* Destination of the output. See lttng(1) for URL format. */
  42         char ctrl_url[PATH_MAX];
  43         /* Destination of the output. See lttng(1) for URL format. */
  44         char data_url[PATH_MAX];
  45 };
  46
  47 /*
  48  * Snapshot output list object opaque to the user.
  49  */
  50 struct lttng_snapshot_output_list {
  51         /*
  52          * The position in the output array. This is changed by a get_next call.
  53          */
  54         int index;
  55
  56         /*
  57          * Number of element in the array.
  58          */
  59         size_t count;
  60
  61         /*
  62          * Containes snapshot output object.
  63          */
  64         struct lttng_snapshot_output *array;
  65 };
  66
  67 #endif /* LTTNG_SNAPSHOT_INTERNAL_ABI_H */