[babeltrace.git] / plugins / text / pretty / pretty.h

#ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
#define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H

/*
 * BabelTrace - CTF Text Output Plug-in
 *
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@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 <stdbool.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/babeltrace.h>

enum pretty_default {
	PRETTY_DEFAULT_UNSET,
	PRETTY_DEFAULT_SHOW,
	PRETTY_DEFAULT_HIDE,
};

enum pretty_color_option {
	PRETTY_COLOR_OPT_NEVER,
	PRETTY_COLOR_OPT_AUTO,
	PRETTY_COLOR_OPT_ALWAYS,
};

struct pretty_options {
	char *output_path;

	enum pretty_default name_default;
	enum pretty_default field_default;

	bool print_scope_field_names;
	bool print_header_field_names;
	bool print_context_field_names;
	bool print_payload_field_names;

	bool print_delta_field;
	bool print_loglevel_field;
	bool print_emf_field;
	bool print_callsite_field;
	bool print_trace_field;
	bool print_trace_domain_field;
	bool print_trace_procname_field;
	bool print_trace_vpid_field;
	bool print_trace_hostname_field;

	bool print_timestamp_cycles;
	bool clock_seconds;
	bool clock_date;
	bool clock_gmt;
	enum pretty_color_option color;
	bool verbose;
};

struct pretty_component {
	struct pretty_options options;
	struct bt_notification_iterator *input_iterator;
	FILE *out, *err;
	int depth;	/* nesting, used for tabulation alignment. */
	bool start_line;
	GString *string;
	GString *tmp_string;
	struct bt_private_value *plugin_opt_map; /* Temporary parameter map. */
	bool use_colors;

	uint64_t last_cycles_timestamp;
	uint64_t delta_cycles;

	uint64_t last_real_timestamp;
	uint64_t delta_real_timestamp;

	bool negative_timestamp_warning_done;
};

enum stream_packet_context_quarks_enum {
	Q_TIMESTAMP_BEGIN,
	Q_TIMESTAMP_END,
	Q_EVENTS_DISCARDED,
	Q_CONTENT_SIZE,
	Q_PACKET_SIZE,
	Q_PACKET_SEQ_NUM,
	STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */
};

extern
GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];

BT_HIDDEN
enum bt_component_status pretty_init(
		struct bt_private_component *component,
		struct bt_value *params,
		void *init_method_data);

BT_HIDDEN
enum bt_component_status pretty_consume(struct bt_private_component *component);

BT_HIDDEN
enum bt_component_status pretty_port_connected(
		struct bt_private_component *component,
		struct bt_private_port *self_port,
		struct bt_port *other_port);

BT_HIDDEN
void pretty_finalize(struct bt_private_component *component);

BT_HIDDEN
enum bt_component_status pretty_print_event(struct pretty_component *pretty,
		struct bt_notification *event_notif);

BT_HIDDEN
enum bt_component_status pretty_print_packet(struct pretty_component *pretty,
		struct bt_notification *packet_beginning_notif);

#endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */
Commit	Line	Data
3228cc1d PP	1	#ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
3228cc1d PP	2	#define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
af9a82eb JG	3
	4	/*
	5	* BabelTrace - CTF Text Output Plug-in
	6	*
	7	* Copyright 2016 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
	30	#include <stdbool.h>
	31	#include <babeltrace/babeltrace-internal.h>
9d408fca	32	#include <babeltrace/babeltrace.h>
3228cc1d PP	33
	34	enum pretty_default {
	35	PRETTY_DEFAULT_UNSET,
	36	PRETTY_DEFAULT_SHOW,
	37	PRETTY_DEFAULT_HIDE,
6e1bc0df MD	38	};
6e1bc0df MD	39
3228cc1d PP	40	enum pretty_color_option {
	41	PRETTY_COLOR_OPT_NEVER,
	42	PRETTY_COLOR_OPT_AUTO,
	43	PRETTY_COLOR_OPT_ALWAYS,
ad96d936 PP	44	};
ad96d936 PP	45
3228cc1d	46	struct pretty_options {
6e1bc0df	47	char *output_path;
6e1bc0df	48
3228cc1d PP	49	enum pretty_default name_default;
3228cc1d PP	50	enum pretty_default field_default;
6e1bc0df MD	51
	52	bool print_scope_field_names;
	53	bool print_header_field_names;
	54	bool print_context_field_names;
	55	bool print_payload_field_names;
	56
	57	bool print_delta_field;
	58	bool print_loglevel_field;
	59	bool print_emf_field;
60535549	60	bool print_callsite_field;
6e1bc0df MD	61	bool print_trace_field;
	62	bool print_trace_domain_field;
	63	bool print_trace_procname_field;
	64	bool print_trace_vpid_field;
	65	bool print_trace_hostname_field;
	66
	67	bool print_timestamp_cycles;
	68	bool clock_seconds;
	69	bool clock_date;
	70	bool clock_gmt;
3228cc1d	71	enum pretty_color_option color;
a263021c	72	bool verbose;
af9a82eb JG	73	};
af9a82eb JG	74
3228cc1d PP	75	struct pretty_component {
3228cc1d PP	76	struct pretty_options options;
75e1829b	77	struct bt_notification_iterator *input_iterator;
af9a82eb	78	FILE out, err;
6a18b281	79	int depth; /* nesting, used for tabulation alignment. */
6e1bc0df	80	bool start_line;
6a18b281	81	GString *string;
5280f742	82	GString *tmp_string;
da91b29a	83	struct bt_private_value plugin_opt_map; / Temporary parameter map. */
ad96d936	84	bool use_colors;
3af83b5a MD	85
	86	uint64_t last_cycles_timestamp;
	87	uint64_t delta_cycles;
	88
	89	uint64_t last_real_timestamp;
	90	uint64_t delta_real_timestamp;
18adbd19 MD	91
18adbd19 MD	92	bool negative_timestamp_warning_done;
af9a82eb JG	93	};
af9a82eb JG	94
2b4c4a7c JD	95	enum stream_packet_context_quarks_enum {
	96	Q_TIMESTAMP_BEGIN,
	97	Q_TIMESTAMP_END,
	98	Q_EVENTS_DISCARDED,
	99	Q_CONTENT_SIZE,
	100	Q_PACKET_SIZE,
	101	Q_PACKET_SEQ_NUM,
	102	STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */
	103	};
	104
61d6f9b1	105	extern
2b4c4a7c JD	106	GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];
2b4c4a7c JD	107
af9a82eb	108	BT_HIDDEN
3228cc1d PP	109	enum bt_component_status pretty_init(
	110	struct bt_private_component *component,
	111	struct bt_value *params,
	112	void *init_method_data);
	113
	114	BT_HIDDEN
	115	enum bt_component_status pretty_consume(struct bt_private_component *component);
	116
	117	BT_HIDDEN
bf55043c	118	enum bt_component_status pretty_port_connected(
3228cc1d PP	119	struct bt_private_component *component,
	120	struct bt_private_port *self_port,
	121	struct bt_port *other_port);
	122
	123	BT_HIDDEN
	124	void pretty_finalize(struct bt_private_component *component);
	125
	126	BT_HIDDEN
	127	enum bt_component_status pretty_print_event(struct pretty_component *pretty,
d9f65f09	128	struct bt_notification *event_notif);
af9a82eb	129
0f6bea4e PP	130	BT_HIDDEN
	131	enum bt_component_status pretty_print_packet(struct pretty_component *pretty,
	132	struct bt_notification *packet_beginning_notif);
	133
3228cc1d	134	#endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */