Docs: document the evaluation API
[lttng-tools.git] / include / lttng / condition / condition-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_INTERNAL_H
19 #define LTTNG_CONDITION_INTERNAL_H
20
21 #include <lttng/condition/condition.h>
22 #include <common/macros.h>
23 #include <common/buffer-view.h>
24 #include <stdbool.h>
25 #include <urcu/list.h>
26 #include <stdint.h>
27
28 typedef void (*condition_destroy_cb)(struct lttng_condition *condition);
29 typedef bool (*condition_validate_cb)(const struct lttng_condition *condition);
30 typedef ssize_t (*condition_serialize_cb)(
31 const struct lttng_condition *condition, char *buf);
32 typedef bool (*condition_equal_cb)(const struct lttng_condition *a,
33 const struct lttng_condition *b);
34 typedef ssize_t (*condition_create_from_buffer_cb)(
35 const struct lttng_buffer_view *view,
36 struct lttng_condition **condition);
37
38 struct lttng_condition {
39 enum lttng_condition_type type;
40 condition_validate_cb validate;
41 condition_serialize_cb serialize;
42 condition_equal_cb equal;
43 condition_destroy_cb destroy;
44 };
45
46 struct lttng_condition_comm {
47 /* enum lttng_condition_type */
48 int8_t condition_type;
49 char payload[];
50 };
51
52 LTTNG_HIDDEN
53 void lttng_condition_init(struct lttng_condition *condition,
54 enum lttng_condition_type type);
55
56 LTTNG_HIDDEN
57 bool lttng_condition_validate(const struct lttng_condition *condition);
58
59 LTTNG_HIDDEN
60 ssize_t lttng_condition_create_from_buffer(
61 const struct lttng_buffer_view *buffer,
62 struct lttng_condition **condition);
63
64 LTTNG_HIDDEN
65 ssize_t lttng_condition_serialize(const struct lttng_condition *condition,
66 char *buf);
67
68 LTTNG_HIDDEN
69 bool lttng_condition_is_equal(const struct lttng_condition *a,
70 const struct lttng_condition *b);
71
72 #endif /* LTTNG_CONDITION_INTERNAL_H */
This page took 0.040786 seconds and 4 git commands to generate.