2 * Copyright (C) 2020 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_LOG_LEVEL_RULE_H
9 #define LTTNG_LOG_LEVEL_RULE_H
15 struct lttng_log_level_rule
;
17 enum lttng_log_level_rule_type
{
18 LTTNG_LOG_LEVEL_RULE_TYPE_UNKNOWN
= -1,
19 LTTNG_LOG_LEVEL_RULE_TYPE_EXACTLY
= 0,
20 LTTNG_LOG_LEVEL_RULE_TYPE_AT_LEAST_AS_SEVERE_AS
= 1,
23 enum lttng_log_level_rule_status
{
24 LTTNG_LOG_LEVEL_RULE_STATUS_OK
= 0,
25 LTTNG_LOG_LEVEL_RULE_STATUS_ERROR
= -1,
26 LTTNG_LOG_LEVEL_RULE_STATUS_INVALID
= -3,
30 * Returns the type of the log level rule `rule`, or:
32 * `LTTNG_LOG_LEVEL_RULE_TYPE_UNKNOWN`:
35 extern enum lttng_log_level_rule_type
lttng_log_level_rule_get_type(
36 const struct lttng_log_level_rule
*rule
);
39 * Creates a log level rule for which a log level must match exactly `level` to
44 * * There's a memory error.
46 * The returned log level rule must be destroyed using
47 * lttng_log_level_rule_destroy().
49 extern struct lttng_log_level_rule
*lttng_log_level_rule_exactly_create(
53 * Sets `level` to the level of the "exactly" log level rule `rule`.
57 * `LTTNG_LOG_LEVEL_RULE_STATUS_OK`:
60 * `LTTNG_LOG_LEVEL_RULE_STATUS_INVALID`:
63 * * The type of `rule` is not `LTTNG_LOG_LEVEL_RULE_TYPE_EXACTLY`.
65 extern enum lttng_log_level_rule_status
lttng_log_level_rule_exactly_get_level(
66 const struct lttng_log_level_rule
*rule
, int *level
);
69 * Creates a log level rule for which a log level must be at least as severe as
70 * `level` to be considered.
74 * * There's a memory error.
76 * The returned log level rule must be destroyed using
77 * lttng_log_level_rule_destroy().
79 extern struct lttng_log_level_rule
*
80 lttng_log_level_rule_at_least_as_severe_as_create(int level
);
83 * Sets `level` to the level of the "at least as severe as" log level rule
88 * `LTTNG_LOG_LEVEL_RULE_STATUS_OK`:
91 * `LTTNG_LOG_LEVEL_RULE_STATUS_INVALID`:
94 * * The type of `rule` is not
95 * `LTTNG_LOG_LEVEL_RULE_TYPE_AT_LEAST_AS_SEVERE_AS`.
97 extern enum lttng_log_level_rule_status
98 lttng_log_level_rule_at_least_as_severe_as_get_level(
99 const struct lttng_log_level_rule
*rule
, int *level
);
102 * Destroy the log level rule `log_level_rule` if not `NULL`.
104 extern void lttng_log_level_rule_destroy(
105 struct lttng_log_level_rule
*log_level_rule
);
111 #endif /* LTTNG_LOG_LEVEL_RULE_H */