builtin-mem.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451
  1. // SPDX-License-Identifier: GPL-2.0
  2. #include <inttypes.h>
  3. #include <sys/types.h>
  4. #include <sys/stat.h>
  5. #include <unistd.h>
  6. #include "builtin.h"
  7. #include "perf.h"
  8. #include <subcmd/parse-options.h>
  9. #include "util/trace-event.h"
  10. #include "util/tool.h"
  11. #include "util/session.h"
  12. #include "util/data.h"
  13. #include "util/map_symbol.h"
  14. #include "util/mem-events.h"
  15. #include "util/debug.h"
  16. #include "util/dso.h"
  17. #include "util/map.h"
  18. #include "util/symbol.h"
  19. #include <linux/err.h>
  20. #define MEM_OPERATION_LOAD 0x1
  21. #define MEM_OPERATION_STORE 0x2
  22. struct perf_mem {
  23. struct perf_tool tool;
  24. char const *input_name;
  25. bool hide_unresolved;
  26. bool dump_raw;
  27. bool force;
  28. bool phys_addr;
  29. int operation;
  30. const char *cpu_list;
  31. DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
  32. };
  33. static int parse_record_events(const struct option *opt,
  34. const char *str, int unset __maybe_unused)
  35. {
  36. struct perf_mem *mem = *(struct perf_mem **)opt->value;
  37. if (!strcmp(str, "list")) {
  38. perf_mem_events__list();
  39. exit(0);
  40. }
  41. if (perf_mem_events__parse(str))
  42. exit(-1);
  43. mem->operation = 0;
  44. return 0;
  45. }
  46. static const char * const __usage[] = {
  47. "perf mem record [<options>] [<command>]",
  48. "perf mem record [<options>] -- <command> [<options>]",
  49. NULL
  50. };
  51. static const char * const *record_mem_usage = __usage;
  52. static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
  53. {
  54. int rec_argc, i = 0, j;
  55. const char **rec_argv;
  56. int ret;
  57. bool all_user = false, all_kernel = false;
  58. struct option options[] = {
  59. OPT_CALLBACK('e', "event", &mem, "event",
  60. "event selector. use 'perf mem record -e list' to list available events",
  61. parse_record_events),
  62. OPT_UINTEGER(0, "ldlat", &perf_mem_events__loads_ldlat, "mem-loads latency"),
  63. OPT_INCR('v', "verbose", &verbose,
  64. "be more verbose (show counter open errors, etc)"),
  65. OPT_BOOLEAN('U', "all-user", &all_user, "collect only user level data"),
  66. OPT_BOOLEAN('K', "all-kernel", &all_kernel, "collect only kernel level data"),
  67. OPT_END()
  68. };
  69. argc = parse_options(argc, argv, options, record_mem_usage,
  70. PARSE_OPT_KEEP_UNKNOWN);
  71. rec_argc = argc + 9; /* max number of arguments */
  72. rec_argv = calloc(rec_argc + 1, sizeof(char *));
  73. if (!rec_argv)
  74. return -1;
  75. rec_argv[i++] = "record";
  76. if (mem->operation & MEM_OPERATION_LOAD)
  77. perf_mem_events[PERF_MEM_EVENTS__LOAD].record = true;
  78. if (mem->operation & MEM_OPERATION_STORE)
  79. perf_mem_events[PERF_MEM_EVENTS__STORE].record = true;
  80. if (perf_mem_events[PERF_MEM_EVENTS__LOAD].record)
  81. rec_argv[i++] = "-W";
  82. rec_argv[i++] = "-d";
  83. if (mem->phys_addr)
  84. rec_argv[i++] = "--phys-data";
  85. for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
  86. if (!perf_mem_events[j].record)
  87. continue;
  88. if (!perf_mem_events[j].supported) {
  89. pr_err("failed: event '%s' not supported\n",
  90. perf_mem_events__name(j));
  91. free(rec_argv);
  92. return -1;
  93. }
  94. rec_argv[i++] = "-e";
  95. rec_argv[i++] = perf_mem_events__name(j);
  96. }
  97. if (all_user)
  98. rec_argv[i++] = "--all-user";
  99. if (all_kernel)
  100. rec_argv[i++] = "--all-kernel";
  101. for (j = 0; j < argc; j++, i++)
  102. rec_argv[i] = argv[j];
  103. if (verbose > 0) {
  104. pr_debug("calling: record ");
  105. while (rec_argv[j]) {
  106. pr_debug("%s ", rec_argv[j]);
  107. j++;
  108. }
  109. pr_debug("\n");
  110. }
  111. ret = cmd_record(i, rec_argv);
  112. free(rec_argv);
  113. return ret;
  114. }
  115. static int
  116. dump_raw_samples(struct perf_tool *tool,
  117. union perf_event *event,
  118. struct perf_sample *sample,
  119. struct machine *machine)
  120. {
  121. struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
  122. struct addr_location al;
  123. const char *fmt;
  124. if (machine__resolve(machine, &al, sample) < 0) {
  125. fprintf(stderr, "problem processing %d event, skipping it.\n",
  126. event->header.type);
  127. return -1;
  128. }
  129. if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
  130. goto out_put;
  131. if (al.map != NULL)
  132. al.map->dso->hit = 1;
  133. if (mem->phys_addr) {
  134. if (symbol_conf.field_sep) {
  135. fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s0x%016"PRIx64
  136. "%s%"PRIu64"%s0x%"PRIx64"%s%s:%s\n";
  137. } else {
  138. fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
  139. "%s0x%016"PRIx64"%s%5"PRIu64"%s0x%06"PRIx64
  140. "%s%s:%s\n";
  141. symbol_conf.field_sep = " ";
  142. }
  143. printf(fmt,
  144. sample->pid,
  145. symbol_conf.field_sep,
  146. sample->tid,
  147. symbol_conf.field_sep,
  148. sample->ip,
  149. symbol_conf.field_sep,
  150. sample->addr,
  151. symbol_conf.field_sep,
  152. sample->phys_addr,
  153. symbol_conf.field_sep,
  154. sample->weight,
  155. symbol_conf.field_sep,
  156. sample->data_src,
  157. symbol_conf.field_sep,
  158. al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
  159. al.sym ? al.sym->name : "???");
  160. } else {
  161. if (symbol_conf.field_sep) {
  162. fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
  163. "%s0x%"PRIx64"%s%s:%s\n";
  164. } else {
  165. fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
  166. "%s%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
  167. symbol_conf.field_sep = " ";
  168. }
  169. printf(fmt,
  170. sample->pid,
  171. symbol_conf.field_sep,
  172. sample->tid,
  173. symbol_conf.field_sep,
  174. sample->ip,
  175. symbol_conf.field_sep,
  176. sample->addr,
  177. symbol_conf.field_sep,
  178. sample->weight,
  179. symbol_conf.field_sep,
  180. sample->data_src,
  181. symbol_conf.field_sep,
  182. al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
  183. al.sym ? al.sym->name : "???");
  184. }
  185. out_put:
  186. addr_location__put(&al);
  187. return 0;
  188. }
  189. static int process_sample_event(struct perf_tool *tool,
  190. union perf_event *event,
  191. struct perf_sample *sample,
  192. struct evsel *evsel __maybe_unused,
  193. struct machine *machine)
  194. {
  195. return dump_raw_samples(tool, event, sample, machine);
  196. }
  197. static int report_raw_events(struct perf_mem *mem)
  198. {
  199. struct perf_data data = {
  200. .path = input_name,
  201. .mode = PERF_DATA_MODE_READ,
  202. .force = mem->force,
  203. };
  204. int ret;
  205. struct perf_session *session = perf_session__new(&data, false,
  206. &mem->tool);
  207. if (IS_ERR(session))
  208. return PTR_ERR(session);
  209. if (mem->cpu_list) {
  210. ret = perf_session__cpu_bitmap(session, mem->cpu_list,
  211. mem->cpu_bitmap);
  212. if (ret < 0)
  213. goto out_delete;
  214. }
  215. ret = symbol__init(&session->header.env);
  216. if (ret < 0)
  217. goto out_delete;
  218. if (mem->phys_addr)
  219. printf("# PID, TID, IP, ADDR, PHYS ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
  220. else
  221. printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
  222. ret = perf_session__process_events(session);
  223. out_delete:
  224. perf_session__delete(session);
  225. return ret;
  226. }
  227. static int report_events(int argc, const char **argv, struct perf_mem *mem)
  228. {
  229. const char **rep_argv;
  230. int ret, i = 0, j, rep_argc;
  231. if (mem->dump_raw)
  232. return report_raw_events(mem);
  233. rep_argc = argc + 3;
  234. rep_argv = calloc(rep_argc + 1, sizeof(char *));
  235. if (!rep_argv)
  236. return -1;
  237. rep_argv[i++] = "report";
  238. rep_argv[i++] = "--mem-mode";
  239. rep_argv[i++] = "-n"; /* display number of samples */
  240. /*
  241. * there is no weight (cost) associated with stores, so don't print
  242. * the column
  243. */
  244. if (!(mem->operation & MEM_OPERATION_LOAD)) {
  245. if (mem->phys_addr)
  246. rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
  247. "dso_daddr,tlb,locked,phys_daddr";
  248. else
  249. rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
  250. "dso_daddr,tlb,locked";
  251. } else if (mem->phys_addr)
  252. rep_argv[i++] = "--sort=local_weight,mem,sym,dso,symbol_daddr,"
  253. "dso_daddr,snoop,tlb,locked,phys_daddr";
  254. for (j = 1; j < argc; j++, i++)
  255. rep_argv[i] = argv[j];
  256. ret = cmd_report(i, rep_argv);
  257. free(rep_argv);
  258. return ret;
  259. }
  260. struct mem_mode {
  261. const char *name;
  262. int mode;
  263. };
  264. #define MEM_OPT(n, m) \
  265. { .name = n, .mode = (m) }
  266. #define MEM_END { .name = NULL }
  267. static const struct mem_mode mem_modes[]={
  268. MEM_OPT("load", MEM_OPERATION_LOAD),
  269. MEM_OPT("store", MEM_OPERATION_STORE),
  270. MEM_END
  271. };
  272. static int
  273. parse_mem_ops(const struct option *opt, const char *str, int unset)
  274. {
  275. int *mode = (int *)opt->value;
  276. const struct mem_mode *m;
  277. char *s, *os = NULL, *p;
  278. int ret = -1;
  279. if (unset)
  280. return 0;
  281. /* str may be NULL in case no arg is passed to -t */
  282. if (str) {
  283. /* because str is read-only */
  284. s = os = strdup(str);
  285. if (!s)
  286. return -1;
  287. /* reset mode */
  288. *mode = 0;
  289. for (;;) {
  290. p = strchr(s, ',');
  291. if (p)
  292. *p = '\0';
  293. for (m = mem_modes; m->name; m++) {
  294. if (!strcasecmp(s, m->name))
  295. break;
  296. }
  297. if (!m->name) {
  298. fprintf(stderr, "unknown sampling op %s,"
  299. " check man page\n", s);
  300. goto error;
  301. }
  302. *mode |= m->mode;
  303. if (!p)
  304. break;
  305. s = p + 1;
  306. }
  307. }
  308. ret = 0;
  309. if (*mode == 0)
  310. *mode = MEM_OPERATION_LOAD;
  311. error:
  312. free(os);
  313. return ret;
  314. }
  315. int cmd_mem(int argc, const char **argv)
  316. {
  317. struct stat st;
  318. struct perf_mem mem = {
  319. .tool = {
  320. .sample = process_sample_event,
  321. .mmap = perf_event__process_mmap,
  322. .mmap2 = perf_event__process_mmap2,
  323. .comm = perf_event__process_comm,
  324. .lost = perf_event__process_lost,
  325. .fork = perf_event__process_fork,
  326. .build_id = perf_event__process_build_id,
  327. .namespaces = perf_event__process_namespaces,
  328. .ordered_events = true,
  329. },
  330. .input_name = "perf.data",
  331. /*
  332. * default to both load an store sampling
  333. */
  334. .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
  335. };
  336. const struct option mem_options[] = {
  337. OPT_CALLBACK('t', "type", &mem.operation,
  338. "type", "memory operations(load,store) Default load,store",
  339. parse_mem_ops),
  340. OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
  341. "dump raw samples in ASCII"),
  342. OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
  343. "Only display entries resolved to a symbol"),
  344. OPT_STRING('i', "input", &input_name, "file",
  345. "input file name"),
  346. OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
  347. "list of cpus to profile"),
  348. OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
  349. "separator",
  350. "separator for columns, no spaces will be added"
  351. " between columns '.' is reserved."),
  352. OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
  353. OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
  354. OPT_END()
  355. };
  356. const char *const mem_subcommands[] = { "record", "report", NULL };
  357. const char *mem_usage[] = {
  358. NULL,
  359. NULL
  360. };
  361. if (perf_mem_events__init()) {
  362. pr_err("failed: memory events not supported\n");
  363. return -1;
  364. }
  365. argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
  366. mem_usage, PARSE_OPT_KEEP_UNKNOWN);
  367. if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
  368. usage_with_options(mem_usage, mem_options);
  369. if (!mem.input_name || !strlen(mem.input_name)) {
  370. if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
  371. mem.input_name = "-";
  372. else
  373. mem.input_name = "perf.data";
  374. }
  375. if (!strncmp(argv[0], "rec", 3))
  376. return __cmd_record(argc, argv, &mem);
  377. else if (!strncmp(argv[0], "rep", 3))
  378. return report_events(argc, argv, &mem);
  379. else
  380. usage_with_options(mem_usage, mem_options);
  381. return 0;
  382. }