Commit | Line | Data |
---|---|---|
07800601 IM |
1 | /* |
2 | * builtin-help.c | |
3 | * | |
4 | * Builtin help command | |
5 | */ | |
f37a291c | 6 | #include "perf.h" |
41840d21 | 7 | #include "util/config.h" |
07800601 | 8 | #include "builtin.h" |
4b6ab94e | 9 | #include <subcmd/exec-cmd.h> |
07800601 | 10 | #include "common-cmds.h" |
4b6ab94e JP |
11 | #include <subcmd/parse-options.h> |
12 | #include <subcmd/run-command.h> | |
13 | #include <subcmd/help.h> | |
84f5d36f | 14 | #include "util/debug.h" |
877a7a11 | 15 | #include <linux/kernel.h> |
07800601 IM |
16 | |
17 | static struct man_viewer_list { | |
18 | struct man_viewer_list *next; | |
7909675d | 19 | char name[0]; |
07800601 IM |
20 | } *man_viewer_list; |
21 | ||
22 | static struct man_viewer_info_list { | |
23 | struct man_viewer_info_list *next; | |
24 | const char *info; | |
7909675d | 25 | char name[0]; |
07800601 IM |
26 | } *man_viewer_info_list; |
27 | ||
28 | enum help_format { | |
cc584821 | 29 | HELP_FORMAT_NONE, |
07800601 IM |
30 | HELP_FORMAT_MAN, |
31 | HELP_FORMAT_INFO, | |
32 | HELP_FORMAT_WEB, | |
33 | }; | |
34 | ||
07800601 IM |
35 | static enum help_format parse_help_format(const char *format) |
36 | { | |
37 | if (!strcmp(format, "man")) | |
38 | return HELP_FORMAT_MAN; | |
39 | if (!strcmp(format, "info")) | |
40 | return HELP_FORMAT_INFO; | |
41 | if (!strcmp(format, "web") || !strcmp(format, "html")) | |
42 | return HELP_FORMAT_WEB; | |
cc584821 DA |
43 | |
44 | pr_err("unrecognized help format '%s'", format); | |
45 | return HELP_FORMAT_NONE; | |
07800601 IM |
46 | } |
47 | ||
48 | static const char *get_man_viewer_info(const char *name) | |
49 | { | |
50 | struct man_viewer_info_list *viewer; | |
51 | ||
c1e53017 | 52 | for (viewer = man_viewer_info_list; viewer; viewer = viewer->next) { |
07800601 IM |
53 | if (!strcasecmp(name, viewer->name)) |
54 | return viewer->info; | |
55 | } | |
56 | return NULL; | |
57 | } | |
58 | ||
59 | static int check_emacsclient_version(void) | |
60 | { | |
61 | struct strbuf buffer = STRBUF_INIT; | |
62 | struct child_process ec_process; | |
63 | const char *argv_ec[] = { "emacsclient", "--version", NULL }; | |
64 | int version; | |
b72ca403 | 65 | int ret = -1; |
07800601 IM |
66 | |
67 | /* emacsclient prints its version number on stderr */ | |
68 | memset(&ec_process, 0, sizeof(ec_process)); | |
69 | ec_process.argv = argv_ec; | |
70 | ec_process.err = -1; | |
71 | ec_process.stdout_to_stderr = 1; | |
72 | if (start_command(&ec_process)) { | |
73 | fprintf(stderr, "Failed to start emacsclient.\n"); | |
74 | return -1; | |
75 | } | |
b72ca403 MH |
76 | if (strbuf_read(&buffer, ec_process.err, 20) < 0) { |
77 | fprintf(stderr, "Failed to read emacsclient version\n"); | |
78 | goto out; | |
79 | } | |
07800601 IM |
80 | close(ec_process.err); |
81 | ||
82 | /* | |
83 | * Don't bother checking return value, because "emacsclient --version" | |
84 | * seems to always exits with code 1. | |
85 | */ | |
86 | finish_command(&ec_process); | |
87 | ||
88 | if (prefixcmp(buffer.buf, "emacsclient")) { | |
89 | fprintf(stderr, "Failed to parse emacsclient version.\n"); | |
b72ca403 | 90 | goto out; |
07800601 IM |
91 | } |
92 | ||
d1130686 | 93 | version = atoi(buffer.buf + strlen("emacsclient")); |
07800601 IM |
94 | |
95 | if (version < 22) { | |
96 | fprintf(stderr, | |
97 | "emacsclient version '%d' too old (< 22).\n", | |
98 | version); | |
b72ca403 MH |
99 | } else |
100 | ret = 0; | |
101 | out: | |
07800601 | 102 | strbuf_release(&buffer); |
b72ca403 | 103 | return ret; |
07800601 IM |
104 | } |
105 | ||
c1e53017 | 106 | static void exec_woman_emacs(const char *path, const char *page) |
07800601 | 107 | { |
ede395d2 MH |
108 | char sbuf[STRERR_BUFSIZE]; |
109 | ||
07800601 IM |
110 | if (!check_emacsclient_version()) { |
111 | /* This works only with emacsclient version >= 22. */ | |
a610f5cb | 112 | char *man_page; |
07800601 IM |
113 | |
114 | if (!path) | |
115 | path = "emacsclient"; | |
a610f5cb ACM |
116 | if (asprintf(&man_page, "(woman \"%s\")", page) > 0) { |
117 | execlp(path, "emacsclient", "-e", man_page, NULL); | |
118 | free(man_page); | |
119 | } | |
ede395d2 | 120 | warning("failed to exec '%s': %s", path, |
c8b5f2c9 | 121 | str_error_r(errno, sbuf, sizeof(sbuf))); |
07800601 IM |
122 | } |
123 | } | |
124 | ||
c1e53017 | 125 | static void exec_man_konqueror(const char *path, const char *page) |
07800601 IM |
126 | { |
127 | const char *display = getenv("DISPLAY"); | |
ede395d2 | 128 | |
07800601 | 129 | if (display && *display) { |
a610f5cb | 130 | char *man_page; |
07800601 | 131 | const char *filename = "kfmclient"; |
ede395d2 | 132 | char sbuf[STRERR_BUFSIZE]; |
07800601 IM |
133 | |
134 | /* It's simpler to launch konqueror using kfmclient. */ | |
135 | if (path) { | |
136 | const char *file = strrchr(path, '/'); | |
137 | if (file && !strcmp(file + 1, "konqueror")) { | |
138 | char *new = strdup(path); | |
139 | char *dest = strrchr(new, '/'); | |
140 | ||
141 | /* strlen("konqueror") == strlen("kfmclient") */ | |
142 | strcpy(dest + 1, "kfmclient"); | |
143 | path = new; | |
144 | } | |
145 | if (file) | |
146 | filename = file; | |
147 | } else | |
148 | path = "kfmclient"; | |
a610f5cb ACM |
149 | if (asprintf(&man_page, "man:%s(1)", page) > 0) { |
150 | execlp(path, filename, "newTab", man_page, NULL); | |
151 | free(man_page); | |
152 | } | |
ede395d2 | 153 | warning("failed to exec '%s': %s", path, |
c8b5f2c9 | 154 | str_error_r(errno, sbuf, sizeof(sbuf))); |
07800601 IM |
155 | } |
156 | } | |
157 | ||
c1e53017 | 158 | static void exec_man_man(const char *path, const char *page) |
07800601 | 159 | { |
ede395d2 MH |
160 | char sbuf[STRERR_BUFSIZE]; |
161 | ||
07800601 IM |
162 | if (!path) |
163 | path = "man"; | |
164 | execlp(path, "man", page, NULL); | |
ede395d2 | 165 | warning("failed to exec '%s': %s", path, |
c8b5f2c9 | 166 | str_error_r(errno, sbuf, sizeof(sbuf))); |
07800601 IM |
167 | } |
168 | ||
169 | static void exec_man_cmd(const char *cmd, const char *page) | |
170 | { | |
ede395d2 | 171 | char sbuf[STRERR_BUFSIZE]; |
a610f5cb | 172 | char *shell_cmd; |
ede395d2 | 173 | |
a610f5cb ACM |
174 | if (asprintf(&shell_cmd, "%s %s", cmd, page) > 0) { |
175 | execl("/bin/sh", "sh", "-c", shell_cmd, NULL); | |
176 | free(shell_cmd); | |
177 | } | |
ede395d2 | 178 | warning("failed to exec '%s': %s", cmd, |
c8b5f2c9 | 179 | str_error_r(errno, sbuf, sizeof(sbuf))); |
07800601 IM |
180 | } |
181 | ||
182 | static void add_man_viewer(const char *name) | |
183 | { | |
184 | struct man_viewer_list **p = &man_viewer_list; | |
185 | size_t len = strlen(name); | |
186 | ||
187 | while (*p) | |
188 | p = &((*p)->next); | |
36479484 | 189 | *p = zalloc(sizeof(**p) + len + 1); |
07800601 IM |
190 | strncpy((*p)->name, name, len); |
191 | } | |
192 | ||
193 | static int supported_man_viewer(const char *name, size_t len) | |
194 | { | |
195 | return (!strncasecmp("man", name, len) || | |
196 | !strncasecmp("woman", name, len) || | |
197 | !strncasecmp("konqueror", name, len)); | |
198 | } | |
199 | ||
200 | static void do_add_man_viewer_info(const char *name, | |
201 | size_t len, | |
202 | const char *value) | |
203 | { | |
36479484 | 204 | struct man_viewer_info_list *new = zalloc(sizeof(*new) + len + 1); |
07800601 IM |
205 | |
206 | strncpy(new->name, name, len); | |
207 | new->info = strdup(value); | |
208 | new->next = man_viewer_info_list; | |
209 | man_viewer_info_list = new; | |
210 | } | |
211 | ||
212 | static int add_man_viewer_path(const char *name, | |
213 | size_t len, | |
214 | const char *value) | |
215 | { | |
216 | if (supported_man_viewer(name, len)) | |
217 | do_add_man_viewer_info(name, len, value); | |
218 | else | |
219 | warning("'%s': path for unsupported man viewer.\n" | |
220 | "Please consider using 'man.<tool>.cmd' instead.", | |
221 | name); | |
222 | ||
223 | return 0; | |
224 | } | |
225 | ||
226 | static int add_man_viewer_cmd(const char *name, | |
227 | size_t len, | |
228 | const char *value) | |
229 | { | |
230 | if (supported_man_viewer(name, len)) | |
231 | warning("'%s': cmd for supported man viewer.\n" | |
232 | "Please consider using 'man.<tool>.path' instead.", | |
233 | name); | |
234 | else | |
235 | do_add_man_viewer_info(name, len, value); | |
236 | ||
237 | return 0; | |
238 | } | |
239 | ||
240 | static int add_man_viewer_info(const char *var, const char *value) | |
241 | { | |
242 | const char *name = var + 4; | |
243 | const char *subkey = strrchr(name, '.'); | |
244 | ||
245 | if (!subkey) | |
246 | return error("Config with no key for man viewer: %s", name); | |
247 | ||
248 | if (!strcmp(subkey, ".path")) { | |
249 | if (!value) | |
250 | return config_error_nonbool(var); | |
251 | return add_man_viewer_path(name, subkey - name, value); | |
252 | } | |
253 | if (!strcmp(subkey, ".cmd")) { | |
254 | if (!value) | |
255 | return config_error_nonbool(var); | |
256 | return add_man_viewer_cmd(name, subkey - name, value); | |
257 | } | |
258 | ||
259 | warning("'%s': unsupported man viewer sub key.", subkey); | |
260 | return 0; | |
261 | } | |
262 | ||
263 | static int perf_help_config(const char *var, const char *value, void *cb) | |
264 | { | |
2bae1d1b ACM |
265 | enum help_format *help_formatp = cb; |
266 | ||
07800601 IM |
267 | if (!strcmp(var, "help.format")) { |
268 | if (!value) | |
269 | return config_error_nonbool(var); | |
2bae1d1b ACM |
270 | *help_formatp = parse_help_format(value); |
271 | if (*help_formatp == HELP_FORMAT_NONE) | |
cc584821 | 272 | return -1; |
07800601 IM |
273 | return 0; |
274 | } | |
275 | if (!strcmp(var, "man.viewer")) { | |
276 | if (!value) | |
277 | return config_error_nonbool(var); | |
278 | add_man_viewer(value); | |
279 | return 0; | |
280 | } | |
281 | if (!prefixcmp(var, "man.")) | |
282 | return add_man_viewer_info(var, value); | |
283 | ||
b8cbb349 | 284 | return 0; |
07800601 IM |
285 | } |
286 | ||
287 | static struct cmdnames main_cmds, other_cmds; | |
288 | ||
289 | void list_common_cmds_help(void) | |
290 | { | |
f37a291c | 291 | unsigned int i, longest = 0; |
07800601 IM |
292 | |
293 | for (i = 0; i < ARRAY_SIZE(common_cmds); i++) { | |
294 | if (longest < strlen(common_cmds[i].name)) | |
295 | longest = strlen(common_cmds[i].name); | |
296 | } | |
297 | ||
502fc5c7 | 298 | puts(" The most commonly used perf commands are:"); |
07800601 | 299 | for (i = 0; i < ARRAY_SIZE(common_cmds); i++) { |
3912f2ab | 300 | printf(" %-*s ", longest, common_cmds[i].name); |
07800601 IM |
301 | puts(common_cmds[i].help); |
302 | } | |
303 | } | |
304 | ||
07800601 IM |
305 | static const char *cmd_to_page(const char *perf_cmd) |
306 | { | |
a610f5cb ACM |
307 | char *s; |
308 | ||
07800601 IM |
309 | if (!perf_cmd) |
310 | return "perf"; | |
311 | else if (!prefixcmp(perf_cmd, "perf")) | |
312 | return perf_cmd; | |
a610f5cb ACM |
313 | |
314 | return asprintf(&s, "perf-%s", perf_cmd) < 0 ? NULL : s; | |
07800601 IM |
315 | } |
316 | ||
317 | static void setup_man_path(void) | |
318 | { | |
a610f5cb | 319 | char *new_path; |
07800601 IM |
320 | const char *old_path = getenv("MANPATH"); |
321 | ||
322 | /* We should always put ':' after our path. If there is no | |
323 | * old_path, the ':' at the end will let 'man' to try | |
324 | * system-wide paths after ours to find the manual page. If | |
325 | * there is old_path, we need ':' as delimiter. */ | |
a610f5cb ACM |
326 | if (asprintf(&new_path, "%s:%s", system_path(PERF_MAN_PATH), old_path ?: "") > 0) { |
327 | setenv("MANPATH", new_path, 1); | |
328 | free(new_path); | |
329 | } else { | |
330 | error("Unable to setup man path"); | |
331 | } | |
07800601 IM |
332 | } |
333 | ||
334 | static void exec_viewer(const char *name, const char *page) | |
335 | { | |
336 | const char *info = get_man_viewer_info(name); | |
337 | ||
338 | if (!strcasecmp(name, "man")) | |
339 | exec_man_man(info, page); | |
340 | else if (!strcasecmp(name, "woman")) | |
341 | exec_woman_emacs(info, page); | |
342 | else if (!strcasecmp(name, "konqueror")) | |
343 | exec_man_konqueror(info, page); | |
344 | else if (info) | |
345 | exec_man_cmd(info, page); | |
346 | else | |
347 | warning("'%s': unknown man viewer.", name); | |
348 | } | |
349 | ||
cc584821 | 350 | static int show_man_page(const char *perf_cmd) |
07800601 IM |
351 | { |
352 | struct man_viewer_list *viewer; | |
353 | const char *page = cmd_to_page(perf_cmd); | |
354 | const char *fallback = getenv("PERF_MAN_VIEWER"); | |
355 | ||
356 | setup_man_path(); | |
357 | for (viewer = man_viewer_list; viewer; viewer = viewer->next) | |
07800601 | 358 | exec_viewer(viewer->name, page); /* will return when unable */ |
c1e53017 | 359 | |
07800601 IM |
360 | if (fallback) |
361 | exec_viewer(fallback, page); | |
362 | exec_viewer("man", page); | |
cc584821 DA |
363 | |
364 | pr_err("no man viewer handled the request"); | |
365 | return -1; | |
07800601 IM |
366 | } |
367 | ||
cc584821 | 368 | static int show_info_page(const char *perf_cmd) |
07800601 IM |
369 | { |
370 | const char *page = cmd_to_page(perf_cmd); | |
371 | setenv("INFOPATH", system_path(PERF_INFO_PATH), 1); | |
372 | execlp("info", "info", "perfman", page, NULL); | |
cc584821 | 373 | return -1; |
07800601 IM |
374 | } |
375 | ||
a610f5cb | 376 | static int get_html_page_path(char **page_path, const char *page) |
07800601 IM |
377 | { |
378 | struct stat st; | |
379 | const char *html_path = system_path(PERF_HTML_PATH); | |
380 | ||
381 | /* Check that we have a perf documentation directory. */ | |
382 | if (stat(mkpath("%s/perf.html", html_path), &st) | |
cc584821 DA |
383 | || !S_ISREG(st.st_mode)) { |
384 | pr_err("'%s': not a documentation directory.", html_path); | |
385 | return -1; | |
386 | } | |
07800601 | 387 | |
a610f5cb | 388 | return asprintf(page_path, "%s/%s.html", html_path, page); |
07800601 IM |
389 | } |
390 | ||
391 | /* | |
392 | * If open_html is not defined in a platform-specific way (see for | |
393 | * example compat/mingw.h), we use the script web--browse to display | |
394 | * HTML. | |
395 | */ | |
396 | #ifndef open_html | |
16f762a2 | 397 | static void open_html(const char *path) |
07800601 | 398 | { |
46113a54 | 399 | execl_cmd("web--browse", "-c", "help.browser", path, NULL); |
07800601 IM |
400 | } |
401 | #endif | |
402 | ||
cc584821 | 403 | static int show_html_page(const char *perf_cmd) |
07800601 IM |
404 | { |
405 | const char *page = cmd_to_page(perf_cmd); | |
a610f5cb | 406 | char *page_path; /* it leaks but we exec bellow */ |
07800601 | 407 | |
a610f5cb | 408 | if (get_html_page_path(&page_path, page) < 0) |
cc584821 | 409 | return -1; |
07800601 | 410 | |
a610f5cb | 411 | open_html(page_path); |
cc584821 DA |
412 | |
413 | return 0; | |
07800601 IM |
414 | } |
415 | ||
b0ad8ea6 | 416 | int cmd_help(int argc, const char **argv) |
07800601 | 417 | { |
2bae1d1b | 418 | bool show_all = false; |
670ab5d2 | 419 | enum help_format help_format = HELP_FORMAT_MAN; |
2bae1d1b ACM |
420 | struct option builtin_help_options[] = { |
421 | OPT_BOOLEAN('a', "all", &show_all, "print all available commands"), | |
422 | OPT_SET_UINT('m', "man", &help_format, "show man page", HELP_FORMAT_MAN), | |
423 | OPT_SET_UINT('w', "web", &help_format, "show manual in web browser", | |
424 | HELP_FORMAT_WEB), | |
425 | OPT_SET_UINT('i', "info", &help_format, "show info page", | |
426 | HELP_FORMAT_INFO), | |
427 | OPT_END(), | |
428 | }; | |
e24a1108 YS |
429 | const char * const builtin_help_subcommands[] = { |
430 | "buildid-cache", "buildid-list", "diff", "evlist", "help", "list", | |
431 | "record", "report", "bench", "stat", "timechart", "top", "annotate", | |
35563771 | 432 | "script", "sched", "kallsyms", "kmem", "lock", "kvm", "test", "inject", "mem", "data", |
e24a1108 YS |
433 | #ifdef HAVE_LIBELF_SUPPORT |
434 | "probe", | |
435 | #endif | |
436 | #ifdef HAVE_LIBAUDIT_SUPPORT | |
437 | "trace", | |
438 | #endif | |
439 | NULL }; | |
440 | const char *builtin_help_usage[] = { | |
2bae1d1b ACM |
441 | "perf help [--all] [--man|--web|--info] [command]", |
442 | NULL | |
443 | }; | |
ecc4c561 | 444 | int rc; |
f37a291c | 445 | |
07800601 IM |
446 | load_command_list("perf-", &main_cmds, &other_cmds); |
447 | ||
ecc4c561 ACM |
448 | rc = perf_config(perf_help_config, &help_format); |
449 | if (rc) | |
450 | return rc; | |
07800601 | 451 | |
e24a1108 YS |
452 | argc = parse_options_subcommand(argc, argv, builtin_help_options, |
453 | builtin_help_subcommands, builtin_help_usage, 0); | |
07800601 IM |
454 | |
455 | if (show_all) { | |
3a134ae9 | 456 | printf("\n Usage: %s\n\n", perf_usage_string); |
07800601 | 457 | list_commands("perf commands", &main_cmds, &other_cmds); |
502fc5c7 | 458 | printf(" %s\n\n", perf_more_info_string); |
07800601 IM |
459 | return 0; |
460 | } | |
461 | ||
462 | if (!argv[0]) { | |
502fc5c7 | 463 | printf("\n usage: %s\n\n", perf_usage_string); |
07800601 | 464 | list_common_cmds_help(); |
502fc5c7 | 465 | printf("\n %s\n\n", perf_more_info_string); |
07800601 IM |
466 | return 0; |
467 | } | |
468 | ||
07800601 IM |
469 | switch (help_format) { |
470 | case HELP_FORMAT_MAN: | |
cc584821 | 471 | rc = show_man_page(argv[0]); |
07800601 IM |
472 | break; |
473 | case HELP_FORMAT_INFO: | |
cc584821 | 474 | rc = show_info_page(argv[0]); |
07800601 IM |
475 | break; |
476 | case HELP_FORMAT_WEB: | |
cc584821 DA |
477 | rc = show_html_page(argv[0]); |
478 | break; | |
479 | case HELP_FORMAT_NONE: | |
480 | /* fall-through */ | |
83a0944f | 481 | default: |
cc584821 | 482 | rc = -1; |
07800601 IM |
483 | break; |
484 | } | |
485 | ||
cc584821 | 486 | return rc; |
07800601 | 487 | } |