tools/perf/util/session.c

   1 #define _FILE_OFFSET_BITS 64
   2
   3 #include <linux/kernel.h>
   4
   5 #include <byteswap.h>
   6 #include <unistd.h>
   7 #include <sys/types.h>
   8
   9 #include "session.h"
  10 #include "sort.h"
  11 #include "util.h"
  12
  13 static int perf_session__open(struct perf_session *self, bool force)
  14 {
  15         struct stat input_stat;
  16
  17         self->fd = open(self->filename, O_RDONLY);
  18         if (self->fd < 0) {
  19                 pr_err("failed to open file: %s", self->filename);
  20                 if (!strcmp(self->filename, "perf.data"))
  21                         pr_err("  (try 'perf record' first)");
  22                 pr_err("\n");
  23                 return -errno;
  24         }
  25
  26         if (fstat(self->fd, &input_stat) < 0)
  27                 goto out_close;
  28
  29         if (!force && input_stat.st_uid && (input_stat.st_uid != geteuid())) {
  30                 pr_err("file %s not owned by current user or root\n",
  31                        self->filename);
  32                 goto out_close;
  33         }
  34
  35         if (!input_stat.st_size) {
  36                 pr_info("zero-sized file (%s), nothing to do!\n",
  37                         self->filename);
  38                 goto out_close;
  39         }
  40
  41         if (perf_header__read(&self->header, self->fd) < 0) {
  42                 pr_err("incompatible file format");
  43                 goto out_close;
  44         }
  45
  46         self->size = input_stat.st_size;
  47         return 0;
  48
  49 out_close:
  50         close(self->fd);
  51         self->fd = -1;
  52         return -1;
  53 }
  54
  55 struct perf_session *perf_session__new(const char *filename, int mode, bool force)
  56 {
  57         size_t len = filename ? strlen(filename) + 1 : 0;
  58         struct perf_session *self = zalloc(sizeof(*self) + len);
  59
  60         if (self == NULL)
  61                 goto out;
  62
  63         if (perf_header__init(&self->header) < 0)
  64                 goto out_free;
  65
  66         memcpy(self->filename, filename, len);
  67         self->threads = RB_ROOT;
  68         self->stats_by_id = RB_ROOT;
  69         self->last_match = NULL;
  70         self->mmap_window = 32;
  71         self->cwd = NULL;
  72         self->cwdlen = 0;
  73         self->unknown_events = 0;
  74         map_groups__init(&self->kmaps);
  75
  76         if (mode == O_RDONLY) {
  77                 if (perf_session__open(self, force) < 0)
  78                         goto out_delete;
  79         } else if (mode == O_WRONLY) {
  80                 /*
  81                  * In O_RDONLY mode this will be performed when reading the
  82                  * kernel MMAP event, in event__process_mmap().
  83                  */
  84                 if (perf_session__create_kernel_maps(self) < 0)
  85                         goto out_delete;
  86         }
  87
  88         self->sample_type = perf_header__sample_type(&self->header);
  89 out:
  90         return self;
  91 out_free:
  92         free(self);
  93         return NULL;
  94 out_delete:
  95         perf_session__delete(self);
  96         return NULL;
  97 }
  98
  99 void perf_session__delete(struct perf_session *self)
 100 {
 101         perf_header__exit(&self->header);
 102         close(self->fd);
 103         free(self->cwd);
 104         free(self);
 105 }
 106
 107 static bool symbol__match_parent_regex(struct symbol *sym)
 108 {
 109         if (sym->name && !regexec(&parent_regex, sym->name, 0, NULL, 0))
 110                 return 1;
 111
 112         return 0;
 113 }
 114
 115 struct map_symbol *perf_session__resolve_callchain(struct perf_session *self,
 116                                                    struct thread *thread,
 117                                                    struct ip_callchain *chain,
 118                                                    struct symbol **parent)
 119 {
 120         u8 cpumode = PERF_RECORD_MISC_USER;
 121         unsigned int i;
 122         struct map_symbol *syms = calloc(chain->nr, sizeof(*syms));
 123
 124         if (!syms)
 125                 return NULL;
 126
 127         for (i = 0; i < chain->nr; i++) {
 128                 u64 ip = chain->ips[i];
 129                 struct addr_location al;
 130
 131                 if (ip >= PERF_CONTEXT_MAX) {
 132                         switch (ip) {
 133                         case PERF_CONTEXT_HV:
 134                                 cpumode = PERF_RECORD_MISC_HYPERVISOR;  break;
 135                         case PERF_CONTEXT_KERNEL:
 136                                 cpumode = PERF_RECORD_MISC_KERNEL;      break;
 137                         case PERF_CONTEXT_USER:
 138                                 cpumode = PERF_RECORD_MISC_USER;        break;
 139                         default:
 140                                 break;
 141                         }
 142                         continue;
 143                 }
 144
 145                 thread__find_addr_location(thread, self, cpumode,
 146                                            MAP__FUNCTION, ip, &al, NULL);
 147                 if (al.sym != NULL) {
 148                         if (sort__has_parent && !*parent &&
 149                             symbol__match_parent_regex(al.sym))
 150                                 *parent = al.sym;
 151                         if (!symbol_conf.use_callchain)
 152                                 break;
 153                         syms[i].map = al.map;
 154                         syms[i].sym = al.sym;
 155                 }
 156         }
 157
 158         return syms;
 159 }
 160
 161 static int process_event_stub(event_t *event __used,
 162                               struct perf_session *session __used)
 163 {
 164         dump_printf(": unhandled!\n");
 165         return 0;
 166 }
 167
 168 static void perf_event_ops__fill_defaults(struct perf_event_ops *handler)
 169 {
 170         if (handler->sample == NULL)
 171                 handler->sample = process_event_stub;
 172         if (handler->mmap == NULL)
 173                 handler->mmap = process_event_stub;
 174         if (handler->comm == NULL)
 175                 handler->comm = process_event_stub;
 176         if (handler->fork == NULL)
 177                 handler->fork = process_event_stub;
 178         if (handler->exit == NULL)
 179                 handler->exit = process_event_stub;
 180         if (handler->lost == NULL)
 181                 handler->lost = process_event_stub;
 182         if (handler->read == NULL)
 183                 handler->read = process_event_stub;
 184         if (handler->throttle == NULL)
 185                 handler->throttle = process_event_stub;
 186         if (handler->unthrottle == NULL)
 187                 handler->unthrottle = process_event_stub;
 188 }
 189
 190 static const char *event__name[] = {
 191         [0]                      = "TOTAL",
 192         [PERF_RECORD_MMAP]       = "MMAP",
 193         [PERF_RECORD_LOST]       = "LOST",
 194         [PERF_RECORD_COMM]       = "COMM",
 195         [PERF_RECORD_EXIT]       = "EXIT",
 196         [PERF_RECORD_THROTTLE]   = "THROTTLE",
 197         [PERF_RECORD_UNTHROTTLE] = "UNTHROTTLE",
 198         [PERF_RECORD_FORK]       = "FORK",
 199         [PERF_RECORD_READ]       = "READ",
 200         [PERF_RECORD_SAMPLE]     = "SAMPLE",
 201 };
 202
 203 unsigned long event__total[PERF_RECORD_MAX];
 204
 205 void event__print_totals(void)
 206 {
 207         int i;
 208         for (i = 0; i < PERF_RECORD_MAX; ++i)
 209                 pr_info("%10s events: %10ld\n",
 210                         event__name[i], event__total[i]);
 211 }
 212
 213 void mem_bswap_64(void *src, int byte_size)
 214 {
 215         u64 *m = src;
 216
 217         while (byte_size > 0) {
 218                 *m = bswap_64(*m);
 219                 byte_size -= sizeof(u64);
 220                 ++m;
 221         }
 222 }
 223
 224 static void event__all64_swap(event_t *self)
 225 {
 226         struct perf_event_header *hdr = &self->header;
 227         mem_bswap_64(hdr + 1, self->header.size - sizeof(*hdr));
 228 }
 229
 230 static void event__comm_swap(event_t *self)
 231 {
 232         self->comm.pid = bswap_32(self->comm.pid);
 233         self->comm.tid = bswap_32(self->comm.tid);
 234 }
 235
 236 static void event__mmap_swap(event_t *self)
 237 {
 238         self->mmap.pid   = bswap_32(self->mmap.pid);
 239         self->mmap.tid   = bswap_32(self->mmap.tid);
 240         self->mmap.start = bswap_64(self->mmap.start);
 241         self->mmap.len   = bswap_64(self->mmap.len);
 242         self->mmap.pgoff = bswap_64(self->mmap.pgoff);
 243 }
 244
 245 static void event__task_swap(event_t *self)
 246 {
 247         self->fork.pid  = bswap_32(self->fork.pid);
 248         self->fork.tid  = bswap_32(self->fork.tid);
 249         self->fork.ppid = bswap_32(self->fork.ppid);
 250         self->fork.ptid = bswap_32(self->fork.ptid);
 251         self->fork.time = bswap_64(self->fork.time);
 252 }
 253
 254 static void event__read_swap(event_t *self)
 255 {
 256         self->read.pid          = bswap_32(self->read.pid);
 257         self->read.tid          = bswap_32(self->read.tid);
 258         self->read.value        = bswap_64(self->read.value);
 259         self->read.time_enabled = bswap_64(self->read.time_enabled);
 260         self->read.time_running = bswap_64(self->read.time_running);
 261         self->read.id           = bswap_64(self->read.id);
 262 }
 263
 264 typedef void (*event__swap_op)(event_t *self);
 265
 266 static event__swap_op event__swap_ops[] = {
 267         [PERF_RECORD_MMAP]   = event__mmap_swap,
 268         [PERF_RECORD_COMM]   = event__comm_swap,
 269         [PERF_RECORD_FORK]   = event__task_swap,
 270         [PERF_RECORD_EXIT]   = event__task_swap,
 271         [PERF_RECORD_LOST]   = event__all64_swap,
 272         [PERF_RECORD_READ]   = event__read_swap,
 273         [PERF_RECORD_SAMPLE] = event__all64_swap,
 274         [PERF_RECORD_MAX]    = NULL,
 275 };
 276
 277 static int perf_session__process_event(struct perf_session *self,
 278                                        event_t *event,
 279                                        struct perf_event_ops *ops,
 280                                        u64 offset, u64 head)
 281 {
 282         trace_event(event);
 283
 284         if (event->header.type < PERF_RECORD_MAX) {
 285                 dump_printf("%#Lx [%#x]: PERF_RECORD_%s",
 286                             offset + head, event->header.size,
 287                             event__name[event->header.type]);
 288                 ++event__total[0];
 289                 ++event__total[event->header.type];
 290         }
 291
 292         if (self->header.needs_swap && event__swap_ops[event->header.type])
 293                 event__swap_ops[event->header.type](event);
 294
 295         switch (event->header.type) {
 296         case PERF_RECORD_SAMPLE:
 297                 return ops->sample(event, self);
 298         case PERF_RECORD_MMAP:
 299                 return ops->mmap(event, self);
 300         case PERF_RECORD_COMM:
 301                 return ops->comm(event, self);
 302         case PERF_RECORD_FORK:
 303                 return ops->fork(event, self);
 304         case PERF_RECORD_EXIT:
 305                 return ops->exit(event, self);
 306         case PERF_RECORD_LOST:
 307                 return ops->lost(event, self);
 308         case PERF_RECORD_READ:
 309                 return ops->read(event, self);
 310         case PERF_RECORD_THROTTLE:
 311                 return ops->throttle(event, self);
 312         case PERF_RECORD_UNTHROTTLE:
 313                 return ops->unthrottle(event, self);
 314         default:
 315                 self->unknown_events++;
 316                 return -1;
 317         }
 318 }
 319
 320 void perf_event_header__bswap(struct perf_event_header *self)
 321 {
 322         self->type = bswap_32(self->type);
 323         self->misc = bswap_16(self->misc);
 324         self->size = bswap_16(self->size);
 325 }
 326
 327 int perf_header__read_build_ids(struct perf_header *self,
 328                                 int input, u64 offset, u64 size)
 329 {
 330         struct build_id_event bev;
 331         char filename[PATH_MAX];
 332         u64 limit = offset + size;
 333         int err = -1;
 334
 335         while (offset < limit) {
 336                 struct dso *dso;
 337                 ssize_t len;
 338                 struct list_head *head = &dsos__user;
 339
 340                 if (read(input, &bev, sizeof(bev)) != sizeof(bev))
 341                         goto out;
 342
 343                 if (self->needs_swap)
 344                         perf_event_header__bswap(&bev.header);
 345
 346                 len = bev.header.size - sizeof(bev);
 347                 if (read(input, filename, len) != len)
 348                         goto out;
 349
 350                 if (bev.header.misc & PERF_RECORD_MISC_KERNEL)
 351                         head = &dsos__kernel;
 352
 353                 dso = __dsos__findnew(head, filename);
 354                 if (dso != NULL) {
 355                         dso__set_build_id(dso, &bev.build_id);
 356                         if (head == &dsos__kernel && filename[0] == '[')
 357                                 dso->kernel = 1;
 358                 }
 359
 360                 offset += bev.header.size;
 361         }
 362         err = 0;
 363 out:
 364         return err;
 365 }
 366
 367 static struct thread *perf_session__register_idle_thread(struct perf_session *self)
 368 {
 369         struct thread *thread = perf_session__findnew(self, 0);
 370
 371         if (thread == NULL || thread__set_comm(thread, "swapper")) {
 372                 pr_err("problem inserting idle task.\n");
 373                 thread = NULL;
 374         }
 375
 376         return thread;
 377 }
 378
 379 int __perf_session__process_events(struct perf_session *self,
 380                                    u64 data_offset, u64 data_size,
 381                                    u64 file_size, struct perf_event_ops *ops)
 382 {
 383         int err, mmap_prot, mmap_flags;
 384         u64 head, shift;
 385         u64 offset = 0;
 386         size_t  page_size;
 387         event_t *event;
 388         uint32_t size;
 389         char *buf;
 390         struct ui_progress *progress = ui_progress__new("Processing events...",
 391                                                         self->size);
 392         if (progress == NULL)
 393                 return -1;
 394
 395         perf_event_ops__fill_defaults(ops);
 396
 397         page_size = sysconf(_SC_PAGESIZE);
 398
 399         head = data_offset;
 400         shift = page_size * (head / page_size);
 401         offset += shift;
 402         head -= shift;
 403
 404         mmap_prot  = PROT_READ;
 405         mmap_flags = MAP_SHARED;
 406
 407         if (self->header.needs_swap) {
 408                 mmap_prot  |= PROT_WRITE;
 409                 mmap_flags = MAP_PRIVATE;
 410         }
 411 remap:
 412         buf = mmap(NULL, page_size * self->mmap_window, mmap_prot,
 413                    mmap_flags, self->fd, offset);
 414         if (buf == MAP_FAILED) {
 415                 pr_err("failed to mmap file\n");
 416                 err = -errno;
 417                 goto out_err;
 418         }
 419
 420 more:
 421         event = (event_t *)(buf + head);
 422         ui_progress__update(progress, offset);
 423
 424         if (self->header.needs_swap)
 425                 perf_event_header__bswap(&event->header);
 426         size = event->header.size;
 427         if (size == 0)
 428                 size = 8;
 429
 430         if (head + event->header.size >= page_size * self->mmap_window) {
 431                 int munmap_ret;
 432
 433                 shift = page_size * (head / page_size);
 434
 435                 munmap_ret = munmap(buf, page_size * self->mmap_window);
 436                 assert(munmap_ret == 0);
 437
 438                 offset += shift;
 439                 head -= shift;
 440                 goto remap;
 441         }
 442
 443         size = event->header.size;
 444
 445         dump_printf("\n%#Lx [%#x]: event: %d\n",
 446                     offset + head, event->header.size, event->header.type);
 447
 448         if (size == 0 ||
 449             perf_session__process_event(self, event, ops, offset, head) < 0) {
 450                 dump_printf("%#Lx [%#x]: skipping unknown header type: %d\n",
 451                             offset + head, event->header.size,
 452                             event->header.type);
 453                 /*
 454                  * assume we lost track of the stream, check alignment, and
 455                  * increment a single u64 in the hope to catch on again 'soon'.
 456                  */
 457                 if (unlikely(head & 7))
 458                         head &= ~7ULL;
 459
 460                 size = 8;
 461         }
 462
 463         head += size;
 464
 465         if (offset + head >= data_offset + data_size)
 466                 goto done;
 467
 468         if (offset + head < file_size)
 469                 goto more;
 470 done:
 471         err = 0;
 472 out_err:
 473         ui_progress__delete(progress);
 474         return err;
 475 }
 476
 477 int perf_session__process_events(struct perf_session *self,
 478                                  struct perf_event_ops *ops)
 479 {
 480         int err;
 481
 482         if (perf_session__register_idle_thread(self) == NULL)
 483                 return -ENOMEM;
 484
 485         if (!symbol_conf.full_paths) {
 486                 char bf[PATH_MAX];
 487
 488                 if (getcwd(bf, sizeof(bf)) == NULL) {
 489                         err = -errno;
 490 out_getcwd_err:
 491                         pr_err("failed to get the current directory\n");
 492                         goto out_err;
 493                 }
 494                 self->cwd = strdup(bf);
 495                 if (self->cwd == NULL) {
 496                         err = -ENOMEM;
 497                         goto out_getcwd_err;
 498                 }
 499                 self->cwdlen = strlen(self->cwd);
 500         }
 501
 502         err = __perf_session__process_events(self, self->header.data_offset,
 503                                              self->header.data_size,
 504                                              self->size, ops);
 505 out_err:
 506         return err;
 507 }
 508
 509 bool perf_session__has_traces(struct perf_session *self, const char *msg)
 510 {
 511         if (!(self->sample_type & PERF_SAMPLE_RAW)) {
 512                 pr_err("No trace sample to read. Did you call 'perf %s'?\n", msg);
 513                 return false;
 514         }
 515
 516         return true;
 517 }
 518
 519 int perf_session__set_kallsyms_ref_reloc_sym(struct perf_session *self,
 520                                              const char *symbol_name,
 521                                              u64 addr)
 522 {
 523         char *bracket;
 524         enum map_type i;
 525
 526         self->ref_reloc_sym.name = strdup(symbol_name);
 527         if (self->ref_reloc_sym.name == NULL)
 528                 return -ENOMEM;
 529
 530         bracket = strchr(self->ref_reloc_sym.name, ']');
 531         if (bracket)
 532                 *bracket = '\0';
 533
 534         self->ref_reloc_sym.addr = addr;
 535
 536         for (i = 0; i < MAP__NR_TYPES; ++i) {
 537                 struct kmap *kmap = map__kmap(self->vmlinux_maps[i]);
 538                 kmap->ref_reloc_sym = &self->ref_reloc_sym;
 539         }
 540
 541         return 0;
 542 }