tools/perf/builtin-inject.c

   1 /*
   2  * builtin-inject.c
   3  *
   4  * Builtin inject command: Examine the live mode (stdin) event stream
   5  * and repipe it to stdout while optionally injecting additional
   6  * events into it.
   7  */
   8 #include "builtin.h"
   9
  10 #include "perf.h"
  11 #include "util/color.h"
  12 #include "util/evlist.h"
  13 #include "util/evsel.h"
  14 #include "util/session.h"
  15 #include "util/tool.h"
  16 #include "util/debug.h"
  17 #include "util/build-id.h"
  18
  19 #include "util/parse-options.h"
  20
  21 #include <linux/list.h>
  22
  23 struct perf_inject {
  24         struct perf_tool tool;
  25         bool             build_ids;
  26         bool             sched_stat;
  27         const char       *input_name;
  28         int              pipe_output,
  29                          output;
  30         u64              bytes_written;
  31         struct list_head samples;
  32 };
  33
  34 struct event_entry {
  35         struct list_head node;
  36         u32              tid;
  37         union perf_event event[0];
  38 };
  39
  40 static int perf_event__repipe_synth(struct perf_tool *tool,
  41                                     union perf_event *event)
  42 {
  43         struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
  44         uint32_t size;
  45         void *buf = event;
  46
  47         size = event->header.size;
  48
  49         while (size) {
  50                 int ret = write(inject->output, buf, size);
  51                 if (ret < 0)
  52                         return -errno;
  53
  54                 size -= ret;
  55                 buf += ret;
  56                 inject->bytes_written += ret;
  57         }
  58
  59         return 0;
  60 }
  61
  62 static int perf_event__repipe_op2_synth(struct perf_tool *tool,
  63                                         union perf_event *event,
  64                                         struct perf_session *session
  65                                         __maybe_unused)
  66 {
  67         return perf_event__repipe_synth(tool, event);
  68 }
  69
  70 static int perf_event__repipe_event_type_synth(struct perf_tool *tool,
  71                                                union perf_event *event)
  72 {
  73         return perf_event__repipe_synth(tool, event);
  74 }
  75
  76 static int perf_event__repipe_attr(struct perf_tool *tool,
  77                                    union perf_event *event,
  78                                    struct perf_evlist **pevlist)
  79 {
  80         int ret;
  81
  82         ret = perf_event__process_attr(tool, event, pevlist);
  83         if (ret)
  84                 return ret;
  85
  86         return perf_event__repipe_synth(tool, event);
  87 }
  88
  89 static int perf_event__repipe(struct perf_tool *tool,
  90                               union perf_event *event,
  91                               struct perf_sample *sample __maybe_unused,
  92                               struct machine *machine __maybe_unused)
  93 {
  94         return perf_event__repipe_synth(tool, event);
  95 }
  96
  97 typedef int (*inject_handler)(struct perf_tool *tool,
  98                               union perf_event *event,
  99                               struct perf_sample *sample,
 100                               struct perf_evsel *evsel,
 101                               struct machine *machine);
 102
 103 static int perf_event__repipe_sample(struct perf_tool *tool,
 104                                      union perf_event *event,
 105                                      struct perf_sample *sample,
 106                                      struct perf_evsel *evsel,
 107                                      struct machine *machine)
 108 {
 109         if (evsel->handler.func) {
 110                 inject_handler f = evsel->handler.func;
 111                 return f(tool, event, sample, evsel, machine);
 112         }
 113
 114         build_id__mark_dso_hit(tool, event, sample, evsel, machine);
 115
 116         return perf_event__repipe_synth(tool, event);
 117 }
 118
 119 static int perf_event__repipe_mmap(struct perf_tool *tool,
 120                                    union perf_event *event,
 121                                    struct perf_sample *sample,
 122                                    struct machine *machine)
 123 {
 124         int err;
 125
 126         err = perf_event__process_mmap(tool, event, sample, machine);
 127         perf_event__repipe(tool, event, sample, machine);
 128
 129         return err;
 130 }
 131
 132 static int perf_event__repipe_fork(struct perf_tool *tool,
 133                                    union perf_event *event,
 134                                    struct perf_sample *sample,
 135                                    struct machine *machine)
 136 {
 137         int err;
 138
 139         err = perf_event__process_fork(tool, event, sample, machine);
 140         perf_event__repipe(tool, event, sample, machine);
 141
 142         return err;
 143 }
 144
 145 static int perf_event__repipe_tracing_data(struct perf_tool *tool,
 146                                            union perf_event *event,
 147                                            struct perf_session *session)
 148 {
 149         int err;
 150
 151         perf_event__repipe_synth(tool, event);
 152         err = perf_event__process_tracing_data(tool, event, session);
 153
 154         return err;
 155 }
 156
 157 static int dso__read_build_id(struct dso *self)
 158 {
 159         if (self->has_build_id)
 160                 return 0;
 161
 162         if (filename__read_build_id(self->long_name, self->build_id,
 163                                     sizeof(self->build_id)) > 0) {
 164                 self->has_build_id = true;
 165                 return 0;
 166         }
 167
 168         return -1;
 169 }
 170
 171 static int dso__inject_build_id(struct dso *self, struct perf_tool *tool,
 172                                 struct machine *machine)
 173 {
 174         u16 misc = PERF_RECORD_MISC_USER;
 175         int err;
 176
 177         if (dso__read_build_id(self) < 0) {
 178                 pr_debug("no build_id found for %s\n", self->long_name);
 179                 return -1;
 180         }
 181
 182         if (self->kernel)
 183                 misc = PERF_RECORD_MISC_KERNEL;
 184
 185         err = perf_event__synthesize_build_id(tool, self, misc, perf_event__repipe,
 186                                               machine);
 187         if (err) {
 188                 pr_err("Can't synthesize build_id event for %s\n", self->long_name);
 189                 return -1;
 190         }
 191
 192         return 0;
 193 }
 194
 195 static int perf_event__inject_buildid(struct perf_tool *tool,
 196                                       union perf_event *event,
 197                                       struct perf_sample *sample,
 198                                       struct perf_evsel *evsel __maybe_unused,
 199                                       struct machine *machine)
 200 {
 201         struct addr_location al;
 202         struct thread *thread;
 203         u8 cpumode;
 204
 205         cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
 206
 207         thread = machine__findnew_thread(machine, event->ip.pid);
 208         if (thread == NULL) {
 209                 pr_err("problem processing %d event, skipping it.\n",
 210                        event->header.type);
 211                 goto repipe;
 212         }
 213
 214         thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
 215                               event->ip.ip, &al);
 216
 217         if (al.map != NULL) {
 218                 if (!al.map->dso->hit) {
 219                         al.map->dso->hit = 1;
 220                         if (map__load(al.map, NULL) >= 0) {
 221                                 dso__inject_build_id(al.map->dso, tool, machine);
 222                                 /*
 223                                  * If this fails, too bad, let the other side
 224                                  * account this as unresolved.
 225                                  */
 226                         } else {
 227 #ifdef LIBELF_SUPPORT
 228                                 pr_warning("no symbols found in %s, maybe "
 229                                            "install a debug package?\n",
 230                                            al.map->dso->long_name);
 231 #endif
 232                         }
 233                 }
 234         }
 235
 236 repipe:
 237         perf_event__repipe(tool, event, sample, machine);
 238         return 0;
 239 }
 240
 241 static int perf_inject__sched_process_exit(struct perf_tool *tool,
 242                                            union perf_event *event __maybe_unused,
 243                                            struct perf_sample *sample,
 244                                            struct perf_evsel *evsel __maybe_unused,
 245                                            struct machine *machine __maybe_unused)
 246 {
 247         struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
 248         struct event_entry *ent;
 249
 250         list_for_each_entry(ent, &inject->samples, node) {
 251                 if (sample->tid == ent->tid) {
 252                         list_del_init(&ent->node);
 253                         free(ent);
 254                         break;
 255                 }
 256         }
 257
 258         return 0;
 259 }
 260
 261 static int perf_inject__sched_switch(struct perf_tool *tool,
 262                                      union perf_event *event,
 263                                      struct perf_sample *sample,
 264                                      struct perf_evsel *evsel,
 265                                      struct machine *machine)
 266 {
 267         struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
 268         struct event_entry *ent;
 269
 270         perf_inject__sched_process_exit(tool, event, sample, evsel, machine);
 271
 272         ent = malloc(event->header.size + sizeof(struct event_entry));
 273         if (ent == NULL) {
 274                 color_fprintf(stderr, PERF_COLOR_RED,
 275                              "Not enough memory to process sched switch event!");
 276                 return -1;
 277         }
 278
 279         ent->tid = sample->tid;
 280         memcpy(&ent->event, event, event->header.size);
 281         list_add(&ent->node, &inject->samples);
 282         return 0;
 283 }
 284
 285 static int perf_inject__sched_stat(struct perf_tool *tool,
 286                                    union perf_event *event __maybe_unused,
 287                                    struct perf_sample *sample,
 288                                    struct perf_evsel *evsel,
 289                                    struct machine *machine)
 290 {
 291         struct event_entry *ent;
 292         union perf_event *event_sw;
 293         struct perf_sample sample_sw;
 294         struct perf_inject *inject = container_of(tool, struct perf_inject, tool);
 295         u32 pid = perf_evsel__intval(evsel, sample, "pid");
 296
 297         list_for_each_entry(ent, &inject->samples, node) {
 298                 if (pid == ent->tid)
 299                         goto found;
 300         }
 301
 302         return 0;
 303 found:
 304         event_sw = &ent->event[0];
 305         perf_evsel__parse_sample(evsel, event_sw, &sample_sw);
 306
 307         sample_sw.period = sample->period;
 308         sample_sw.time   = sample->time;
 309         perf_event__synthesize_sample(event_sw, evsel->attr.sample_type,
 310                                       &sample_sw, false);
 311         build_id__mark_dso_hit(tool, event_sw, &sample_sw, evsel, machine);
 312         return perf_event__repipe(tool, event_sw, &sample_sw, machine);
 313 }
 314
 315 extern volatile int session_done;
 316
 317 static void sig_handler(int sig __maybe_unused)
 318 {
 319         session_done = 1;
 320 }
 321
 322 static int perf_evsel__check_stype(struct perf_evsel *evsel,
 323                                    u64 sample_type, const char *sample_msg)
 324 {
 325         struct perf_event_attr *attr = &evsel->attr;
 326         const char *name = perf_evsel__name(evsel);
 327
 328         if (!(attr->sample_type & sample_type)) {
 329                 pr_err("Samples for %s event do not have %s attribute set.",
 330                         name, sample_msg);
 331                 return -EINVAL;
 332         }
 333
 334         return 0;
 335 }
 336
 337 static int __cmd_inject(struct perf_inject *inject)
 338 {
 339         struct perf_session *session;
 340         int ret = -EINVAL;
 341
 342         signal(SIGINT, sig_handler);
 343
 344         if (inject->build_ids || inject->sched_stat) {
 345                 inject->tool.mmap         = perf_event__repipe_mmap;
 346                 inject->tool.fork         = perf_event__repipe_fork;
 347                 inject->tool.tracing_data = perf_event__repipe_tracing_data;
 348         }
 349
 350         session = perf_session__new(inject->input_name, O_RDONLY, false, true, &inject->tool);
 351         if (session == NULL)
 352                 return -ENOMEM;
 353
 354         if (inject->build_ids) {
 355                 inject->tool.sample = perf_event__inject_buildid;
 356         } else if (inject->sched_stat) {
 357                 struct perf_evsel *evsel;
 358
 359                 inject->tool.ordered_samples = true;
 360
 361                 list_for_each_entry(evsel, &session->evlist->entries, node) {
 362                         const char *name = perf_evsel__name(evsel);
 363
 364                         if (!strcmp(name, "sched:sched_switch")) {
 365                                 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID"))
 366                                         return -EINVAL;
 367
 368                                 evsel->handler.func = perf_inject__sched_switch;
 369                         } else if (!strcmp(name, "sched:sched_process_exit"))
 370                                 evsel->handler.func = perf_inject__sched_process_exit;
 371                         else if (!strncmp(name, "sched:sched_stat_", 17))
 372                                 evsel->handler.func = perf_inject__sched_stat;
 373                 }
 374         }
 375
 376         if (!inject->pipe_output)
 377                 lseek(inject->output, session->header.data_offset, SEEK_SET);
 378
 379         ret = perf_session__process_events(session, &inject->tool);
 380
 381         if (!inject->pipe_output) {
 382                 session->header.data_size = inject->bytes_written;
 383                 perf_session__write_header(session, session->evlist, inject->output, true);
 384         }
 385
 386         perf_session__delete(session);
 387
 388         return ret;
 389 }
 390
 391 int cmd_inject(int argc, const char **argv, const char *prefix __maybe_unused)
 392 {
 393         struct perf_inject inject = {
 394                 .tool = {
 395                         .sample         = perf_event__repipe_sample,
 396                         .mmap           = perf_event__repipe,
 397                         .comm           = perf_event__repipe,
 398                         .fork           = perf_event__repipe,
 399                         .exit           = perf_event__repipe,
 400                         .lost           = perf_event__repipe,
 401                         .read           = perf_event__repipe_sample,
 402                         .throttle       = perf_event__repipe,
 403                         .unthrottle     = perf_event__repipe,
 404                         .attr           = perf_event__repipe_attr,
 405                         .event_type     = perf_event__repipe_event_type_synth,
 406                         .tracing_data   = perf_event__repipe_op2_synth,
 407                         .finished_round = perf_event__repipe_op2_synth,
 408                         .build_id       = perf_event__repipe_op2_synth,
 409                 },
 410                 .input_name  = "-",
 411                 .samples = LIST_HEAD_INIT(inject.samples),
 412         };
 413         const char *output_name = "-";
 414         const struct option options[] = {
 415                 OPT_BOOLEAN('b', "build-ids", &inject.build_ids,
 416                             "Inject build-ids into the output stream"),
 417                 OPT_STRING('i', "input", &inject.input_name, "file",
 418                            "input file name"),
 419                 OPT_STRING('o', "output", &output_name, "file",
 420                            "output file name"),
 421                 OPT_BOOLEAN('s', "sched-stat", &inject.sched_stat,
 422                             "Merge sched-stat and sched-switch for getting events "
 423                             "where and how long tasks slept"),
 424                 OPT_INCR('v', "verbose", &verbose,
 425                          "be more verbose (show build ids, etc)"),
 426                 OPT_END()
 427         };
 428         const char * const inject_usage[] = {
 429                 "perf inject [<options>]",
 430                 NULL
 431         };
 432
 433         argc = parse_options(argc, argv, options, inject_usage, 0);
 434
 435         /*
 436          * Any (unrecognized) arguments left?
 437          */
 438         if (argc)
 439                 usage_with_options(inject_usage, options);
 440
 441         if (!strcmp(output_name, "-")) {
 442                 inject.pipe_output = 1;
 443                 inject.output = STDOUT_FILENO;
 444         } else {
 445                 inject.output = open(output_name, O_CREAT | O_WRONLY | O_TRUNC,
 446                                                   S_IRUSR | S_IWUSR);
 447                 if (inject.output < 0) {
 448                         perror("failed to create output file");
 449                         return -1;
 450                 }
 451         }
 452
 453         if (symbol__init() < 0)
 454                 return -1;
 455
 456         return __cmd_inject(&inject);
 457 }