tools/perf/util/probe-file.c

   1 /*
   2  * probe-file.c : operate ftrace k/uprobe events files
   3  *
   4  * Written by Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  */
  17 #include "util.h"
  18 #include "event.h"
  19 #include "strlist.h"
  20 #include "debug.h"
  21 #include "cache.h"
  22 #include "color.h"
  23 #include "symbol.h"
  24 #include "thread.h"
  25 #include <api/fs/tracing_path.h>
  26 #include "probe-event.h"
  27 #include "probe-file.h"
  28 #include "session.h"
  29
  30 #define MAX_CMDLEN 256
  31
  32 static void print_open_warning(int err, bool uprobe)
  33 {
  34         char sbuf[STRERR_BUFSIZE];
  35
  36         if (err == -ENOENT) {
  37                 const char *config;
  38
  39                 if (uprobe)
  40                         config = "CONFIG_UPROBE_EVENTS";
  41                 else
  42                         config = "CONFIG_KPROBE_EVENTS";
  43
  44                 pr_warning("%cprobe_events file does not exist"
  45                            " - please rebuild kernel with %s.\n",
  46                            uprobe ? 'u' : 'k', config);
  47         } else if (err == -ENOTSUP)
  48                 pr_warning("Tracefs or debugfs is not mounted.\n");
  49         else
  50                 pr_warning("Failed to open %cprobe_events: %s\n",
  51                            uprobe ? 'u' : 'k',
  52                            strerror_r(-err, sbuf, sizeof(sbuf)));
  53 }
  54
  55 static void print_both_open_warning(int kerr, int uerr)
  56 {
  57         /* Both kprobes and uprobes are disabled, warn it. */
  58         if (kerr == -ENOTSUP && uerr == -ENOTSUP)
  59                 pr_warning("Tracefs or debugfs is not mounted.\n");
  60         else if (kerr == -ENOENT && uerr == -ENOENT)
  61                 pr_warning("Please rebuild kernel with CONFIG_KPROBE_EVENTS "
  62                            "or/and CONFIG_UPROBE_EVENTS.\n");
  63         else {
  64                 char sbuf[STRERR_BUFSIZE];
  65                 pr_warning("Failed to open kprobe events: %s.\n",
  66                            strerror_r(-kerr, sbuf, sizeof(sbuf)));
  67                 pr_warning("Failed to open uprobe events: %s.\n",
  68                            strerror_r(-uerr, sbuf, sizeof(sbuf)));
  69         }
  70 }
  71
  72 static int open_probe_events(const char *trace_file, bool readwrite)
  73 {
  74         char buf[PATH_MAX];
  75         const char *tracing_dir = "";
  76         int ret;
  77
  78         ret = e_snprintf(buf, PATH_MAX, "%s/%s%s",
  79                          tracing_path, tracing_dir, trace_file);
  80         if (ret >= 0) {
  81                 pr_debug("Opening %s write=%d\n", buf, readwrite);
  82                 if (readwrite && !probe_event_dry_run)
  83                         ret = open(buf, O_RDWR | O_APPEND, 0);
  84                 else
  85                         ret = open(buf, O_RDONLY, 0);
  86
  87                 if (ret < 0)
  88                         ret = -errno;
  89         }
  90         return ret;
  91 }
  92
  93 static int open_kprobe_events(bool readwrite)
  94 {
  95         return open_probe_events("kprobe_events", readwrite);
  96 }
  97
  98 static int open_uprobe_events(bool readwrite)
  99 {
 100         return open_probe_events("uprobe_events", readwrite);
 101 }
 102
 103 int probe_file__open(int flag)
 104 {
 105         int fd;
 106
 107         if (flag & PF_FL_UPROBE)
 108                 fd = open_uprobe_events(flag & PF_FL_RW);
 109         else
 110                 fd = open_kprobe_events(flag & PF_FL_RW);
 111         if (fd < 0)
 112                 print_open_warning(fd, flag & PF_FL_UPROBE);
 113
 114         return fd;
 115 }
 116
 117 int probe_file__open_both(int *kfd, int *ufd, int flag)
 118 {
 119         if (!kfd || !ufd)
 120                 return -EINVAL;
 121
 122         *kfd = open_kprobe_events(flag & PF_FL_RW);
 123         *ufd = open_uprobe_events(flag & PF_FL_RW);
 124         if (*kfd < 0 && *ufd < 0) {
 125                 print_both_open_warning(*kfd, *ufd);
 126                 return *kfd;
 127         }
 128
 129         return 0;
 130 }
 131
 132 /* Get raw string list of current kprobe_events  or uprobe_events */
 133 struct strlist *probe_file__get_rawlist(int fd)
 134 {
 135         int ret, idx;
 136         FILE *fp;
 137         char buf[MAX_CMDLEN];
 138         char *p;
 139         struct strlist *sl;
 140
 141         sl = strlist__new(NULL, NULL);
 142
 143         fp = fdopen(dup(fd), "r");
 144         while (!feof(fp)) {
 145                 p = fgets(buf, MAX_CMDLEN, fp);
 146                 if (!p)
 147                         break;
 148
 149                 idx = strlen(p) - 1;
 150                 if (p[idx] == '\n')
 151                         p[idx] = '\0';
 152                 ret = strlist__add(sl, buf);
 153                 if (ret < 0) {
 154                         pr_debug("strlist__add failed (%d)\n", ret);
 155                         strlist__delete(sl);
 156                         return NULL;
 157                 }
 158         }
 159         fclose(fp);
 160
 161         return sl;
 162 }
 163
 164 static struct strlist *__probe_file__get_namelist(int fd, bool include_group)
 165 {
 166         char buf[128];
 167         struct strlist *sl, *rawlist;
 168         struct str_node *ent;
 169         struct probe_trace_event tev;
 170         int ret = 0;
 171
 172         memset(&tev, 0, sizeof(tev));
 173         rawlist = probe_file__get_rawlist(fd);
 174         if (!rawlist)
 175                 return NULL;
 176         sl = strlist__new(NULL, NULL);
 177         strlist__for_each(ent, rawlist) {
 178                 ret = parse_probe_trace_command(ent->s, &tev);
 179                 if (ret < 0)
 180                         break;
 181                 if (include_group) {
 182                         ret = e_snprintf(buf, 128, "%s:%s", tev.group,
 183                                         tev.event);
 184                         if (ret >= 0)
 185                                 ret = strlist__add(sl, buf);
 186                 } else
 187                         ret = strlist__add(sl, tev.event);
 188                 clear_probe_trace_event(&tev);
 189                 if (ret < 0)
 190                         break;
 191         }
 192         strlist__delete(rawlist);
 193
 194         if (ret < 0) {
 195                 strlist__delete(sl);
 196                 return NULL;
 197         }
 198         return sl;
 199 }
 200
 201 /* Get current perf-probe event names */
 202 struct strlist *probe_file__get_namelist(int fd)
 203 {
 204         return __probe_file__get_namelist(fd, false);
 205 }
 206
 207 int probe_file__add_event(int fd, struct probe_trace_event *tev)
 208 {
 209         int ret = 0;
 210         char *buf = synthesize_probe_trace_command(tev);
 211         char sbuf[STRERR_BUFSIZE];
 212
 213         if (!buf) {
 214                 pr_debug("Failed to synthesize probe trace event.\n");
 215                 return -EINVAL;
 216         }
 217
 218         pr_debug("Writing event: %s\n", buf);
 219         if (!probe_event_dry_run) {
 220                 ret = write(fd, buf, strlen(buf));
 221                 if (ret <= 0) {
 222                         ret = -errno;
 223                         pr_warning("Failed to write event: %s\n",
 224                                    strerror_r(errno, sbuf, sizeof(sbuf)));
 225                 }
 226         }
 227         free(buf);
 228
 229         return ret;
 230 }
 231
 232 static int __del_trace_probe_event(int fd, struct str_node *ent)
 233 {
 234         char *p;
 235         char buf[128];
 236         int ret;
 237
 238         /* Convert from perf-probe event to trace-probe event */
 239         ret = e_snprintf(buf, 128, "-:%s", ent->s);
 240         if (ret < 0)
 241                 goto error;
 242
 243         p = strchr(buf + 2, ':');
 244         if (!p) {
 245                 pr_debug("Internal error: %s should have ':' but not.\n",
 246                          ent->s);
 247                 ret = -ENOTSUP;
 248                 goto error;
 249         }
 250         *p = '/';
 251
 252         pr_debug("Writing event: %s\n", buf);
 253         ret = write(fd, buf, strlen(buf));
 254         if (ret < 0) {
 255                 ret = -errno;
 256                 goto error;
 257         }
 258
 259         return 0;
 260 error:
 261         pr_warning("Failed to delete event: %s\n",
 262                    strerror_r(-ret, buf, sizeof(buf)));
 263         return ret;
 264 }
 265
 266 int probe_file__get_events(int fd, struct strfilter *filter,
 267                            struct strlist *plist)
 268 {
 269         struct strlist *namelist;
 270         struct str_node *ent;
 271         const char *p;
 272         int ret = -ENOENT;
 273
 274         namelist = __probe_file__get_namelist(fd, true);
 275         if (!namelist)
 276                 return -ENOENT;
 277
 278         strlist__for_each(ent, namelist) {
 279                 p = strchr(ent->s, ':');
 280                 if ((p && strfilter__compare(filter, p + 1)) ||
 281                     strfilter__compare(filter, ent->s)) {
 282                         strlist__add(plist, ent->s);
 283                         ret = 0;
 284                 }
 285         }
 286         strlist__delete(namelist);
 287
 288         return ret;
 289 }
 290
 291 int probe_file__del_strlist(int fd, struct strlist *namelist)
 292 {
 293         int ret = 0;
 294         struct str_node *ent;
 295
 296         strlist__for_each(ent, namelist) {
 297                 ret = __del_trace_probe_event(fd, ent);
 298                 if (ret < 0)
 299                         break;
 300         }
 301         return ret;
 302 }
 303
 304 int probe_file__del_events(int fd, struct strfilter *filter)
 305 {
 306         struct strlist *namelist;
 307         int ret;
 308
 309         namelist = strlist__new(NULL, NULL);
 310         if (!namelist)
 311                 return -ENOMEM;
 312
 313         ret = probe_file__get_events(fd, filter, namelist);
 314         if (ret < 0)
 315                 return ret;
 316
 317         ret = probe_file__del_strlist(fd, namelist);
 318         strlist__delete(namelist);
 319
 320         return ret;
 321 }