builtin-script.c 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836
  1. #include "builtin.h"
  2. #include "perf.h"
  3. #include "util/cache.h"
  4. #include "util/debug.h"
  5. #include "util/exec_cmd.h"
  6. #include "util/header.h"
  7. #include "util/parse-options.h"
  8. #include "util/session.h"
  9. #include "util/tool.h"
  10. #include "util/symbol.h"
  11. #include "util/thread.h"
  12. #include "util/trace-event.h"
  13. #include "util/util.h"
  14. #include "util/evlist.h"
  15. #include "util/evsel.h"
  16. #include "util/sort.h"
  17. #include "util/data.h"
  18. #include <linux/bitmap.h>
  19. static char const *script_name;
  20. static char const *generate_script_lang;
  21. static bool debug_mode;
  22. static u64 last_timestamp;
  23. static u64 nr_unordered;
  24. extern const struct option record_options[];
  25. static bool no_callchain;
  26. static bool latency_format;
  27. static bool system_wide;
  28. static const char *cpu_list;
  29. static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
  30. enum perf_output_field {
  31. PERF_OUTPUT_COMM = 1U << 0,
  32. PERF_OUTPUT_TID = 1U << 1,
  33. PERF_OUTPUT_PID = 1U << 2,
  34. PERF_OUTPUT_TIME = 1U << 3,
  35. PERF_OUTPUT_CPU = 1U << 4,
  36. PERF_OUTPUT_EVNAME = 1U << 5,
  37. PERF_OUTPUT_TRACE = 1U << 6,
  38. PERF_OUTPUT_IP = 1U << 7,
  39. PERF_OUTPUT_SYM = 1U << 8,
  40. PERF_OUTPUT_DSO = 1U << 9,
  41. PERF_OUTPUT_ADDR = 1U << 10,
  42. PERF_OUTPUT_SYMOFFSET = 1U << 11,
  43. PERF_OUTPUT_SRCLINE = 1U << 12,
  44. };
  45. struct output_option {
  46. const char *str;
  47. enum perf_output_field field;
  48. } all_output_options[] = {
  49. {.str = "comm", .field = PERF_OUTPUT_COMM},
  50. {.str = "tid", .field = PERF_OUTPUT_TID},
  51. {.str = "pid", .field = PERF_OUTPUT_PID},
  52. {.str = "time", .field = PERF_OUTPUT_TIME},
  53. {.str = "cpu", .field = PERF_OUTPUT_CPU},
  54. {.str = "event", .field = PERF_OUTPUT_EVNAME},
  55. {.str = "trace", .field = PERF_OUTPUT_TRACE},
  56. {.str = "ip", .field = PERF_OUTPUT_IP},
  57. {.str = "sym", .field = PERF_OUTPUT_SYM},
  58. {.str = "dso", .field = PERF_OUTPUT_DSO},
  59. {.str = "addr", .field = PERF_OUTPUT_ADDR},
  60. {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
  61. {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
  62. };
  63. /* default set to maintain compatibility with current format */
  64. static struct {
  65. bool user_set;
  66. bool wildcard_set;
  67. unsigned int print_ip_opts;
  68. u64 fields;
  69. u64 invalid_fields;
  70. } output[PERF_TYPE_MAX] = {
  71. [PERF_TYPE_HARDWARE] = {
  72. .user_set = false,
  73. .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
  74. PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
  75. PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
  76. PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
  77. .invalid_fields = PERF_OUTPUT_TRACE,
  78. },
  79. [PERF_TYPE_SOFTWARE] = {
  80. .user_set = false,
  81. .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
  82. PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
  83. PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
  84. PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
  85. .invalid_fields = PERF_OUTPUT_TRACE,
  86. },
  87. [PERF_TYPE_TRACEPOINT] = {
  88. .user_set = false,
  89. .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
  90. PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
  91. PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
  92. },
  93. [PERF_TYPE_RAW] = {
  94. .user_set = false,
  95. .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
  96. PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
  97. PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
  98. PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
  99. .invalid_fields = PERF_OUTPUT_TRACE,
  100. },
  101. };
  102. static bool output_set_by_user(void)
  103. {
  104. int j;
  105. for (j = 0; j < PERF_TYPE_MAX; ++j) {
  106. if (output[j].user_set)
  107. return true;
  108. }
  109. return false;
  110. }
  111. static const char *output_field2str(enum perf_output_field field)
  112. {
  113. int i, imax = ARRAY_SIZE(all_output_options);
  114. const char *str = "";
  115. for (i = 0; i < imax; ++i) {
  116. if (all_output_options[i].field == field) {
  117. str = all_output_options[i].str;
  118. break;
  119. }
  120. }
  121. return str;
  122. }
  123. #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
  124. static int perf_evsel__check_stype(struct perf_evsel *evsel,
  125. u64 sample_type, const char *sample_msg,
  126. enum perf_output_field field)
  127. {
  128. struct perf_event_attr *attr = &evsel->attr;
  129. int type = attr->type;
  130. const char *evname;
  131. if (attr->sample_type & sample_type)
  132. return 0;
  133. if (output[type].user_set) {
  134. evname = perf_evsel__name(evsel);
  135. pr_err("Samples for '%s' event do not have %s attribute set. "
  136. "Cannot print '%s' field.\n",
  137. evname, sample_msg, output_field2str(field));
  138. return -1;
  139. }
  140. /* user did not ask for it explicitly so remove from the default list */
  141. output[type].fields &= ~field;
  142. evname = perf_evsel__name(evsel);
  143. pr_debug("Samples for '%s' event do not have %s attribute set. "
  144. "Skipping '%s' field.\n",
  145. evname, sample_msg, output_field2str(field));
  146. return 0;
  147. }
  148. static int perf_evsel__check_attr(struct perf_evsel *evsel,
  149. struct perf_session *session)
  150. {
  151. struct perf_event_attr *attr = &evsel->attr;
  152. if (PRINT_FIELD(TRACE) &&
  153. !perf_session__has_traces(session, "record -R"))
  154. return -EINVAL;
  155. if (PRINT_FIELD(IP)) {
  156. if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
  157. PERF_OUTPUT_IP))
  158. return -EINVAL;
  159. if (!no_callchain &&
  160. !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
  161. symbol_conf.use_callchain = false;
  162. }
  163. if (PRINT_FIELD(ADDR) &&
  164. perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
  165. PERF_OUTPUT_ADDR))
  166. return -EINVAL;
  167. if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
  168. pr_err("Display of symbols requested but neither sample IP nor "
  169. "sample address\nis selected. Hence, no addresses to convert "
  170. "to symbols.\n");
  171. return -EINVAL;
  172. }
  173. if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
  174. pr_err("Display of offsets requested but symbol is not"
  175. "selected.\n");
  176. return -EINVAL;
  177. }
  178. if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
  179. pr_err("Display of DSO requested but neither sample IP nor "
  180. "sample address\nis selected. Hence, no addresses to convert "
  181. "to DSO.\n");
  182. return -EINVAL;
  183. }
  184. if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
  185. pr_err("Display of source line number requested but sample IP is not\n"
  186. "selected. Hence, no address to lookup the source line number.\n");
  187. return -EINVAL;
  188. }
  189. if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
  190. perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
  191. PERF_OUTPUT_TID|PERF_OUTPUT_PID))
  192. return -EINVAL;
  193. if (PRINT_FIELD(TIME) &&
  194. perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
  195. PERF_OUTPUT_TIME))
  196. return -EINVAL;
  197. if (PRINT_FIELD(CPU) &&
  198. perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
  199. PERF_OUTPUT_CPU))
  200. return -EINVAL;
  201. return 0;
  202. }
  203. static void set_print_ip_opts(struct perf_event_attr *attr)
  204. {
  205. unsigned int type = attr->type;
  206. output[type].print_ip_opts = 0;
  207. if (PRINT_FIELD(IP))
  208. output[type].print_ip_opts |= PRINT_IP_OPT_IP;
  209. if (PRINT_FIELD(SYM))
  210. output[type].print_ip_opts |= PRINT_IP_OPT_SYM;
  211. if (PRINT_FIELD(DSO))
  212. output[type].print_ip_opts |= PRINT_IP_OPT_DSO;
  213. if (PRINT_FIELD(SYMOFFSET))
  214. output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
  215. if (PRINT_FIELD(SRCLINE))
  216. output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
  217. }
  218. /*
  219. * verify all user requested events exist and the samples
  220. * have the expected data
  221. */
  222. static int perf_session__check_output_opt(struct perf_session *session)
  223. {
  224. int j;
  225. struct perf_evsel *evsel;
  226. for (j = 0; j < PERF_TYPE_MAX; ++j) {
  227. evsel = perf_session__find_first_evtype(session, j);
  228. /*
  229. * even if fields is set to 0 (ie., show nothing) event must
  230. * exist if user explicitly includes it on the command line
  231. */
  232. if (!evsel && output[j].user_set && !output[j].wildcard_set) {
  233. pr_err("%s events do not exist. "
  234. "Remove corresponding -f option to proceed.\n",
  235. event_type(j));
  236. return -1;
  237. }
  238. if (evsel && output[j].fields &&
  239. perf_evsel__check_attr(evsel, session))
  240. return -1;
  241. if (evsel == NULL)
  242. continue;
  243. set_print_ip_opts(&evsel->attr);
  244. }
  245. /*
  246. * set default for tracepoints to print symbols only
  247. * if callchains are present
  248. */
  249. if (symbol_conf.use_callchain &&
  250. !output[PERF_TYPE_TRACEPOINT].user_set) {
  251. struct perf_event_attr *attr;
  252. j = PERF_TYPE_TRACEPOINT;
  253. evsel = perf_session__find_first_evtype(session, j);
  254. if (evsel == NULL)
  255. goto out;
  256. attr = &evsel->attr;
  257. if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
  258. output[j].fields |= PERF_OUTPUT_IP;
  259. output[j].fields |= PERF_OUTPUT_SYM;
  260. output[j].fields |= PERF_OUTPUT_DSO;
  261. set_print_ip_opts(attr);
  262. }
  263. }
  264. out:
  265. return 0;
  266. }
  267. static void print_sample_start(struct perf_sample *sample,
  268. struct thread *thread,
  269. struct perf_evsel *evsel)
  270. {
  271. struct perf_event_attr *attr = &evsel->attr;
  272. unsigned long secs;
  273. unsigned long usecs;
  274. unsigned long long nsecs;
  275. if (PRINT_FIELD(COMM)) {
  276. if (latency_format)
  277. printf("%8.8s ", thread__comm_str(thread));
  278. else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
  279. printf("%s ", thread__comm_str(thread));
  280. else
  281. printf("%16s ", thread__comm_str(thread));
  282. }
  283. if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
  284. printf("%5d/%-5d ", sample->pid, sample->tid);
  285. else if (PRINT_FIELD(PID))
  286. printf("%5d ", sample->pid);
  287. else if (PRINT_FIELD(TID))
  288. printf("%5d ", sample->tid);
  289. if (PRINT_FIELD(CPU)) {
  290. if (latency_format)
  291. printf("%3d ", sample->cpu);
  292. else
  293. printf("[%03d] ", sample->cpu);
  294. }
  295. if (PRINT_FIELD(TIME)) {
  296. nsecs = sample->time;
  297. secs = nsecs / NSECS_PER_SEC;
  298. nsecs -= secs * NSECS_PER_SEC;
  299. usecs = nsecs / NSECS_PER_USEC;
  300. printf("%5lu.%06lu: ", secs, usecs);
  301. }
  302. }
  303. static bool is_bts_event(struct perf_event_attr *attr)
  304. {
  305. return ((attr->type == PERF_TYPE_HARDWARE) &&
  306. (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
  307. (attr->sample_period == 1));
  308. }
  309. static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
  310. {
  311. if ((attr->type == PERF_TYPE_SOFTWARE) &&
  312. ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
  313. (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
  314. (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
  315. return true;
  316. if (is_bts_event(attr))
  317. return true;
  318. return false;
  319. }
  320. static void print_sample_addr(union perf_event *event,
  321. struct perf_sample *sample,
  322. struct machine *machine,
  323. struct thread *thread,
  324. struct perf_event_attr *attr)
  325. {
  326. struct addr_location al;
  327. u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
  328. printf("%16" PRIx64, sample->addr);
  329. if (!sample_addr_correlates_sym(attr))
  330. return;
  331. thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
  332. sample->addr, &al);
  333. if (!al.map)
  334. thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
  335. sample->addr, &al);
  336. al.cpu = sample->cpu;
  337. al.sym = NULL;
  338. if (al.map)
  339. al.sym = map__find_symbol(al.map, al.addr, NULL);
  340. if (PRINT_FIELD(SYM)) {
  341. printf(" ");
  342. if (PRINT_FIELD(SYMOFFSET))
  343. symbol__fprintf_symname_offs(al.sym, &al, stdout);
  344. else
  345. symbol__fprintf_symname(al.sym, stdout);
  346. }
  347. if (PRINT_FIELD(DSO)) {
  348. printf(" (");
  349. map__fprintf_dsoname(al.map, stdout);
  350. printf(")");
  351. }
  352. }
  353. static void print_sample_bts(union perf_event *event,
  354. struct perf_sample *sample,
  355. struct perf_evsel *evsel,
  356. struct thread *thread,
  357. struct addr_location *al)
  358. {
  359. struct perf_event_attr *attr = &evsel->attr;
  360. bool print_srcline_last = false;
  361. /* print branch_from information */
  362. if (PRINT_FIELD(IP)) {
  363. unsigned int print_opts = output[attr->type].print_ip_opts;
  364. if (symbol_conf.use_callchain && sample->callchain) {
  365. printf("\n");
  366. } else {
  367. printf(" ");
  368. if (print_opts & PRINT_IP_OPT_SRCLINE) {
  369. print_srcline_last = true;
  370. print_opts &= ~PRINT_IP_OPT_SRCLINE;
  371. }
  372. }
  373. perf_evsel__print_ip(evsel, sample, al, print_opts,
  374. PERF_MAX_STACK_DEPTH);
  375. }
  376. printf(" => ");
  377. /* print branch_to information */
  378. if (PRINT_FIELD(ADDR) ||
  379. ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
  380. !output[attr->type].user_set))
  381. print_sample_addr(event, sample, al->machine, thread, attr);
  382. if (print_srcline_last)
  383. map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
  384. printf("\n");
  385. }
  386. static void process_event(union perf_event *event, struct perf_sample *sample,
  387. struct perf_evsel *evsel, struct thread *thread,
  388. struct addr_location *al)
  389. {
  390. struct perf_event_attr *attr = &evsel->attr;
  391. if (output[attr->type].fields == 0)
  392. return;
  393. print_sample_start(sample, thread, evsel);
  394. if (PRINT_FIELD(EVNAME)) {
  395. const char *evname = perf_evsel__name(evsel);
  396. printf("%s: ", evname ? evname : "[unknown]");
  397. }
  398. if (is_bts_event(attr)) {
  399. print_sample_bts(event, sample, evsel, thread, al);
  400. return;
  401. }
  402. if (PRINT_FIELD(TRACE))
  403. event_format__print(evsel->tp_format, sample->cpu,
  404. sample->raw_data, sample->raw_size);
  405. if (PRINT_FIELD(ADDR))
  406. print_sample_addr(event, sample, al->machine, thread, attr);
  407. if (PRINT_FIELD(IP)) {
  408. if (!symbol_conf.use_callchain)
  409. printf(" ");
  410. else
  411. printf("\n");
  412. perf_evsel__print_ip(evsel, sample, al,
  413. output[attr->type].print_ip_opts,
  414. PERF_MAX_STACK_DEPTH);
  415. }
  416. printf("\n");
  417. }
  418. static int default_start_script(const char *script __maybe_unused,
  419. int argc __maybe_unused,
  420. const char **argv __maybe_unused)
  421. {
  422. return 0;
  423. }
  424. static int default_stop_script(void)
  425. {
  426. return 0;
  427. }
  428. static int default_generate_script(struct pevent *pevent __maybe_unused,
  429. const char *outfile __maybe_unused)
  430. {
  431. return 0;
  432. }
  433. static struct scripting_ops default_scripting_ops = {
  434. .start_script = default_start_script,
  435. .stop_script = default_stop_script,
  436. .process_event = process_event,
  437. .generate_script = default_generate_script,
  438. };
  439. static struct scripting_ops *scripting_ops;
  440. static void setup_scripting(void)
  441. {
  442. setup_perl_scripting();
  443. setup_python_scripting();
  444. scripting_ops = &default_scripting_ops;
  445. }
  446. static int cleanup_scripting(void)
  447. {
  448. pr_debug("\nperf script stopped\n");
  449. return scripting_ops->stop_script();
  450. }
  451. static int process_sample_event(struct perf_tool *tool __maybe_unused,
  452. union perf_event *event,
  453. struct perf_sample *sample,
  454. struct perf_evsel *evsel,
  455. struct machine *machine)
  456. {
  457. struct addr_location al;
  458. struct thread *thread = machine__findnew_thread(machine, sample->pid,
  459. sample->tid);
  460. if (thread == NULL) {
  461. pr_debug("problem processing %d event, skipping it.\n",
  462. event->header.type);
  463. return -1;
  464. }
  465. if (debug_mode) {
  466. if (sample->time < last_timestamp) {
  467. pr_err("Samples misordered, previous: %" PRIu64
  468. " this: %" PRIu64 "\n", last_timestamp,
  469. sample->time);
  470. nr_unordered++;
  471. }
  472. last_timestamp = sample->time;
  473. return 0;
  474. }
  475. if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
  476. pr_err("problem processing %d event, skipping it.\n",
  477. event->header.type);
  478. return -1;
  479. }
  480. if (al.filtered)
  481. return 0;
  482. if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
  483. return 0;
  484. scripting_ops->process_event(event, sample, evsel, thread, &al);
  485. evsel->hists.stats.total_period += sample->period;
  486. return 0;
  487. }
  488. struct perf_script {
  489. struct perf_tool tool;
  490. struct perf_session *session;
  491. bool show_task_events;
  492. bool show_mmap_events;
  493. };
  494. static int process_attr(struct perf_tool *tool, union perf_event *event,
  495. struct perf_evlist **pevlist)
  496. {
  497. struct perf_script *scr = container_of(tool, struct perf_script, tool);
  498. struct perf_evlist *evlist;
  499. struct perf_evsel *evsel, *pos;
  500. int err;
  501. err = perf_event__process_attr(tool, event, pevlist);
  502. if (err)
  503. return err;
  504. evlist = *pevlist;
  505. evsel = perf_evlist__last(*pevlist);
  506. if (evsel->attr.type >= PERF_TYPE_MAX)
  507. return 0;
  508. evlist__for_each(evlist, pos) {
  509. if (pos->attr.type == evsel->attr.type && pos != evsel)
  510. return 0;
  511. }
  512. set_print_ip_opts(&evsel->attr);
  513. return perf_evsel__check_attr(evsel, scr->session);
  514. }
  515. static int process_comm_event(struct perf_tool *tool,
  516. union perf_event *event,
  517. struct perf_sample *sample,
  518. struct machine *machine)
  519. {
  520. struct thread *thread;
  521. struct perf_script *script = container_of(tool, struct perf_script, tool);
  522. struct perf_session *session = script->session;
  523. struct perf_evsel *evsel = perf_evlist__first(session->evlist);
  524. int ret = -1;
  525. thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
  526. if (thread == NULL) {
  527. pr_debug("problem processing COMM event, skipping it.\n");
  528. return -1;
  529. }
  530. if (perf_event__process_comm(tool, event, sample, machine) < 0)
  531. goto out;
  532. if (!evsel->attr.sample_id_all) {
  533. sample->cpu = 0;
  534. sample->time = 0;
  535. sample->tid = event->comm.tid;
  536. sample->pid = event->comm.pid;
  537. }
  538. print_sample_start(sample, thread, evsel);
  539. perf_event__fprintf(event, stdout);
  540. ret = 0;
  541. out:
  542. return ret;
  543. }
  544. static int process_fork_event(struct perf_tool *tool,
  545. union perf_event *event,
  546. struct perf_sample *sample,
  547. struct machine *machine)
  548. {
  549. struct thread *thread;
  550. struct perf_script *script = container_of(tool, struct perf_script, tool);
  551. struct perf_session *session = script->session;
  552. struct perf_evsel *evsel = perf_evlist__first(session->evlist);
  553. if (perf_event__process_fork(tool, event, sample, machine) < 0)
  554. return -1;
  555. thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
  556. if (thread == NULL) {
  557. pr_debug("problem processing FORK event, skipping it.\n");
  558. return -1;
  559. }
  560. if (!evsel->attr.sample_id_all) {
  561. sample->cpu = 0;
  562. sample->time = event->fork.time;
  563. sample->tid = event->fork.tid;
  564. sample->pid = event->fork.pid;
  565. }
  566. print_sample_start(sample, thread, evsel);
  567. perf_event__fprintf(event, stdout);
  568. return 0;
  569. }
  570. static int process_exit_event(struct perf_tool *tool,
  571. union perf_event *event,
  572. struct perf_sample *sample,
  573. struct machine *machine)
  574. {
  575. struct thread *thread;
  576. struct perf_script *script = container_of(tool, struct perf_script, tool);
  577. struct perf_session *session = script->session;
  578. struct perf_evsel *evsel = perf_evlist__first(session->evlist);
  579. thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
  580. if (thread == NULL) {
  581. pr_debug("problem processing EXIT event, skipping it.\n");
  582. return -1;
  583. }
  584. if (!evsel->attr.sample_id_all) {
  585. sample->cpu = 0;
  586. sample->time = 0;
  587. sample->tid = event->comm.tid;
  588. sample->pid = event->comm.pid;
  589. }
  590. print_sample_start(sample, thread, evsel);
  591. perf_event__fprintf(event, stdout);
  592. if (perf_event__process_exit(tool, event, sample, machine) < 0)
  593. return -1;
  594. return 0;
  595. }
  596. static int process_mmap_event(struct perf_tool *tool,
  597. union perf_event *event,
  598. struct perf_sample *sample,
  599. struct machine *machine)
  600. {
  601. struct thread *thread;
  602. struct perf_script *script = container_of(tool, struct perf_script, tool);
  603. struct perf_session *session = script->session;
  604. struct perf_evsel *evsel = perf_evlist__first(session->evlist);
  605. if (perf_event__process_mmap(tool, event, sample, machine) < 0)
  606. return -1;
  607. thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
  608. if (thread == NULL) {
  609. pr_debug("problem processing MMAP event, skipping it.\n");
  610. return -1;
  611. }
  612. if (!evsel->attr.sample_id_all) {
  613. sample->cpu = 0;
  614. sample->time = 0;
  615. sample->tid = event->mmap.tid;
  616. sample->pid = event->mmap.pid;
  617. }
  618. print_sample_start(sample, thread, evsel);
  619. perf_event__fprintf(event, stdout);
  620. return 0;
  621. }
  622. static int process_mmap2_event(struct perf_tool *tool,
  623. union perf_event *event,
  624. struct perf_sample *sample,
  625. struct machine *machine)
  626. {
  627. struct thread *thread;
  628. struct perf_script *script = container_of(tool, struct perf_script, tool);
  629. struct perf_session *session = script->session;
  630. struct perf_evsel *evsel = perf_evlist__first(session->evlist);
  631. if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
  632. return -1;
  633. thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
  634. if (thread == NULL) {
  635. pr_debug("problem processing MMAP2 event, skipping it.\n");
  636. return -1;
  637. }
  638. if (!evsel->attr.sample_id_all) {
  639. sample->cpu = 0;
  640. sample->time = 0;
  641. sample->tid = event->mmap2.tid;
  642. sample->pid = event->mmap2.pid;
  643. }
  644. print_sample_start(sample, thread, evsel);
  645. perf_event__fprintf(event, stdout);
  646. return 0;
  647. }
  648. static void sig_handler(int sig __maybe_unused)
  649. {
  650. session_done = 1;
  651. }
  652. static int __cmd_script(struct perf_script *script)
  653. {
  654. int ret;
  655. signal(SIGINT, sig_handler);
  656. /* override event processing functions */
  657. if (script->show_task_events) {
  658. script->tool.comm = process_comm_event;
  659. script->tool.fork = process_fork_event;
  660. script->tool.exit = process_exit_event;
  661. }
  662. if (script->show_mmap_events) {
  663. script->tool.mmap = process_mmap_event;
  664. script->tool.mmap2 = process_mmap2_event;
  665. }
  666. ret = perf_session__process_events(script->session, &script->tool);
  667. if (debug_mode)
  668. pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
  669. return ret;
  670. }
  671. struct script_spec {
  672. struct list_head node;
  673. struct scripting_ops *ops;
  674. char spec[0];
  675. };
  676. static LIST_HEAD(script_specs);
  677. static struct script_spec *script_spec__new(const char *spec,
  678. struct scripting_ops *ops)
  679. {
  680. struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
  681. if (s != NULL) {
  682. strcpy(s->spec, spec);
  683. s->ops = ops;
  684. }
  685. return s;
  686. }
  687. static void script_spec__add(struct script_spec *s)
  688. {
  689. list_add_tail(&s->node, &script_specs);
  690. }
  691. static struct script_spec *script_spec__find(const char *spec)
  692. {
  693. struct script_spec *s;
  694. list_for_each_entry(s, &script_specs, node)
  695. if (strcasecmp(s->spec, spec) == 0)
  696. return s;
  697. return NULL;
  698. }
  699. static struct script_spec *script_spec__findnew(const char *spec,
  700. struct scripting_ops *ops)
  701. {
  702. struct script_spec *s = script_spec__find(spec);
  703. if (s)
  704. return s;
  705. s = script_spec__new(spec, ops);
  706. if (!s)
  707. return NULL;
  708. script_spec__add(s);
  709. return s;
  710. }
  711. int script_spec_register(const char *spec, struct scripting_ops *ops)
  712. {
  713. struct script_spec *s;
  714. s = script_spec__find(spec);
  715. if (s)
  716. return -1;
  717. s = script_spec__findnew(spec, ops);
  718. if (!s)
  719. return -1;
  720. return 0;
  721. }
  722. static struct scripting_ops *script_spec__lookup(const char *spec)
  723. {
  724. struct script_spec *s = script_spec__find(spec);
  725. if (!s)
  726. return NULL;
  727. return s->ops;
  728. }
  729. static void list_available_languages(void)
  730. {
  731. struct script_spec *s;
  732. fprintf(stderr, "\n");
  733. fprintf(stderr, "Scripting language extensions (used in "
  734. "perf script -s [spec:]script.[spec]):\n\n");
  735. list_for_each_entry(s, &script_specs, node)
  736. fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
  737. fprintf(stderr, "\n");
  738. }
  739. static int parse_scriptname(const struct option *opt __maybe_unused,
  740. const char *str, int unset __maybe_unused)
  741. {
  742. char spec[PATH_MAX];
  743. const char *script, *ext;
  744. int len;
  745. if (strcmp(str, "lang") == 0) {
  746. list_available_languages();
  747. exit(0);
  748. }
  749. script = strchr(str, ':');
  750. if (script) {
  751. len = script - str;
  752. if (len >= PATH_MAX) {
  753. fprintf(stderr, "invalid language specifier");
  754. return -1;
  755. }
  756. strncpy(spec, str, len);
  757. spec[len] = '\0';
  758. scripting_ops = script_spec__lookup(spec);
  759. if (!scripting_ops) {
  760. fprintf(stderr, "invalid language specifier");
  761. return -1;
  762. }
  763. script++;
  764. } else {
  765. script = str;
  766. ext = strrchr(script, '.');
  767. if (!ext) {
  768. fprintf(stderr, "invalid script extension");
  769. return -1;
  770. }
  771. scripting_ops = script_spec__lookup(++ext);
  772. if (!scripting_ops) {
  773. fprintf(stderr, "invalid script extension");
  774. return -1;
  775. }
  776. }
  777. script_name = strdup(script);
  778. return 0;
  779. }
  780. static int parse_output_fields(const struct option *opt __maybe_unused,
  781. const char *arg, int unset __maybe_unused)
  782. {
  783. char *tok;
  784. int i, imax = ARRAY_SIZE(all_output_options);
  785. int j;
  786. int rc = 0;
  787. char *str = strdup(arg);
  788. int type = -1;
  789. if (!str)
  790. return -ENOMEM;
  791. /* first word can state for which event type the user is specifying
  792. * the fields. If no type exists, the specified fields apply to all
  793. * event types found in the file minus the invalid fields for a type.
  794. */
  795. tok = strchr(str, ':');
  796. if (tok) {
  797. *tok = '\0';
  798. tok++;
  799. if (!strcmp(str, "hw"))
  800. type = PERF_TYPE_HARDWARE;
  801. else if (!strcmp(str, "sw"))
  802. type = PERF_TYPE_SOFTWARE;
  803. else if (!strcmp(str, "trace"))
  804. type = PERF_TYPE_TRACEPOINT;
  805. else if (!strcmp(str, "raw"))
  806. type = PERF_TYPE_RAW;
  807. else {
  808. fprintf(stderr, "Invalid event type in field string.\n");
  809. rc = -EINVAL;
  810. goto out;
  811. }
  812. if (output[type].user_set)
  813. pr_warning("Overriding previous field request for %s events.\n",
  814. event_type(type));
  815. output[type].fields = 0;
  816. output[type].user_set = true;
  817. output[type].wildcard_set = false;
  818. } else {
  819. tok = str;
  820. if (strlen(str) == 0) {
  821. fprintf(stderr,
  822. "Cannot set fields to 'none' for all event types.\n");
  823. rc = -EINVAL;
  824. goto out;
  825. }
  826. if (output_set_by_user())
  827. pr_warning("Overriding previous field request for all events.\n");
  828. for (j = 0; j < PERF_TYPE_MAX; ++j) {
  829. output[j].fields = 0;
  830. output[j].user_set = true;
  831. output[j].wildcard_set = true;
  832. }
  833. }
  834. tok = strtok(tok, ",");
  835. while (tok) {
  836. for (i = 0; i < imax; ++i) {
  837. if (strcmp(tok, all_output_options[i].str) == 0)
  838. break;
  839. }
  840. if (i == imax) {
  841. fprintf(stderr, "Invalid field requested.\n");
  842. rc = -EINVAL;
  843. goto out;
  844. }
  845. if (type == -1) {
  846. /* add user option to all events types for
  847. * which it is valid
  848. */
  849. for (j = 0; j < PERF_TYPE_MAX; ++j) {
  850. if (output[j].invalid_fields & all_output_options[i].field) {
  851. pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
  852. all_output_options[i].str, event_type(j));
  853. } else
  854. output[j].fields |= all_output_options[i].field;
  855. }
  856. } else {
  857. if (output[type].invalid_fields & all_output_options[i].field) {
  858. fprintf(stderr, "\'%s\' not valid for %s events.\n",
  859. all_output_options[i].str, event_type(type));
  860. rc = -EINVAL;
  861. goto out;
  862. }
  863. output[type].fields |= all_output_options[i].field;
  864. }
  865. tok = strtok(NULL, ",");
  866. }
  867. if (type >= 0) {
  868. if (output[type].fields == 0) {
  869. pr_debug("No fields requested for %s type. "
  870. "Events will not be displayed.\n", event_type(type));
  871. }
  872. }
  873. out:
  874. free(str);
  875. return rc;
  876. }
  877. /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
  878. static int is_directory(const char *base_path, const struct dirent *dent)
  879. {
  880. char path[PATH_MAX];
  881. struct stat st;
  882. sprintf(path, "%s/%s", base_path, dent->d_name);
  883. if (stat(path, &st))
  884. return 0;
  885. return S_ISDIR(st.st_mode);
  886. }
  887. #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
  888. while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
  889. lang_next) \
  890. if ((lang_dirent.d_type == DT_DIR || \
  891. (lang_dirent.d_type == DT_UNKNOWN && \
  892. is_directory(scripts_path, &lang_dirent))) && \
  893. (strcmp(lang_dirent.d_name, ".")) && \
  894. (strcmp(lang_dirent.d_name, "..")))
  895. #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
  896. while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
  897. script_next) \
  898. if (script_dirent.d_type != DT_DIR && \
  899. (script_dirent.d_type != DT_UNKNOWN || \
  900. !is_directory(lang_path, &script_dirent)))
  901. #define RECORD_SUFFIX "-record"
  902. #define REPORT_SUFFIX "-report"
  903. struct script_desc {
  904. struct list_head node;
  905. char *name;
  906. char *half_liner;
  907. char *args;
  908. };
  909. static LIST_HEAD(script_descs);
  910. static struct script_desc *script_desc__new(const char *name)
  911. {
  912. struct script_desc *s = zalloc(sizeof(*s));
  913. if (s != NULL && name)
  914. s->name = strdup(name);
  915. return s;
  916. }
  917. static void script_desc__delete(struct script_desc *s)
  918. {
  919. zfree(&s->name);
  920. zfree(&s->half_liner);
  921. zfree(&s->args);
  922. free(s);
  923. }
  924. static void script_desc__add(struct script_desc *s)
  925. {
  926. list_add_tail(&s->node, &script_descs);
  927. }
  928. static struct script_desc *script_desc__find(const char *name)
  929. {
  930. struct script_desc *s;
  931. list_for_each_entry(s, &script_descs, node)
  932. if (strcasecmp(s->name, name) == 0)
  933. return s;
  934. return NULL;
  935. }
  936. static struct script_desc *script_desc__findnew(const char *name)
  937. {
  938. struct script_desc *s = script_desc__find(name);
  939. if (s)
  940. return s;
  941. s = script_desc__new(name);
  942. if (!s)
  943. goto out_delete_desc;
  944. script_desc__add(s);
  945. return s;
  946. out_delete_desc:
  947. script_desc__delete(s);
  948. return NULL;
  949. }
  950. static const char *ends_with(const char *str, const char *suffix)
  951. {
  952. size_t suffix_len = strlen(suffix);
  953. const char *p = str;
  954. if (strlen(str) > suffix_len) {
  955. p = str + strlen(str) - suffix_len;
  956. if (!strncmp(p, suffix, suffix_len))
  957. return p;
  958. }
  959. return NULL;
  960. }
  961. static int read_script_info(struct script_desc *desc, const char *filename)
  962. {
  963. char line[BUFSIZ], *p;
  964. FILE *fp;
  965. fp = fopen(filename, "r");
  966. if (!fp)
  967. return -1;
  968. while (fgets(line, sizeof(line), fp)) {
  969. p = ltrim(line);
  970. if (strlen(p) == 0)
  971. continue;
  972. if (*p != '#')
  973. continue;
  974. p++;
  975. if (strlen(p) && *p == '!')
  976. continue;
  977. p = ltrim(p);
  978. if (strlen(p) && p[strlen(p) - 1] == '\n')
  979. p[strlen(p) - 1] = '\0';
  980. if (!strncmp(p, "description:", strlen("description:"))) {
  981. p += strlen("description:");
  982. desc->half_liner = strdup(ltrim(p));
  983. continue;
  984. }
  985. if (!strncmp(p, "args:", strlen("args:"))) {
  986. p += strlen("args:");
  987. desc->args = strdup(ltrim(p));
  988. continue;
  989. }
  990. }
  991. fclose(fp);
  992. return 0;
  993. }
  994. static char *get_script_root(struct dirent *script_dirent, const char *suffix)
  995. {
  996. char *script_root, *str;
  997. script_root = strdup(script_dirent->d_name);
  998. if (!script_root)
  999. return NULL;
  1000. str = (char *)ends_with(script_root, suffix);
  1001. if (!str) {
  1002. free(script_root);
  1003. return NULL;
  1004. }
  1005. *str = '\0';
  1006. return script_root;
  1007. }
  1008. static int list_available_scripts(const struct option *opt __maybe_unused,
  1009. const char *s __maybe_unused,
  1010. int unset __maybe_unused)
  1011. {
  1012. struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
  1013. char scripts_path[MAXPATHLEN];
  1014. DIR *scripts_dir, *lang_dir;
  1015. char script_path[MAXPATHLEN];
  1016. char lang_path[MAXPATHLEN];
  1017. struct script_desc *desc;
  1018. char first_half[BUFSIZ];
  1019. char *script_root;
  1020. snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
  1021. scripts_dir = opendir(scripts_path);
  1022. if (!scripts_dir)
  1023. return -1;
  1024. for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
  1025. snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
  1026. lang_dirent.d_name);
  1027. lang_dir = opendir(lang_path);
  1028. if (!lang_dir)
  1029. continue;
  1030. for_each_script(lang_path, lang_dir, script_dirent, script_next) {
  1031. script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
  1032. if (script_root) {
  1033. desc = script_desc__findnew(script_root);
  1034. snprintf(script_path, MAXPATHLEN, "%s/%s",
  1035. lang_path, script_dirent.d_name);
  1036. read_script_info(desc, script_path);
  1037. free(script_root);
  1038. }
  1039. }
  1040. }
  1041. fprintf(stdout, "List of available trace scripts:\n");
  1042. list_for_each_entry(desc, &script_descs, node) {
  1043. sprintf(first_half, "%s %s", desc->name,
  1044. desc->args ? desc->args : "");
  1045. fprintf(stdout, " %-36s %s\n", first_half,
  1046. desc->half_liner ? desc->half_liner : "");
  1047. }
  1048. exit(0);
  1049. }
  1050. /*
  1051. * Some scripts specify the required events in their "xxx-record" file,
  1052. * this function will check if the events in perf.data match those
  1053. * mentioned in the "xxx-record".
  1054. *
  1055. * Fixme: All existing "xxx-record" are all in good formats "-e event ",
  1056. * which is covered well now. And new parsing code should be added to
  1057. * cover the future complexing formats like event groups etc.
  1058. */
  1059. static int check_ev_match(char *dir_name, char *scriptname,
  1060. struct perf_session *session)
  1061. {
  1062. char filename[MAXPATHLEN], evname[128];
  1063. char line[BUFSIZ], *p;
  1064. struct perf_evsel *pos;
  1065. int match, len;
  1066. FILE *fp;
  1067. sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
  1068. fp = fopen(filename, "r");
  1069. if (!fp)
  1070. return -1;
  1071. while (fgets(line, sizeof(line), fp)) {
  1072. p = ltrim(line);
  1073. if (*p == '#')
  1074. continue;
  1075. while (strlen(p)) {
  1076. p = strstr(p, "-e");
  1077. if (!p)
  1078. break;
  1079. p += 2;
  1080. p = ltrim(p);
  1081. len = strcspn(p, " \t");
  1082. if (!len)
  1083. break;
  1084. snprintf(evname, len + 1, "%s", p);
  1085. match = 0;
  1086. evlist__for_each(session->evlist, pos) {
  1087. if (!strcmp(perf_evsel__name(pos), evname)) {
  1088. match = 1;
  1089. break;
  1090. }
  1091. }
  1092. if (!match) {
  1093. fclose(fp);
  1094. return -1;
  1095. }
  1096. }
  1097. }
  1098. fclose(fp);
  1099. return 0;
  1100. }
  1101. /*
  1102. * Return -1 if none is found, otherwise the actual scripts number.
  1103. *
  1104. * Currently the only user of this function is the script browser, which
  1105. * will list all statically runnable scripts, select one, execute it and
  1106. * show the output in a perf browser.
  1107. */
  1108. int find_scripts(char **scripts_array, char **scripts_path_array)
  1109. {
  1110. struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
  1111. char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
  1112. DIR *scripts_dir, *lang_dir;
  1113. struct perf_session *session;
  1114. struct perf_data_file file = {
  1115. .path = input_name,
  1116. .mode = PERF_DATA_MODE_READ,
  1117. };
  1118. char *temp;
  1119. int i = 0;
  1120. session = perf_session__new(&file, false, NULL);
  1121. if (!session)
  1122. return -1;
  1123. snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
  1124. scripts_dir = opendir(scripts_path);
  1125. if (!scripts_dir) {
  1126. perf_session__delete(session);
  1127. return -1;
  1128. }
  1129. for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
  1130. snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
  1131. lang_dirent.d_name);
  1132. #ifdef NO_LIBPERL
  1133. if (strstr(lang_path, "perl"))
  1134. continue;
  1135. #endif
  1136. #ifdef NO_LIBPYTHON
  1137. if (strstr(lang_path, "python"))
  1138. continue;
  1139. #endif
  1140. lang_dir = opendir(lang_path);
  1141. if (!lang_dir)
  1142. continue;
  1143. for_each_script(lang_path, lang_dir, script_dirent, script_next) {
  1144. /* Skip those real time scripts: xxxtop.p[yl] */
  1145. if (strstr(script_dirent.d_name, "top."))
  1146. continue;
  1147. sprintf(scripts_path_array[i], "%s/%s", lang_path,
  1148. script_dirent.d_name);
  1149. temp = strchr(script_dirent.d_name, '.');
  1150. snprintf(scripts_array[i],
  1151. (temp - script_dirent.d_name) + 1,
  1152. "%s", script_dirent.d_name);
  1153. if (check_ev_match(lang_path,
  1154. scripts_array[i], session))
  1155. continue;
  1156. i++;
  1157. }
  1158. closedir(lang_dir);
  1159. }
  1160. closedir(scripts_dir);
  1161. perf_session__delete(session);
  1162. return i;
  1163. }
  1164. static char *get_script_path(const char *script_root, const char *suffix)
  1165. {
  1166. struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
  1167. char scripts_path[MAXPATHLEN];
  1168. char script_path[MAXPATHLEN];
  1169. DIR *scripts_dir, *lang_dir;
  1170. char lang_path[MAXPATHLEN];
  1171. char *__script_root;
  1172. snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
  1173. scripts_dir = opendir(scripts_path);
  1174. if (!scripts_dir)
  1175. return NULL;
  1176. for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
  1177. snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
  1178. lang_dirent.d_name);
  1179. lang_dir = opendir(lang_path);
  1180. if (!lang_dir)
  1181. continue;
  1182. for_each_script(lang_path, lang_dir, script_dirent, script_next) {
  1183. __script_root = get_script_root(&script_dirent, suffix);
  1184. if (__script_root && !strcmp(script_root, __script_root)) {
  1185. free(__script_root);
  1186. closedir(lang_dir);
  1187. closedir(scripts_dir);
  1188. snprintf(script_path, MAXPATHLEN, "%s/%s",
  1189. lang_path, script_dirent.d_name);
  1190. return strdup(script_path);
  1191. }
  1192. free(__script_root);
  1193. }
  1194. closedir(lang_dir);
  1195. }
  1196. closedir(scripts_dir);
  1197. return NULL;
  1198. }
  1199. static bool is_top_script(const char *script_path)
  1200. {
  1201. return ends_with(script_path, "top") == NULL ? false : true;
  1202. }
  1203. static int has_required_arg(char *script_path)
  1204. {
  1205. struct script_desc *desc;
  1206. int n_args = 0;
  1207. char *p;
  1208. desc = script_desc__new(NULL);
  1209. if (read_script_info(desc, script_path))
  1210. goto out;
  1211. if (!desc->args)
  1212. goto out;
  1213. for (p = desc->args; *p; p++)
  1214. if (*p == '<')
  1215. n_args++;
  1216. out:
  1217. script_desc__delete(desc);
  1218. return n_args;
  1219. }
  1220. static int have_cmd(int argc, const char **argv)
  1221. {
  1222. char **__argv = malloc(sizeof(const char *) * argc);
  1223. if (!__argv) {
  1224. pr_err("malloc failed\n");
  1225. return -1;
  1226. }
  1227. memcpy(__argv, argv, sizeof(const char *) * argc);
  1228. argc = parse_options(argc, (const char **)__argv, record_options,
  1229. NULL, PARSE_OPT_STOP_AT_NON_OPTION);
  1230. free(__argv);
  1231. system_wide = (argc == 0);
  1232. return 0;
  1233. }
  1234. int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
  1235. {
  1236. bool show_full_info = false;
  1237. bool header = false;
  1238. bool header_only = false;
  1239. char *rec_script_path = NULL;
  1240. char *rep_script_path = NULL;
  1241. struct perf_session *session;
  1242. char *script_path = NULL;
  1243. const char **__argv;
  1244. int i, j, err;
  1245. struct perf_script script = {
  1246. .tool = {
  1247. .sample = process_sample_event,
  1248. .mmap = perf_event__process_mmap,
  1249. .mmap2 = perf_event__process_mmap2,
  1250. .comm = perf_event__process_comm,
  1251. .exit = perf_event__process_exit,
  1252. .fork = perf_event__process_fork,
  1253. .attr = process_attr,
  1254. .tracing_data = perf_event__process_tracing_data,
  1255. .build_id = perf_event__process_build_id,
  1256. .ordered_samples = true,
  1257. .ordering_requires_timestamps = true,
  1258. },
  1259. };
  1260. const struct option options[] = {
  1261. OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
  1262. "dump raw trace in ASCII"),
  1263. OPT_INCR('v', "verbose", &verbose,
  1264. "be more verbose (show symbol address, etc)"),
  1265. OPT_BOOLEAN('L', "Latency", &latency_format,
  1266. "show latency attributes (irqs/preemption disabled, etc)"),
  1267. OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
  1268. list_available_scripts),
  1269. OPT_CALLBACK('s', "script", NULL, "name",
  1270. "script file name (lang:script name, script name, or *)",
  1271. parse_scriptname),
  1272. OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
  1273. "generate perf-script.xx script in specified language"),
  1274. OPT_STRING('i', "input", &input_name, "file", "input file name"),
  1275. OPT_BOOLEAN('d', "debug-mode", &debug_mode,
  1276. "do various checks like samples ordering and lost events"),
  1277. OPT_BOOLEAN(0, "header", &header, "Show data header."),
  1278. OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
  1279. OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
  1280. "file", "vmlinux pathname"),
  1281. OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
  1282. "file", "kallsyms pathname"),
  1283. OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
  1284. "When printing symbols do not display call chain"),
  1285. OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
  1286. "Look for files with symbols relative to this directory"),
  1287. OPT_CALLBACK('f', "fields", NULL, "str",
  1288. "comma separated output fields prepend with 'type:'. "
  1289. "Valid types: hw,sw,trace,raw. "
  1290. "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
  1291. "addr,symoff", parse_output_fields),
  1292. OPT_BOOLEAN('a', "all-cpus", &system_wide,
  1293. "system-wide collection from all CPUs"),
  1294. OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
  1295. "only consider these symbols"),
  1296. OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
  1297. OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
  1298. "only display events for these comms"),
  1299. OPT_BOOLEAN('I', "show-info", &show_full_info,
  1300. "display extended information from perf.data file"),
  1301. OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
  1302. "Show the path of [kernel.kallsyms]"),
  1303. OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
  1304. "Show the fork/comm/exit events"),
  1305. OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
  1306. "Show the mmap events"),
  1307. OPT_END()
  1308. };
  1309. const char * const script_usage[] = {
  1310. "perf script [<options>]",
  1311. "perf script [<options>] record <script> [<record-options>] <command>",
  1312. "perf script [<options>] report <script> [script-args]",
  1313. "perf script [<options>] <script> [<record-options>] <command>",
  1314. "perf script [<options>] <top-script> [script-args]",
  1315. NULL
  1316. };
  1317. struct perf_data_file file = {
  1318. .mode = PERF_DATA_MODE_READ,
  1319. };
  1320. setup_scripting();
  1321. argc = parse_options(argc, argv, options, script_usage,
  1322. PARSE_OPT_STOP_AT_NON_OPTION);
  1323. file.path = input_name;
  1324. if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
  1325. rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
  1326. if (!rec_script_path)
  1327. return cmd_record(argc, argv, NULL);
  1328. }
  1329. if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
  1330. rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
  1331. if (!rep_script_path) {
  1332. fprintf(stderr,
  1333. "Please specify a valid report script"
  1334. "(see 'perf script -l' for listing)\n");
  1335. return -1;
  1336. }
  1337. }
  1338. /* make sure PERF_EXEC_PATH is set for scripts */
  1339. perf_set_argv_exec_path(perf_exec_path());
  1340. if (argc && !script_name && !rec_script_path && !rep_script_path) {
  1341. int live_pipe[2];
  1342. int rep_args;
  1343. pid_t pid;
  1344. rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
  1345. rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
  1346. if (!rec_script_path && !rep_script_path) {
  1347. fprintf(stderr, " Couldn't find script %s\n\n See perf"
  1348. " script -l for available scripts.\n", argv[0]);
  1349. usage_with_options(script_usage, options);
  1350. }
  1351. if (is_top_script(argv[0])) {
  1352. rep_args = argc - 1;
  1353. } else {
  1354. int rec_args;
  1355. rep_args = has_required_arg(rep_script_path);
  1356. rec_args = (argc - 1) - rep_args;
  1357. if (rec_args < 0) {
  1358. fprintf(stderr, " %s script requires options."
  1359. "\n\n See perf script -l for available "
  1360. "scripts and options.\n", argv[0]);
  1361. usage_with_options(script_usage, options);
  1362. }
  1363. }
  1364. if (pipe(live_pipe) < 0) {
  1365. perror("failed to create pipe");
  1366. return -1;
  1367. }
  1368. pid = fork();
  1369. if (pid < 0) {
  1370. perror("failed to fork");
  1371. return -1;
  1372. }
  1373. if (!pid) {
  1374. j = 0;
  1375. dup2(live_pipe[1], 1);
  1376. close(live_pipe[0]);
  1377. if (is_top_script(argv[0])) {
  1378. system_wide = true;
  1379. } else if (!system_wide) {
  1380. if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
  1381. err = -1;
  1382. goto out;
  1383. }
  1384. }
  1385. __argv = malloc((argc + 6) * sizeof(const char *));
  1386. if (!__argv) {
  1387. pr_err("malloc failed\n");
  1388. err = -ENOMEM;
  1389. goto out;
  1390. }
  1391. __argv[j++] = "/bin/sh";
  1392. __argv[j++] = rec_script_path;
  1393. if (system_wide)
  1394. __argv[j++] = "-a";
  1395. __argv[j++] = "-q";
  1396. __argv[j++] = "-o";
  1397. __argv[j++] = "-";
  1398. for (i = rep_args + 1; i < argc; i++)
  1399. __argv[j++] = argv[i];
  1400. __argv[j++] = NULL;
  1401. execvp("/bin/sh", (char **)__argv);
  1402. free(__argv);
  1403. exit(-1);
  1404. }
  1405. dup2(live_pipe[0], 0);
  1406. close(live_pipe[1]);
  1407. __argv = malloc((argc + 4) * sizeof(const char *));
  1408. if (!__argv) {
  1409. pr_err("malloc failed\n");
  1410. err = -ENOMEM;
  1411. goto out;
  1412. }
  1413. j = 0;
  1414. __argv[j++] = "/bin/sh";
  1415. __argv[j++] = rep_script_path;
  1416. for (i = 1; i < rep_args + 1; i++)
  1417. __argv[j++] = argv[i];
  1418. __argv[j++] = "-i";
  1419. __argv[j++] = "-";
  1420. __argv[j++] = NULL;
  1421. execvp("/bin/sh", (char **)__argv);
  1422. free(__argv);
  1423. exit(-1);
  1424. }
  1425. if (rec_script_path)
  1426. script_path = rec_script_path;
  1427. if (rep_script_path)
  1428. script_path = rep_script_path;
  1429. if (script_path) {
  1430. j = 0;
  1431. if (!rec_script_path)
  1432. system_wide = false;
  1433. else if (!system_wide) {
  1434. if (have_cmd(argc - 1, &argv[1]) != 0) {
  1435. err = -1;
  1436. goto out;
  1437. }
  1438. }
  1439. __argv = malloc((argc + 2) * sizeof(const char *));
  1440. if (!__argv) {
  1441. pr_err("malloc failed\n");
  1442. err = -ENOMEM;
  1443. goto out;
  1444. }
  1445. __argv[j++] = "/bin/sh";
  1446. __argv[j++] = script_path;
  1447. if (system_wide)
  1448. __argv[j++] = "-a";
  1449. for (i = 2; i < argc; i++)
  1450. __argv[j++] = argv[i];
  1451. __argv[j++] = NULL;
  1452. execvp("/bin/sh", (char **)__argv);
  1453. free(__argv);
  1454. exit(-1);
  1455. }
  1456. if (symbol__init() < 0)
  1457. return -1;
  1458. if (!script_name)
  1459. setup_pager();
  1460. session = perf_session__new(&file, false, &script.tool);
  1461. if (session == NULL)
  1462. return -ENOMEM;
  1463. if (header || header_only) {
  1464. perf_session__fprintf_info(session, stdout, show_full_info);
  1465. if (header_only)
  1466. return 0;
  1467. }
  1468. script.session = session;
  1469. if (cpu_list) {
  1470. if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
  1471. return -1;
  1472. }
  1473. if (!no_callchain)
  1474. symbol_conf.use_callchain = true;
  1475. else
  1476. symbol_conf.use_callchain = false;
  1477. if (generate_script_lang) {
  1478. struct stat perf_stat;
  1479. int input;
  1480. if (output_set_by_user()) {
  1481. fprintf(stderr,
  1482. "custom fields not supported for generated scripts");
  1483. return -1;
  1484. }
  1485. input = open(file.path, O_RDONLY); /* input_name */
  1486. if (input < 0) {
  1487. perror("failed to open file");
  1488. return -1;
  1489. }
  1490. err = fstat(input, &perf_stat);
  1491. if (err < 0) {
  1492. perror("failed to stat file");
  1493. return -1;
  1494. }
  1495. if (!perf_stat.st_size) {
  1496. fprintf(stderr, "zero-sized file, nothing to do!\n");
  1497. return 0;
  1498. }
  1499. scripting_ops = script_spec__lookup(generate_script_lang);
  1500. if (!scripting_ops) {
  1501. fprintf(stderr, "invalid language specifier");
  1502. return -1;
  1503. }
  1504. err = scripting_ops->generate_script(session->tevent.pevent,
  1505. "perf-script");
  1506. goto out;
  1507. }
  1508. if (script_name) {
  1509. err = scripting_ops->start_script(script_name, argc, argv);
  1510. if (err)
  1511. goto out;
  1512. pr_debug("perf script started with script %s\n\n", script_name);
  1513. }
  1514. err = perf_session__check_output_opt(session);
  1515. if (err < 0)
  1516. goto out;
  1517. err = __cmd_script(&script);
  1518. perf_session__delete(session);
  1519. cleanup_scripting();
  1520. out:
  1521. return err;
  1522. }