[babeltrace.git] / src / plugins / text / details / details.h

#ifndef BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H
#define BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H

/*
 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <glib.h>
#include <babeltrace2/babeltrace.h>
#include <stdbool.h>

/*
 * This structure contains a hash table which maps trace IR stream class
 * and event class addresses to whether or not they have been printed
 * already during the lifetime of the component.
 *
 * It is safe to keep the addresses (weak references) in this hash table
 * as long as the trace class to which the structure is associated
 * exists because it's not possible to remove stream classes from a
 * trace class and event classes from a stream class.
 */
struct details_trace_class_meta {
	/*
	 * Stream class or event class address (`const void *`) ->
	 * `guint` (as a pointer)
	 *
	 * This acts as a set in fact; we don't care about the values,
	 * but we put 1 so that we can use g_hash_table_lookup() to know
	 * whether or not the hash table contains a given key
	 * (g_hash_table_lookup() returns `NULL` when not found, but
	 * also when the value is `NULL`).
	 */
	GHashTable *objects;

	/*
	 * Trace class destruction listener ID (`UINT64_C(-1)` if
	 * there's no listener ID.
	 */
	uint64_t tc_destruction_listener_id;
};

/*
 * An entry of the `traces` hash table of a
 * `struct details_comp` structure.
 */
struct details_trace {
	/* Unique ID of this trace within the lifetime of the component */
	uint64_t unique_id;

	/*
	 * Trace destruction listener ID (`UINT64_C(-1)` if there's no
	 * listener ID.
	 */
	uint64_t trace_destruction_listener_id;
};

/* A `sink.text.details` component */
struct details_comp {
	bt_logging_level log_level;

	/* Component's configuration */
	struct {
		/* Write metadata objects */
		bool with_meta;

		/*
		 * Compact mode: each line is a single message, and
		 * there are no extended message properties and
		 * event/packet fields. `with_meta` can still be true in
		 * compact mode, printing the full metadata objects, but
		 * making the messages compact.
		 */
		bool compact;

		/* Colorize output */
		bool with_color;

		/* Write message's time */
		bool with_time;

		/* Write trace class's name */
		bool with_trace_class_name;

		/* Write trace's name */
		bool with_trace_name;

		/* Write stream class's name */
		bool with_stream_class_name;

		/* Write stream's name */
		bool with_stream_name;

		/* Write UUID */
		bool with_uuid;
	} cfg;

	/*
	 * `const bt_trace_class *` (weak) ->
	 * `struct details_trace_class_meta *` (owned by this)
	 *
	 * The key (trace class object) is weak. An entry is added, if
	 * `cfg.with_meta` above is true, when first encountering a
	 * trace class. An entry is removed when a trace class is
	 * destroyed or when the component is finalized.
	 */
	GHashTable *meta;

	/*
	 * `const bt_trace *` (weak) ->
	 * `struct details_trace *` (owner by this)
	 *
	 * This hash table associates a trace object to a unique ID
	 * within the lifetime of this component. This is used to easily
	 * follow the messages of a given trace/stream when reading the
	 * text output of the component. We cannot use the actual stream
	 * ID properties for this because many streams can share the
	 * same ID (with different stream classes or different traces).
	 *
	 * When adding an entry, the unique ID to use is
	 * `next_unique_trace_id`.
	 *
	 * An entry is added when first encountering a trace. An entry
	 * is removed when a trace is destroyed or when the component is
	 * finalized.
	 */
	GHashTable *traces;
	uint32_t next_unique_trace_id;

	/* Upstream message iterator */
	bt_self_component_port_input_message_iterator *msg_iter;

	/*
	 * True if this component printed something. This is used to
	 * prepend a newline to the next message string instead of
	 * appending it so that the last printed message is not followed
	 * with an empty line.
	 */
	bool printed_something;

	/* Current message's output buffer */
	GString *str;
};

BT_HIDDEN
bt_self_component_status details_init(
		bt_self_component_sink *component,
		const bt_value *params, void *init_method_data);

BT_HIDDEN
void details_finalize(bt_self_component_sink *component);

BT_HIDDEN
bt_self_component_status details_graph_is_configured(
		bt_self_component_sink *comp);

BT_HIDDEN
bt_self_component_status details_consume(bt_self_component_sink *component);

BT_HIDDEN
void details_destroy_details_trace_class_meta(
		struct details_trace_class_meta *details_trace_class_meta);

BT_HIDDEN
struct details_trace_class_meta *details_create_details_trace_class_meta(void);

#endif /* BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H */
Commit	Line	Data
55478183 PP	1	#ifndef BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H
	2	#define BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H
	3
	4	/*
	5	* Copyright 2019 Philippe Proulx <pproulx@efficios.com>
	6	*
	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:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	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
	23	* SOFTWARE.
	24	*/
	25
	26	#include <glib.h>
	27	#include <babeltrace2/babeltrace.h>
	28	#include <stdbool.h>
	29
	30	/*
	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.
	34	*
	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.
	39	*/
	40	struct details_trace_class_meta {
	41	/*
	42	* Stream class or event class address (`const void *`) ->
	43	* `guint` (as a pointer)
	44	*
	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`).
	50	*/
	51	GHashTable *objects;
	52
	53	/*
	54	* Trace class destruction listener ID (`UINT64_C(-1)` if
	55	* there's no listener ID.
	56	*/
	57	uint64_t tc_destruction_listener_id;
	58	};
	59
	60	/*
	61	* An entry of the `traces` hash table of a
	62	* `struct details_comp` structure.
	63	*/
	64	struct details_trace {
65	/* Unique ID of this trace within the lifetime of the component */
66	uint64_t unique_id;
67
68	/*
69	* Trace destruction listener ID (`UINT64_C(-1)` if there's no
70	* listener ID.
71	*/
72	uint64_t trace_destruction_listener_id;
73	};
74
75	/* A `sink.text.details` component */
76	struct details_comp {
6c868a3a PP	77	bt_logging_level log_level;
6c868a3a PP	78
55478183 PP	79	/* Component's configuration */
	80	struct {
	81	/* Write metadata objects */
	82	bool with_meta;
	83
	84	/*
	85	* Compact mode: each line is a single message, and
	86	* there are no extended message properties and
	87	* event/packet fields. `with_meta` can still be true in
	88	* compact mode, printing the full metadata objects, but
	89	* making the messages compact.
	90	*/
	91	bool compact;
	92
	93	/* Colorize output */
	94	bool with_color;
	95
	96	/* Write message's time */
	97	bool with_time;
	98
	99	/* Write trace class's name */
	100	bool with_trace_class_name;
	101
	102	/* Write trace's name */
	103	bool with_trace_name;
	104
	105	/* Write stream class's name */
	106	bool with_stream_class_name;
	107
	108	/* Write stream's name */
	109	bool with_stream_name;
	110
	111	/* Write UUID */
	112	bool with_uuid;
	113	} cfg;
	114
	115	/*
	116	* `const bt_trace_class *` (weak) ->
	117	* `struct details_trace_class_meta *` (owned by this)
	118	*
	119	* The key (trace class object) is weak. An entry is added, if
	120	* `cfg.with_meta` above is true, when first encountering a
	121	* trace class. An entry is removed when a trace class is
	122	* destroyed or when the component is finalized.
	123	*/
	124	GHashTable *meta;
	125
	126	/*
	127	* `const bt_trace *` (weak) ->
	128	* `struct details_trace *` (owner by this)
	129	*
	130	* This hash table associates a trace object to a unique ID
	131	* within the lifetime of this component. This is used to easily
	132	* follow the messages of a given trace/stream when reading the
	133	* text output of the component. We cannot use the actual stream
	134	* ID properties for this because many streams can share the
	135	* same ID (with different stream classes or different traces).
	136	*
	137	* When adding an entry, the unique ID to use is
	138	* `next_unique_trace_id`.
	139	*
	140	* An entry is added when first encountering a trace. An entry
	141	* is removed when a trace is destroyed or when the component is
	142	* finalized.
143	*/
144	GHashTable *traces;
145	uint32_t next_unique_trace_id;
146
147	/* Upstream message iterator */
148	bt_self_component_port_input_message_iterator *msg_iter;
149
150	/*
151	* True if this component printed something. This is used to
152	* prepend a newline to the next message string instead of
153	* appending it so that the last printed message is not followed
154	* with an empty line.
155	*/
156	bool printed_something;
157
158	/* Current message's output buffer */
159	GString *str;
160	};
161
162	BT_HIDDEN
163	bt_self_component_status details_init(
164	bt_self_component_sink *component,
165	const bt_value params, void init_method_data);
166
167	BT_HIDDEN
168	void details_finalize(bt_self_component_sink *component);
169
170	BT_HIDDEN
171	bt_self_component_status details_graph_is_configured(
172	bt_self_component_sink *comp);
173
174	BT_HIDDEN
175	bt_self_component_status details_consume(bt_self_component_sink *component);
176
177	BT_HIDDEN
178	void details_destroy_details_trace_class_meta(
179	struct details_trace_class_meta *details_trace_class_meta);
180
181	BT_HIDDEN
182	struct details_trace_class_meta *details_create_details_trace_class_meta(void);
183
184	#endif /* BABELTRACE_PLUGINS_TEXT_DETAILS_DETAILS_H */