drivers/oprofile/buffer_sync.c

   1 /**
   2  * @file buffer_sync.c
   3  *
   4  * @remark Copyright 2002 OProfile authors
   5  * @remark Read the file COPYING
   6  *
   7  * @author John Levon <levon@movementarian.org>
   8  * @author Barry Kasindorf
   9  *
  10  * This is the core of the buffer management. Each
  11  * CPU buffer is processed and entered into the
  12  * global event buffer. Such processing is necessary
  13  * in several circumstances, mentioned below.
  14  *
  15  * The processing does the job of converting the
  16  * transitory EIP value into a persistent dentry/offset
  17  * value that the profiler can record at its leisure.
  18  *
  19  * See fs/dcookies.c for a description of the dentry/offset
  20  * objects.
  21  */
  22
  23 #include <linux/mm.h>
  24 #include <linux/workqueue.h>
  25 #include <linux/notifier.h>
  26 #include <linux/dcookies.h>
  27 #include <linux/profile.h>
  28 #include <linux/module.h>
  29 #include <linux/fs.h>
  30 #include <linux/oprofile.h>
  31 #include <linux/sched.h>
  32
  33 #include "oprofile_stats.h"
  34 #include "event_buffer.h"
  35 #include "cpu_buffer.h"
  36 #include "buffer_sync.h"
  37
  38 static LIST_HEAD(dying_tasks);
  39 static LIST_HEAD(dead_tasks);
  40 static cpumask_t marked_cpus = CPU_MASK_NONE;
  41 static DEFINE_SPINLOCK(task_mortuary);
  42 static void process_task_mortuary(void);
  43
  44
  45 /* Take ownership of the task struct and place it on the
  46  * list for processing. Only after two full buffer syncs
  47  * does the task eventually get freed, because by then
  48  * we are sure we will not reference it again.
  49  * Can be invoked from softirq via RCU callback due to
  50  * call_rcu() of the task struct, hence the _irqsave.
  51  */
  52 static int
  53 task_free_notify(struct notifier_block *self, unsigned long val, void *data)
  54 {
  55         unsigned long flags;
  56         struct task_struct *task = data;
  57         spin_lock_irqsave(&task_mortuary, flags);
  58         list_add(&task->tasks, &dying_tasks);
  59         spin_unlock_irqrestore(&task_mortuary, flags);
  60         return NOTIFY_OK;
  61 }
  62
  63
  64 /* The task is on its way out. A sync of the buffer means we can catch
  65  * any remaining samples for this task.
  66  */
  67 static int
  68 task_exit_notify(struct notifier_block *self, unsigned long val, void *data)
  69 {
  70         /* To avoid latency problems, we only process the current CPU,
  71          * hoping that most samples for the task are on this CPU
  72          */
  73         sync_buffer(raw_smp_processor_id());
  74         return 0;
  75 }
  76
  77
  78 /* The task is about to try a do_munmap(). We peek at what it's going to
  79  * do, and if it's an executable region, process the samples first, so
  80  * we don't lose any. This does not have to be exact, it's a QoI issue
  81  * only.
  82  */
  83 static int
  84 munmap_notify(struct notifier_block *self, unsigned long val, void *data)
  85 {
  86         unsigned long addr = (unsigned long)data;
  87         struct mm_struct *mm = current->mm;
  88         struct vm_area_struct *mpnt;
  89
  90         down_read(&mm->mmap_sem);
  91
  92         mpnt = find_vma(mm, addr);
  93         if (mpnt && mpnt->vm_file && (mpnt->vm_flags & VM_EXEC)) {
  94                 up_read(&mm->mmap_sem);
  95                 /* To avoid latency problems, we only process the current CPU,
  96                  * hoping that most samples for the task are on this CPU
  97                  */
  98                 sync_buffer(raw_smp_processor_id());
  99                 return 0;
 100         }
 101
 102         up_read(&mm->mmap_sem);
 103         return 0;
 104 }
 105
 106
 107 /* We need to be told about new modules so we don't attribute to a previously
 108  * loaded module, or drop the samples on the floor.
 109  */
 110 static int
 111 module_load_notify(struct notifier_block *self, unsigned long val, void *data)
 112 {
 113 #ifdef CONFIG_MODULES
 114         if (val != MODULE_STATE_COMING)
 115                 return 0;
 116
 117         /* FIXME: should we process all CPU buffers ? */
 118         mutex_lock(&buffer_mutex);
 119         add_event_entry(ESCAPE_CODE);
 120         add_event_entry(MODULE_LOADED_CODE);
 121         mutex_unlock(&buffer_mutex);
 122 #endif
 123         return 0;
 124 }
 125
 126
 127 static struct notifier_block task_free_nb = {
 128         .notifier_call  = task_free_notify,
 129 };
 130
 131 static struct notifier_block task_exit_nb = {
 132         .notifier_call  = task_exit_notify,
 133 };
 134
 135 static struct notifier_block munmap_nb = {
 136         .notifier_call  = munmap_notify,
 137 };
 138
 139 static struct notifier_block module_load_nb = {
 140         .notifier_call = module_load_notify,
 141 };
 142
 143
 144 static void end_sync(void)
 145 {
 146         end_cpu_work();
 147         /* make sure we don't leak task structs */
 148         process_task_mortuary();
 149         process_task_mortuary();
 150 }
 151
 152
 153 int sync_start(void)
 154 {
 155         int err;
 156
 157         start_cpu_work();
 158
 159         err = task_handoff_register(&task_free_nb);
 160         if (err)
 161                 goto out1;
 162         err = profile_event_register(PROFILE_TASK_EXIT, &task_exit_nb);
 163         if (err)
 164                 goto out2;
 165         err = profile_event_register(PROFILE_MUNMAP, &munmap_nb);
 166         if (err)
 167                 goto out3;
 168         err = register_module_notifier(&module_load_nb);
 169         if (err)
 170                 goto out4;
 171
 172 out:
 173         return err;
 174 out4:
 175         profile_event_unregister(PROFILE_MUNMAP, &munmap_nb);
 176 out3:
 177         profile_event_unregister(PROFILE_TASK_EXIT, &task_exit_nb);
 178 out2:
 179         task_handoff_unregister(&task_free_nb);
 180 out1:
 181         end_sync();
 182         goto out;
 183 }
 184
 185
 186 void sync_stop(void)
 187 {
 188         unregister_module_notifier(&module_load_nb);
 189         profile_event_unregister(PROFILE_MUNMAP, &munmap_nb);
 190         profile_event_unregister(PROFILE_TASK_EXIT, &task_exit_nb);
 191         task_handoff_unregister(&task_free_nb);
 192         end_sync();
 193 }
 194
 195
 196 /* Optimisation. We can manage without taking the dcookie sem
 197  * because we cannot reach this code without at least one
 198  * dcookie user still being registered (namely, the reader
 199  * of the event buffer). */
 200 static inline unsigned long fast_get_dcookie(struct path *path)
 201 {
 202         unsigned long cookie;
 203
 204         if (path->dentry->d_cookie)
 205                 return (unsigned long)path->dentry;
 206         get_dcookie(path, &cookie);
 207         return cookie;
 208 }
 209
 210
 211 /* Look up the dcookie for the task's first VM_EXECUTABLE mapping,
 212  * which corresponds loosely to "application name". This is
 213  * not strictly necessary but allows oprofile to associate
 214  * shared-library samples with particular applications
 215  */
 216 static unsigned long get_exec_dcookie(struct mm_struct *mm)
 217 {
 218         unsigned long cookie = NO_COOKIE;
 219         struct vm_area_struct *vma;
 220
 221         if (!mm)
 222                 goto out;
 223
 224         for (vma = mm->mmap; vma; vma = vma->vm_next) {
 225                 if (!vma->vm_file)
 226                         continue;
 227                 if (!(vma->vm_flags & VM_EXECUTABLE))
 228                         continue;
 229                 cookie = fast_get_dcookie(&vma->vm_file->f_path);
 230                 break;
 231         }
 232
 233 out:
 234         return cookie;
 235 }
 236
 237
 238 /* Convert the EIP value of a sample into a persistent dentry/offset
 239  * pair that can then be added to the global event buffer. We make
 240  * sure to do this lookup before a mm->mmap modification happens so
 241  * we don't lose track.
 242  */
 243 static unsigned long
 244 lookup_dcookie(struct mm_struct *mm, unsigned long addr, off_t *offset)
 245 {
 246         unsigned long cookie = NO_COOKIE;
 247         struct vm_area_struct *vma;
 248
 249         for (vma = find_vma(mm, addr); vma; vma = vma->vm_next) {
 250
 251                 if (addr < vma->vm_start || addr >= vma->vm_end)
 252                         continue;
 253
 254                 if (vma->vm_file) {
 255                         cookie = fast_get_dcookie(&vma->vm_file->f_path);
 256                         *offset = (vma->vm_pgoff << PAGE_SHIFT) + addr -
 257                                 vma->vm_start;
 258                 } else {
 259                         /* must be an anonymous map */
 260                         *offset = addr;
 261                 }
 262
 263                 break;
 264         }
 265
 266         if (!vma)
 267                 cookie = INVALID_COOKIE;
 268
 269         return cookie;
 270 }
 271
 272 static void increment_tail(struct oprofile_cpu_buffer *b)
 273 {
 274         unsigned long new_tail = b->tail_pos + 1;
 275
 276         rmb();  /* be sure fifo pointers are synchromized */
 277
 278         if (new_tail < b->buffer_size)
 279                 b->tail_pos = new_tail;
 280         else
 281                 b->tail_pos = 0;
 282 }
 283
 284 static unsigned long last_cookie = INVALID_COOKIE;
 285
 286 static void add_cpu_switch(int i)
 287 {
 288         add_event_entry(ESCAPE_CODE);
 289         add_event_entry(CPU_SWITCH_CODE);
 290         add_event_entry(i);
 291         last_cookie = INVALID_COOKIE;
 292 }
 293
 294 static void add_kernel_ctx_switch(unsigned int in_kernel)
 295 {
 296         add_event_entry(ESCAPE_CODE);
 297         if (in_kernel)
 298                 add_event_entry(KERNEL_ENTER_SWITCH_CODE);
 299         else
 300                 add_event_entry(KERNEL_EXIT_SWITCH_CODE);
 301 }
 302
 303 static void
 304 add_user_ctx_switch(struct task_struct const *task, unsigned long cookie)
 305 {
 306         add_event_entry(ESCAPE_CODE);
 307         add_event_entry(CTX_SWITCH_CODE);
 308         add_event_entry(task->pid);
 309         add_event_entry(cookie);
 310         /* Another code for daemon back-compat */
 311         add_event_entry(ESCAPE_CODE);
 312         add_event_entry(CTX_TGID_CODE);
 313         add_event_entry(task->tgid);
 314 }
 315
 316
 317 static void add_cookie_switch(unsigned long cookie)
 318 {
 319         add_event_entry(ESCAPE_CODE);
 320         add_event_entry(COOKIE_SWITCH_CODE);
 321         add_event_entry(cookie);
 322 }
 323
 324
 325 static void add_trace_begin(void)
 326 {
 327         add_event_entry(ESCAPE_CODE);
 328         add_event_entry(TRACE_BEGIN_CODE);
 329 }
 330
 331 #ifdef CONFIG_OPROFILE_IBS
 332
 333 #define IBS_FETCH_CODE_SIZE     2
 334 #define IBS_OP_CODE_SIZE        5
 335 #define IBS_EIP(offset)                         \
 336         (((struct op_sample *)&cpu_buf->buffer[(offset)])->eip)
 337 #define IBS_EVENT(offset)                               \
 338         (((struct op_sample *)&cpu_buf->buffer[(offset)])->event)
 339
 340 /*
 341  * Add IBS fetch and op entries to event buffer
 342  */
 343 static void add_ibs_begin(struct oprofile_cpu_buffer *cpu_buf, int code,
 344         int in_kernel, struct mm_struct *mm)
 345 {
 346         unsigned long rip;
 347         int i, count;
 348         unsigned long ibs_cookie = 0;
 349         off_t offset;
 350
 351         increment_tail(cpu_buf);        /* move to RIP entry */
 352
 353         rip = IBS_EIP(cpu_buf->tail_pos);
 354
 355 #ifdef __LP64__
 356         rip += IBS_EVENT(cpu_buf->tail_pos) << 32;
 357 #endif
 358
 359         if (mm) {
 360                 ibs_cookie = lookup_dcookie(mm, rip, &offset);
 361
 362                 if (ibs_cookie == NO_COOKIE)
 363                         offset = rip;
 364                 if (ibs_cookie == INVALID_COOKIE) {
 365                         atomic_inc(&oprofile_stats.sample_lost_no_mapping);
 366                         offset = rip;
 367                 }
 368                 if (ibs_cookie != last_cookie) {
 369                         add_cookie_switch(ibs_cookie);
 370                         last_cookie = ibs_cookie;
 371                 }
 372         } else
 373                 offset = rip;
 374
 375         add_event_entry(ESCAPE_CODE);
 376         add_event_entry(code);
 377         add_event_entry(offset);        /* Offset from Dcookie */
 378
 379         /* we send the Dcookie offset, but send the raw Linear Add also*/
 380         add_event_entry(IBS_EIP(cpu_buf->tail_pos));
 381         add_event_entry(IBS_EVENT(cpu_buf->tail_pos));
 382
 383         if (code == IBS_FETCH_CODE)
 384                 count = IBS_FETCH_CODE_SIZE;    /*IBS FETCH is 2 int64s*/
 385         else
 386                 count = IBS_OP_CODE_SIZE;       /*IBS OP is 5 int64s*/
 387
 388         for (i = 0; i < count; i++) {
 389                 increment_tail(cpu_buf);
 390                 add_event_entry(IBS_EIP(cpu_buf->tail_pos));
 391                 add_event_entry(IBS_EVENT(cpu_buf->tail_pos));
 392         }
 393 }
 394
 395 #endif
 396
 397 static void add_sample_entry(unsigned long offset, unsigned long event)
 398 {
 399         add_event_entry(offset);
 400         add_event_entry(event);
 401 }
 402
 403
 404 static int add_us_sample(struct mm_struct *mm, struct op_sample *s)
 405 {
 406         unsigned long cookie;
 407         off_t offset;
 408
 409         cookie = lookup_dcookie(mm, s->eip, &offset);
 410
 411         if (cookie == INVALID_COOKIE) {
 412                 atomic_inc(&oprofile_stats.sample_lost_no_mapping);
 413                 return 0;
 414         }
 415
 416         if (cookie != last_cookie) {
 417                 add_cookie_switch(cookie);
 418                 last_cookie = cookie;
 419         }
 420
 421         add_sample_entry(offset, s->event);
 422
 423         return 1;
 424 }
 425
 426
 427 /* Add a sample to the global event buffer. If possible the
 428  * sample is converted into a persistent dentry/offset pair
 429  * for later lookup from userspace.
 430  */
 431 static int
 432 add_sample(struct mm_struct *mm, struct op_sample *s, int in_kernel)
 433 {
 434         if (in_kernel) {
 435                 add_sample_entry(s->eip, s->event);
 436                 return 1;
 437         } else if (mm) {
 438                 return add_us_sample(mm, s);
 439         } else {
 440                 atomic_inc(&oprofile_stats.sample_lost_no_mm);
 441         }
 442         return 0;
 443 }
 444
 445
 446 static void release_mm(struct mm_struct *mm)
 447 {
 448         if (!mm)
 449                 return;
 450         up_read(&mm->mmap_sem);
 451         mmput(mm);
 452 }
 453
 454
 455 static struct mm_struct *take_tasks_mm(struct task_struct *task)
 456 {
 457         struct mm_struct *mm = get_task_mm(task);
 458         if (mm)
 459                 down_read(&mm->mmap_sem);
 460         return mm;
 461 }
 462
 463
 464 static inline int is_code(unsigned long val)
 465 {
 466         return val == ESCAPE_CODE;
 467 }
 468
 469
 470 /* "acquire" as many cpu buffer slots as we can */
 471 static unsigned long get_slots(struct oprofile_cpu_buffer *b)
 472 {
 473         unsigned long head = b->head_pos;
 474         unsigned long tail = b->tail_pos;
 475
 476         /*
 477          * Subtle. This resets the persistent last_task
 478          * and in_kernel values used for switching notes.
 479          * BUT, there is a small window between reading
 480          * head_pos, and this call, that means samples
 481          * can appear at the new head position, but not
 482          * be prefixed with the notes for switching
 483          * kernel mode or a task switch. This small hole
 484          * can lead to mis-attribution or samples where
 485          * we don't know if it's in the kernel or not,
 486          * at the start of an event buffer.
 487          */
 488         cpu_buffer_reset(b);
 489
 490         if (head >= tail)
 491                 return head - tail;
 492
 493         return head + (b->buffer_size - tail);
 494 }
 495
 496
 497 /* Move tasks along towards death. Any tasks on dead_tasks
 498  * will definitely have no remaining references in any
 499  * CPU buffers at this point, because we use two lists,
 500  * and to have reached the list, it must have gone through
 501  * one full sync already.
 502  */
 503 static void process_task_mortuary(void)
 504 {
 505         unsigned long flags;
 506         LIST_HEAD(local_dead_tasks);
 507         struct task_struct *task;
 508         struct task_struct *ttask;
 509
 510         spin_lock_irqsave(&task_mortuary, flags);
 511
 512         list_splice_init(&dead_tasks, &local_dead_tasks);
 513         list_splice_init(&dying_tasks, &dead_tasks);
 514
 515         spin_unlock_irqrestore(&task_mortuary, flags);
 516
 517         list_for_each_entry_safe(task, ttask, &local_dead_tasks, tasks) {
 518                 list_del(&task->tasks);
 519                 free_task(task);
 520         }
 521 }
 522
 523
 524 static void mark_done(int cpu)
 525 {
 526         int i;
 527
 528         cpu_set(cpu, marked_cpus);
 529
 530         for_each_online_cpu(i) {
 531                 if (!cpu_isset(i, marked_cpus))
 532                         return;
 533         }
 534
 535         /* All CPUs have been processed at least once,
 536          * we can process the mortuary once
 537          */
 538         process_task_mortuary();
 539
 540         cpus_clear(marked_cpus);
 541 }
 542
 543
 544 /* FIXME: this is not sufficient if we implement syscall barrier backtrace
 545  * traversal, the code switch to sb_sample_start at first kernel enter/exit
 546  * switch so we need a fifth state and some special handling in sync_buffer()
 547  */
 548 typedef enum {
 549         sb_bt_ignore = -2,
 550         sb_buffer_start,
 551         sb_bt_start,
 552         sb_sample_start,
 553 } sync_buffer_state;
 554
 555 /* Sync one of the CPU's buffers into the global event buffer.
 556  * Here we need to go through each batch of samples punctuated
 557  * by context switch notes, taking the task's mmap_sem and doing
 558  * lookup in task->mm->mmap to convert EIP into dcookie/offset
 559  * value.
 560  */
 561 void sync_buffer(int cpu)
 562 {
 563         struct oprofile_cpu_buffer *cpu_buf = &per_cpu(cpu_buffer, cpu);
 564         struct mm_struct *mm = NULL;
 565         struct task_struct *new;
 566         unsigned long cookie = 0;
 567         int in_kernel = 1;
 568         unsigned int i;
 569         sync_buffer_state state = sb_buffer_start;
 570         unsigned long available;
 571
 572         mutex_lock(&buffer_mutex);
 573
 574         add_cpu_switch(cpu);
 575
 576         /* Remember, only we can modify tail_pos */
 577
 578         available = get_slots(cpu_buf);
 579
 580         for (i = 0; i < available; ++i) {
 581                 struct op_sample *s = &cpu_buf->buffer[cpu_buf->tail_pos];
 582
 583                 if (is_code(s->eip)) {
 584                         if (s->event <= CPU_IS_KERNEL) {
 585                                 /* kernel/userspace switch */
 586                                 in_kernel = s->event;
 587                                 if (state == sb_buffer_start)
 588                                         state = sb_sample_start;
 589                                 add_kernel_ctx_switch(s->event);
 590                         } else if (s->event == CPU_TRACE_BEGIN) {
 591                                 state = sb_bt_start;
 592                                 add_trace_begin();
 593 #ifdef CONFIG_OPROFILE_IBS
 594                         } else if (s->event == IBS_FETCH_BEGIN) {
 595                                 state = sb_bt_start;
 596                                 add_ibs_begin(cpu_buf,
 597                                         IBS_FETCH_CODE, in_kernel, mm);
 598                         } else if (s->event == IBS_OP_BEGIN) {
 599                                 state = sb_bt_start;
 600                                 add_ibs_begin(cpu_buf,
 601                                         IBS_OP_CODE, in_kernel, mm);
 602 #endif
 603                         } else {
 604                                 struct mm_struct *oldmm = mm;
 605
 606                                 /* userspace context switch */
 607                                 new = (struct task_struct *)s->event;
 608
 609                                 release_mm(oldmm);
 610                                 mm = take_tasks_mm(new);
 611                                 if (mm != oldmm)
 612                                         cookie = get_exec_dcookie(mm);
 613                                 add_user_ctx_switch(new, cookie);
 614                         }
 615                 } else if (state >= sb_bt_start &&
 616                            !add_sample(mm, s, in_kernel)) {
 617                         if (state == sb_bt_start) {
 618                                 state = sb_bt_ignore;
 619                                 atomic_inc(&oprofile_stats.bt_lost_no_mapping);
 620                         }
 621                 }
 622
 623                 increment_tail(cpu_buf);
 624         }
 625         release_mm(mm);
 626
 627         mark_done(cpu);
 628
 629         mutex_unlock(&buffer_mutex);
 630 }