[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/graph/component.h>
#include <babeltrace/graph/private-component.h>
#include <babeltrace/graph/private-port.h>
#include <babeltrace/ctf-ir/event.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;
	char *debug_info_dir;
	char *debug_info_target_prefix;

	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;
	bool debug_info_full_path;
	enum pretty_color_option color;
	bool verbose;
};

struct pretty_component {
	struct pretty_options options;
	struct bt_notification_iterator *input_iterator;
	FILE *out, *err;
	bool processed_first_event; /* Should be per-iterator. */
	int depth;	/* nesting, used for tabulation alignment. */
	bool start_line;
	GString *string;
	struct bt_value *plugin_opt_map;	/* Temporary parameter map. */
	bool use_colors;
	bool error;

	uint64_t last_cycles_timestamp;
	uint64_t delta_cycles;

	uint64_t last_real_timestamp;
	uint64_t delta_real_timestamp;
};

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. */
};

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
void 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_ctf_event *event);

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