Commit | Line | Data |
---|---|---|
862ca4ed PP |
1 | #ifndef BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H |
2 | #define BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H | |
3 | ||
4 | /* | |
e2f7325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
862ca4ed PP |
6 | * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
862ca4ed PP |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | * | |
26 | * The Common Trace Format (CTF) Specification is available at | |
27 | * http://www.efficios.com/ctf | |
28 | */ | |
29 | ||
d24d5663 PP |
30 | #include <stdint.h> |
31 | ||
b19ff26f PP |
32 | /* |
33 | * For bt_bool, bt_uuid, bt_trace_class, bt_stream_class, | |
34 | * bt_field_class, bt_value | |
35 | */ | |
3fadfbc0 | 36 | #include <babeltrace2/types.h> |
862ca4ed | 37 | |
d24d5663 PP |
38 | /* For __BT_FUNC_STATUS_* */ |
39 | #define __BT_FUNC_STATUS_ENABLE | |
40 | #include <babeltrace2/func-status.h> | |
41 | #undef __BT_FUNC_STATUS_ENABLE | |
862ca4ed PP |
42 | |
43 | #ifdef __cplusplus | |
44 | extern "C" { | |
45 | #endif | |
46 | ||
ad5268b5 FD |
47 | typedef void (* bt_trace_class_destruction_listener_func)( |
48 | const bt_trace_class *trace_class, void *data); | |
49 | ||
862ca4ed | 50 | extern bt_bool bt_trace_class_assigns_automatic_stream_class_id( |
b19ff26f | 51 | const bt_trace_class *trace_class); |
862ca4ed PP |
52 | |
53 | extern const char *bt_trace_class_get_name( | |
b19ff26f | 54 | const bt_trace_class *trace_class); |
862ca4ed PP |
55 | |
56 | extern bt_uuid bt_trace_class_get_uuid( | |
b19ff26f | 57 | const bt_trace_class *trace_class); |
862ca4ed PP |
58 | |
59 | extern uint64_t bt_trace_class_get_environment_entry_count( | |
b19ff26f | 60 | const bt_trace_class *trace_class); |
862ca4ed PP |
61 | |
62 | extern void bt_trace_class_borrow_environment_entry_by_index_const( | |
b19ff26f PP |
63 | const bt_trace_class *trace_class, uint64_t index, |
64 | const char **name, const bt_value **value); | |
862ca4ed | 65 | |
b19ff26f | 66 | extern const bt_value * |
862ca4ed | 67 | bt_trace_class_borrow_environment_entry_value_by_name_const( |
b19ff26f | 68 | const bt_trace_class *trace_class, const char *name); |
862ca4ed | 69 | |
862ca4ed | 70 | extern uint64_t bt_trace_class_get_stream_class_count( |
b19ff26f | 71 | const bt_trace_class *trace_class); |
862ca4ed | 72 | |
b19ff26f | 73 | extern const bt_stream_class * |
862ca4ed | 74 | bt_trace_class_borrow_stream_class_by_index_const( |
b19ff26f | 75 | const bt_trace_class *trace_class, uint64_t index); |
862ca4ed | 76 | |
b19ff26f PP |
77 | extern const bt_stream_class *bt_trace_class_borrow_stream_class_by_id_const( |
78 | const bt_trace_class *trace_class, uint64_t id); | |
862ca4ed | 79 | |
d24d5663 PP |
80 | typedef enum bt_trace_class_add_listener_status { |
81 | BT_TRACE_CLASS_ADD_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
82 | BT_TRACE_CLASS_ADD_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK, | |
83 | } bt_trace_class_add_listener_status; | |
84 | ||
85 | extern bt_trace_class_add_listener_status | |
86 | bt_trace_class_add_destruction_listener( | |
ad5268b5 FD |
87 | const bt_trace_class *trace_class, |
88 | bt_trace_class_destruction_listener_func listener, | |
89 | void *data, uint64_t *listener_id); | |
90 | ||
d24d5663 PP |
91 | typedef enum bt_trace_class_remove_listener_status { |
92 | BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
93 | BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK, | |
94 | } bt_trace_class_remove_listener_status; | |
95 | ||
96 | extern bt_trace_class_remove_listener_status | |
97 | bt_trace_class_remove_destruction_listener( | |
ad5268b5 FD |
98 | const bt_trace_class *trace_class, uint64_t listener_id); |
99 | ||
b19ff26f | 100 | extern void bt_trace_class_get_ref(const bt_trace_class *trace_class); |
c5b9b441 | 101 | |
b19ff26f | 102 | extern void bt_trace_class_put_ref(const bt_trace_class *trace_class); |
c5b9b441 PP |
103 | |
104 | #define BT_TRACE_CLASS_PUT_REF_AND_RESET(_var) \ | |
105 | do { \ | |
106 | bt_trace_class_put_ref(_var); \ | |
107 | (_var) = NULL; \ | |
108 | } while (0) | |
109 | ||
110 | #define BT_TRACE_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
111 | do { \ | |
112 | bt_trace_class_put_ref(_var_dst); \ | |
113 | (_var_dst) = (_var_src); \ | |
114 | (_var_src) = NULL; \ | |
115 | } while (0) | |
116 | ||
862ca4ed PP |
117 | #ifdef __cplusplus |
118 | } | |
119 | #endif | |
120 | ||
d24d5663 PP |
121 | #include <babeltrace2/undef-func-status.h> |
122 | ||
862ca4ed | 123 | #endif /* BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H */ |