[linux-block.git] / tools / perf / ui / gtk / annotate.c

// SPDX-License-Identifier: GPL-2.0
#include "gtk.h"
#include "util/debug.h"
#include "util/annotate.h"
#include "util/evsel.h"
#include "ui/helpline.h"
#include <inttypes.h>
#include <signal.h>

enum {
	ANN_COL__PERCENT,
	ANN_COL__OFFSET,
	ANN_COL__LINE,

	MAX_ANN_COLS
};

static const char *const col_names[] = {
	"Overhead",
	"Offset",
	"Line"
};

static int perf_gtk__get_percent(char *buf, size_t size, struct symbol *sym,
				 struct disasm_line *dl, int evidx)
{
	struct sym_hist *symhist;
	double percent = 0.0;
	const char *markup;
	int ret = 0;

	strcpy(buf, "");

	if (dl->offset == (s64) -1)
		return 0;

	symhist = annotation__histogram(symbol__annotation(sym), evidx);
	if (!symbol_conf.event_group && !symhist->addr[dl->offset].nr_samples)
		return 0;

	percent = 100.0 * symhist->addr[dl->offset].nr_samples / symhist->nr_samples;

	markup = perf_gtk__get_percent_color(percent);
	if (markup)
		ret += scnprintf(buf, size, "%s", markup);
	ret += scnprintf(buf + ret, size - ret, "%6.2f%%", percent);
	if (markup)
		ret += scnprintf(buf + ret, size - ret, "</span>");

	return ret;
}

static int perf_gtk__get_offset(char *buf, size_t size, struct symbol *sym,
				struct map *map, struct disasm_line *dl)
{
	u64 start = map__rip_2objdump(map, sym->start);

	strcpy(buf, "");

	if (dl->offset == (s64) -1)
		return 0;

	return scnprintf(buf, size, "%"PRIx64, start + dl->offset);
}

static int perf_gtk__get_line(char *buf, size_t size, struct disasm_line *dl)
{
	int ret = 0;
	char *line = g_markup_escape_text(dl->line, -1);
	const char *markup = "<span fgcolor='gray'>";

	strcpy(buf, "");

	if (!line)
		return 0;

	if (dl->offset != (s64) -1)
		markup = NULL;

	if (markup)
		ret += scnprintf(buf, size, "%s", markup);
	ret += scnprintf(buf + ret, size - ret, "%s", line);
	if (markup)
		ret += scnprintf(buf + ret, size - ret, "</span>");

	g_free(line);
	return ret;
}

static int perf_gtk__annotate_symbol(GtkWidget *window, struct symbol *sym,
				struct map *map, struct perf_evsel *evsel,
				struct hist_browser_timer *hbt __maybe_unused)
{
	struct disasm_line *pos, *n;
	struct annotation *notes;
	GType col_types[MAX_ANN_COLS];
	GtkCellRenderer *renderer;
	GtkListStore *store;
	GtkWidget *view;
	int i;
	char s[512];

	notes = symbol__annotation(sym);

	for (i = 0; i < MAX_ANN_COLS; i++) {
		col_types[i] = G_TYPE_STRING;
	}
	store = gtk_list_store_newv(MAX_ANN_COLS, col_types);

	view = gtk_tree_view_new();
	renderer = gtk_cell_renderer_text_new();

	for (i = 0; i < MAX_ANN_COLS; i++) {
		gtk_tree_view_insert_column_with_attributes(GTK_TREE_VIEW(view),
					-1, col_names[i], renderer, "markup",
					i, NULL);
	}

	gtk_tree_view_set_model(GTK_TREE_VIEW(view), GTK_TREE_MODEL(store));
	g_object_unref(GTK_TREE_MODEL(store));

	list_for_each_entry(pos, &notes->src->source, node) {
		GtkTreeIter iter;
		int ret = 0;

		gtk_list_store_append(store, &iter);

		if (perf_evsel__is_group_event(evsel)) {
			for (i = 0; i < evsel->nr_members; i++) {
				ret += perf_gtk__get_percent(s + ret,
							     sizeof(s) - ret,
							     sym, pos,
							     evsel->idx + i);
				ret += scnprintf(s + ret, sizeof(s) - ret, " ");
			}
		} else {
			ret = perf_gtk__get_percent(s, sizeof(s), sym, pos,
						    evsel->idx);
		}

		if (ret)
			gtk_list_store_set(store, &iter, ANN_COL__PERCENT, s, -1);
		if (perf_gtk__get_offset(s, sizeof(s), sym, map, pos))
			gtk_list_store_set(store, &iter, ANN_COL__OFFSET, s, -1);
		if (perf_gtk__get_line(s, sizeof(s), pos))
			gtk_list_store_set(store, &iter, ANN_COL__LINE, s, -1);
	}

	gtk_container_add(GTK_CONTAINER(window), view);

	list_for_each_entry_safe(pos, n, &notes->src->source, node) {
		list_del(&pos->node);
		disasm_line__free(pos);
	}

	return 0;
}

static int symbol__gtk_annotate(struct symbol *sym, struct map *map,
				struct perf_evsel *evsel,
				struct hist_browser_timer *hbt)
{
	GtkWidget *window;
	GtkWidget *notebook;
	GtkWidget *scrolled_window;
	GtkWidget *tab_label;
	int err;

	if (map->dso->annotate_warned)
		return -1;

	err = symbol__disassemble(sym, map, perf_evsel__env_arch(evsel),
				  0, NULL, NULL);
	if (err) {
		char msg[BUFSIZ];
		symbol__strerror_disassemble(sym, map, err, msg, sizeof(msg));
		ui__error("Couldn't annotate %s: %s\n", sym->name, msg);
		return -1;
	}

	if (perf_gtk__is_active_context(pgctx)) {
		window = pgctx->main_window;
		notebook = pgctx->notebook;
	} else {
		GtkWidget *vbox;
		GtkWidget *infobar;
		GtkWidget *statbar;

		signal(SIGSEGV, perf_gtk__signal);
		signal(SIGFPE,  perf_gtk__signal);
		signal(SIGINT,  perf_gtk__signal);
		signal(SIGQUIT, perf_gtk__signal);
		signal(SIGTERM, perf_gtk__signal);

		window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
		gtk_window_set_title(GTK_WINDOW(window), "perf annotate");

		g_signal_connect(window, "delete_event", gtk_main_quit, NULL);

		pgctx = perf_gtk__activate_context(window);
		if (!pgctx)
			return -1;

		vbox = gtk_vbox_new(FALSE, 0);
		notebook = gtk_notebook_new();
		pgctx->notebook = notebook;

		gtk_box_pack_start(GTK_BOX(vbox), notebook, TRUE, TRUE, 0);

		infobar = perf_gtk__setup_info_bar();
		if (infobar) {
			gtk_box_pack_start(GTK_BOX(vbox), infobar,
					   FALSE, FALSE, 0);
		}

		statbar = perf_gtk__setup_statusbar();
		gtk_box_pack_start(GTK_BOX(vbox), statbar, FALSE, FALSE, 0);

		gtk_container_add(GTK_CONTAINER(window), vbox);
	}

	scrolled_window = gtk_scrolled_window_new(NULL, NULL);
	tab_label = gtk_label_new(sym->name);

	gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled_window),
				       GTK_POLICY_AUTOMATIC,
				       GTK_POLICY_AUTOMATIC);

	gtk_notebook_append_page(GTK_NOTEBOOK(notebook), scrolled_window,
				 tab_label);

	perf_gtk__annotate_symbol(scrolled_window, sym, map, evsel, hbt);
	return 0;
}

int hist_entry__gtk_annotate(struct hist_entry *he,
			     struct perf_evsel *evsel,
			     struct hist_browser_timer *hbt)
{
	return symbol__gtk_annotate(he->ms.sym, he->ms.map, evsel, hbt);
}

void perf_gtk__show_annotations(void)
{
	GtkWidget *window;

	if (!perf_gtk__is_active_context(pgctx))
		return;

	window = pgctx->main_window;
	gtk_widget_show_all(window);

	perf_gtk__resize_window(window);
	gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);

	gtk_main();

	perf_gtk__deactivate_context(&pgctx);
}
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
2b676bf0 NK	2	#include "gtk.h"
	3	#include "util/debug.h"
	4	#include "util/annotate.h"
db8fd07a	5	#include "util/evsel.h"
2b676bf0	6	#include "ui/helpline.h"
fd20e811	7	#include <inttypes.h>
9607ad3a	8	#include <signal.h>
2b676bf0 NK	9
	10	enum {
	11	ANN_COL__PERCENT,
	12	ANN_COL__OFFSET,
	13	ANN_COL__LINE,
	14
	15	MAX_ANN_COLS
	16	};
	17
	18	static const char *const col_names[] = {
	19	"Overhead",
	20	"Offset",
	21	"Line"
	22	};
	23
	24	static int perf_gtk__get_percent(char buf, size_t size, struct symbol sym,
	25	struct disasm_line *dl, int evidx)
	26	{
	27	struct sym_hist *symhist;
	28	double percent = 0.0;
	29	const char *markup;
	30	int ret = 0;
	31
	32	strcpy(buf, "");
	33
	34	if (dl->offset == (s64) -1)
	35	return 0;
	36
	37	symhist = annotation__histogram(symbol__annotation(sym), evidx);
896bccd3	38	if (!symbol_conf.event_group && !symhist->addr[dl->offset].nr_samples)
2b676bf0 NK	39	return 0;
2b676bf0 NK	40
8158683d	41	percent = 100.0 * symhist->addr[dl->offset].nr_samples / symhist->nr_samples;
2b676bf0 NK	42
	43	markup = perf_gtk__get_percent_color(percent);
	44	if (markup)
	45	ret += scnprintf(buf, size, "%s", markup);
	46	ret += scnprintf(buf + ret, size - ret, "%6.2f%%", percent);
	47	if (markup)
	48	ret += scnprintf(buf + ret, size - ret, "</span>");
	49
	50	return ret;
	51	}
	52
	53	static int perf_gtk__get_offset(char buf, size_t size, struct symbol sym,
	54	struct map map, struct disasm_line dl)
	55	{
	56	u64 start = map__rip_2objdump(map, sym->start);
	57
	58	strcpy(buf, "");
	59
	60	if (dl->offset == (s64) -1)
	61	return 0;
	62
	63	return scnprintf(buf, size, "%"PRIx64, start + dl->offset);
	64	}
	65
23752237 NK	66	static int perf_gtk__get_line(char buf, size_t size, struct disasm_line dl)
	67	{
	68	int ret = 0;
	69	char *line = g_markup_escape_text(dl->line, -1);
	70	const char *markup = "<span fgcolor='gray'>";
	71
	72	strcpy(buf, "");
	73
	74	if (!line)
	75	return 0;
	76
	77	if (dl->offset != (s64) -1)
	78	markup = NULL;
	79
	80	if (markup)
	81	ret += scnprintf(buf, size, "%s", markup);
	82	ret += scnprintf(buf + ret, size - ret, "%s", line);
	83	if (markup)
	84	ret += scnprintf(buf + ret, size - ret, "</span>");
	85
	86	g_free(line);
	87	return ret;
	88	}
	89
2b676bf0	90	static int perf_gtk__annotate_symbol(GtkWidget window, struct symbol sym,
db8fd07a	91	struct map map, struct perf_evsel evsel,
2b676bf0 NK	92	struct hist_browser_timer *hbt __maybe_unused)
	93	{
	94	struct disasm_line pos, n;
	95	struct annotation *notes;
	96	GType col_types[MAX_ANN_COLS];
	97	GtkCellRenderer *renderer;
	98	GtkListStore *store;
	99	GtkWidget *view;
	100	int i;
	101	char s[512];
	102
2b676bf0 NK	103	notes = symbol__annotation(sym);
	104
	105	for (i = 0; i < MAX_ANN_COLS; i++) {
	106	col_types[i] = G_TYPE_STRING;
	107	}
	108	store = gtk_list_store_newv(MAX_ANN_COLS, col_types);
	109
	110	view = gtk_tree_view_new();
	111	renderer = gtk_cell_renderer_text_new();
	112
	113	for (i = 0; i < MAX_ANN_COLS; i++) {
	114	gtk_tree_view_insert_column_with_attributes(GTK_TREE_VIEW(view),
23752237	115	-1, col_names[i], renderer, "markup",
2b676bf0 NK	116	i, NULL);
	117	}
	118
	119	gtk_tree_view_set_model(GTK_TREE_VIEW(view), GTK_TREE_MODEL(store));
	120	g_object_unref(GTK_TREE_MODEL(store));
	121
	122	list_for_each_entry(pos, &notes->src->source, node) {
	123	GtkTreeIter iter;
d8d7cd93	124	int ret = 0;
2b676bf0 NK	125
	126	gtk_list_store_append(store, &iter);
	127
d8d7cd93 NK	128	if (perf_evsel__is_group_event(evsel)) {
	129	for (i = 0; i < evsel->nr_members; i++) {
	130	ret += perf_gtk__get_percent(s + ret,
	131	sizeof(s) - ret,
	132	sym, pos,
	133	evsel->idx + i);
	134	ret += scnprintf(s + ret, sizeof(s) - ret, " ");
	135	}
	136	} else {
	137	ret = perf_gtk__get_percent(s, sizeof(s), sym, pos,
	138	evsel->idx);
	139	}
	140
	141	if (ret)
2b676bf0 NK	142	gtk_list_store_set(store, &iter, ANN_COL__PERCENT, s, -1);
	143	if (perf_gtk__get_offset(s, sizeof(s), sym, map, pos))
	144	gtk_list_store_set(store, &iter, ANN_COL__OFFSET, s, -1);
23752237 NK	145	if (perf_gtk__get_line(s, sizeof(s), pos))
23752237 NK	146	gtk_list_store_set(store, &iter, ANN_COL__LINE, s, -1);
2b676bf0 NK	147	}
	148
	149	gtk_container_add(GTK_CONTAINER(window), view);
	150
	151	list_for_each_entry_safe(pos, n, &notes->src->source, node) {
	152	list_del(&pos->node);
	153	disasm_line__free(pos);
	154	}
	155
	156	return 0;
	157	}
	158
fc67297b NK	159	static int symbol__gtk_annotate(struct symbol sym, struct map map,
	160	struct perf_evsel *evsel,
	161	struct hist_browser_timer *hbt)
2b676bf0	162	{
2b676bf0	163	GtkWidget *window;
7a60ba94	164	GtkWidget *notebook;
2b676bf0 NK	165	GtkWidget *scrolled_window;
2b676bf0 NK	166	GtkWidget *tab_label;
ee51d851	167	int err;
2b676bf0	168
c0e79be7 NK	169	if (map->dso->annotate_warned)
	170	return -1;
	171
dcaa3948	172	err = symbol__disassemble(sym, map, perf_evsel__env_arch(evsel),
69fb09f6	173	0, NULL, NULL);
ee51d851 ACM	174	if (err) {
	175	char msg[BUFSIZ];
	176	symbol__strerror_disassemble(sym, map, err, msg, sizeof(msg));
	177	ui__error("Couldn't annotate %s: %s\n", sym->name, msg);
c0e79be7 NK	178	return -1;
	179	}
	180
7a60ba94 NK	181	if (perf_gtk__is_active_context(pgctx)) {
	182	window = pgctx->main_window;
	183	notebook = pgctx->notebook;
	184	} else {
	185	GtkWidget *vbox;
	186	GtkWidget *infobar;
	187	GtkWidget *statbar;
2b676bf0	188
7a60ba94 NK	189	signal(SIGSEGV, perf_gtk__signal);
	190	signal(SIGFPE, perf_gtk__signal);
	191	signal(SIGINT, perf_gtk__signal);
	192	signal(SIGQUIT, perf_gtk__signal);
	193	signal(SIGTERM, perf_gtk__signal);
2b676bf0	194
7a60ba94 NK	195	window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
7a60ba94 NK	196	gtk_window_set_title(GTK_WINDOW(window), "perf annotate");
2b676bf0	197
7a60ba94 NK	198	g_signal_connect(window, "delete_event", gtk_main_quit, NULL);
	199
	200	pgctx = perf_gtk__activate_context(window);
	201	if (!pgctx)
	202	return -1;
	203
	204	vbox = gtk_vbox_new(FALSE, 0);
	205	notebook = gtk_notebook_new();
	206	pgctx->notebook = notebook;
	207
	208	gtk_box_pack_start(GTK_BOX(vbox), notebook, TRUE, TRUE, 0);
	209
	210	infobar = perf_gtk__setup_info_bar();
	211	if (infobar) {
	212	gtk_box_pack_start(GTK_BOX(vbox), infobar,
	213	FALSE, FALSE, 0);
	214	}
	215
	216	statbar = perf_gtk__setup_statusbar();
	217	gtk_box_pack_start(GTK_BOX(vbox), statbar, FALSE, FALSE, 0);
	218
	219	gtk_container_add(GTK_CONTAINER(window), vbox);
	220	}
2b676bf0	221
2b676bf0 NK	222	scrolled_window = gtk_scrolled_window_new(NULL, NULL);
	223	tab_label = gtk_label_new(sym->name);
	224
	225	gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled_window),
	226	GTK_POLICY_AUTOMATIC,
	227	GTK_POLICY_AUTOMATIC);
	228
	229	gtk_notebook_append_page(GTK_NOTEBOOK(notebook), scrolled_window,
	230	tab_label);
2b676bf0	231
db8fd07a	232	perf_gtk__annotate_symbol(scrolled_window, sym, map, evsel, hbt);
7a60ba94 NK	233	return 0;
7a60ba94 NK	234	}
2b676bf0	235
fc67297b NK	236	int hist_entry__gtk_annotate(struct hist_entry *he,
	237	struct perf_evsel *evsel,
	238	struct hist_browser_timer *hbt)
	239	{
	240	return symbol__gtk_annotate(he->ms.sym, he->ms.map, evsel, hbt);
	241	}
	242
7a60ba94 NK	243	void perf_gtk__show_annotations(void)
	244	{
	245	GtkWidget *window;
2b676bf0	246
7a60ba94 NK	247	if (!perf_gtk__is_active_context(pgctx))
7a60ba94 NK	248	return;
2b676bf0	249
7a60ba94	250	window = pgctx->main_window;
2b676bf0 NK	251	gtk_widget_show_all(window);
	252
	253	perf_gtk__resize_window(window);
	254	gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
	255
	256	gtk_main();
	257
	258	perf_gtk__deactivate_context(&pgctx);
2b676bf0	259	}