git.oblomov.eu Git - linux-2.6/blob - drivers/oprofile/buffer_sync.c

   1 /**
   2  * @file buffer_sync.c
   3  *
   4  * @remark Copyright 2002-2009 OProfile authors
   5  * @remark Read the file COPYING
   6  *
   7  * @author John Levon <levon@movementarian.org>
   8  * @author Barry Kasindorf
   9  * @author Robert Richter <robert.richter@amd.com>
  10  *
  11  * This is the core of the buffer management. Each
  12  * CPU buffer is processed and entered into the
  13  * global event buffer. Such processing is necessary
  14  * in several circumstances, mentioned below.
  15  *
  16  * The processing does the job of converting the
  17  * transitory EIP value into a persistent dentry/offset
  18  * value that the profiler can record at its leisure.
  19  *
  20  * See fs/dcookies.c for a description of the dentry/offset
  21  * objects.
  22  */
  23
  24 #include <linux/mm.h>
  25 #include <linux/workqueue.h>
  26 #include <linux/notifier.h>
  27 #include <linux/dcookies.h>
  28 #include <linux/profile.h>
  29 #include <linux/module.h>
  30 #include <linux/fs.h>
  31 #include <linux/oprofile.h>
  32 #include <linux/sched.h>
  33
  34 #include "oprofile_stats.h"
  35 #include "event_buffer.h"
  36 #include "cpu_buffer.h"
  37 #include "buffer_sync.h"
  38
  39 static LIST_HEAD(dying_tasks);
  40 static LIST_HEAD(dead_tasks);
  41 static cpumask_var_t marked_cpus;
  42 static DEFINE_SPINLOCK(task_mortuary);
  43 static void process_task_mortuary(void);
  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_flags & DCACHE_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 unsigned long last_cookie = INVALID_COOKIE;
 273
 274 static void add_cpu_switch(int i)
 275 {
 276         add_event_entry(ESCAPE_CODE);
 277         add_event_entry(CPU_SWITCH_CODE);
 278         add_event_entry(i);
 279         last_cookie = INVALID_COOKIE;
 280 }
 281
 282 static void add_kernel_ctx_switch(unsigned int in_kernel)
 283 {
 284         add_event_entry(ESCAPE_CODE);
 285         if (in_kernel)
 286                 add_event_entry(KERNEL_ENTER_SWITCH_CODE);
 287         else
 288                 add_event_entry(KERNEL_EXIT_SWITCH_CODE);
 289 }
 290
 291 static void
 292 add_user_ctx_switch(struct task_struct const *task, unsigned long cookie)
 293 {
 294         add_event_entry(ESCAPE_CODE);
 295         add_event_entry(CTX_SWITCH_CODE);
 296         add_event_entry(task->pid);
 297         add_event_entry(cookie);
 298         /* Another code for daemon back-compat */
 299         add_event_entry(ESCAPE_CODE);
 300         add_event_entry(CTX_TGID_CODE);
 301         add_event_entry(task->tgid);
 302 }
 303
 304
 305 static void add_cookie_switch(unsigned long cookie)
 306 {
 307         add_event_entry(ESCAPE_CODE);
 308         add_event_entry(COOKIE_SWITCH_CODE);
 309         add_event_entry(cookie);
 310 }
 311
 312
 313 static void add_trace_begin(void)
 314 {
 315         add_event_entry(ESCAPE_CODE);
 316         add_event_entry(TRACE_BEGIN_CODE);
 317 }
 318
 319 static void add_data(struct op_entry *entry, struct mm_struct *mm)
 320 {
 321         unsigned long code, pc, val;
 322         unsigned long cookie;
 323         off_t offset;
 324
 325         if (!op_cpu_buffer_get_data(entry, &code))
 326                 return;
 327         if (!op_cpu_buffer_get_data(entry, &pc))
 328                 return;
 329         if (!op_cpu_buffer_get_size(entry))
 330                 return;
 331
 332         if (mm) {
 333                 cookie = lookup_dcookie(mm, pc, &offset);
 334
 335                 if (cookie == NO_COOKIE)
 336                         offset = pc;
 337                 if (cookie == INVALID_COOKIE) {
 338                         atomic_inc(&oprofile_stats.sample_lost_no_mapping);
 339                         offset = pc;
 340                 }
 341                 if (cookie != last_cookie) {
 342                         add_cookie_switch(cookie);
 343                         last_cookie = cookie;
 344                 }
 345         } else
 346                 offset = pc;
 347
 348         add_event_entry(ESCAPE_CODE);
 349         add_event_entry(code);
 350         add_event_entry(offset);        /* Offset from Dcookie */
 351
 352         while (op_cpu_buffer_get_data(entry, &val))
 353                 add_event_entry(val);
 354 }
 355
 356 static inline void add_sample_entry(unsigned long offset, unsigned long event)
 357 {
 358         add_event_entry(offset);
 359         add_event_entry(event);
 360 }
 361
 362
 363 /*
 364  * Add a sample to the global event buffer. If possible the
 365  * sample is converted into a persistent dentry/offset pair
 366  * for later lookup from userspace. Return 0 on failure.
 367  */
 368 static int
 369 add_sample(struct mm_struct *mm, struct op_sample *s, int in_kernel)
 370 {
 371         unsigned long cookie;
 372         off_t offset;
 373
 374         if (in_kernel) {
 375                 add_sample_entry(s->eip, s->event);
 376                 return 1;
 377         }
 378
 379         /* add userspace sample */
 380
 381         if (!mm) {
 382                 atomic_inc(&oprofile_stats.sample_lost_no_mm);
 383                 return 0;
 384         }
 385
 386         cookie = lookup_dcookie(mm, s->eip, &offset);
 387
 388         if (cookie == INVALID_COOKIE) {
 389                 atomic_inc(&oprofile_stats.sample_lost_no_mapping);
 390                 return 0;
 391         }
 392
 393         if (cookie != last_cookie) {
 394                 add_cookie_switch(cookie);
 395                 last_cookie = cookie;
 396         }
 397
 398         add_sample_entry(offset, s->event);
 399
 400         return 1;
 401 }
 402
 403
 404 static void release_mm(struct mm_struct *mm)
 405 {
 406         if (!mm)
 407                 return;
 408         up_read(&mm->mmap_sem);
 409         mmput(mm);
 410 }
 411
 412
 413 static struct mm_struct *take_tasks_mm(struct task_struct *task)
 414 {
 415         struct mm_struct *mm = get_task_mm(task);
 416         if (mm)
 417                 down_read(&mm->mmap_sem);
 418         return mm;
 419 }
 420
 421
 422 static inline int is_code(unsigned long val)
 423 {
 424         return val == ESCAPE_CODE;
 425 }
 426
 427
 428 /* Move tasks along towards death. Any tasks on dead_tasks
 429  * will definitely have no remaining references in any
 430  * CPU buffers at this point, because we use two lists,
 431  * and to have reached the list, it must have gone through
 432  * one full sync already.
 433  */
 434 static void process_task_mortuary(void)
 435 {
 436         unsigned long flags;
 437         LIST_HEAD(local_dead_tasks);
 438         struct task_struct *task;
 439         struct task_struct *ttask;
 440
 441         spin_lock_irqsave(&task_mortuary, flags);
 442
 443         list_splice_init(&dead_tasks, &local_dead_tasks);
 444         list_splice_init(&dying_tasks, &dead_tasks);
 445
 446         spin_unlock_irqrestore(&task_mortuary, flags);
 447
 448         list_for_each_entry_safe(task, ttask, &local_dead_tasks, tasks) {
 449                 list_del(&task->tasks);
 450                 free_task(task);
 451         }
 452 }
 453
 454
 455 static void mark_done(int cpu)
 456 {
 457         int i;
 458
 459         cpumask_set_cpu(cpu, marked_cpus);
 460
 461         for_each_online_cpu(i) {
 462                 if (!cpumask_test_cpu(i, marked_cpus))
 463                         return;
 464         }
 465
 466         /* All CPUs have been processed at least once,
 467          * we can process the mortuary once
 468          */
 469         process_task_mortuary();
 470
 471         cpumask_clear(marked_cpus);
 472 }
 473
 474
 475 /* FIXME: this is not sufficient if we implement syscall barrier backtrace
 476  * traversal, the code switch to sb_sample_start at first kernel enter/exit
 477  * switch so we need a fifth state and some special handling in sync_buffer()
 478  */
 479 typedef enum {
 480         sb_bt_ignore = -2,
 481         sb_buffer_start,
 482         sb_bt_start,
 483         sb_sample_start,
 484 } sync_buffer_state;
 485
 486 /* Sync one of the CPU's buffers into the global event buffer.
 487  * Here we need to go through each batch of samples punctuated
 488  * by context switch notes, taking the task's mmap_sem and doing
 489  * lookup in task->mm->mmap to convert EIP into dcookie/offset
 490  * value.
 491  */
 492 void sync_buffer(int cpu)
 493 {
 494         struct mm_struct *mm = NULL;
 495         struct mm_struct *oldmm;
 496         unsigned long val;
 497         struct task_struct *new;
 498         unsigned long cookie = 0;
 499         int in_kernel = 1;
 500         sync_buffer_state state = sb_buffer_start;
 501         unsigned int i;
 502         unsigned long available;
 503         unsigned long flags;
 504         struct op_entry entry;
 505         struct op_sample *sample;
 506
 507         mutex_lock(&buffer_mutex);
 508
 509         add_cpu_switch(cpu);
 510
 511         op_cpu_buffer_reset(cpu);
 512         available = op_cpu_buffer_entries(cpu);
 513
 514         for (i = 0; i < available; ++i) {
 515                 sample = op_cpu_buffer_read_entry(&entry, cpu);
 516                 if (!sample)
 517                         break;
 518
 519                 if (is_code(sample->eip)) {
 520                         flags = sample->event;
 521                         if (flags & TRACE_BEGIN) {
 522                                 state = sb_bt_start;
 523                                 add_trace_begin();
 524                         }
 525                         if (flags & KERNEL_CTX_SWITCH) {
 526                                 /* kernel/userspace switch */
 527                                 in_kernel = flags & IS_KERNEL;
 528                                 if (state == sb_buffer_start)
 529                                         state = sb_sample_start;
 530                                 add_kernel_ctx_switch(flags & IS_KERNEL);
 531                         }
 532                         if (flags & USER_CTX_SWITCH
 533                             && op_cpu_buffer_get_data(&entry, &val)) {
 534                                 /* userspace context switch */
 535                                 new = (struct task_struct *)val;
 536                                 oldmm = mm;
 537                                 release_mm(oldmm);
 538                                 mm = take_tasks_mm(new);
 539                                 if (mm != oldmm)
 540                                         cookie = get_exec_dcookie(mm);
 541                                 add_user_ctx_switch(new, cookie);
 542                         }
 543                         if (op_cpu_buffer_get_size(&entry))
 544                                 add_data(&entry, mm);
 545                         continue;
 546                 }
 547
 548                 if (state < sb_bt_start)
 549                         /* ignore sample */
 550                         continue;
 551
 552                 if (add_sample(mm, sample, in_kernel))
 553                         continue;
 554
 555                 /* ignore backtraces if failed to add a sample */
 556                 if (state == sb_bt_start) {
 557                         state = sb_bt_ignore;
 558                         atomic_inc(&oprofile_stats.bt_lost_no_mapping);
 559                 }
 560         }
 561         release_mm(mm);
 562
 563         mark_done(cpu);
 564
 565         mutex_unlock(&buffer_mutex);
 566 }
 567
 568 int __init buffer_sync_init(void)
 569 {
 570         if (!alloc_cpumask_var(&marked_cpus, GFP_KERNEL))
 571                 return -ENOMEM;
 572
 573         cpumask_clear(marked_cpus);
 574                 return 0;
 575 }
 576
 577 void __exit buffer_sync_cleanup(void)
 578 {
 579         free_cpumask_var(marked_cpus);
 580 }
 581
 582 /* The function can be used to add a buffer worth of data directly to
 583  * the kernel buffer. The buffer is assumed to be a circular buffer.
 584  * Take the entries from index start and end at index end, wrapping
 585  * at max_entries.
 586  */
 587 void oprofile_put_buff(unsigned long *buf, unsigned int start,
 588                        unsigned int stop, unsigned int max)
 589 {
 590         int i;
 591
 592         i = start;
 593
 594         mutex_lock(&buffer_mutex);
 595         while (i != stop) {
 596                 add_event_entry(buf[i++]);
 597
 598                 if (i >= max)
 599                         i = 0;
 600         }
 601
 602         mutex_unlock(&buffer_mutex);
 603 }
 604