Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_TRACE_CONST_H |
2 | #define BABELTRACE2_TRACE_IR_TRACE_CONST_H | |
40f4ba76 PP |
3 | |
4 | /* | |
e2f7325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
40f4ba76 PP |
6 | * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
40f4ba76 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 | ||
4fa90f32 PP |
30 | #ifndef __BT_IN_BABELTRACE_H |
31 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
32 | #endif | |
33 | ||
d24d5663 PP |
34 | #include <stdint.h> |
35 | ||
b19ff26f PP |
36 | /* |
37 | * For bt_bool, bt_uuid, bt_trace, bt_stream, bt_stream_class, | |
38 | * bt_field_class, bt_value | |
39 | */ | |
3fadfbc0 | 40 | #include <babeltrace2/types.h> |
40f4ba76 | 41 | |
40f4ba76 PP |
42 | #ifdef __cplusplus |
43 | extern "C" { | |
44 | #endif | |
45 | ||
ad5268b5 FD |
46 | typedef void (* bt_trace_destruction_listener_func)( |
47 | const bt_trace *trace, void *data); | |
40f4ba76 | 48 | |
b19ff26f PP |
49 | extern const bt_trace_class *bt_trace_borrow_class_const( |
50 | const bt_trace *trace); | |
40f4ba76 | 51 | |
b19ff26f | 52 | extern const char *bt_trace_get_name(const bt_trace *trace); |
40f4ba76 | 53 | |
335a2da5 PP |
54 | extern bt_uuid bt_trace_get_uuid(const bt_trace *trace); |
55 | ||
56 | extern uint64_t bt_trace_get_environment_entry_count(const bt_trace *trace); | |
57 | ||
58 | extern void bt_trace_borrow_environment_entry_by_index_const( | |
59 | const bt_trace *trace, uint64_t index, | |
60 | const char **name, const bt_value **value); | |
61 | ||
62 | extern const bt_value *bt_trace_borrow_environment_entry_value_by_name_const( | |
63 | const bt_trace *trace, const char *name); | |
64 | ||
b19ff26f | 65 | extern uint64_t bt_trace_get_stream_count(const bt_trace *trace); |
40f4ba76 | 66 | |
b19ff26f PP |
67 | extern const bt_stream *bt_trace_borrow_stream_by_index_const( |
68 | const bt_trace *trace, uint64_t index); | |
40f4ba76 | 69 | |
b19ff26f PP |
70 | extern const bt_stream *bt_trace_borrow_stream_by_id_const( |
71 | const bt_trace *trace, uint64_t id); | |
40f4ba76 | 72 | |
d24d5663 PP |
73 | typedef enum bt_trace_add_listener_status { |
74 | BT_TRACE_ADD_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
75 | BT_TRACE_ADD_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK, | |
76 | } bt_trace_add_listener_status; | |
77 | ||
78 | extern bt_trace_add_listener_status bt_trace_add_destruction_listener( | |
23578e82 | 79 | const bt_trace *trace, |
ad5268b5 FD |
80 | bt_trace_destruction_listener_func listener, |
81 | void *data, uint64_t *listener_id); | |
40f4ba76 | 82 | |
d24d5663 PP |
83 | typedef enum bt_trace_remove_listener_status { |
84 | BT_TRACE_REMOVE_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
85 | BT_TRACE_REMOVE_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK, | |
86 | } bt_trace_remove_listener_status; | |
87 | ||
88 | extern bt_trace_remove_listener_status bt_trace_remove_destruction_listener( | |
23578e82 | 89 | const bt_trace *trace, uint64_t listener_id); |
40f4ba76 | 90 | |
b19ff26f | 91 | extern void bt_trace_get_ref(const bt_trace *trace); |
c5b9b441 | 92 | |
b19ff26f | 93 | extern void bt_trace_put_ref(const bt_trace *trace); |
c5b9b441 PP |
94 | |
95 | #define BT_TRACE_PUT_REF_AND_RESET(_var) \ | |
96 | do { \ | |
97 | bt_trace_put_ref(_var); \ | |
98 | (_var) = NULL; \ | |
99 | } while (0) | |
100 | ||
101 | #define BT_TRACE_MOVE_REF(_var_dst, _var_src) \ | |
102 | do { \ | |
103 | bt_trace_put_ref(_var_dst); \ | |
104 | (_var_dst) = (_var_src); \ | |
105 | (_var_src) = NULL; \ | |
106 | } while (0) | |
107 | ||
40f4ba76 PP |
108 | #ifdef __cplusplus |
109 | } | |
110 | #endif | |
111 | ||
924dc299 | 112 | #endif /* BABELTRACE2_TRACE_IR_TRACE_CONST_H */ |