builtin-help.c 11.6 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3 4 5 6
/*
 * builtin-help.c
 *
 * Builtin help command
 */
7
#include "perf.h"
8
#include "util/config.h"
9
#include "builtin.h"
10
#include <subcmd/exec-cmd.h>
11
#include "common-cmds.h"
12 13 14
#include <subcmd/parse-options.h>
#include <subcmd/run-command.h>
#include <subcmd/help.h>
15
#include "util/debug.h"
16
#include <linux/kernel.h>
17
#include <errno.h>
18 19 20 21
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
22 23 24

static struct man_viewer_list {
	struct man_viewer_list *next;
25
	char name[0];
26 27 28 29 30
} *man_viewer_list;

static struct man_viewer_info_list {
	struct man_viewer_info_list *next;
	const char *info;
31
	char name[0];
32 33 34
} *man_viewer_info_list;

enum help_format {
35
	HELP_FORMAT_NONE,
36 37 38 39 40 41 42 43 44 45 46 47 48
	HELP_FORMAT_MAN,
	HELP_FORMAT_INFO,
	HELP_FORMAT_WEB,
};

static enum help_format parse_help_format(const char *format)
{
	if (!strcmp(format, "man"))
		return HELP_FORMAT_MAN;
	if (!strcmp(format, "info"))
		return HELP_FORMAT_INFO;
	if (!strcmp(format, "web") || !strcmp(format, "html"))
		return HELP_FORMAT_WEB;
49 50 51

	pr_err("unrecognized help format '%s'", format);
	return HELP_FORMAT_NONE;
52 53 54 55 56 57
}

static const char *get_man_viewer_info(const char *name)
{
	struct man_viewer_info_list *viewer;

58
	for (viewer = man_viewer_info_list; viewer; viewer = viewer->next) {
59 60 61 62 63 64 65 66 67 68 69 70
		if (!strcasecmp(name, viewer->name))
			return viewer->info;
	}
	return NULL;
}

static int check_emacsclient_version(void)
{
	struct strbuf buffer = STRBUF_INIT;
	struct child_process ec_process;
	const char *argv_ec[] = { "emacsclient", "--version", NULL };
	int version;
71
	int ret = -1;
72 73 74 75 76 77 78 79 80 81

	/* emacsclient prints its version number on stderr */
	memset(&ec_process, 0, sizeof(ec_process));
	ec_process.argv = argv_ec;
	ec_process.err = -1;
	ec_process.stdout_to_stderr = 1;
	if (start_command(&ec_process)) {
		fprintf(stderr, "Failed to start emacsclient.\n");
		return -1;
	}
82 83 84 85
	if (strbuf_read(&buffer, ec_process.err, 20) < 0) {
		fprintf(stderr, "Failed to read emacsclient version\n");
		goto out;
	}
86 87 88 89 90 91 92 93
	close(ec_process.err);

	/*
	 * Don't bother checking return value, because "emacsclient --version"
	 * seems to always exits with code 1.
	 */
	finish_command(&ec_process);

94
	if (!strstarts(buffer.buf, "emacsclient")) {
95
		fprintf(stderr, "Failed to parse emacsclient version.\n");
96
		goto out;
97 98
	}

99
	version = atoi(buffer.buf + strlen("emacsclient"));
100 101 102 103 104

	if (version < 22) {
		fprintf(stderr,
			"emacsclient version '%d' too old (< 22).\n",
			version);
105 106 107
	} else
		ret = 0;
out:
108
	strbuf_release(&buffer);
109
	return ret;
110 111
}

112
static void exec_failed(const char *cmd)
113
{
114
	char sbuf[STRERR_BUFSIZE];
115 116
	pr_warning("failed to exec '%s': %s", cmd, str_error_r(errno, sbuf, sizeof(sbuf)));
}
117

118 119
static void exec_woman_emacs(const char *path, const char *page)
{
120 121
	if (!check_emacsclient_version()) {
		/* This works only with emacsclient version >= 22. */
122
		char *man_page;
123 124 125

		if (!path)
			path = "emacsclient";
126 127 128 129
		if (asprintf(&man_page, "(woman \"%s\")", page) > 0) {
			execlp(path, "emacsclient", "-e", man_page, NULL);
			free(man_page);
		}
130
		exec_failed(path);
131 132 133
	}
}

134
static void exec_man_konqueror(const char *path, const char *page)
135 136
{
	const char *display = getenv("DISPLAY");
137

138
	if (display && *display) {
139
		char *man_page;
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
		const char *filename = "kfmclient";

		/* It's simpler to launch konqueror using kfmclient. */
		if (path) {
			const char *file = strrchr(path, '/');
			if (file && !strcmp(file + 1, "konqueror")) {
				char *new = strdup(path);
				char *dest = strrchr(new, '/');

				/* strlen("konqueror") == strlen("kfmclient") */
				strcpy(dest + 1, "kfmclient");
				path = new;
			}
			if (file)
				filename = file;
		} else
			path = "kfmclient";
157 158 159 160
		if (asprintf(&man_page, "man:%s(1)", page) > 0) {
			execlp(path, filename, "newTab", man_page, NULL);
			free(man_page);
		}
161
		exec_failed(path);
162 163 164
	}
}

165
static void exec_man_man(const char *path, const char *page)
166 167 168 169
{
	if (!path)
		path = "man";
	execlp(path, "man", page, NULL);
170
	exec_failed(path);
171 172 173 174
}

static void exec_man_cmd(const char *cmd, const char *page)
{
175
	char *shell_cmd;
176

177 178 179 180
	if (asprintf(&shell_cmd, "%s %s", cmd, page) > 0) {
		execl("/bin/sh", "sh", "-c", shell_cmd, NULL);
		free(shell_cmd);
	}
181
	exec_failed(cmd);
182 183 184 185 186 187 188 189 190
}

static void add_man_viewer(const char *name)
{
	struct man_viewer_list **p = &man_viewer_list;
	size_t len = strlen(name);

	while (*p)
		p = &((*p)->next);
191
	*p = zalloc(sizeof(**p) + len + 1);
192 193 194 195 196 197 198 199 200 201 202 203 204 205
	strncpy((*p)->name, name, len);
}

static int supported_man_viewer(const char *name, size_t len)
{
	return (!strncasecmp("man", name, len) ||
		!strncasecmp("woman", name, len) ||
		!strncasecmp("konqueror", name, len));
}

static void do_add_man_viewer_info(const char *name,
				   size_t len,
				   const char *value)
{
206
	struct man_viewer_info_list *new = zalloc(sizeof(*new) + len + 1);
207 208 209 210 211 212 213

	strncpy(new->name, name, len);
	new->info = strdup(value);
	new->next = man_viewer_info_list;
	man_viewer_info_list = new;
}

214 215 216 217 218 219
static void unsupported_man_viewer(const char *name, const char *var)
{
	pr_warning("'%s': path for unsupported man viewer.\n"
		   "Please consider using 'man.<tool>.%s' instead.", name, var);
}

220 221 222 223 224 225 226
static int add_man_viewer_path(const char *name,
			       size_t len,
			       const char *value)
{
	if (supported_man_viewer(name, len))
		do_add_man_viewer_info(name, len, value);
	else
227
		unsupported_man_viewer(name, "cmd");
228 229 230 231 232 233 234 235 236

	return 0;
}

static int add_man_viewer_cmd(const char *name,
			      size_t len,
			      const char *value)
{
	if (supported_man_viewer(name, len))
237
		unsupported_man_viewer(name, "path");
238 239 240 241 242 243 244 245 246 247 248
	else
		do_add_man_viewer_info(name, len, value);

	return 0;
}

static int add_man_viewer_info(const char *var, const char *value)
{
	const char *name = var + 4;
	const char *subkey = strrchr(name, '.');

249 250 251 252
	if (!subkey) {
		pr_err("Config with no key for man viewer: %s", name);
		return -1;
	}
253 254 255 256 257 258 259 260 261 262 263 264

	if (!strcmp(subkey, ".path")) {
		if (!value)
			return config_error_nonbool(var);
		return add_man_viewer_path(name, subkey - name, value);
	}
	if (!strcmp(subkey, ".cmd")) {
		if (!value)
			return config_error_nonbool(var);
		return add_man_viewer_cmd(name, subkey - name, value);
	}

265
	pr_warning("'%s': unsupported man viewer sub key.", subkey);
266 267 268 269 270
	return 0;
}

static int perf_help_config(const char *var, const char *value, void *cb)
{
271 272
	enum help_format *help_formatp = cb;

273 274 275
	if (!strcmp(var, "help.format")) {
		if (!value)
			return config_error_nonbool(var);
276 277
		*help_formatp = parse_help_format(value);
		if (*help_formatp == HELP_FORMAT_NONE)
278
			return -1;
279 280 281 282 283 284 285 286
		return 0;
	}
	if (!strcmp(var, "man.viewer")) {
		if (!value)
			return config_error_nonbool(var);
		add_man_viewer(value);
		return 0;
	}
287
	if (strstarts(var, "man."))
288 289
		return add_man_viewer_info(var, value);

290
	return 0;
291 292 293 294 295 296
}

static struct cmdnames main_cmds, other_cmds;

void list_common_cmds_help(void)
{
297
	unsigned int i, longest = 0;
298 299 300 301 302 303

	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
		if (longest < strlen(common_cmds[i].name))
			longest = strlen(common_cmds[i].name);
	}

304
	puts(" The most commonly used perf commands are:");
305
	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
306
		printf("   %-*s   ", longest, common_cmds[i].name);
307 308 309 310 311 312
		puts(common_cmds[i].help);
	}
}

static const char *cmd_to_page(const char *perf_cmd)
{
313 314
	char *s;

315 316
	if (!perf_cmd)
		return "perf";
317
	else if (strstarts(perf_cmd, "perf"))
318
		return perf_cmd;
319 320

	return asprintf(&s, "perf-%s", perf_cmd) < 0 ? NULL : s;
321 322 323 324
}

static void setup_man_path(void)
{
325
	char *new_path;
326 327 328 329 330 331
	const char *old_path = getenv("MANPATH");

	/* We should always put ':' after our path. If there is no
	 * old_path, the ':' at the end will let 'man' to try
	 * system-wide paths after ours to find the manual page. If
	 * there is old_path, we need ':' as delimiter. */
332 333 334 335
	if (asprintf(&new_path, "%s:%s", system_path(PERF_MAN_PATH), old_path ?: "") > 0) {
		setenv("MANPATH", new_path, 1);
		free(new_path);
	} else {
336
		pr_err("Unable to setup man path");
337
	}
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
}

static void exec_viewer(const char *name, const char *page)
{
	const char *info = get_man_viewer_info(name);

	if (!strcasecmp(name, "man"))
		exec_man_man(info, page);
	else if (!strcasecmp(name, "woman"))
		exec_woman_emacs(info, page);
	else if (!strcasecmp(name, "konqueror"))
		exec_man_konqueror(info, page);
	else if (info)
		exec_man_cmd(info, page);
	else
353
		pr_warning("'%s': unknown man viewer.", name);
354 355
}

356
static int show_man_page(const char *perf_cmd)
357 358 359 360 361 362 363 364
{
	struct man_viewer_list *viewer;
	const char *page = cmd_to_page(perf_cmd);
	const char *fallback = getenv("PERF_MAN_VIEWER");

	setup_man_path();
	for (viewer = man_viewer_list; viewer; viewer = viewer->next)
		exec_viewer(viewer->name, page); /* will return when unable */
365

366 367 368
	if (fallback)
		exec_viewer(fallback, page);
	exec_viewer("man", page);
369 370 371

	pr_err("no man viewer handled the request");
	return -1;
372 373
}

374
static int show_info_page(const char *perf_cmd)
375 376 377 378
{
	const char *page = cmd_to_page(perf_cmd);
	setenv("INFOPATH", system_path(PERF_INFO_PATH), 1);
	execlp("info", "info", "perfman", page, NULL);
379
	return -1;
380 381
}

382
static int get_html_page_path(char **page_path, const char *page)
383 384 385 386 387 388
{
	struct stat st;
	const char *html_path = system_path(PERF_HTML_PATH);

	/* Check that we have a perf documentation directory. */
	if (stat(mkpath("%s/perf.html", html_path), &st)
389 390 391 392
	    || !S_ISREG(st.st_mode)) {
		pr_err("'%s': not a documentation directory.", html_path);
		return -1;
	}
393

394
	return asprintf(page_path, "%s/%s.html", html_path, page);
395 396 397 398 399 400 401 402
}

/*
 * If open_html is not defined in a platform-specific way (see for
 * example compat/mingw.h), we use the script web--browse to display
 * HTML.
 */
#ifndef open_html
403
static void open_html(const char *path)
404
{
405
	execl_cmd("web--browse", "-c", "help.browser", path, NULL);
406 407 408
}
#endif

409
static int show_html_page(const char *perf_cmd)
410 411
{
	const char *page = cmd_to_page(perf_cmd);
412
	char *page_path; /* it leaks but we exec bellow */
413

414
	if (get_html_page_path(&page_path, page) < 0)
415
		return -1;
416

417
	open_html(page_path);
418 419

	return 0;
420 421
}

422
int cmd_help(int argc, const char **argv)
423
{
424
	bool show_all = false;
425
	enum help_format help_format = HELP_FORMAT_MAN;
426 427 428 429 430 431 432 433 434
	struct option builtin_help_options[] = {
	OPT_BOOLEAN('a', "all", &show_all, "print all available commands"),
	OPT_SET_UINT('m', "man", &help_format, "show man page", HELP_FORMAT_MAN),
	OPT_SET_UINT('w', "web", &help_format, "show manual in web browser",
			HELP_FORMAT_WEB),
	OPT_SET_UINT('i', "info", &help_format, "show info page",
			HELP_FORMAT_INFO),
	OPT_END(),
	};
435 436 437
	const char * const builtin_help_subcommands[] = {
		"buildid-cache", "buildid-list", "diff", "evlist", "help", "list",
		"record", "report", "bench", "stat", "timechart", "top", "annotate",
438
		"script", "sched", "kallsyms", "kmem", "lock", "kvm", "test", "inject", "mem", "data",
439 440 441
#ifdef HAVE_LIBELF_SUPPORT
		"probe",
#endif
442
#if defined(HAVE_LIBAUDIT_SUPPORT) || defined(HAVE_SYSCALL_TABLE)
443 444 445 446
		"trace",
#endif
	NULL };
	const char *builtin_help_usage[] = {
447 448 449
		"perf help [--all] [--man|--web|--info] [command]",
		NULL
	};
450
	int rc;
451

452 453
	load_command_list("perf-", &main_cmds, &other_cmds);

454 455 456
	rc = perf_config(perf_help_config, &help_format);
	if (rc)
		return rc;
457

458 459
	argc = parse_options_subcommand(argc, argv, builtin_help_options,
			builtin_help_subcommands, builtin_help_usage, 0);
460 461

	if (show_all) {
462
		printf("\n Usage: %s\n\n", perf_usage_string);
463
		list_commands("perf commands", &main_cmds, &other_cmds);
464
		printf(" %s\n\n", perf_more_info_string);
465 466 467 468
		return 0;
	}

	if (!argv[0]) {
469
		printf("\n usage: %s\n\n", perf_usage_string);
470
		list_common_cmds_help();
471
		printf("\n %s\n\n", perf_more_info_string);
472 473 474 475 476
		return 0;
	}

	switch (help_format) {
	case HELP_FORMAT_MAN:
477
		rc = show_man_page(argv[0]);
478 479
		break;
	case HELP_FORMAT_INFO:
480
		rc = show_info_page(argv[0]);
481 482
		break;
	case HELP_FORMAT_WEB:
483 484 485 486
		rc = show_html_page(argv[0]);
		break;
	case HELP_FORMAT_NONE:
		/* fall-through */
487
	default:
488
		rc = -1;
489 490 491
		break;
	}

492
	return rc;
493
}