6b1507566770140da4519887bec6543eabe404b1
[linux-2.6-microblaze.git] / tools / perf / builtin-probe.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * builtin-probe.c
4  *
5  * Builtin probe command: Set up probe events by C expression
6  *
7  * Written by Masami Hiramatsu <mhiramat@redhat.com>
8  */
9 #include <sys/utsname.h>
10 #include <sys/types.h>
11 #include <sys/stat.h>
12 #include <fcntl.h>
13 #include <errno.h>
14 #include <stdio.h>
15 #include <unistd.h>
16 #include <stdlib.h>
17 #include <string.h>
18
19 #include "builtin.h"
20 #include "namespaces.h"
21 #include "util/build-id.h"
22 #include "util/strlist.h"
23 #include "util/strfilter.h"
24 #include "util/symbol_conf.h"
25 #include "util/debug.h"
26 #include <subcmd/parse-options.h>
27 #include "util/probe-finder.h"
28 #include "util/probe-event.h"
29 #include "util/probe-file.h"
30 #include <linux/string.h>
31 #include <linux/zalloc.h>
32
33 #define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*"
34 #define DEFAULT_FUNC_FILTER "!_*"
35 #define DEFAULT_LIST_FILTER "*"
36
37 /* Session management structure */
38 static struct {
39         int command;    /* Command short_name */
40         bool list_events;
41         bool uprobes;
42         bool quiet;
43         bool target_used;
44         int nevents;
45         struct perf_probe_event events[MAX_PROBES];
46         struct line_range line_range;
47         char *target;
48         struct strfilter *filter;
49         struct nsinfo *nsi;
50 } params;
51
52 /* Parse an event definition. Note that any error must die. */
53 static int parse_probe_event(const char *str)
54 {
55         struct perf_probe_event *pev = &params.events[params.nevents];
56         int ret;
57
58         pr_debug("probe-definition(%d): %s\n", params.nevents, str);
59         if (++params.nevents == MAX_PROBES) {
60                 pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
61                 return -1;
62         }
63
64         pev->uprobes = params.uprobes;
65         if (params.target) {
66                 pev->target = strdup(params.target);
67                 if (!pev->target)
68                         return -ENOMEM;
69                 params.target_used = true;
70         }
71
72         pev->nsi = nsinfo__get(params.nsi);
73
74         /* Parse a perf-probe command into event */
75         ret = parse_perf_probe_command(str, pev);
76         pr_debug("%d arguments\n", pev->nargs);
77
78         return ret;
79 }
80
81 static int params_add_filter(const char *str)
82 {
83         const char *err = NULL;
84         int ret = 0;
85
86         pr_debug2("Add filter: %s\n", str);
87         if (!params.filter) {
88                 params.filter = strfilter__new(str, &err);
89                 if (!params.filter)
90                         ret = err ? -EINVAL : -ENOMEM;
91         } else
92                 ret = strfilter__or(params.filter, str, &err);
93
94         if (ret == -EINVAL) {
95                 pr_err("Filter parse error at %td.\n", err - str + 1);
96                 pr_err("Source: \"%s\"\n", str);
97                 pr_err("         %*c\n", (int)(err - str + 1), '^');
98         }
99
100         return ret;
101 }
102
103 static int set_target(const char *ptr)
104 {
105         int found = 0;
106         const char *buf;
107
108         /*
109          * The first argument after options can be an absolute path
110          * to an executable / library or kernel module.
111          *
112          * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
113          * short module name.
114          */
115         if (!params.target && ptr && *ptr == '/') {
116                 params.target = strdup(ptr);
117                 if (!params.target)
118                         return -ENOMEM;
119                 params.target_used = false;
120
121                 found = 1;
122                 buf = ptr + (strlen(ptr) - 3);
123
124                 if (strcmp(buf, ".ko"))
125                         params.uprobes = true;
126
127         }
128
129         return found;
130 }
131
132 static int parse_probe_event_argv(int argc, const char **argv)
133 {
134         int i, len, ret, found_target;
135         char *buf;
136
137         found_target = set_target(argv[0]);
138         if (found_target < 0)
139                 return found_target;
140
141         if (found_target && argc == 1)
142                 return 0;
143
144         /* Bind up rest arguments */
145         len = 0;
146         for (i = 0; i < argc; i++) {
147                 if (i == 0 && found_target)
148                         continue;
149
150                 len += strlen(argv[i]) + 1;
151         }
152         buf = zalloc(len + 1);
153         if (buf == NULL)
154                 return -ENOMEM;
155         len = 0;
156         for (i = 0; i < argc; i++) {
157                 if (i == 0 && found_target)
158                         continue;
159
160                 len += sprintf(&buf[len], "%s ", argv[i]);
161         }
162         ret = parse_probe_event(buf);
163         free(buf);
164         return ret;
165 }
166
167 static int opt_set_target(const struct option *opt, const char *str,
168                         int unset __maybe_unused)
169 {
170         int ret = -ENOENT;
171         char *tmp;
172
173         if  (str) {
174                 if (!strcmp(opt->long_name, "exec"))
175                         params.uprobes = true;
176                 else if (!strcmp(opt->long_name, "module"))
177                         params.uprobes = false;
178                 else
179                         return ret;
180
181                 /* Expand given path to absolute path, except for modulename */
182                 if (params.uprobes || strchr(str, '/')) {
183                         tmp = nsinfo__realpath(str, params.nsi);
184                         if (!tmp) {
185                                 pr_warning("Failed to get the absolute path of %s: %m\n", str);
186                                 return ret;
187                         }
188                 } else {
189                         tmp = strdup(str);
190                         if (!tmp)
191                                 return -ENOMEM;
192                 }
193                 free(params.target);
194                 params.target = tmp;
195                 params.target_used = false;
196                 ret = 0;
197         }
198
199         return ret;
200 }
201
202 static int opt_set_target_ns(const struct option *opt __maybe_unused,
203                              const char *str, int unset __maybe_unused)
204 {
205         int ret = -ENOENT;
206         pid_t ns_pid;
207         struct nsinfo *nsip;
208
209         if (str) {
210                 errno = 0;
211                 ns_pid = (pid_t)strtol(str, NULL, 10);
212                 if (errno != 0) {
213                         ret = -errno;
214                         pr_warning("Failed to parse %s as a pid: %s\n", str,
215                                    strerror(errno));
216                         return ret;
217                 }
218                 nsip = nsinfo__new(ns_pid);
219                 if (nsip && nsip->need_setns)
220                         params.nsi = nsinfo__get(nsip);
221                 nsinfo__put(nsip);
222
223                 ret = 0;
224         }
225
226         return ret;
227 }
228
229
230 /* Command option callbacks */
231
232 #ifdef HAVE_DWARF_SUPPORT
233 static int opt_show_lines(const struct option *opt,
234                           const char *str, int unset __maybe_unused)
235 {
236         int ret = 0;
237
238         if (!str)
239                 return 0;
240
241         if (params.command == 'L') {
242                 pr_warning("Warning: more than one --line options are"
243                            " detected. Only the first one is valid.\n");
244                 return 0;
245         }
246
247         params.command = opt->short_name;
248         ret = parse_line_range_desc(str, &params.line_range);
249
250         return ret;
251 }
252
253 static int opt_show_vars(const struct option *opt,
254                          const char *str, int unset __maybe_unused)
255 {
256         struct perf_probe_event *pev = &params.events[params.nevents];
257         int ret;
258
259         if (!str)
260                 return 0;
261
262         ret = parse_probe_event(str);
263         if (!ret && pev->nargs != 0) {
264                 pr_err("  Error: '--vars' doesn't accept arguments.\n");
265                 return -EINVAL;
266         }
267         params.command = opt->short_name;
268
269         return ret;
270 }
271 #else
272 # define opt_show_lines NULL
273 # define opt_show_vars NULL
274 #endif
275 static int opt_add_probe_event(const struct option *opt,
276                               const char *str, int unset __maybe_unused)
277 {
278         if (str) {
279                 params.command = opt->short_name;
280                 return parse_probe_event(str);
281         }
282
283         return 0;
284 }
285
286 static int opt_set_filter_with_command(const struct option *opt,
287                                        const char *str, int unset)
288 {
289         if (!unset)
290                 params.command = opt->short_name;
291
292         if (str)
293                 return params_add_filter(str);
294
295         return 0;
296 }
297
298 static int opt_set_filter(const struct option *opt __maybe_unused,
299                           const char *str, int unset __maybe_unused)
300 {
301         if (str)
302                 return params_add_filter(str);
303
304         return 0;
305 }
306
307 static int init_params(void)
308 {
309         return line_range__init(&params.line_range);
310 }
311
312 static void cleanup_params(void)
313 {
314         int i;
315
316         for (i = 0; i < params.nevents; i++)
317                 clear_perf_probe_event(params.events + i);
318         line_range__clear(&params.line_range);
319         free(params.target);
320         strfilter__delete(params.filter);
321         nsinfo__put(params.nsi);
322         memset(&params, 0, sizeof(params));
323 }
324
325 static void pr_err_with_code(const char *msg, int err)
326 {
327         char sbuf[STRERR_BUFSIZE];
328
329         pr_err("%s", msg);
330         pr_debug(" Reason: %s (Code: %d)",
331                  str_error_r(-err, sbuf, sizeof(sbuf)), err);
332         pr_err("\n");
333 }
334
335 static int perf_add_probe_events(struct perf_probe_event *pevs, int npevs)
336 {
337         int ret;
338         int i, k;
339         const char *event = NULL, *group = NULL;
340
341         ret = init_probe_symbol_maps(pevs->uprobes);
342         if (ret < 0)
343                 return ret;
344
345         ret = convert_perf_probe_events(pevs, npevs);
346         if (ret < 0)
347                 goto out_cleanup;
348
349         if (params.command == 'D') {    /* it shows definition */
350                 ret = show_probe_trace_events(pevs, npevs);
351                 goto out_cleanup;
352         }
353
354         ret = apply_perf_probe_events(pevs, npevs);
355         if (ret < 0)
356                 goto out_cleanup;
357
358         for (i = k = 0; i < npevs; i++)
359                 k += pevs[i].ntevs;
360
361         pr_info("Added new event%s\n", (k > 1) ? "s:" : ":");
362         for (i = 0; i < npevs; i++) {
363                 struct perf_probe_event *pev = &pevs[i];
364
365                 for (k = 0; k < pev->ntevs; k++) {
366                         struct probe_trace_event *tev = &pev->tevs[k];
367                         /* Skipped events have no event name */
368                         if (!tev->event)
369                                 continue;
370
371                         /* We use tev's name for showing new events */
372                         show_perf_probe_event(tev->group, tev->event, pev,
373                                               tev->point.module, false);
374
375                         /* Save the last valid name */
376                         event = tev->event;
377                         group = tev->group;
378                 }
379         }
380
381         /* Note that it is possible to skip all events because of blacklist */
382         if (event) {
383                 /* Show how to use the event. */
384                 pr_info("\nYou can now use it in all perf tools, such as:\n\n");
385                 pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
386         }
387
388 out_cleanup:
389         cleanup_perf_probe_events(pevs, npevs);
390         exit_probe_symbol_maps();
391         return ret;
392 }
393
394 static int del_perf_probe_caches(struct strfilter *filter)
395 {
396         struct probe_cache *cache;
397         struct strlist *bidlist;
398         struct str_node *nd;
399         int ret;
400
401         bidlist = build_id_cache__list_all(false);
402         if (!bidlist) {
403                 ret = -errno;
404                 pr_debug("Failed to get buildids: %d\n", ret);
405                 return ret ?: -ENOMEM;
406         }
407
408         strlist__for_each_entry(nd, bidlist) {
409                 cache = probe_cache__new(nd->s, NULL);
410                 if (!cache)
411                         continue;
412                 if (probe_cache__filter_purge(cache, filter) < 0 ||
413                     probe_cache__commit(cache) < 0)
414                         pr_warning("Failed to remove entries for %s\n", nd->s);
415                 probe_cache__delete(cache);
416         }
417         return 0;
418 }
419
420 static int perf_del_probe_events(struct strfilter *filter)
421 {
422         int ret, ret2, ufd = -1, kfd = -1;
423         char *str = strfilter__string(filter);
424         struct strlist *klist = NULL, *ulist = NULL;
425         struct str_node *ent;
426
427         if (!str)
428                 return -EINVAL;
429
430         pr_debug("Delete filter: \'%s\'\n", str);
431
432         if (probe_conf.cache)
433                 return del_perf_probe_caches(filter);
434
435         /* Get current event names */
436         ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
437         if (ret < 0)
438                 goto out;
439
440         klist = strlist__new(NULL, NULL);
441         ulist = strlist__new(NULL, NULL);
442         if (!klist || !ulist) {
443                 ret = -ENOMEM;
444                 goto out;
445         }
446
447         ret = probe_file__get_events(kfd, filter, klist);
448         if (ret == 0) {
449                 strlist__for_each_entry(ent, klist)
450                         pr_info("Removed event: %s\n", ent->s);
451
452                 ret = probe_file__del_strlist(kfd, klist);
453                 if (ret < 0)
454                         goto error;
455         } else if (ret == -ENOMEM)
456                 goto error;
457
458         ret2 = probe_file__get_events(ufd, filter, ulist);
459         if (ret2 == 0) {
460                 strlist__for_each_entry(ent, ulist)
461                         pr_info("Removed event: %s\n", ent->s);
462
463                 ret2 = probe_file__del_strlist(ufd, ulist);
464                 if (ret2 < 0)
465                         goto error;
466         } else if (ret2 == -ENOMEM)
467                 goto error;
468
469         if (ret == -ENOENT && ret2 == -ENOENT)
470                 pr_warning("\"%s\" does not hit any event.\n", str);
471         else
472                 ret = 0;
473
474 error:
475         if (kfd >= 0)
476                 close(kfd);
477         if (ufd >= 0)
478                 close(ufd);
479 out:
480         strlist__delete(klist);
481         strlist__delete(ulist);
482         free(str);
483
484         return ret;
485 }
486
487 #ifdef HAVE_DWARF_SUPPORT
488 #define PROBEDEF_STR    \
489         "[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT [[NAME=]ARG ...]"
490 #else
491 #define PROBEDEF_STR    "[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]"
492 #endif
493
494
495 static int
496 __cmd_probe(int argc, const char **argv)
497 {
498         const char * const probe_usage[] = {
499                 "perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
500                 "perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
501                 "perf probe [<options>] --del '[GROUP:]EVENT' ...",
502                 "perf probe --list [GROUP:]EVENT ...",
503 #ifdef HAVE_DWARF_SUPPORT
504                 "perf probe [<options>] --line 'LINEDESC'",
505                 "perf probe [<options>] --vars 'PROBEPOINT'",
506 #endif
507                 "perf probe [<options>] --funcs",
508                 NULL
509         };
510         struct option options[] = {
511         OPT_INCR('v', "verbose", &verbose,
512                     "be more verbose (show parsed arguments, etc)"),
513         OPT_BOOLEAN('q', "quiet", &params.quiet,
514                     "be quiet (do not show any messages)"),
515         OPT_CALLBACK_DEFAULT('l', "list", NULL, "[GROUP:]EVENT",
516                              "list up probe events",
517                              opt_set_filter_with_command, DEFAULT_LIST_FILTER),
518         OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
519                      opt_set_filter_with_command),
520         OPT_CALLBACK('a', "add", NULL, PROBEDEF_STR,
521                 "probe point definition, where\n"
522                 "\t\tGROUP:\tGroup name (optional)\n"
523                 "\t\tEVENT:\tEvent name\n"
524                 "\t\tFUNC:\tFunction name\n"
525                 "\t\tOFF:\tOffset from function entry (in byte)\n"
526                 "\t\t%return:\tPut the probe at function return\n"
527 #ifdef HAVE_DWARF_SUPPORT
528                 "\t\tSRC:\tSource code path\n"
529                 "\t\tRL:\tRelative line number from function entry.\n"
530                 "\t\tAL:\tAbsolute line number in file.\n"
531                 "\t\tPT:\tLazy expression of line code.\n"
532                 "\t\tARG:\tProbe argument (local variable name or\n"
533                 "\t\t\tkprobe-tracer argument format.)\n",
534 #else
535                 "\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
536 #endif
537                 opt_add_probe_event),
538         OPT_CALLBACK('D', "definition", NULL, PROBEDEF_STR,
539                 "Show trace event definition of given traceevent for k/uprobe_events.",
540                 opt_add_probe_event),
541         OPT_BOOLEAN('f', "force", &probe_conf.force_add, "forcibly add events"
542                     " with existing name"),
543         OPT_CALLBACK('L', "line", NULL,
544                      "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
545                      "Show source code lines.", opt_show_lines),
546         OPT_CALLBACK('V', "vars", NULL,
547                      "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
548                      "Show accessible variables on PROBEDEF", opt_show_vars),
549         OPT_BOOLEAN('\0', "externs", &probe_conf.show_ext_vars,
550                     "Show external variables too (with --vars only)"),
551         OPT_BOOLEAN('\0', "range", &probe_conf.show_location_range,
552                 "Show variables location range in scope (with --vars only)"),
553         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
554                    "file", "vmlinux pathname"),
555         OPT_STRING('s', "source", &symbol_conf.source_prefix,
556                    "directory", "path to kernel source"),
557         OPT_BOOLEAN('\0', "no-inlines", &probe_conf.no_inlines,
558                 "Don't search inlined functions"),
559         OPT__DRY_RUN(&probe_event_dry_run),
560         OPT_INTEGER('\0', "max-probes", &probe_conf.max_probes,
561                  "Set how many probe points can be found for a probe."),
562         OPT_CALLBACK_DEFAULT('F', "funcs", NULL, "[FILTER]",
563                              "Show potential probe-able functions.",
564                              opt_set_filter_with_command, DEFAULT_FUNC_FILTER),
565         OPT_CALLBACK('\0', "filter", NULL,
566                      "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
567                      "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
568                      "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
569                      opt_set_filter),
570         OPT_CALLBACK('x', "exec", NULL, "executable|path",
571                         "target executable name or path", opt_set_target),
572         OPT_CALLBACK('m', "module", NULL, "modname|path",
573                 "target module name (for online) or path (for offline)",
574                 opt_set_target),
575         OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
576                     "Enable symbol demangling"),
577         OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
578                     "Enable kernel symbol demangling"),
579         OPT_BOOLEAN(0, "cache", &probe_conf.cache, "Manipulate probe cache"),
580         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
581                    "Look for files with symbols relative to this directory"),
582         OPT_CALLBACK(0, "target-ns", NULL, "pid",
583                      "target pid for namespace contexts", opt_set_target_ns),
584         OPT_END()
585         };
586         int ret;
587
588         set_option_flag(options, 'a', "add", PARSE_OPT_EXCLUSIVE);
589         set_option_flag(options, 'd', "del", PARSE_OPT_EXCLUSIVE);
590         set_option_flag(options, 'D', "definition", PARSE_OPT_EXCLUSIVE);
591         set_option_flag(options, 'l', "list", PARSE_OPT_EXCLUSIVE);
592 #ifdef HAVE_DWARF_SUPPORT
593         set_option_flag(options, 'L', "line", PARSE_OPT_EXCLUSIVE);
594         set_option_flag(options, 'V', "vars", PARSE_OPT_EXCLUSIVE);
595 #else
596 # define set_nobuild(s, l, c) set_option_nobuild(options, s, l, "NO_DWARF=1", c)
597         set_nobuild('L', "line", false);
598         set_nobuild('V', "vars", false);
599         set_nobuild('\0', "externs", false);
600         set_nobuild('\0', "range", false);
601         set_nobuild('k', "vmlinux", true);
602         set_nobuild('s', "source", true);
603         set_nobuild('\0', "no-inlines", true);
604 # undef set_nobuild
605 #endif
606         set_option_flag(options, 'F', "funcs", PARSE_OPT_EXCLUSIVE);
607
608         argc = parse_options(argc, argv, options, probe_usage,
609                              PARSE_OPT_STOP_AT_NON_OPTION);
610         if (argc > 0) {
611                 if (strcmp(argv[0], "-") == 0) {
612                         usage_with_options_msg(probe_usage, options,
613                                 "'-' is not supported.\n");
614                 }
615                 if (params.command && params.command != 'a') {
616                         usage_with_options_msg(probe_usage, options,
617                                 "another command except --add is set.\n");
618                 }
619                 ret = parse_probe_event_argv(argc, argv);
620                 if (ret < 0) {
621                         pr_err_with_code("  Error: Command Parse Error.", ret);
622                         return ret;
623                 }
624                 params.command = 'a';
625         }
626
627         if (params.quiet) {
628                 if (verbose != 0) {
629                         pr_err("  Error: -v and -q are exclusive.\n");
630                         return -EINVAL;
631                 }
632                 verbose = -1;
633         }
634
635         if (probe_conf.max_probes == 0)
636                 probe_conf.max_probes = MAX_PROBES;
637
638         /*
639          * Only consider the user's kernel image path if given.
640          */
641         symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
642
643         /*
644          * Except for --list, --del and --add, other command doesn't depend
645          * nor change running kernel. So if user gives offline vmlinux,
646          * ignore its buildid.
647          */
648         if (!strchr("lda", params.command) && symbol_conf.vmlinux_name)
649                 symbol_conf.ignore_vmlinux_buildid = true;
650
651         switch (params.command) {
652         case 'l':
653                 if (params.uprobes) {
654                         pr_err("  Error: Don't use --list with --exec.\n");
655                         parse_options_usage(probe_usage, options, "l", true);
656                         parse_options_usage(NULL, options, "x", true);
657                         return -EINVAL;
658                 }
659                 ret = show_perf_probe_events(params.filter);
660                 if (ret < 0)
661                         pr_err_with_code("  Error: Failed to show event list.", ret);
662                 return ret;
663         case 'F':
664                 ret = show_available_funcs(params.target, params.nsi,
665                                            params.filter, params.uprobes);
666                 if (ret < 0)
667                         pr_err_with_code("  Error: Failed to show functions.", ret);
668                 return ret;
669 #ifdef HAVE_DWARF_SUPPORT
670         case 'L':
671                 ret = show_line_range(&params.line_range, params.target,
672                                       params.nsi, params.uprobes);
673                 if (ret < 0)
674                         pr_err_with_code("  Error: Failed to show lines.", ret);
675                 return ret;
676         case 'V':
677                 if (!params.filter)
678                         params.filter = strfilter__new(DEFAULT_VAR_FILTER,
679                                                        NULL);
680
681                 ret = show_available_vars(params.events, params.nevents,
682                                           params.filter);
683                 if (ret < 0)
684                         pr_err_with_code("  Error: Failed to show vars.", ret);
685                 return ret;
686 #endif
687         case 'd':
688                 ret = perf_del_probe_events(params.filter);
689                 if (ret < 0) {
690                         pr_err_with_code("  Error: Failed to delete events.", ret);
691                         return ret;
692                 }
693                 break;
694         case 'D':
695         case 'a':
696
697                 /* Ensure the last given target is used */
698                 if (params.target && !params.target_used) {
699                         pr_err("  Error: -x/-m must follow the probe definitions.\n");
700                         parse_options_usage(probe_usage, options, "m", true);
701                         parse_options_usage(NULL, options, "x", true);
702                         return -EINVAL;
703                 }
704
705                 ret = perf_add_probe_events(params.events, params.nevents);
706                 if (ret < 0) {
707
708                         /*
709                          * When perf_add_probe_events() fails it calls
710                          * cleanup_perf_probe_events(pevs, npevs), i.e.
711                          * cleanup_perf_probe_events(params.events, params.nevents), which
712                          * will call clear_perf_probe_event(), so set nevents to zero
713                          * to avoid cleanup_params() to call clear_perf_probe_event() again
714                          * on the same pevs.
715                          */
716                         params.nevents = 0;
717                         pr_err_with_code("  Error: Failed to add events.", ret);
718                         return ret;
719                 }
720                 break;
721         default:
722                 usage_with_options(probe_usage, options);
723         }
724         return 0;
725 }
726
727 int cmd_probe(int argc, const char **argv)
728 {
729         int ret;
730
731         ret = init_params();
732         if (!ret) {
733                 ret = __cmd_probe(argc, argv);
734                 cleanup_params();
735         }
736
737         return ret < 0 ? ret : 0;
738 }