X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fcondition%2Fbuffer-usage.h;h=198f3e65768198fec1148fe232fa269d42b601e5;hb=HEAD;hp=3784bc9af03bedecc46991fff4e80d41a7da22e7;hpb=319370bdd77c9e2cee13a1c84fa5200e51cee0fe;p=lttng-tools.git diff --git a/include/lttng/condition/buffer-usage.h b/include/lttng/condition/buffer-usage.h index 3784bc9af..198f3e657 100644 --- a/include/lttng/condition/buffer-usage.h +++ b/include/lttng/condition/buffer-usage.h @@ -1,27 +1,19 @@ /* - * Copyright (C) 2017 - Jérémie Galarneau + * Copyright (C) 2017 Jérémie Galarneau * - * 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 #include -#include +#include #include +#include + +#include #ifdef __cplusplus extern "C" { @@ -66,8 +58,7 @@ extern "C" { * 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. @@ -82,8 +73,7 @@ lttng_condition_buffer_usage_low_create(void); * 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. @@ -97,10 +87,9 @@ lttng_condition_buffer_usage_high_create(void); * 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. @@ -113,10 +102,9 @@ lttng_condition_buffer_usage_get_threshold_ratio( * 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. @@ -129,10 +117,9 @@ lttng_condition_buffer_usage_set_threshold_ratio( * 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. @@ -143,10 +130,9 @@ lttng_condition_buffer_usage_get_threshold( * 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. @@ -160,10 +146,9 @@ lttng_condition_buffer_usage_set_threshold( * 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. @@ -173,10 +158,9 @@ lttng_condition_buffer_usage_get_session_name( * 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. @@ -190,10 +174,9 @@ lttng_condition_buffer_usage_set_session_name( * 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. @@ -203,10 +186,9 @@ lttng_condition_buffer_usage_get_channel_name( * 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. @@ -216,10 +198,9 @@ lttng_condition_buffer_usage_set_channel_name( * 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. @@ -227,11 +208,9 @@ lttng_condition_buffer_usage_get_domain_type( * 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 @@ -246,25 +225,23 @@ lttng_condition_buffer_usage_set_domain_type( /* * 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 }