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