annotate.c

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