builtin-top.c 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239
  1. /*
  2. * builtin-top.c
  3. *
  4. * Builtin top command: Display a continuously updated profile of
  5. * any workload, CPU or specific PID.
  6. *
  7. * Copyright (C) 2008, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
  8. * 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
  9. *
  10. * Improvements and fixes by:
  11. *
  12. * Arjan van de Ven <arjan@linux.intel.com>
  13. * Yanmin Zhang <yanmin.zhang@intel.com>
  14. * Wu Fengguang <fengguang.wu@intel.com>
  15. * Mike Galbraith <efault@gmx.de>
  16. * Paul Mackerras <paulus@samba.org>
  17. *
  18. * Released under the GPL v2. (and only v2, not any later version)
  19. */
  20. #include "builtin.h"
  21. #include "perf.h"
  22. #include "util/annotate.h"
  23. #include "util/cache.h"
  24. #include "util/color.h"
  25. #include "util/evlist.h"
  26. #include "util/evsel.h"
  27. #include "util/machine.h"
  28. #include "util/session.h"
  29. #include "util/symbol.h"
  30. #include "util/thread.h"
  31. #include "util/thread_map.h"
  32. #include "util/top.h"
  33. #include "util/util.h"
  34. #include <linux/rbtree.h>
  35. #include "util/parse-options.h"
  36. #include "util/parse-events.h"
  37. #include "util/cpumap.h"
  38. #include "util/xyarray.h"
  39. #include "util/sort.h"
  40. #include "util/intlist.h"
  41. #include "util/debug.h"
  42. #include <assert.h>
  43. #include <elf.h>
  44. #include <fcntl.h>
  45. #include <stdio.h>
  46. #include <termios.h>
  47. #include <unistd.h>
  48. #include <inttypes.h>
  49. #include <errno.h>
  50. #include <time.h>
  51. #include <sched.h>
  52. #include <sys/syscall.h>
  53. #include <sys/ioctl.h>
  54. #include <sys/poll.h>
  55. #include <sys/prctl.h>
  56. #include <sys/wait.h>
  57. #include <sys/uio.h>
  58. #include <sys/utsname.h>
  59. #include <sys/mman.h>
  60. #include <linux/unistd.h>
  61. #include <linux/types.h>
  62. void get_term_dimensions(struct winsize *ws)
  63. {
  64. char *s = getenv("LINES");
  65. if (s != NULL) {
  66. ws->ws_row = atoi(s);
  67. s = getenv("COLUMNS");
  68. if (s != NULL) {
  69. ws->ws_col = atoi(s);
  70. if (ws->ws_row && ws->ws_col)
  71. return;
  72. }
  73. }
  74. #ifdef TIOCGWINSZ
  75. if (ioctl(1, TIOCGWINSZ, ws) == 0 &&
  76. ws->ws_row && ws->ws_col)
  77. return;
  78. #endif
  79. ws->ws_row = 25;
  80. ws->ws_col = 80;
  81. }
  82. static void perf_top__update_print_entries(struct perf_top *top)
  83. {
  84. if (top->print_entries > 9)
  85. top->print_entries -= 9;
  86. }
  87. static void perf_top__sig_winch(int sig __maybe_unused,
  88. siginfo_t *info __maybe_unused, void *arg)
  89. {
  90. struct perf_top *top = arg;
  91. get_term_dimensions(&top->winsize);
  92. if (!top->print_entries
  93. || (top->print_entries+4) > top->winsize.ws_row) {
  94. top->print_entries = top->winsize.ws_row;
  95. } else {
  96. top->print_entries += 4;
  97. top->winsize.ws_row = top->print_entries;
  98. }
  99. perf_top__update_print_entries(top);
  100. }
  101. static int perf_top__parse_source(struct perf_top *top, struct hist_entry *he)
  102. {
  103. struct symbol *sym;
  104. struct annotation *notes;
  105. struct map *map;
  106. int err = -1;
  107. if (!he || !he->ms.sym)
  108. return -1;
  109. sym = he->ms.sym;
  110. map = he->ms.map;
  111. /*
  112. * We can't annotate with just /proc/kallsyms
  113. */
  114. if (map->dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS) {
  115. pr_err("Can't annotate %s: No vmlinux file was found in the "
  116. "path\n", sym->name);
  117. sleep(1);
  118. return -1;
  119. }
  120. notes = symbol__annotation(sym);
  121. if (notes->src != NULL) {
  122. pthread_mutex_lock(&notes->lock);
  123. goto out_assign;
  124. }
  125. pthread_mutex_lock(&notes->lock);
  126. if (symbol__alloc_hist(sym) < 0) {
  127. pthread_mutex_unlock(&notes->lock);
  128. pr_err("Not enough memory for annotating '%s' symbol!\n",
  129. sym->name);
  130. sleep(1);
  131. return err;
  132. }
  133. err = symbol__annotate(sym, map, 0);
  134. if (err == 0) {
  135. out_assign:
  136. top->sym_filter_entry = he;
  137. }
  138. pthread_mutex_unlock(&notes->lock);
  139. return err;
  140. }
  141. static void __zero_source_counters(struct hist_entry *he)
  142. {
  143. struct symbol *sym = he->ms.sym;
  144. symbol__annotate_zero_histograms(sym);
  145. }
  146. static void ui__warn_map_erange(struct map *map, struct symbol *sym, u64 ip)
  147. {
  148. struct utsname uts;
  149. int err = uname(&uts);
  150. ui__warning("Out of bounds address found:\n\n"
  151. "Addr: %" PRIx64 "\n"
  152. "DSO: %s %c\n"
  153. "Map: %" PRIx64 "-%" PRIx64 "\n"
  154. "Symbol: %" PRIx64 "-%" PRIx64 " %c %s\n"
  155. "Arch: %s\n"
  156. "Kernel: %s\n"
  157. "Tools: %s\n\n"
  158. "Not all samples will be on the annotation output.\n\n"
  159. "Please report to linux-kernel@vger.kernel.org\n",
  160. ip, map->dso->long_name, dso__symtab_origin(map->dso),
  161. map->start, map->end, sym->start, sym->end,
  162. sym->binding == STB_GLOBAL ? 'g' :
  163. sym->binding == STB_LOCAL ? 'l' : 'w', sym->name,
  164. err ? "[unknown]" : uts.machine,
  165. err ? "[unknown]" : uts.release, perf_version_string);
  166. if (use_browser <= 0)
  167. sleep(5);
  168. map->erange_warned = true;
  169. }
  170. static void perf_top__record_precise_ip(struct perf_top *top,
  171. struct hist_entry *he,
  172. int counter, u64 ip)
  173. {
  174. struct annotation *notes;
  175. struct symbol *sym;
  176. int err;
  177. if (he == NULL || he->ms.sym == NULL ||
  178. ((top->sym_filter_entry == NULL ||
  179. top->sym_filter_entry->ms.sym != he->ms.sym) && use_browser != 1))
  180. return;
  181. sym = he->ms.sym;
  182. notes = symbol__annotation(sym);
  183. if (pthread_mutex_trylock(&notes->lock))
  184. return;
  185. if (notes->src == NULL && symbol__alloc_hist(sym) < 0) {
  186. pthread_mutex_unlock(&notes->lock);
  187. pr_err("Not enough memory for annotating '%s' symbol!\n",
  188. sym->name);
  189. sleep(1);
  190. return;
  191. }
  192. ip = he->ms.map->map_ip(he->ms.map, ip);
  193. err = symbol__inc_addr_samples(sym, he->ms.map, counter, ip);
  194. pthread_mutex_unlock(&notes->lock);
  195. if (err == -ERANGE && !he->ms.map->erange_warned)
  196. ui__warn_map_erange(he->ms.map, sym, ip);
  197. }
  198. static void perf_top__show_details(struct perf_top *top)
  199. {
  200. struct hist_entry *he = top->sym_filter_entry;
  201. struct annotation *notes;
  202. struct symbol *symbol;
  203. int more;
  204. if (!he)
  205. return;
  206. symbol = he->ms.sym;
  207. notes = symbol__annotation(symbol);
  208. pthread_mutex_lock(&notes->lock);
  209. if (notes->src == NULL)
  210. goto out_unlock;
  211. printf("Showing %s for %s\n", perf_evsel__name(top->sym_evsel), symbol->name);
  212. printf(" Events Pcnt (>=%d%%)\n", top->sym_pcnt_filter);
  213. more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel->idx,
  214. 0, top->sym_pcnt_filter, top->print_entries, 4);
  215. if (top->zero)
  216. symbol__annotate_zero_histogram(symbol, top->sym_evsel->idx);
  217. else
  218. symbol__annotate_decay_histogram(symbol, top->sym_evsel->idx);
  219. if (more != 0)
  220. printf("%d lines not displayed, maybe increase display entries [e]\n", more);
  221. out_unlock:
  222. pthread_mutex_unlock(&notes->lock);
  223. }
  224. static const char CONSOLE_CLEAR[] = "";
  225. static struct hist_entry *perf_evsel__add_hist_entry(struct perf_evsel *evsel,
  226. struct addr_location *al,
  227. struct perf_sample *sample)
  228. {
  229. struct hist_entry *he;
  230. he = __hists__add_entry(&evsel->hists, al, NULL, sample->period);
  231. if (he == NULL)
  232. return NULL;
  233. hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
  234. return he;
  235. }
  236. static void perf_top__print_sym_table(struct perf_top *top)
  237. {
  238. char bf[160];
  239. int printed = 0;
  240. const int win_width = top->winsize.ws_col - 1;
  241. puts(CONSOLE_CLEAR);
  242. perf_top__header_snprintf(top, bf, sizeof(bf));
  243. printf("%s\n", bf);
  244. perf_top__reset_sample_counters(top);
  245. printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
  246. if (top->sym_evsel->hists.stats.nr_lost_warned !=
  247. top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST]) {
  248. top->sym_evsel->hists.stats.nr_lost_warned =
  249. top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST];
  250. color_fprintf(stdout, PERF_COLOR_RED,
  251. "WARNING: LOST %d chunks, Check IO/CPU overload",
  252. top->sym_evsel->hists.stats.nr_lost_warned);
  253. ++printed;
  254. }
  255. if (top->sym_filter_entry) {
  256. perf_top__show_details(top);
  257. return;
  258. }
  259. hists__collapse_resort_threaded(&top->sym_evsel->hists);
  260. hists__output_resort_threaded(&top->sym_evsel->hists);
  261. hists__decay_entries_threaded(&top->sym_evsel->hists,
  262. top->hide_user_symbols,
  263. top->hide_kernel_symbols);
  264. hists__output_recalc_col_len(&top->sym_evsel->hists,
  265. top->winsize.ws_row - 3);
  266. putchar('\n');
  267. hists__fprintf(&top->sym_evsel->hists, false,
  268. top->winsize.ws_row - 4 - printed, win_width, stdout);
  269. }
  270. static void prompt_integer(int *target, const char *msg)
  271. {
  272. char *buf = malloc(0), *p;
  273. size_t dummy = 0;
  274. int tmp;
  275. fprintf(stdout, "\n%s: ", msg);
  276. if (getline(&buf, &dummy, stdin) < 0)
  277. return;
  278. p = strchr(buf, '\n');
  279. if (p)
  280. *p = 0;
  281. p = buf;
  282. while(*p) {
  283. if (!isdigit(*p))
  284. goto out_free;
  285. p++;
  286. }
  287. tmp = strtoul(buf, NULL, 10);
  288. *target = tmp;
  289. out_free:
  290. free(buf);
  291. }
  292. static void prompt_percent(int *target, const char *msg)
  293. {
  294. int tmp = 0;
  295. prompt_integer(&tmp, msg);
  296. if (tmp >= 0 && tmp <= 100)
  297. *target = tmp;
  298. }
  299. static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
  300. {
  301. char *buf = malloc(0), *p;
  302. struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
  303. struct rb_node *next;
  304. size_t dummy = 0;
  305. /* zero counters of active symbol */
  306. if (syme) {
  307. __zero_source_counters(syme);
  308. top->sym_filter_entry = NULL;
  309. }
  310. fprintf(stdout, "\n%s: ", msg);
  311. if (getline(&buf, &dummy, stdin) < 0)
  312. goto out_free;
  313. p = strchr(buf, '\n');
  314. if (p)
  315. *p = 0;
  316. next = rb_first(&top->sym_evsel->hists.entries);
  317. while (next) {
  318. n = rb_entry(next, struct hist_entry, rb_node);
  319. if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
  320. found = n;
  321. break;
  322. }
  323. next = rb_next(&n->rb_node);
  324. }
  325. if (!found) {
  326. fprintf(stderr, "Sorry, %s is not active.\n", buf);
  327. sleep(1);
  328. } else
  329. perf_top__parse_source(top, found);
  330. out_free:
  331. free(buf);
  332. }
  333. static void perf_top__print_mapped_keys(struct perf_top *top)
  334. {
  335. char *name = NULL;
  336. if (top->sym_filter_entry) {
  337. struct symbol *sym = top->sym_filter_entry->ms.sym;
  338. name = sym->name;
  339. }
  340. fprintf(stdout, "\nMapped keys:\n");
  341. fprintf(stdout, "\t[d] display refresh delay. \t(%d)\n", top->delay_secs);
  342. fprintf(stdout, "\t[e] display entries (lines). \t(%d)\n", top->print_entries);
  343. if (top->evlist->nr_entries > 1)
  344. fprintf(stdout, "\t[E] active event counter. \t(%s)\n", perf_evsel__name(top->sym_evsel));
  345. fprintf(stdout, "\t[f] profile display filter (count). \t(%d)\n", top->count_filter);
  346. fprintf(stdout, "\t[F] annotate display filter (percent). \t(%d%%)\n", top->sym_pcnt_filter);
  347. fprintf(stdout, "\t[s] annotate symbol. \t(%s)\n", name?: "NULL");
  348. fprintf(stdout, "\t[S] stop annotation.\n");
  349. fprintf(stdout,
  350. "\t[K] hide kernel_symbols symbols. \t(%s)\n",
  351. top->hide_kernel_symbols ? "yes" : "no");
  352. fprintf(stdout,
  353. "\t[U] hide user symbols. \t(%s)\n",
  354. top->hide_user_symbols ? "yes" : "no");
  355. fprintf(stdout, "\t[z] toggle sample zeroing. \t(%d)\n", top->zero ? 1 : 0);
  356. fprintf(stdout, "\t[qQ] quit.\n");
  357. }
  358. static int perf_top__key_mapped(struct perf_top *top, int c)
  359. {
  360. switch (c) {
  361. case 'd':
  362. case 'e':
  363. case 'f':
  364. case 'z':
  365. case 'q':
  366. case 'Q':
  367. case 'K':
  368. case 'U':
  369. case 'F':
  370. case 's':
  371. case 'S':
  372. return 1;
  373. case 'E':
  374. return top->evlist->nr_entries > 1 ? 1 : 0;
  375. default:
  376. break;
  377. }
  378. return 0;
  379. }
  380. static void perf_top__handle_keypress(struct perf_top *top, int c)
  381. {
  382. if (!perf_top__key_mapped(top, c)) {
  383. struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
  384. struct termios tc, save;
  385. perf_top__print_mapped_keys(top);
  386. fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
  387. fflush(stdout);
  388. tcgetattr(0, &save);
  389. tc = save;
  390. tc.c_lflag &= ~(ICANON | ECHO);
  391. tc.c_cc[VMIN] = 0;
  392. tc.c_cc[VTIME] = 0;
  393. tcsetattr(0, TCSANOW, &tc);
  394. poll(&stdin_poll, 1, -1);
  395. c = getc(stdin);
  396. tcsetattr(0, TCSAFLUSH, &save);
  397. if (!perf_top__key_mapped(top, c))
  398. return;
  399. }
  400. switch (c) {
  401. case 'd':
  402. prompt_integer(&top->delay_secs, "Enter display delay");
  403. if (top->delay_secs < 1)
  404. top->delay_secs = 1;
  405. break;
  406. case 'e':
  407. prompt_integer(&top->print_entries, "Enter display entries (lines)");
  408. if (top->print_entries == 0) {
  409. struct sigaction act = {
  410. .sa_sigaction = perf_top__sig_winch,
  411. .sa_flags = SA_SIGINFO,
  412. };
  413. perf_top__sig_winch(SIGWINCH, NULL, top);
  414. sigaction(SIGWINCH, &act, NULL);
  415. } else {
  416. perf_top__sig_winch(SIGWINCH, NULL, top);
  417. signal(SIGWINCH, SIG_DFL);
  418. }
  419. break;
  420. case 'E':
  421. if (top->evlist->nr_entries > 1) {
  422. /* Select 0 as the default event: */
  423. int counter = 0;
  424. fprintf(stderr, "\nAvailable events:");
  425. list_for_each_entry(top->sym_evsel, &top->evlist->entries, node)
  426. fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
  427. prompt_integer(&counter, "Enter details event counter");
  428. if (counter >= top->evlist->nr_entries) {
  429. top->sym_evsel = perf_evlist__first(top->evlist);
  430. fprintf(stderr, "Sorry, no such event, using %s.\n", perf_evsel__name(top->sym_evsel));
  431. sleep(1);
  432. break;
  433. }
  434. list_for_each_entry(top->sym_evsel, &top->evlist->entries, node)
  435. if (top->sym_evsel->idx == counter)
  436. break;
  437. } else
  438. top->sym_evsel = perf_evlist__first(top->evlist);
  439. break;
  440. case 'f':
  441. prompt_integer(&top->count_filter, "Enter display event count filter");
  442. break;
  443. case 'F':
  444. prompt_percent(&top->sym_pcnt_filter,
  445. "Enter details display event filter (percent)");
  446. break;
  447. case 'K':
  448. top->hide_kernel_symbols = !top->hide_kernel_symbols;
  449. break;
  450. case 'q':
  451. case 'Q':
  452. printf("exiting.\n");
  453. if (top->dump_symtab)
  454. perf_session__fprintf_dsos(top->session, stderr);
  455. exit(0);
  456. case 's':
  457. perf_top__prompt_symbol(top, "Enter details symbol");
  458. break;
  459. case 'S':
  460. if (!top->sym_filter_entry)
  461. break;
  462. else {
  463. struct hist_entry *syme = top->sym_filter_entry;
  464. top->sym_filter_entry = NULL;
  465. __zero_source_counters(syme);
  466. }
  467. break;
  468. case 'U':
  469. top->hide_user_symbols = !top->hide_user_symbols;
  470. break;
  471. case 'z':
  472. top->zero = !top->zero;
  473. break;
  474. default:
  475. break;
  476. }
  477. }
  478. static void perf_top__sort_new_samples(void *arg)
  479. {
  480. struct perf_top *t = arg;
  481. perf_top__reset_sample_counters(t);
  482. if (t->evlist->selected != NULL)
  483. t->sym_evsel = t->evlist->selected;
  484. hists__collapse_resort_threaded(&t->sym_evsel->hists);
  485. hists__output_resort_threaded(&t->sym_evsel->hists);
  486. hists__decay_entries_threaded(&t->sym_evsel->hists,
  487. t->hide_user_symbols,
  488. t->hide_kernel_symbols);
  489. }
  490. static void *display_thread_tui(void *arg)
  491. {
  492. struct perf_evsel *pos;
  493. struct perf_top *top = arg;
  494. const char *help = "For a higher level overview, try: perf top --sort comm,dso";
  495. struct hist_browser_timer hbt = {
  496. .timer = perf_top__sort_new_samples,
  497. .arg = top,
  498. .refresh = top->delay_secs,
  499. };
  500. perf_top__sort_new_samples(top);
  501. /*
  502. * Initialize the uid_filter_str, in the future the TUI will allow
  503. * Zooming in/out UIDs. For now juse use whatever the user passed
  504. * via --uid.
  505. */
  506. list_for_each_entry(pos, &top->evlist->entries, node)
  507. pos->hists.uid_filter_str = top->record_opts.target.uid_str;
  508. perf_evlist__tui_browse_hists(top->evlist, help, &hbt,
  509. &top->session->header.env);
  510. exit_browser(0);
  511. exit(0);
  512. return NULL;
  513. }
  514. static void *display_thread(void *arg)
  515. {
  516. struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
  517. struct termios tc, save;
  518. struct perf_top *top = arg;
  519. int delay_msecs, c;
  520. tcgetattr(0, &save);
  521. tc = save;
  522. tc.c_lflag &= ~(ICANON | ECHO);
  523. tc.c_cc[VMIN] = 0;
  524. tc.c_cc[VTIME] = 0;
  525. pthread__unblock_sigwinch();
  526. repeat:
  527. delay_msecs = top->delay_secs * 1000;
  528. tcsetattr(0, TCSANOW, &tc);
  529. /* trash return*/
  530. getc(stdin);
  531. while (1) {
  532. perf_top__print_sym_table(top);
  533. /*
  534. * Either timeout expired or we got an EINTR due to SIGWINCH,
  535. * refresh screen in both cases.
  536. */
  537. switch (poll(&stdin_poll, 1, delay_msecs)) {
  538. case 0:
  539. continue;
  540. case -1:
  541. if (errno == EINTR)
  542. continue;
  543. /* Fall trhu */
  544. default:
  545. goto process_hotkey;
  546. }
  547. }
  548. process_hotkey:
  549. c = getc(stdin);
  550. tcsetattr(0, TCSAFLUSH, &save);
  551. perf_top__handle_keypress(top, c);
  552. goto repeat;
  553. return NULL;
  554. }
  555. /* Tag samples to be skipped. */
  556. static const char *skip_symbols[] = {
  557. "intel_idle",
  558. "default_idle",
  559. "native_safe_halt",
  560. "cpu_idle",
  561. "enter_idle",
  562. "exit_idle",
  563. "mwait_idle",
  564. "mwait_idle_with_hints",
  565. "poll_idle",
  566. "ppc64_runlatch_off",
  567. "pseries_dedicated_idle_sleep",
  568. NULL
  569. };
  570. static int symbol_filter(struct map *map __maybe_unused, struct symbol *sym)
  571. {
  572. const char *name = sym->name;
  573. int i;
  574. /*
  575. * ppc64 uses function descriptors and appends a '.' to the
  576. * start of every instruction address. Remove it.
  577. */
  578. if (name[0] == '.')
  579. name++;
  580. if (!strcmp(name, "_text") ||
  581. !strcmp(name, "_etext") ||
  582. !strcmp(name, "_sinittext") ||
  583. !strncmp("init_module", name, 11) ||
  584. !strncmp("cleanup_module", name, 14) ||
  585. strstr(name, "_text_start") ||
  586. strstr(name, "_text_end"))
  587. return 1;
  588. for (i = 0; skip_symbols[i]; i++) {
  589. if (!strcmp(skip_symbols[i], name)) {
  590. sym->ignore = true;
  591. break;
  592. }
  593. }
  594. return 0;
  595. }
  596. static void perf_event__process_sample(struct perf_tool *tool,
  597. const union perf_event *event,
  598. struct perf_evsel *evsel,
  599. struct perf_sample *sample,
  600. struct machine *machine)
  601. {
  602. struct perf_top *top = container_of(tool, struct perf_top, tool);
  603. struct symbol *parent = NULL;
  604. u64 ip = event->ip.ip;
  605. struct addr_location al;
  606. int err;
  607. if (!machine && perf_guest) {
  608. static struct intlist *seen;
  609. if (!seen)
  610. seen = intlist__new();
  611. if (!intlist__has_entry(seen, event->ip.pid)) {
  612. pr_err("Can't find guest [%d]'s kernel information\n",
  613. event->ip.pid);
  614. intlist__add(seen, event->ip.pid);
  615. }
  616. return;
  617. }
  618. if (!machine) {
  619. pr_err("%u unprocessable samples recorded.\n",
  620. top->session->stats.nr_unprocessable_samples++);
  621. return;
  622. }
  623. if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
  624. top->exact_samples++;
  625. if (perf_event__preprocess_sample(event, machine, &al, sample,
  626. symbol_filter) < 0 ||
  627. al.filtered)
  628. return;
  629. if (!top->kptr_restrict_warned &&
  630. symbol_conf.kptr_restrict &&
  631. al.cpumode == PERF_RECORD_MISC_KERNEL) {
  632. ui__warning(
  633. "Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
  634. "Check /proc/sys/kernel/kptr_restrict.\n\n"
  635. "Kernel%s samples will not be resolved.\n",
  636. !RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION]) ?
  637. " modules" : "");
  638. if (use_browser <= 0)
  639. sleep(5);
  640. top->kptr_restrict_warned = true;
  641. }
  642. if (al.sym == NULL) {
  643. const char *msg = "Kernel samples will not be resolved.\n";
  644. /*
  645. * As we do lazy loading of symtabs we only will know if the
  646. * specified vmlinux file is invalid when we actually have a
  647. * hit in kernel space and then try to load it. So if we get
  648. * here and there are _no_ symbols in the DSO backing the
  649. * kernel map, bail out.
  650. *
  651. * We may never get here, for instance, if we use -K/
  652. * --hide-kernel-symbols, even if the user specifies an
  653. * invalid --vmlinux ;-)
  654. */
  655. if (!top->kptr_restrict_warned && !top->vmlinux_warned &&
  656. al.map == machine->vmlinux_maps[MAP__FUNCTION] &&
  657. RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION])) {
  658. if (symbol_conf.vmlinux_name) {
  659. ui__warning("The %s file can't be used.\n%s",
  660. symbol_conf.vmlinux_name, msg);
  661. } else {
  662. ui__warning("A vmlinux file was not found.\n%s",
  663. msg);
  664. }
  665. if (use_browser <= 0)
  666. sleep(5);
  667. top->vmlinux_warned = true;
  668. }
  669. }
  670. if (al.sym == NULL || !al.sym->ignore) {
  671. struct hist_entry *he;
  672. if ((sort__has_parent || symbol_conf.use_callchain) &&
  673. sample->callchain) {
  674. err = machine__resolve_callchain(machine, evsel,
  675. al.thread, sample,
  676. &parent);
  677. if (err)
  678. return;
  679. }
  680. he = perf_evsel__add_hist_entry(evsel, &al, sample);
  681. if (he == NULL) {
  682. pr_err("Problem incrementing symbol period, skipping event\n");
  683. return;
  684. }
  685. if (symbol_conf.use_callchain) {
  686. err = callchain_append(he->callchain, &callchain_cursor,
  687. sample->period);
  688. if (err)
  689. return;
  690. }
  691. if (top->sort_has_symbols)
  692. perf_top__record_precise_ip(top, he, evsel->idx, ip);
  693. }
  694. return;
  695. }
  696. static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
  697. {
  698. struct perf_sample sample;
  699. struct perf_evsel *evsel;
  700. struct perf_session *session = top->session;
  701. union perf_event *event;
  702. struct machine *machine;
  703. u8 origin;
  704. int ret;
  705. while ((event = perf_evlist__mmap_read(top->evlist, idx)) != NULL) {
  706. ret = perf_evlist__parse_sample(top->evlist, event, &sample);
  707. if (ret) {
  708. pr_err("Can't parse sample, err = %d\n", ret);
  709. continue;
  710. }
  711. evsel = perf_evlist__id2evsel(session->evlist, sample.id);
  712. assert(evsel != NULL);
  713. origin = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
  714. if (event->header.type == PERF_RECORD_SAMPLE)
  715. ++top->samples;
  716. switch (origin) {
  717. case PERF_RECORD_MISC_USER:
  718. ++top->us_samples;
  719. if (top->hide_user_symbols)
  720. continue;
  721. machine = &session->machines.host;
  722. break;
  723. case PERF_RECORD_MISC_KERNEL:
  724. ++top->kernel_samples;
  725. if (top->hide_kernel_symbols)
  726. continue;
  727. machine = &session->machines.host;
  728. break;
  729. case PERF_RECORD_MISC_GUEST_KERNEL:
  730. ++top->guest_kernel_samples;
  731. machine = perf_session__find_machine(session, event->ip.pid);
  732. break;
  733. case PERF_RECORD_MISC_GUEST_USER:
  734. ++top->guest_us_samples;
  735. /*
  736. * TODO: we don't process guest user from host side
  737. * except simple counting.
  738. */
  739. /* Fall thru */
  740. default:
  741. continue;
  742. }
  743. if (event->header.type == PERF_RECORD_SAMPLE) {
  744. perf_event__process_sample(&top->tool, event, evsel,
  745. &sample, machine);
  746. } else if (event->header.type < PERF_RECORD_MAX) {
  747. hists__inc_nr_events(&evsel->hists, event->header.type);
  748. machine__process_event(machine, event);
  749. } else
  750. ++session->stats.nr_unknown_events;
  751. }
  752. }
  753. static void perf_top__mmap_read(struct perf_top *top)
  754. {
  755. int i;
  756. for (i = 0; i < top->evlist->nr_mmaps; i++)
  757. perf_top__mmap_read_idx(top, i);
  758. }
  759. static void perf_top__start_counters(struct perf_top *top)
  760. {
  761. char msg[512];
  762. struct perf_evsel *counter;
  763. struct perf_evlist *evlist = top->evlist;
  764. struct perf_record_opts *opts = &top->record_opts;
  765. perf_evlist__config(evlist, opts);
  766. list_for_each_entry(counter, &evlist->entries, node) {
  767. try_again:
  768. if (perf_evsel__open(counter, top->evlist->cpus,
  769. top->evlist->threads) < 0) {
  770. if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
  771. if (verbose)
  772. ui__warning("%s\n", msg);
  773. goto try_again;
  774. }
  775. perf_evsel__open_strerror(counter, &opts->target,
  776. errno, msg, sizeof(msg));
  777. ui__error("%s\n", msg);
  778. goto out_err;
  779. }
  780. }
  781. if (perf_evlist__mmap(evlist, opts->mmap_pages, false) < 0) {
  782. ui__error("Failed to mmap with %d (%s)\n",
  783. errno, strerror(errno));
  784. goto out_err;
  785. }
  786. return;
  787. out_err:
  788. exit_browser(0);
  789. exit(0);
  790. }
  791. static int perf_top__setup_sample_type(struct perf_top *top)
  792. {
  793. if (!top->sort_has_symbols) {
  794. if (symbol_conf.use_callchain) {
  795. ui__error("Selected -g but \"sym\" not present in --sort/-s.");
  796. return -EINVAL;
  797. }
  798. } else if (callchain_param.mode != CHAIN_NONE) {
  799. if (callchain_register_param(&callchain_param) < 0) {
  800. ui__error("Can't register callchain params.\n");
  801. return -EINVAL;
  802. }
  803. }
  804. return 0;
  805. }
  806. static int __cmd_top(struct perf_top *top)
  807. {
  808. struct perf_record_opts *opts = &top->record_opts;
  809. pthread_t thread;
  810. int ret;
  811. /*
  812. * FIXME: perf_session__new should allow passing a O_MMAP, so that all this
  813. * mmap reading, etc is encapsulated in it. Use O_WRONLY for now.
  814. */
  815. top->session = perf_session__new(NULL, O_WRONLY, false, false, NULL);
  816. if (top->session == NULL)
  817. return -ENOMEM;
  818. ret = perf_top__setup_sample_type(top);
  819. if (ret)
  820. goto out_delete;
  821. if (perf_target__has_task(&opts->target))
  822. perf_event__synthesize_thread_map(&top->tool, top->evlist->threads,
  823. perf_event__process,
  824. &top->session->machines.host);
  825. else
  826. perf_event__synthesize_threads(&top->tool, perf_event__process,
  827. &top->session->machines.host);
  828. perf_top__start_counters(top);
  829. top->session->evlist = top->evlist;
  830. perf_session__set_id_hdr_size(top->session);
  831. /*
  832. * When perf is starting the traced process, all the events (apart from
  833. * group members) have enable_on_exec=1 set, so don't spoil it by
  834. * prematurely enabling them.
  835. *
  836. * XXX 'top' still doesn't start workloads like record, trace, but should,
  837. * so leave the check here.
  838. */
  839. if (!perf_target__none(&opts->target))
  840. perf_evlist__enable(top->evlist);
  841. /* Wait for a minimal set of events before starting the snapshot */
  842. poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
  843. perf_top__mmap_read(top);
  844. if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
  845. display_thread), top)) {
  846. ui__error("Could not create display thread.\n");
  847. exit(-1);
  848. }
  849. if (top->realtime_prio) {
  850. struct sched_param param;
  851. param.sched_priority = top->realtime_prio;
  852. if (sched_setscheduler(0, SCHED_FIFO, &param)) {
  853. ui__error("Could not set realtime priority.\n");
  854. exit(-1);
  855. }
  856. }
  857. while (1) {
  858. u64 hits = top->samples;
  859. perf_top__mmap_read(top);
  860. if (hits == top->samples)
  861. ret = poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
  862. }
  863. out_delete:
  864. perf_session__delete(top->session);
  865. top->session = NULL;
  866. return 0;
  867. }
  868. static int
  869. parse_callchain_opt(const struct option *opt, const char *arg, int unset)
  870. {
  871. /*
  872. * --no-call-graph
  873. */
  874. if (unset)
  875. return 0;
  876. symbol_conf.use_callchain = true;
  877. return record_parse_callchain_opt(opt, arg, unset);
  878. }
  879. int cmd_top(int argc, const char **argv, const char *prefix __maybe_unused)
  880. {
  881. int status;
  882. char errbuf[BUFSIZ];
  883. struct perf_top top = {
  884. .count_filter = 5,
  885. .delay_secs = 2,
  886. .record_opts = {
  887. .mmap_pages = UINT_MAX,
  888. .user_freq = UINT_MAX,
  889. .user_interval = ULLONG_MAX,
  890. .freq = 4000, /* 4 KHz */
  891. .target = {
  892. .uses_mmap = true,
  893. },
  894. },
  895. .sym_pcnt_filter = 5,
  896. };
  897. struct perf_record_opts *opts = &top.record_opts;
  898. struct perf_target *target = &opts->target;
  899. const struct option options[] = {
  900. OPT_CALLBACK('e', "event", &top.evlist, "event",
  901. "event selector. use 'perf list' to list available events",
  902. parse_events_option),
  903. OPT_U64('c', "count", &opts->user_interval, "event period to sample"),
  904. OPT_STRING('p', "pid", &target->pid, "pid",
  905. "profile events on existing process id"),
  906. OPT_STRING('t', "tid", &target->tid, "tid",
  907. "profile events on existing thread id"),
  908. OPT_BOOLEAN('a', "all-cpus", &target->system_wide,
  909. "system-wide collection from all CPUs"),
  910. OPT_STRING('C', "cpu", &target->cpu_list, "cpu",
  911. "list of cpus to monitor"),
  912. OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
  913. "file", "vmlinux pathname"),
  914. OPT_BOOLEAN('K', "hide_kernel_symbols", &top.hide_kernel_symbols,
  915. "hide kernel symbols"),
  916. OPT_UINTEGER('m', "mmap-pages", &opts->mmap_pages,
  917. "number of mmap data pages"),
  918. OPT_INTEGER('r', "realtime", &top.realtime_prio,
  919. "collect data with this RT SCHED_FIFO priority"),
  920. OPT_INTEGER('d', "delay", &top.delay_secs,
  921. "number of seconds to delay between refreshes"),
  922. OPT_BOOLEAN('D', "dump-symtab", &top.dump_symtab,
  923. "dump the symbol table used for profiling"),
  924. OPT_INTEGER('f', "count-filter", &top.count_filter,
  925. "only display functions with more events than this"),
  926. OPT_BOOLEAN('g', "group", &opts->group,
  927. "put the counters into a counter group"),
  928. OPT_BOOLEAN('i', "no-inherit", &opts->no_inherit,
  929. "child tasks do not inherit counters"),
  930. OPT_STRING(0, "sym-annotate", &top.sym_filter, "symbol name",
  931. "symbol to annotate"),
  932. OPT_BOOLEAN('z', "zero", &top.zero, "zero history across updates"),
  933. OPT_UINTEGER('F', "freq", &opts->user_freq, "profile at this frequency"),
  934. OPT_INTEGER('E', "entries", &top.print_entries,
  935. "display this many functions"),
  936. OPT_BOOLEAN('U', "hide_user_symbols", &top.hide_user_symbols,
  937. "hide user symbols"),
  938. OPT_BOOLEAN(0, "tui", &top.use_tui, "Use the TUI interface"),
  939. OPT_BOOLEAN(0, "stdio", &top.use_stdio, "Use the stdio interface"),
  940. OPT_INCR('v', "verbose", &verbose,
  941. "be more verbose (show counter open errors, etc)"),
  942. OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
  943. "sort by key(s): pid, comm, dso, symbol, parent"),
  944. OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
  945. "Show a column with the number of samples"),
  946. OPT_CALLBACK_DEFAULT('G', "call-graph", &top.record_opts,
  947. "mode[,dump_size]", record_callchain_help,
  948. &parse_callchain_opt, "fp"),
  949. OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
  950. "Show a column with the sum of periods"),
  951. OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
  952. "only consider symbols in these dsos"),
  953. OPT_STRING(0, "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
  954. "only consider symbols in these comms"),
  955. OPT_STRING(0, "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
  956. "only consider these symbols"),
  957. OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
  958. "Interleave source code with assembly code (default)"),
  959. OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
  960. "Display raw encoding of assembly instructions (default)"),
  961. OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
  962. "Specify disassembler style (e.g. -M intel for intel syntax)"),
  963. OPT_STRING('u', "uid", &target->uid_str, "user", "user to profile"),
  964. OPT_END()
  965. };
  966. const char * const top_usage[] = {
  967. "perf top [<options>]",
  968. NULL
  969. };
  970. top.evlist = perf_evlist__new(NULL, NULL);
  971. if (top.evlist == NULL)
  972. return -ENOMEM;
  973. symbol_conf.exclude_other = false;
  974. argc = parse_options(argc, argv, options, top_usage, 0);
  975. if (argc)
  976. usage_with_options(top_usage, options);
  977. if (sort_order == default_sort_order)
  978. sort_order = "dso,symbol";
  979. setup_sorting(top_usage, options);
  980. if (top.use_stdio)
  981. use_browser = 0;
  982. else if (top.use_tui)
  983. use_browser = 1;
  984. setup_browser(false);
  985. status = perf_target__validate(target);
  986. if (status) {
  987. perf_target__strerror(target, status, errbuf, BUFSIZ);
  988. ui__warning("%s", errbuf);
  989. }
  990. status = perf_target__parse_uid(target);
  991. if (status) {
  992. int saved_errno = errno;
  993. perf_target__strerror(target, status, errbuf, BUFSIZ);
  994. ui__error("%s", errbuf);
  995. status = -saved_errno;
  996. goto out_delete_evlist;
  997. }
  998. if (perf_target__none(target))
  999. target->system_wide = true;
  1000. if (perf_evlist__create_maps(top.evlist, target) < 0)
  1001. usage_with_options(top_usage, options);
  1002. if (!top.evlist->nr_entries &&
  1003. perf_evlist__add_default(top.evlist) < 0) {
  1004. ui__error("Not enough memory for event selector list\n");
  1005. return -ENOMEM;
  1006. }
  1007. symbol_conf.nr_events = top.evlist->nr_entries;
  1008. if (top.delay_secs < 1)
  1009. top.delay_secs = 1;
  1010. if (opts->user_interval != ULLONG_MAX)
  1011. opts->default_interval = opts->user_interval;
  1012. if (opts->user_freq != UINT_MAX)
  1013. opts->freq = opts->user_freq;
  1014. /*
  1015. * User specified count overrides default frequency.
  1016. */
  1017. if (opts->default_interval)
  1018. opts->freq = 0;
  1019. else if (opts->freq) {
  1020. opts->default_interval = opts->freq;
  1021. } else {
  1022. ui__error("frequency and count are zero, aborting\n");
  1023. status = -EINVAL;
  1024. goto out_delete_evlist;
  1025. }
  1026. top.sym_evsel = perf_evlist__first(top.evlist);
  1027. symbol_conf.priv_size = sizeof(struct annotation);
  1028. symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
  1029. if (symbol__init() < 0)
  1030. return -1;
  1031. sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
  1032. sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
  1033. sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
  1034. /*
  1035. * Avoid annotation data structures overhead when symbols aren't on the
  1036. * sort list.
  1037. */
  1038. top.sort_has_symbols = sort_sym.list.next != NULL;
  1039. get_term_dimensions(&top.winsize);
  1040. if (top.print_entries == 0) {
  1041. struct sigaction act = {
  1042. .sa_sigaction = perf_top__sig_winch,
  1043. .sa_flags = SA_SIGINFO,
  1044. };
  1045. perf_top__update_print_entries(&top);
  1046. sigaction(SIGWINCH, &act, NULL);
  1047. }
  1048. status = __cmd_top(&top);
  1049. out_delete_evlist:
  1050. perf_evlist__delete(top.evlist);
  1051. return status;
  1052. }