1 #ifndef BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H
2 #define BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H
5 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #include <babeltrace2/babeltrace.h>
31 * This structure contains a hash table which maps trace IR stream class
32 * and event class addresses to whether or not they have been printed
33 * already during the lifetime of the component.
35 * It is safe to keep the addresses (weak references) in this hash table
36 * as long as the trace class to which the structure is associated
37 * exists because it's not possible to remove stream classes from a
38 * trace class and event classes from a stream class.
40 struct details_trace_class_meta
{
42 * Stream class or event class address (`const void *`) ->
43 * `guint` (as a pointer)
45 * This acts as a set in fact; we don't care about the values,
46 * but we put 1 so that we can use g_hash_table_lookup() to know
47 * whether or not the hash table contains a given key
48 * (g_hash_table_lookup() returns `NULL` when not found, but
49 * also when the value is `NULL`).
54 * Trace class destruction listener ID (`UINT64_C(-1)` if
55 * there's no listener ID.
57 uint64_t tc_destruction_listener_id
;
61 * An entry of the `traces` hash table of a
62 * `struct details_comp` structure.
64 struct details_trace
{
65 /* Unique ID of this trace within the lifetime of the component */
69 * Trace destruction listener ID (`UINT64_C(-1)` if there's no
72 uint64_t trace_destruction_listener_id
;
75 /* A `sink.text.details` component */
77 bt_logging_level log_level
;
78 bt_self_component
*self_comp
;
80 /* Component's configuration */
82 /* Write metadata objects */
86 * Compact mode: each line is a single message, and
87 * there are no extended message properties and
88 * event/packet fields. `with_meta` can still be true in
89 * compact mode, printing the full metadata objects, but
90 * making the messages compact.
97 /* Write message's time */
100 /* Write trace's name */
101 bool with_trace_name
;
103 /* Write stream class's name */
104 bool with_stream_class_name
;
106 /* Write stream's name */
107 bool with_stream_name
;
114 * `const bt_trace_class *` (weak) ->
115 * `struct details_trace_class_meta *` (owned by this)
117 * The key (trace class object) is weak. An entry is added, if
118 * `cfg.with_meta` above is true, when first encountering a
119 * trace class. An entry is removed when a trace class is
120 * destroyed or when the component is finalized.
125 * `const bt_trace *` (weak) ->
126 * `struct details_trace *` (owner by this)
128 * This hash table associates a trace object to a unique ID
129 * within the lifetime of this component. This is used to easily
130 * follow the messages of a given trace/stream when reading the
131 * text output of the component. We cannot use the actual stream
132 * ID properties for this because many streams can share the
133 * same ID (with different stream classes or different traces).
135 * When adding an entry, the unique ID to use is
136 * `next_unique_trace_id`.
138 * An entry is added when first encountering a trace. An entry
139 * is removed when a trace is destroyed or when the component is
143 uint32_t next_unique_trace_id
;
145 /* Upstream message iterator */
146 bt_self_component_port_input_message_iterator
*msg_iter
;
149 * True if this component printed something. This is used to
150 * prepend a newline to the next message string instead of
151 * appending it so that the last printed message is not followed
152 * with an empty line.
154 bool printed_something
;
156 /* Current message's output buffer */
161 bt_component_class_init_method_status
details_init(
162 bt_self_component_sink
*component
,
163 const bt_value
*params
, void *init_method_data
);
166 void details_finalize(bt_self_component_sink
*component
);
169 bt_component_class_sink_graph_is_configured_method_status
details_graph_is_configured(
170 bt_self_component_sink
*comp
);
173 bt_component_class_sink_consume_method_status
details_consume(bt_self_component_sink
*component
);
176 void details_destroy_details_trace_class_meta(
177 struct details_trace_class_meta
*details_trace_class_meta
);
180 struct details_trace_class_meta
*details_create_details_trace_class_meta(void);
182 #endif /* BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H */