lib: add aliases for Babeltrace structure types
[babeltrace.git] / include / babeltrace / trace-ir / trace-const.h
1 #ifndef BABELTRACE_TRACE_IR_TRACE_CONST_H
2 #define BABELTRACE_TRACE_IR_TRACE_CONST_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
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
30 /*
31 * For bt_bool, bt_uuid, bt_trace, bt_stream, bt_stream_class,
32 * bt_field_class, bt_value
33 */
34 #include <babeltrace/types.h>
35
36 #include <stdint.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 typedef void (* bt_trace_is_static_listener_func)(const bt_trace *trace,
43 void *data);
44
45 typedef void (* bt_trace_listener_removed_func)(const bt_trace *trace,
46 void *data);
47
48 extern const bt_trace_class *bt_trace_borrow_class_const(
49 const bt_trace *trace);
50
51 extern const char *bt_trace_get_name(const bt_trace *trace);
52
53 extern uint64_t bt_trace_get_stream_count(const bt_trace *trace);
54
55 extern const bt_stream *bt_trace_borrow_stream_by_index_const(
56 const bt_trace *trace, uint64_t index);
57
58 extern const bt_stream *bt_trace_borrow_stream_by_id_const(
59 const bt_trace *trace, uint64_t id);
60
61 extern bt_bool bt_trace_is_static(const bt_trace *trace);
62
63 extern int bt_trace_add_is_static_listener(const bt_trace *trace,
64 bt_trace_is_static_listener_func listener,
65 bt_trace_listener_removed_func listener_removed, void *data,
66 uint64_t *listener_id);
67
68 extern int bt_trace_remove_is_static_listener(const bt_trace *trace,
69 uint64_t listener_id);
70
71 extern void bt_trace_get_ref(const bt_trace *trace);
72
73 extern void bt_trace_put_ref(const bt_trace *trace);
74
75 #define BT_TRACE_PUT_REF_AND_RESET(_var) \
76 do { \
77 bt_trace_put_ref(_var); \
78 (_var) = NULL; \
79 } while (0)
80
81 #define BT_TRACE_MOVE_REF(_var_dst, _var_src) \
82 do { \
83 bt_trace_put_ref(_var_dst); \
84 (_var_dst) = (_var_src); \
85 (_var_src) = NULL; \
86 } while (0)
87
88 #ifdef __cplusplus
89 }
90 #endif
91
92 #endif /* BABELTRACE_TRACE_IR_TRACE_CONST_H */
This page took 0.032411 seconds and 4 git commands to generate.