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