include/lttng/condition/buffer-usage-internal.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_INTERNAL_H
  19 #define LTTNG_CONDITION_BUFFER_USAGE_INTERNAL_H
  20
  21 #include <lttng/condition/buffer-usage.h>
  22 #include <lttng/condition/condition-internal.h>
  23 #include <lttng/condition/evaluation-internal.h>
  24 #include <lttng/domain.h>
  25 #include "common/buffer-view.h"
  26
  27 struct lttng_condition_buffer_usage {
  28         struct lttng_condition parent;
  29         struct {
  30                 bool set;
  31                 uint64_t value;
  32         } threshold_bytes;
  33         struct {
  34                 bool set;
  35                 double value;
  36         } threshold_ratio;
  37         char *session_name;
  38         char *channel_name;
  39         struct {
  40                 bool set;
  41                 enum lttng_domain_type type;
  42         } domain;
  43 };
  44
  45 struct lttng_condition_buffer_usage_comm {
  46         uint8_t threshold_set_in_bytes;
  47         /*
  48          * Expressed in bytes if "threshold_set_in_bytes" is not 0.
  49          * Otherwise, it is expressed a ratio in the interval [0.0, 1.0]
  50          * that is mapped to the range on a 32-bit unsigned integer.
  51          * The ratio is obtained by (threshold / UINT32_MAX).
  52          */
  53         uint32_t threshold;
  54         /* Both lengths include the trailing \0. */
  55         uint32_t session_name_len;
  56         uint32_t channel_name_len;
  57         /* enum lttng_domain_type */
  58         int8_t domain_type;
  59         /* session and channel names. */
  60         char names[];
  61 } LTTNG_PACKED;
  62
  63 struct lttng_evaluation_buffer_usage {
  64         struct lttng_evaluation parent;
  65         uint64_t buffer_use;
  66         uint64_t buffer_capacity;
  67 };
  68
  69 struct lttng_evaluation_buffer_usage_comm {
  70         uint64_t buffer_use;
  71         uint64_t buffer_capacity;
  72 } LTTNG_PACKED;
  73
  74 LTTNG_HIDDEN
  75 struct lttng_evaluation *lttng_evaluation_buffer_usage_create(
  76                 enum lttng_condition_type type, uint64_t use,
  77                 uint64_t capacity);
  78
  79 LTTNG_HIDDEN
  80 ssize_t lttng_condition_buffer_usage_low_create_from_buffer(
  81                 const struct lttng_buffer_view *view,
  82                 struct lttng_condition **condition);
  83
  84 LTTNG_HIDDEN
  85 ssize_t lttng_condition_buffer_usage_high_create_from_buffer(
  86                 const struct lttng_buffer_view *view,
  87                 struct lttng_condition **condition);
  88
  89 LTTNG_HIDDEN
  90 ssize_t lttng_evaluation_buffer_usage_low_create_from_buffer(
  91                 const struct lttng_buffer_view *view,
  92                 struct lttng_evaluation **evaluation);
  93
  94 LTTNG_HIDDEN
  95 ssize_t lttng_evaluation_buffer_usage_high_create_from_buffer(
  96                 const struct lttng_buffer_view *view,
  97                 struct lttng_evaluation **evaluation);
  98
  99 #endif /* LTTNG_CONDITION_BUFFER_USAGE_INTERNAL_H */