1 #ifndef BABELTRACE_CTF_IR_TRACE_INTERNAL_H
2 #define BABELTRACE_CTF_IR_TRACE_INTERNAL_H
5 * BabelTrace - CTF IR: Trace internal
7 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
30 #include <babeltrace/ctf-ir/trace.h>
31 #include <babeltrace/ctf-ir/field-types.h>
32 #include <babeltrace/ctf-ir/fields.h>
33 #include <babeltrace/object-internal.h>
34 #include <babeltrace/babeltrace-internal.h>
35 #include <babeltrace/values.h>
36 #include <babeltrace/types.h>
38 #include <sys/types.h>
39 #include <uuid/uuid.h>
41 enum 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
,
52 struct bt_object base
;
57 enum bt_ctf_byte_order native_byte_order
;
58 struct bt_value
*environment
;
59 GPtrArray
*clocks
; /* Array of pointers to bt_ctf_clock_class */
60 GPtrArray
*stream_classes
; /* Array of ptrs to bt_ctf_stream_class */
61 GPtrArray
*streams
; /* Array of ptrs to bt_ctf_stream */
62 struct bt_ctf_field_type
*packet_header_type
;
63 int64_t next_stream_id
;
64 int is_created_by_writer
;
67 * This flag indicates if the trace is valid. A valid
68 * trace is _always_ frozen.
71 GPtrArray
*listeners
; /* Array of struct listener_wrapper */
72 GArray
*is_static_listeners
;
76 struct metadata_context
{
79 unsigned int current_indentation_level
;
83 const char *get_byte_order_string(int byte_order
);
86 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
);
89 int bt_ctf_trace_object_modification(struct bt_ctf_object
*object
,
93 bt_bool
bt_ctf_trace_has_clock_class(struct bt_ctf_trace
*trace
,
94 struct bt_ctf_clock_class
*clock_class
);
97 @brief User function type to use with bt_ctf_trace_add_listener().
99 @param[in] obj New CTF IR object which is part of the trace
101 @param[in] data User data.
105 typedef void (*bt_ctf_listener_cb
)(struct bt_ctf_object
*obj
, void *data
);
108 @brief Adds the trace class modification listener \p listener to
109 the CTF IR trace class \p trace_class.
111 Once you add \p listener to \p trace_class, whenever \p trace_class
112 is modified, \p listener is called with the new element and with
115 @param[in] trace_class Trace class to which to add \p listener.
116 @param[in] listener Modification listener function.
117 @param[in] data User data.
118 @returns 0 on success, or a negative value on error.
120 @prenotnull{trace_class}
121 @prenotnull{listener}
122 @postrefcountsame{trace_class}
125 int bt_ctf_trace_add_listener(struct bt_ctf_trace
*trace_class
,
126 bt_ctf_listener_cb listener
, void *data
);
129 * bt_ctf_trace_get_metadata_string: get metadata string.
131 * Get the trace's TSDL metadata. The caller assumes the ownership of the
134 * @param trace Trace instance.
136 * Returns the metadata string on success, NULL on error.
139 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
);
141 #endif /* BABELTRACE_CTF_IR_TRACE_INTERNAL_H */