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