7 #include "util/config.h"
9 #include <subcmd/exec-cmd.h>
10 #include "common-cmds.h"
11 #include <subcmd/parse-options.h>
12 #include <subcmd/run-command.h>
13 #include <subcmd/help.h>
14 #include "util/debug.h"
15 #include <linux/kernel.h>
18 #include <sys/types.h>
22 static struct man_viewer_list
{
23 struct man_viewer_list
*next
;
27 static struct man_viewer_info_list
{
28 struct man_viewer_info_list
*next
;
31 } *man_viewer_info_list
;
40 static enum help_format
parse_help_format(const char *format
)
42 if (!strcmp(format
, "man"))
43 return HELP_FORMAT_MAN
;
44 if (!strcmp(format
, "info"))
45 return HELP_FORMAT_INFO
;
46 if (!strcmp(format
, "web") || !strcmp(format
, "html"))
47 return HELP_FORMAT_WEB
;
49 pr_err("unrecognized help format '%s'", format
);
50 return HELP_FORMAT_NONE
;
53 static const char *get_man_viewer_info(const char *name
)
55 struct man_viewer_info_list
*viewer
;
57 for (viewer
= man_viewer_info_list
; viewer
; viewer
= viewer
->next
) {
58 if (!strcasecmp(name
, viewer
->name
))
64 static int check_emacsclient_version(void)
66 struct strbuf buffer
= STRBUF_INIT
;
67 struct child_process ec_process
;
68 const char *argv_ec
[] = { "emacsclient", "--version", NULL
};
72 /* emacsclient prints its version number on stderr */
73 memset(&ec_process
, 0, sizeof(ec_process
));
74 ec_process
.argv
= argv_ec
;
76 ec_process
.stdout_to_stderr
= 1;
77 if (start_command(&ec_process
)) {
78 fprintf(stderr
, "Failed to start emacsclient.\n");
81 if (strbuf_read(&buffer
, ec_process
.err
, 20) < 0) {
82 fprintf(stderr
, "Failed to read emacsclient version\n");
85 close(ec_process
.err
);
88 * Don't bother checking return value, because "emacsclient --version"
89 * seems to always exits with code 1.
91 finish_command(&ec_process
);
93 if (prefixcmp(buffer
.buf
, "emacsclient")) {
94 fprintf(stderr
, "Failed to parse emacsclient version.\n");
98 version
= atoi(buffer
.buf
+ strlen("emacsclient"));
102 "emacsclient version '%d' too old (< 22).\n",
107 strbuf_release(&buffer
);
111 static void exec_woman_emacs(const char *path
, const char *page
)
113 char sbuf
[STRERR_BUFSIZE
];
115 if (!check_emacsclient_version()) {
116 /* This works only with emacsclient version >= 22. */
120 path
= "emacsclient";
121 if (asprintf(&man_page
, "(woman \"%s\")", page
) > 0) {
122 execlp(path
, "emacsclient", "-e", man_page
, NULL
);
125 warning("failed to exec '%s': %s", path
,
126 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
130 static void exec_man_konqueror(const char *path
, const char *page
)
132 const char *display
= getenv("DISPLAY");
134 if (display
&& *display
) {
136 const char *filename
= "kfmclient";
137 char sbuf
[STRERR_BUFSIZE
];
139 /* It's simpler to launch konqueror using kfmclient. */
141 const char *file
= strrchr(path
, '/');
142 if (file
&& !strcmp(file
+ 1, "konqueror")) {
143 char *new = strdup(path
);
144 char *dest
= strrchr(new, '/');
146 /* strlen("konqueror") == strlen("kfmclient") */
147 strcpy(dest
+ 1, "kfmclient");
154 if (asprintf(&man_page
, "man:%s(1)", page
) > 0) {
155 execlp(path
, filename
, "newTab", man_page
, NULL
);
158 warning("failed to exec '%s': %s", path
,
159 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
163 static void exec_man_man(const char *path
, const char *page
)
165 char sbuf
[STRERR_BUFSIZE
];
169 execlp(path
, "man", page
, NULL
);
170 warning("failed to exec '%s': %s", path
,
171 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
174 static void exec_man_cmd(const char *cmd
, const char *page
)
176 char sbuf
[STRERR_BUFSIZE
];
179 if (asprintf(&shell_cmd
, "%s %s", cmd
, page
) > 0) {
180 execl("/bin/sh", "sh", "-c", shell_cmd
, NULL
);
183 warning("failed to exec '%s': %s", cmd
,
184 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
187 static void add_man_viewer(const char *name
)
189 struct man_viewer_list
**p
= &man_viewer_list
;
190 size_t len
= strlen(name
);
194 *p
= zalloc(sizeof(**p
) + len
+ 1);
195 strncpy((*p
)->name
, name
, len
);
198 static int supported_man_viewer(const char *name
, size_t len
)
200 return (!strncasecmp("man", name
, len
) ||
201 !strncasecmp("woman", name
, len
) ||
202 !strncasecmp("konqueror", name
, len
));
205 static void do_add_man_viewer_info(const char *name
,
209 struct man_viewer_info_list
*new = zalloc(sizeof(*new) + len
+ 1);
211 strncpy(new->name
, name
, len
);
212 new->info
= strdup(value
);
213 new->next
= man_viewer_info_list
;
214 man_viewer_info_list
= new;
217 static int add_man_viewer_path(const char *name
,
221 if (supported_man_viewer(name
, len
))
222 do_add_man_viewer_info(name
, len
, value
);
224 warning("'%s': path for unsupported man viewer.\n"
225 "Please consider using 'man.<tool>.cmd' instead.",
231 static int add_man_viewer_cmd(const char *name
,
235 if (supported_man_viewer(name
, len
))
236 warning("'%s': cmd for supported man viewer.\n"
237 "Please consider using 'man.<tool>.path' instead.",
240 do_add_man_viewer_info(name
, len
, value
);
245 static int add_man_viewer_info(const char *var
, const char *value
)
247 const char *name
= var
+ 4;
248 const char *subkey
= strrchr(name
, '.');
251 return error("Config with no key for man viewer: %s", name
);
253 if (!strcmp(subkey
, ".path")) {
255 return config_error_nonbool(var
);
256 return add_man_viewer_path(name
, subkey
- name
, value
);
258 if (!strcmp(subkey
, ".cmd")) {
260 return config_error_nonbool(var
);
261 return add_man_viewer_cmd(name
, subkey
- name
, value
);
264 warning("'%s': unsupported man viewer sub key.", subkey
);
268 static int perf_help_config(const char *var
, const char *value
, void *cb
)
270 enum help_format
*help_formatp
= cb
;
272 if (!strcmp(var
, "help.format")) {
274 return config_error_nonbool(var
);
275 *help_formatp
= parse_help_format(value
);
276 if (*help_formatp
== HELP_FORMAT_NONE
)
280 if (!strcmp(var
, "man.viewer")) {
282 return config_error_nonbool(var
);
283 add_man_viewer(value
);
286 if (!prefixcmp(var
, "man."))
287 return add_man_viewer_info(var
, value
);
292 static struct cmdnames main_cmds
, other_cmds
;
294 void list_common_cmds_help(void)
296 unsigned int i
, longest
= 0;
298 for (i
= 0; i
< ARRAY_SIZE(common_cmds
); i
++) {
299 if (longest
< strlen(common_cmds
[i
].name
))
300 longest
= strlen(common_cmds
[i
].name
);
303 puts(" The most commonly used perf commands are:");
304 for (i
= 0; i
< ARRAY_SIZE(common_cmds
); i
++) {
305 printf(" %-*s ", longest
, common_cmds
[i
].name
);
306 puts(common_cmds
[i
].help
);
310 static const char *cmd_to_page(const char *perf_cmd
)
316 else if (!prefixcmp(perf_cmd
, "perf"))
319 return asprintf(&s
, "perf-%s", perf_cmd
) < 0 ? NULL
: s
;
322 static void setup_man_path(void)
325 const char *old_path
= getenv("MANPATH");
327 /* We should always put ':' after our path. If there is no
328 * old_path, the ':' at the end will let 'man' to try
329 * system-wide paths after ours to find the manual page. If
330 * there is old_path, we need ':' as delimiter. */
331 if (asprintf(&new_path
, "%s:%s", system_path(PERF_MAN_PATH
), old_path
?: "") > 0) {
332 setenv("MANPATH", new_path
, 1);
335 error("Unable to setup man path");
339 static void exec_viewer(const char *name
, const char *page
)
341 const char *info
= get_man_viewer_info(name
);
343 if (!strcasecmp(name
, "man"))
344 exec_man_man(info
, page
);
345 else if (!strcasecmp(name
, "woman"))
346 exec_woman_emacs(info
, page
);
347 else if (!strcasecmp(name
, "konqueror"))
348 exec_man_konqueror(info
, page
);
350 exec_man_cmd(info
, page
);
352 warning("'%s': unknown man viewer.", name
);
355 static int show_man_page(const char *perf_cmd
)
357 struct man_viewer_list
*viewer
;
358 const char *page
= cmd_to_page(perf_cmd
);
359 const char *fallback
= getenv("PERF_MAN_VIEWER");
362 for (viewer
= man_viewer_list
; viewer
; viewer
= viewer
->next
)
363 exec_viewer(viewer
->name
, page
); /* will return when unable */
366 exec_viewer(fallback
, page
);
367 exec_viewer("man", page
);
369 pr_err("no man viewer handled the request");
373 static int show_info_page(const char *perf_cmd
)
375 const char *page
= cmd_to_page(perf_cmd
);
376 setenv("INFOPATH", system_path(PERF_INFO_PATH
), 1);
377 execlp("info", "info", "perfman", page
, NULL
);
381 static int get_html_page_path(char **page_path
, const char *page
)
384 const char *html_path
= system_path(PERF_HTML_PATH
);
386 /* Check that we have a perf documentation directory. */
387 if (stat(mkpath("%s/perf.html", html_path
), &st
)
388 || !S_ISREG(st
.st_mode
)) {
389 pr_err("'%s': not a documentation directory.", html_path
);
393 return asprintf(page_path
, "%s/%s.html", html_path
, page
);
397 * If open_html is not defined in a platform-specific way (see for
398 * example compat/mingw.h), we use the script web--browse to display
402 static void open_html(const char *path
)
404 execl_cmd("web--browse", "-c", "help.browser", path
, NULL
);
408 static int show_html_page(const char *perf_cmd
)
410 const char *page
= cmd_to_page(perf_cmd
);
411 char *page_path
; /* it leaks but we exec bellow */
413 if (get_html_page_path(&page_path
, page
) < 0)
416 open_html(page_path
);
421 int cmd_help(int argc
, const char **argv
)
423 bool show_all
= false;
424 enum help_format help_format
= HELP_FORMAT_MAN
;
425 struct option builtin_help_options
[] = {
426 OPT_BOOLEAN('a', "all", &show_all
, "print all available commands"),
427 OPT_SET_UINT('m', "man", &help_format
, "show man page", HELP_FORMAT_MAN
),
428 OPT_SET_UINT('w', "web", &help_format
, "show manual in web browser",
430 OPT_SET_UINT('i', "info", &help_format
, "show info page",
434 const char * const builtin_help_subcommands
[] = {
435 "buildid-cache", "buildid-list", "diff", "evlist", "help", "list",
436 "record", "report", "bench", "stat", "timechart", "top", "annotate",
437 "script", "sched", "kallsyms", "kmem", "lock", "kvm", "test", "inject", "mem", "data",
438 #ifdef HAVE_LIBELF_SUPPORT
441 #ifdef HAVE_LIBAUDIT_SUPPORT
445 const char *builtin_help_usage
[] = {
446 "perf help [--all] [--man|--web|--info] [command]",
451 load_command_list("perf-", &main_cmds
, &other_cmds
);
453 rc
= perf_config(perf_help_config
, &help_format
);
457 argc
= parse_options_subcommand(argc
, argv
, builtin_help_options
,
458 builtin_help_subcommands
, builtin_help_usage
, 0);
461 printf("\n Usage: %s\n\n", perf_usage_string
);
462 list_commands("perf commands", &main_cmds
, &other_cmds
);
463 printf(" %s\n\n", perf_more_info_string
);
468 printf("\n usage: %s\n\n", perf_usage_string
);
469 list_common_cmds_help();
470 printf("\n %s\n\n", perf_more_info_string
);
474 switch (help_format
) {
475 case HELP_FORMAT_MAN
:
476 rc
= show_man_page(argv
[0]);
478 case HELP_FORMAT_INFO
:
479 rc
= show_info_page(argv
[0]);
481 case HELP_FORMAT_WEB
:
482 rc
= show_html_page(argv
[0]);
484 case HELP_FORMAT_NONE
: