include/lttng/condition/buffer-usage.h

   1 /*
   2  * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@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_CONDITION_BUFFER_USAGE_H
  19 #define LTTNG_CONDITION_BUFFER_USAGE_H
  20
  21 #include <lttng/condition/evaluation.h>
  22 #include <lttng/condition/condition.h>
  23 #include <stdint.h>
  24 #include <lttng/domain.h>
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 struct lttng_condition;
  31 struct lttng_evaluation;
  32
  33 extern struct lttng_condition *
  34 lttng_condition_buffer_usage_low_create(void);
  35
  36 extern struct lttng_condition *
  37 lttng_condition_buffer_usage_high_create(void);
  38
  39 /* threshold_ratio expressed as [0.0, 1.0]. */
  40 extern enum lttng_condition_status
  41 lttng_condition_buffer_usage_get_threshold_ratio(
  42                 const struct lttng_condition *condition,
  43                 double *threshold_ratio);
  44
  45 /* threshold_ratio expressed as [0.0, 1.0]. */
  46 extern enum lttng_condition_status
  47 lttng_condition_buffer_usage_set_threshold_ratio(
  48                 struct lttng_condition *condition,
  49                 double threshold_ratio);
  50
  51 extern enum lttng_condition_status
  52 lttng_condition_buffer_usage_get_threshold(
  53                 const struct lttng_condition *condition,
  54                 uint64_t *threshold_bytes);
  55
  56 extern enum lttng_condition_status
  57 lttng_condition_buffer_usage_set_threshold(
  58                 struct lttng_condition *condition,
  59                 uint64_t threshold_bytes);
  60
  61 extern enum lttng_condition_status
  62 lttng_condition_buffer_usage_get_session_name(
  63                 const struct lttng_condition *condition,
  64                 const char **session_name);
  65
  66 extern enum lttng_condition_status
  67 lttng_condition_buffer_usage_set_session_name(
  68                 struct lttng_condition *condition,
  69                 const char *session_name);
  70
  71 extern enum lttng_condition_status
  72 lttng_condition_buffer_usage_get_channel_name(
  73                 const struct lttng_condition *condition,
  74                 const char **channel_name);
  75
  76 extern enum lttng_condition_status
  77 lttng_condition_buffer_usage_set_channel_name(
  78                 struct lttng_condition *condition,
  79                 const char *channel_name);
  80
  81 extern enum lttng_condition_status
  82 lttng_condition_buffer_usage_get_domain_type(
  83                 const struct lttng_condition *condition,
  84                 enum lttng_domain_type *type);
  85
  86 extern enum lttng_condition_status
  87 lttng_condition_buffer_usage_set_domain_type(
  88                 struct lttng_condition *condition,
  89                 enum lttng_domain_type type);
  90
  91
  92 /* LTTng Condition Evaluation */
  93 extern enum lttng_evaluation_status
  94 lttng_evaluation_buffer_usage_get_usage_ratio(
  95                 const struct lttng_evaluation *evaluation,
  96                 double *usage_ratio);
  97
  98 extern enum lttng_evaluation_status
  99 lttng_evaluation_buffer_usage_get_usage(
 100                 const struct lttng_evaluation *evaluation,
 101                 uint64_t *usage_bytes);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* LTTNG_CONDITION_BUFFER_USAGE_H */