lib: metadata: transform fast path precond. checks to BT_ASSERT_PRE()
[babeltrace.git] / include / babeltrace / ctf-ir / trace-internal.h
CommitLineData
daf01357
JG
1#ifndef BABELTRACE_CTF_IR_TRACE_INTERNAL_H
2#define BABELTRACE_CTF_IR_TRACE_INTERNAL_H
3
4/*
5 * BabelTrace - CTF IR: Trace internal
6 *
7 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * SOFTWARE.
28 */
29
daf01357 30#include <babeltrace/ctf-ir/trace.h>
2e33ac5a
PP
31#include <babeltrace/ctf-ir/field-types.h>
32#include <babeltrace/ctf-ir/fields.h>
83509119 33#include <babeltrace/object-internal.h>
daf01357 34#include <babeltrace/babeltrace-internal.h>
dac5c838 35#include <babeltrace/values.h>
c55a9f58 36#include <babeltrace/types.h>
daf01357
JG
37#include <glib.h>
38#include <sys/types.h>
20eee76e 39#include <babeltrace/compat/uuid-internal.h>
daf01357
JG
40
41enum field_type_alias {
42 FIELD_TYPE_ALIAS_UINT5_T = 0,
43 FIELD_TYPE_ALIAS_UINT8_T,
44 FIELD_TYPE_ALIAS_UINT16_T,
45 FIELD_TYPE_ALIAS_UINT27_T,
46 FIELD_TYPE_ALIAS_UINT32_T,
47 FIELD_TYPE_ALIAS_UINT64_T,
48 NR_FIELD_TYPE_ALIAS,
49};
50
50842bdc 51struct bt_trace {
83509119 52 struct bt_object base;
e96045d4 53 GString *name;
daf01357 54 int frozen;
20eee76e 55 unsigned char uuid[BABELTRACE_UUID_LEN];
c55a9f58 56 bt_bool uuid_set;
50842bdc 57 enum bt_byte_order native_byte_order;
dac5c838 58 struct bt_value *environment;
50842bdc
PP
59 GPtrArray *clocks; /* Array of pointers to bt_clock_class */
60 GPtrArray *stream_classes; /* Array of ptrs to bt_stream_class */
61 GPtrArray *streams; /* Array of ptrs to bt_stream */
62 struct bt_field_type *packet_header_type;
9ac68eb1 63 int64_t next_stream_id;
319fd969 64 int is_created_by_writer;
09840de5
PP
65
66 /*
67 * This flag indicates if the trace is valid. A valid
68 * trace is _always_ frozen.
69 */
70 int valid;
50ad4244 71 GPtrArray *listeners; /* Array of struct listener_wrapper */
3602afb0 72 GArray *is_static_listeners;
c55a9f58 73 bt_bool is_static;
8480c8cc 74 bt_bool in_remove_listener;
daf01357
JG
75};
76
daf01357
JG
77struct metadata_context {
78 GString *string;
79 GString *field_name;
80 unsigned int current_indentation_level;
81};
82
daf01357
JG
83BT_HIDDEN
84const char *get_byte_order_string(int byte_order);
85
86BT_HIDDEN
50842bdc 87struct bt_field_type *get_field_type(enum field_type_alias alias);
daf01357 88
9b888ff3 89BT_HIDDEN
50842bdc 90int bt_trace_object_modification(struct bt_visitor_object *object,
9b888ff3
JG
91 void *trace_ptr);
92
c9d90a34 93BT_HIDDEN
50842bdc
PP
94bt_bool bt_trace_has_clock_class(struct bt_trace *trace,
95 struct bt_clock_class *clock_class);
c9d90a34 96
3230ee6b 97/**
50842bdc 98@brief User function type to use with bt_trace_add_listener().
3230ee6b
PP
99
100@param[in] obj New CTF IR object which is part of the trace
101 class hierarchy.
102@param[in] data User data.
103
104@prenotnull{obj}
105*/
50842bdc 106typedef void (*bt_listener_cb)(struct bt_visitor_object *obj, void *data);
3230ee6b
PP
107
108/**
109@brief Adds the trace class modification listener \p listener to
110 the CTF IR trace class \p trace_class.
111
112Once you add \p listener to \p trace_class, whenever \p trace_class
113is modified, \p listener is called with the new element and with
114\p data (user data).
115
116@param[in] trace_class Trace class to which to add \p listener.
117@param[in] listener Modification listener function.
118@param[in] data User data.
119@returns 0 on success, or a negative value on error.
120
121@prenotnull{trace_class}
122@prenotnull{listener}
123@postrefcountsame{trace_class}
124*/
5b876b06 125BT_HIDDEN
50842bdc
PP
126int bt_trace_add_listener(struct bt_trace *trace_class,
127 bt_listener_cb listener, void *data);
3230ee6b 128
5b876b06 129/*
50842bdc 130 * bt_trace_get_metadata_string: get metadata string.
5b876b06
PP
131 *
132 * Get the trace's TSDL metadata. The caller assumes the ownership of the
133 * returned string.
134 *
135 * @param trace Trace instance.
136 *
137 * Returns the metadata string on success, NULL on error.
138 */
139BT_HIDDEN
50842bdc 140char *bt_trace_get_metadata_string(struct bt_trace *trace);
5b876b06 141
daf01357 142#endif /* BABELTRACE_CTF_IR_TRACE_INTERNAL_H */
This page took 0.04961 seconds and 4 git commands to generate.