/*
- * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
*
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LTTNG_CONDITION_BUFFER_USAGE_H
#define LTTNG_CONDITION_BUFFER_USAGE_H
-#include <lttng/condition/evaluation.h>
#include <lttng/condition/condition.h>
-#include <stdint.h>
+#include <lttng/condition/evaluation.h>
#include <lttng/domain.h>
+#include <lttng/lttng-export.h>
+
+#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
-struct lttng_condition;
-struct lttng_evaluation;
-
/**
* Buffer usage conditions allows an action to be taken whenever a channel's
* buffer usage crosses a set threshold.
* Returns a new condition on success, NULL on failure. This condition must be
* destroyed using lttng_condition_destroy().
*/
-extern struct lttng_condition *
-lttng_condition_buffer_usage_low_create(void);
+LTTNG_EXPORT extern struct lttng_condition *lttng_condition_buffer_usage_low_create(void);
/*
* Create a newly allocated upper-bound buffer usage condition.
* Returns a new condition on success, NULL on failure. This condition must be
* destroyed using lttng_condition_destroy().
*/
-extern struct lttng_condition *
-lttng_condition_buffer_usage_high_create(void);
+LTTNG_EXPORT extern struct lttng_condition *lttng_condition_buffer_usage_high_create(void);
/*
* Get the buffer usage threshold ratio of a buffer usage condition.
* expressed as a ratio of total buffer capacity, was not set prior to this
* call.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_get_threshold_ratio(
- const struct lttng_condition *condition,
- double *threshold_ratio);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_get_threshold_ratio(const struct lttng_condition *condition,
+ double *threshold_ratio);
/*
* Set the buffer usage threshold ratio of a buffer usage condition.
* Returns LTTNG_CONDITION_STATUS_OK on success, LTTNG_CONDITION_STATUS_INVALID
* if invalid paramenters are passed.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_set_threshold_ratio(
- struct lttng_condition *condition,
- double threshold_ratio);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_set_threshold_ratio(struct lttng_condition *condition,
+ double threshold_ratio);
/*
* Get the buffer usage threshold of a buffer usage condition.
* LTTNG_CONDITION_STATUS_UNSET if a threshold, expressed as an absolute size in
* bytes, was not set prior to this call.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_get_threshold(
- const struct lttng_condition *condition,
- uint64_t *threshold_bytes);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_get_threshold(const struct lttng_condition *condition,
+ uint64_t *threshold_bytes);
/*
* Set the buffer usage threshold in bytes of a buffer usage condition.
* Returns LTTNG_CONDITION_STATUS_OK on success, LTTNG_CONDITION_STATUS_INVALID
* if invalid paramenters are passed.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_set_threshold(
- struct lttng_condition *condition,
- uint64_t threshold_bytes);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_set_threshold(struct lttng_condition *condition,
+ uint64_t threshold_bytes);
/*
* Get the session name property of a buffer usage condition.
* parameter is passed, or LTTNG_CONDITION_STATUS_UNSET if a session name
* was not set prior to this call.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_get_session_name(
- const struct lttng_condition *condition,
- const char **session_name);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_get_session_name(const struct lttng_condition *condition,
+ const char **session_name);
/*
* Set the session name property of a buffer usage condition.
* Returns LTTNG_CONDITION_STATUS_OK on success, LTTNG_CONDITION_STATUS_INVALID
* if invalid paramenters are passed.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_set_session_name(
- struct lttng_condition *condition,
- const char *session_name);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_set_session_name(struct lttng_condition *condition,
+ const char *session_name);
/*
* Get the channel name property of a buffer usage condition.
* parameter is passed, or LTTNG_CONDITION_STATUS_UNSET if a channel name
* was not set prior to this call.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_get_channel_name(
- const struct lttng_condition *condition,
- const char **channel_name);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_get_channel_name(const struct lttng_condition *condition,
+ const char **channel_name);
/*
* Set the channel name property of a buffer usage condition.
* Returns LTTNG_CONDITION_STATUS_OK on success, LTTNG_CONDITION_STATUS_INVALID
* if invalid paramenters are passed.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_set_channel_name(
- struct lttng_condition *condition,
- const char *channel_name);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_set_channel_name(struct lttng_condition *condition,
+ const char *channel_name);
/*
* Get the domain type property of a buffer usage condition.
* or LTTNG_CONDITION_STATUS_UNSET if a domain type was not set prior to this
* call.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_get_domain_type(
- const struct lttng_condition *condition,
- enum lttng_domain_type *type);
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_get_domain_type(const struct lttng_condition *condition,
+ enum lttng_domain_type *type);
/*
* Set the domain type property of a buffer usage condition.
* Returns LTTNG_CONDITION_STATUS_OK on success, LTTNG_CONDITION_STATUS_INVALID
* if invalid paramenters are passed.
*/
-extern enum lttng_condition_status
-lttng_condition_buffer_usage_set_domain_type(
- struct lttng_condition *condition,
- enum lttng_domain_type type);
-
+LTTNG_EXPORT extern enum lttng_condition_status
+lttng_condition_buffer_usage_set_domain_type(struct lttng_condition *condition,
+ enum lttng_domain_type type);
/**
* lttng_evaluation_buffer_usage are specialised lttng_evaluations which
/*
* Get the buffer usage ratio property of a buffer usage evaluation.
*
- * Returns LTTNG_CONDITION_STATUS_OK on success and a threshold expressed as
- * as a ratio of the buffer's capacity, or LTTNG_CONDITION_STATUS_INVALID if
+ * Returns LTTNG_EVALUATION_STATUS_OK on success and a threshold expressed as
+ * as a ratio of the buffer's capacity, or LTTNG_EVALUATION_STATUS_INVALID if
* an invalid parameter is passed.
*/
-extern enum lttng_evaluation_status
-lttng_evaluation_buffer_usage_get_usage_ratio(
- const struct lttng_evaluation *evaluation,
- double *usage_ratio);
+LTTNG_EXPORT extern enum lttng_evaluation_status
+lttng_evaluation_buffer_usage_get_usage_ratio(const struct lttng_evaluation *evaluation,
+ double *usage_ratio);
/*
* Get the buffer usage property of a buffer usage evaluation.
*
- * Returns LTTNG_CONDITION_STATUS_OK on success and a threshold expressed in
- * bytes, or LTTNG_CONDITION_STATUS_INVALID if an invalid parameter is passed.
+ * Returns LTTNG_EVALUATION_STATUS_OK on success and a threshold expressed in
+ * bytes, or LTTNG_EVALUATION_STATUS_INVALID if an invalid parameter is passed.
*/
-extern enum lttng_evaluation_status
-lttng_evaluation_buffer_usage_get_usage(
- const struct lttng_evaluation *evaluation,
- uint64_t *usage_bytes);
+LTTNG_EXPORT extern enum lttng_evaluation_status
+lttng_evaluation_buffer_usage_get_usage(const struct lttng_evaluation *evaluation,
+ uint64_t *usage_bytes);
#ifdef __cplusplus
}
projects / lttng-tools.git / blobdiff