lib: move trace class's name, UUID, and environment props to trace API
[babeltrace.git] / include / babeltrace2 / trace-ir / trace-class-const.h
... / ...
CommitLineData
1#ifndef BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H
2#define BABELTRACE_TRACE_IR_TRACE_CLASS_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#include <stdint.h>
31
32/*
33 * For bt_bool, bt_uuid, bt_trace_class, bt_stream_class,
34 * bt_field_class, bt_value
35 */
36#include <babeltrace2/types.h>
37
38/* For __BT_FUNC_STATUS_* */
39#define __BT_FUNC_STATUS_ENABLE
40#include <babeltrace2/func-status.h>
41#undef __BT_FUNC_STATUS_ENABLE
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
47typedef void (* bt_trace_class_destruction_listener_func)(
48 const bt_trace_class *trace_class, void *data);
49
50extern bt_bool bt_trace_class_assigns_automatic_stream_class_id(
51 const bt_trace_class *trace_class);
52
53extern uint64_t bt_trace_class_get_stream_class_count(
54 const bt_trace_class *trace_class);
55
56extern const bt_stream_class *
57bt_trace_class_borrow_stream_class_by_index_const(
58 const bt_trace_class *trace_class, uint64_t index);
59
60extern const bt_stream_class *bt_trace_class_borrow_stream_class_by_id_const(
61 const bt_trace_class *trace_class, uint64_t id);
62
63typedef enum bt_trace_class_add_listener_status {
64 BT_TRACE_CLASS_ADD_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
65 BT_TRACE_CLASS_ADD_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK,
66} bt_trace_class_add_listener_status;
67
68extern bt_trace_class_add_listener_status
69bt_trace_class_add_destruction_listener(
70 const bt_trace_class *trace_class,
71 bt_trace_class_destruction_listener_func listener,
72 void *data, uint64_t *listener_id);
73
74typedef enum bt_trace_class_remove_listener_status {
75 BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
76 BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK,
77} bt_trace_class_remove_listener_status;
78
79extern bt_trace_class_remove_listener_status
80bt_trace_class_remove_destruction_listener(
81 const bt_trace_class *trace_class, uint64_t listener_id);
82
83extern void bt_trace_class_get_ref(const bt_trace_class *trace_class);
84
85extern void bt_trace_class_put_ref(const bt_trace_class *trace_class);
86
87#define BT_TRACE_CLASS_PUT_REF_AND_RESET(_var) \
88 do { \
89 bt_trace_class_put_ref(_var); \
90 (_var) = NULL; \
91 } while (0)
92
93#define BT_TRACE_CLASS_MOVE_REF(_var_dst, _var_src) \
94 do { \
95 bt_trace_class_put_ref(_var_dst); \
96 (_var_dst) = (_var_src); \
97 (_var_src) = NULL; \
98 } while (0)
99
100#ifdef __cplusplus
101}
102#endif
103
104#include <babeltrace2/undef-func-status.h>
105
106#endif /* BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H */
This page took 0.023649 seconds and 4 git commands to generate.