Commit | Line | Data |
---|---|---|
3b4c8c43 PP |
1 | #ifndef BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H |
2 | #define BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H | |
3 | ||
4 | /* | |
0554db57 | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
3b4c8c43 PP |
6 | * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
3b4c8c43 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 | ||
b9879703 PP |
30 | /* |
31 | * For bt_bool, bt_uuid, bt_trace_class, bt_stream_class, | |
32 | * bt_field_class, bt_value | |
33 | */ | |
3b4c8c43 PP |
34 | #include <babeltrace/types.h> |
35 | ||
36 | #include <stdint.h> | |
37 | ||
38 | #ifdef __cplusplus | |
39 | extern "C" { | |
40 | #endif | |
41 | ||
b7c5b62e | 42 | typedef enum bt_trace_class_status { |
7c93dec7 PP |
43 | BT_TRACE_CLASS_STATUS_OK = 0, |
44 | BT_TRACE_CLASS_STATUS_NOMEM = -12, | |
b7c5b62e | 45 | } bt_trace_class_status; |
7c93dec7 | 46 | |
2f53eba5 FD |
47 | typedef void (* bt_trace_class_destruction_listener_func)( |
48 | const bt_trace_class *trace_class, void *data); | |
49 | ||
3b4c8c43 | 50 | extern bt_bool bt_trace_class_assigns_automatic_stream_class_id( |
b9879703 | 51 | const bt_trace_class *trace_class); |
3b4c8c43 PP |
52 | |
53 | extern const char *bt_trace_class_get_name( | |
b9879703 | 54 | const bt_trace_class *trace_class); |
3b4c8c43 PP |
55 | |
56 | extern bt_uuid bt_trace_class_get_uuid( | |
b9879703 | 57 | const bt_trace_class *trace_class); |
3b4c8c43 PP |
58 | |
59 | extern uint64_t bt_trace_class_get_environment_entry_count( | |
b9879703 | 60 | const bt_trace_class *trace_class); |
3b4c8c43 PP |
61 | |
62 | extern void bt_trace_class_borrow_environment_entry_by_index_const( | |
b9879703 PP |
63 | const bt_trace_class *trace_class, uint64_t index, |
64 | const char **name, const bt_value **value); | |
3b4c8c43 | 65 | |
b9879703 | 66 | extern const bt_value * |
3b4c8c43 | 67 | bt_trace_class_borrow_environment_entry_value_by_name_const( |
b9879703 | 68 | const bt_trace_class *trace_class, const char *name); |
3b4c8c43 | 69 | |
3b4c8c43 | 70 | extern uint64_t bt_trace_class_get_stream_class_count( |
b9879703 | 71 | const bt_trace_class *trace_class); |
3b4c8c43 | 72 | |
b9879703 | 73 | extern const bt_stream_class * |
3b4c8c43 | 74 | bt_trace_class_borrow_stream_class_by_index_const( |
b9879703 | 75 | const bt_trace_class *trace_class, uint64_t index); |
3b4c8c43 | 76 | |
b9879703 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); | |
3b4c8c43 | 79 | |
2f53eba5 FD |
80 | extern bt_trace_class_status bt_trace_class_add_destruction_listener( |
81 | const bt_trace_class *trace_class, | |
82 | bt_trace_class_destruction_listener_func listener, | |
83 | void *data, uint64_t *listener_id); | |
84 | ||
85 | extern bt_trace_class_status bt_trace_class_remove_destruction_listener( | |
86 | const bt_trace_class *trace_class, uint64_t listener_id); | |
87 | ||
b9879703 | 88 | extern void bt_trace_class_get_ref(const bt_trace_class *trace_class); |
317e35ec | 89 | |
b9879703 | 90 | extern void bt_trace_class_put_ref(const bt_trace_class *trace_class); |
317e35ec PP |
91 | |
92 | #define BT_TRACE_CLASS_PUT_REF_AND_RESET(_var) \ | |
93 | do { \ | |
94 | bt_trace_class_put_ref(_var); \ | |
95 | (_var) = NULL; \ | |
96 | } while (0) | |
97 | ||
98 | #define BT_TRACE_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
99 | do { \ | |
100 | bt_trace_class_put_ref(_var_dst); \ | |
101 | (_var_dst) = (_var_src); \ | |
102 | (_var_src) = NULL; \ | |
103 | } while (0) | |
104 | ||
3b4c8c43 PP |
105 | #ifdef __cplusplus |
106 | } | |
107 | #endif | |
108 | ||
109 | #endif /* BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H */ |