USB: serial: add special case for processing of empty read urbs
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / kernel / trace / trace_selftest.c
blob81003b4d617fad5a966c2ed89fba1e5b47ddffdd
1 /* Include in trace.c */
3 #include <linux/stringify.h>
4 #include <linux/kthread.h>
5 #include <linux/delay.h>
6 #include <linux/slab.h>
8 static inline int trace_valid_entry(struct trace_entry *entry)
10 switch (entry->type) {
11 case TRACE_FN:
12 case TRACE_CTX:
13 case TRACE_WAKE:
14 case TRACE_STACK:
15 case TRACE_PRINT:
16 case TRACE_SPECIAL:
17 case TRACE_BRANCH:
18 case TRACE_GRAPH_ENT:
19 case TRACE_GRAPH_RET:
20 case TRACE_HW_BRANCHES:
21 case TRACE_KSYM:
22 return 1;
24 return 0;
27 static int trace_test_buffer_cpu(struct trace_array *tr, int cpu)
29 struct ring_buffer_event *event;
30 struct trace_entry *entry;
31 unsigned int loops = 0;
33 while ((event = ring_buffer_consume(tr->buffer, cpu, NULL))) {
34 entry = ring_buffer_event_data(event);
37 * The ring buffer is a size of trace_buf_size, if
38 * we loop more than the size, there's something wrong
39 * with the ring buffer.
41 if (loops++ > trace_buf_size) {
42 printk(KERN_CONT ".. bad ring buffer ");
43 goto failed;
45 if (!trace_valid_entry(entry)) {
46 printk(KERN_CONT ".. invalid entry %d ",
47 entry->type);
48 goto failed;
51 return 0;
53 failed:
54 /* disable tracing */
55 tracing_disabled = 1;
56 printk(KERN_CONT ".. corrupted trace buffer .. ");
57 return -1;
61 * Test the trace buffer to see if all the elements
62 * are still sane.
64 static int trace_test_buffer(struct trace_array *tr, unsigned long *count)
66 unsigned long flags, cnt = 0;
67 int cpu, ret = 0;
69 /* Don't allow flipping of max traces now */
70 local_irq_save(flags);
71 arch_spin_lock(&ftrace_max_lock);
73 cnt = ring_buffer_entries(tr->buffer);
76 * The trace_test_buffer_cpu runs a while loop to consume all data.
77 * If the calling tracer is broken, and is constantly filling
78 * the buffer, this will run forever, and hard lock the box.
79 * We disable the ring buffer while we do this test to prevent
80 * a hard lock up.
82 tracing_off();
83 for_each_possible_cpu(cpu) {
84 ret = trace_test_buffer_cpu(tr, cpu);
85 if (ret)
86 break;
88 tracing_on();
89 arch_spin_unlock(&ftrace_max_lock);
90 local_irq_restore(flags);
92 if (count)
93 *count = cnt;
95 return ret;
98 static inline void warn_failed_init_tracer(struct tracer *trace, int init_ret)
100 printk(KERN_WARNING "Failed to init %s tracer, init returned %d\n",
101 trace->name, init_ret);
103 #ifdef CONFIG_FUNCTION_TRACER
105 #ifdef CONFIG_DYNAMIC_FTRACE
107 /* Test dynamic code modification and ftrace filters */
108 int trace_selftest_startup_dynamic_tracing(struct tracer *trace,
109 struct trace_array *tr,
110 int (*func)(void))
112 int save_ftrace_enabled = ftrace_enabled;
113 int save_tracer_enabled = tracer_enabled;
114 unsigned long count;
115 char *func_name;
116 int ret;
118 /* The ftrace test PASSED */
119 printk(KERN_CONT "PASSED\n");
120 pr_info("Testing dynamic ftrace: ");
122 /* enable tracing, and record the filter function */
123 ftrace_enabled = 1;
124 tracer_enabled = 1;
126 /* passed in by parameter to fool gcc from optimizing */
127 func();
130 * Some archs *cough*PowerPC*cough* add characters to the
131 * start of the function names. We simply put a '*' to
132 * accommodate them.
134 func_name = "*" __stringify(DYN_FTRACE_TEST_NAME);
136 /* filter only on our function */
137 ftrace_set_filter(func_name, strlen(func_name), 1);
139 /* enable tracing */
140 ret = tracer_init(trace, tr);
141 if (ret) {
142 warn_failed_init_tracer(trace, ret);
143 goto out;
146 /* Sleep for a 1/10 of a second */
147 msleep(100);
149 /* we should have nothing in the buffer */
150 ret = trace_test_buffer(tr, &count);
151 if (ret)
152 goto out;
154 if (count) {
155 ret = -1;
156 printk(KERN_CONT ".. filter did not filter .. ");
157 goto out;
160 /* call our function again */
161 func();
163 /* sleep again */
164 msleep(100);
166 /* stop the tracing. */
167 tracing_stop();
168 ftrace_enabled = 0;
170 /* check the trace buffer */
171 ret = trace_test_buffer(tr, &count);
172 trace->reset(tr);
173 tracing_start();
175 /* we should only have one item */
176 if (!ret && count != 1) {
177 printk(KERN_CONT ".. filter failed count=%ld ..", count);
178 ret = -1;
179 goto out;
182 out:
183 ftrace_enabled = save_ftrace_enabled;
184 tracer_enabled = save_tracer_enabled;
186 /* Enable tracing on all functions again */
187 ftrace_set_filter(NULL, 0, 1);
189 return ret;
191 #else
192 # define trace_selftest_startup_dynamic_tracing(trace, tr, func) ({ 0; })
193 #endif /* CONFIG_DYNAMIC_FTRACE */
196 * Simple verification test of ftrace function tracer.
197 * Enable ftrace, sleep 1/10 second, and then read the trace
198 * buffer to see if all is in order.
201 trace_selftest_startup_function(struct tracer *trace, struct trace_array *tr)
203 int save_ftrace_enabled = ftrace_enabled;
204 int save_tracer_enabled = tracer_enabled;
205 unsigned long count;
206 int ret;
208 /* make sure msleep has been recorded */
209 msleep(1);
211 /* start the tracing */
212 ftrace_enabled = 1;
213 tracer_enabled = 1;
215 ret = tracer_init(trace, tr);
216 if (ret) {
217 warn_failed_init_tracer(trace, ret);
218 goto out;
221 /* Sleep for a 1/10 of a second */
222 msleep(100);
223 /* stop the tracing. */
224 tracing_stop();
225 ftrace_enabled = 0;
227 /* check the trace buffer */
228 ret = trace_test_buffer(tr, &count);
229 trace->reset(tr);
230 tracing_start();
232 if (!ret && !count) {
233 printk(KERN_CONT ".. no entries found ..");
234 ret = -1;
235 goto out;
238 ret = trace_selftest_startup_dynamic_tracing(trace, tr,
239 DYN_FTRACE_TEST_NAME);
241 out:
242 ftrace_enabled = save_ftrace_enabled;
243 tracer_enabled = save_tracer_enabled;
245 /* kill ftrace totally if we failed */
246 if (ret)
247 ftrace_kill();
249 return ret;
251 #endif /* CONFIG_FUNCTION_TRACER */
254 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
256 /* Maximum number of functions to trace before diagnosing a hang */
257 #define GRAPH_MAX_FUNC_TEST 100000000
259 static void __ftrace_dump(bool disable_tracing);
260 static unsigned int graph_hang_thresh;
262 /* Wrap the real function entry probe to avoid possible hanging */
263 static int trace_graph_entry_watchdog(struct ftrace_graph_ent *trace)
265 /* This is harmlessly racy, we want to approximately detect a hang */
266 if (unlikely(++graph_hang_thresh > GRAPH_MAX_FUNC_TEST)) {
267 ftrace_graph_stop();
268 printk(KERN_WARNING "BUG: Function graph tracer hang!\n");
269 if (ftrace_dump_on_oops)
270 __ftrace_dump(false);
271 return 0;
274 return trace_graph_entry(trace);
278 * Pretty much the same than for the function tracer from which the selftest
279 * has been borrowed.
282 trace_selftest_startup_function_graph(struct tracer *trace,
283 struct trace_array *tr)
285 int ret;
286 unsigned long count;
289 * Simulate the init() callback but we attach a watchdog callback
290 * to detect and recover from possible hangs
292 tracing_reset_online_cpus(tr);
293 set_graph_array(tr);
294 ret = register_ftrace_graph(&trace_graph_return,
295 &trace_graph_entry_watchdog);
296 if (ret) {
297 warn_failed_init_tracer(trace, ret);
298 goto out;
300 tracing_start_cmdline_record();
302 /* Sleep for a 1/10 of a second */
303 msleep(100);
305 /* Have we just recovered from a hang? */
306 if (graph_hang_thresh > GRAPH_MAX_FUNC_TEST) {
307 tracing_selftest_disabled = true;
308 ret = -1;
309 goto out;
312 tracing_stop();
314 /* check the trace buffer */
315 ret = trace_test_buffer(tr, &count);
317 trace->reset(tr);
318 tracing_start();
320 if (!ret && !count) {
321 printk(KERN_CONT ".. no entries found ..");
322 ret = -1;
323 goto out;
326 /* Don't test dynamic tracing, the function tracer already did */
328 out:
329 /* Stop it if we failed */
330 if (ret)
331 ftrace_graph_stop();
333 return ret;
335 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
338 #ifdef CONFIG_IRQSOFF_TRACER
340 trace_selftest_startup_irqsoff(struct tracer *trace, struct trace_array *tr)
342 unsigned long save_max = tracing_max_latency;
343 unsigned long count;
344 int ret;
346 /* start the tracing */
347 ret = tracer_init(trace, tr);
348 if (ret) {
349 warn_failed_init_tracer(trace, ret);
350 return ret;
353 /* reset the max latency */
354 tracing_max_latency = 0;
355 /* disable interrupts for a bit */
356 local_irq_disable();
357 udelay(100);
358 local_irq_enable();
361 * Stop the tracer to avoid a warning subsequent
362 * to buffer flipping failure because tracing_stop()
363 * disables the tr and max buffers, making flipping impossible
364 * in case of parallels max irqs off latencies.
366 trace->stop(tr);
367 /* stop the tracing. */
368 tracing_stop();
369 /* check both trace buffers */
370 ret = trace_test_buffer(tr, NULL);
371 if (!ret)
372 ret = trace_test_buffer(&max_tr, &count);
373 trace->reset(tr);
374 tracing_start();
376 if (!ret && !count) {
377 printk(KERN_CONT ".. no entries found ..");
378 ret = -1;
381 tracing_max_latency = save_max;
383 return ret;
385 #endif /* CONFIG_IRQSOFF_TRACER */
387 #ifdef CONFIG_PREEMPT_TRACER
389 trace_selftest_startup_preemptoff(struct tracer *trace, struct trace_array *tr)
391 unsigned long save_max = tracing_max_latency;
392 unsigned long count;
393 int ret;
396 * Now that the big kernel lock is no longer preemptable,
397 * and this is called with the BKL held, it will always
398 * fail. If preemption is already disabled, simply
399 * pass the test. When the BKL is removed, or becomes
400 * preemptible again, we will once again test this,
401 * so keep it in.
403 if (preempt_count()) {
404 printk(KERN_CONT "can not test ... force ");
405 return 0;
408 /* start the tracing */
409 ret = tracer_init(trace, tr);
410 if (ret) {
411 warn_failed_init_tracer(trace, ret);
412 return ret;
415 /* reset the max latency */
416 tracing_max_latency = 0;
417 /* disable preemption for a bit */
418 preempt_disable();
419 udelay(100);
420 preempt_enable();
423 * Stop the tracer to avoid a warning subsequent
424 * to buffer flipping failure because tracing_stop()
425 * disables the tr and max buffers, making flipping impossible
426 * in case of parallels max preempt off latencies.
428 trace->stop(tr);
429 /* stop the tracing. */
430 tracing_stop();
431 /* check both trace buffers */
432 ret = trace_test_buffer(tr, NULL);
433 if (!ret)
434 ret = trace_test_buffer(&max_tr, &count);
435 trace->reset(tr);
436 tracing_start();
438 if (!ret && !count) {
439 printk(KERN_CONT ".. no entries found ..");
440 ret = -1;
443 tracing_max_latency = save_max;
445 return ret;
447 #endif /* CONFIG_PREEMPT_TRACER */
449 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
451 trace_selftest_startup_preemptirqsoff(struct tracer *trace, struct trace_array *tr)
453 unsigned long save_max = tracing_max_latency;
454 unsigned long count;
455 int ret;
458 * Now that the big kernel lock is no longer preemptable,
459 * and this is called with the BKL held, it will always
460 * fail. If preemption is already disabled, simply
461 * pass the test. When the BKL is removed, or becomes
462 * preemptible again, we will once again test this,
463 * so keep it in.
465 if (preempt_count()) {
466 printk(KERN_CONT "can not test ... force ");
467 return 0;
470 /* start the tracing */
471 ret = tracer_init(trace, tr);
472 if (ret) {
473 warn_failed_init_tracer(trace, ret);
474 goto out_no_start;
477 /* reset the max latency */
478 tracing_max_latency = 0;
480 /* disable preemption and interrupts for a bit */
481 preempt_disable();
482 local_irq_disable();
483 udelay(100);
484 preempt_enable();
485 /* reverse the order of preempt vs irqs */
486 local_irq_enable();
489 * Stop the tracer to avoid a warning subsequent
490 * to buffer flipping failure because tracing_stop()
491 * disables the tr and max buffers, making flipping impossible
492 * in case of parallels max irqs/preempt off latencies.
494 trace->stop(tr);
495 /* stop the tracing. */
496 tracing_stop();
497 /* check both trace buffers */
498 ret = trace_test_buffer(tr, NULL);
499 if (ret)
500 goto out;
502 ret = trace_test_buffer(&max_tr, &count);
503 if (ret)
504 goto out;
506 if (!ret && !count) {
507 printk(KERN_CONT ".. no entries found ..");
508 ret = -1;
509 goto out;
512 /* do the test by disabling interrupts first this time */
513 tracing_max_latency = 0;
514 tracing_start();
515 trace->start(tr);
517 preempt_disable();
518 local_irq_disable();
519 udelay(100);
520 preempt_enable();
521 /* reverse the order of preempt vs irqs */
522 local_irq_enable();
524 trace->stop(tr);
525 /* stop the tracing. */
526 tracing_stop();
527 /* check both trace buffers */
528 ret = trace_test_buffer(tr, NULL);
529 if (ret)
530 goto out;
532 ret = trace_test_buffer(&max_tr, &count);
534 if (!ret && !count) {
535 printk(KERN_CONT ".. no entries found ..");
536 ret = -1;
537 goto out;
540 out:
541 tracing_start();
542 out_no_start:
543 trace->reset(tr);
544 tracing_max_latency = save_max;
546 return ret;
548 #endif /* CONFIG_IRQSOFF_TRACER && CONFIG_PREEMPT_TRACER */
550 #ifdef CONFIG_NOP_TRACER
552 trace_selftest_startup_nop(struct tracer *trace, struct trace_array *tr)
554 /* What could possibly go wrong? */
555 return 0;
557 #endif
559 #ifdef CONFIG_SCHED_TRACER
560 static int trace_wakeup_test_thread(void *data)
562 /* Make this a RT thread, doesn't need to be too high */
563 struct sched_param param = { .sched_priority = 5 };
564 struct completion *x = data;
566 sched_setscheduler(current, SCHED_FIFO, &param);
568 /* Make it know we have a new prio */
569 complete(x);
571 /* now go to sleep and let the test wake us up */
572 set_current_state(TASK_INTERRUPTIBLE);
573 schedule();
575 /* we are awake, now wait to disappear */
576 while (!kthread_should_stop()) {
578 * This is an RT task, do short sleeps to let
579 * others run.
581 msleep(100);
584 return 0;
588 trace_selftest_startup_wakeup(struct tracer *trace, struct trace_array *tr)
590 unsigned long save_max = tracing_max_latency;
591 struct task_struct *p;
592 struct completion isrt;
593 unsigned long count;
594 int ret;
596 init_completion(&isrt);
598 /* create a high prio thread */
599 p = kthread_run(trace_wakeup_test_thread, &isrt, "ftrace-test");
600 if (IS_ERR(p)) {
601 printk(KERN_CONT "Failed to create ftrace wakeup test thread ");
602 return -1;
605 /* make sure the thread is running at an RT prio */
606 wait_for_completion(&isrt);
608 /* start the tracing */
609 ret = tracer_init(trace, tr);
610 if (ret) {
611 warn_failed_init_tracer(trace, ret);
612 return ret;
615 /* reset the max latency */
616 tracing_max_latency = 0;
618 /* sleep to let the RT thread sleep too */
619 msleep(100);
622 * Yes this is slightly racy. It is possible that for some
623 * strange reason that the RT thread we created, did not
624 * call schedule for 100ms after doing the completion,
625 * and we do a wakeup on a task that already is awake.
626 * But that is extremely unlikely, and the worst thing that
627 * happens in such a case, is that we disable tracing.
628 * Honestly, if this race does happen something is horrible
629 * wrong with the system.
632 wake_up_process(p);
634 /* give a little time to let the thread wake up */
635 msleep(100);
637 /* stop the tracing. */
638 tracing_stop();
639 /* check both trace buffers */
640 ret = trace_test_buffer(tr, NULL);
641 if (!ret)
642 ret = trace_test_buffer(&max_tr, &count);
645 trace->reset(tr);
646 tracing_start();
648 tracing_max_latency = save_max;
650 /* kill the thread */
651 kthread_stop(p);
653 if (!ret && !count) {
654 printk(KERN_CONT ".. no entries found ..");
655 ret = -1;
658 return ret;
660 #endif /* CONFIG_SCHED_TRACER */
662 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
664 trace_selftest_startup_sched_switch(struct tracer *trace, struct trace_array *tr)
666 unsigned long count;
667 int ret;
669 /* start the tracing */
670 ret = tracer_init(trace, tr);
671 if (ret) {
672 warn_failed_init_tracer(trace, ret);
673 return ret;
676 /* Sleep for a 1/10 of a second */
677 msleep(100);
678 /* stop the tracing. */
679 tracing_stop();
680 /* check the trace buffer */
681 ret = trace_test_buffer(tr, &count);
682 trace->reset(tr);
683 tracing_start();
685 if (!ret && !count) {
686 printk(KERN_CONT ".. no entries found ..");
687 ret = -1;
690 return ret;
692 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
694 #ifdef CONFIG_SYSPROF_TRACER
696 trace_selftest_startup_sysprof(struct tracer *trace, struct trace_array *tr)
698 unsigned long count;
699 int ret;
701 /* start the tracing */
702 ret = tracer_init(trace, tr);
703 if (ret) {
704 warn_failed_init_tracer(trace, ret);
705 return ret;
708 /* Sleep for a 1/10 of a second */
709 msleep(100);
710 /* stop the tracing. */
711 tracing_stop();
712 /* check the trace buffer */
713 ret = trace_test_buffer(tr, &count);
714 trace->reset(tr);
715 tracing_start();
717 if (!ret && !count) {
718 printk(KERN_CONT ".. no entries found ..");
719 ret = -1;
722 return ret;
724 #endif /* CONFIG_SYSPROF_TRACER */
726 #ifdef CONFIG_BRANCH_TRACER
728 trace_selftest_startup_branch(struct tracer *trace, struct trace_array *tr)
730 unsigned long count;
731 int ret;
733 /* start the tracing */
734 ret = tracer_init(trace, tr);
735 if (ret) {
736 warn_failed_init_tracer(trace, ret);
737 return ret;
740 /* Sleep for a 1/10 of a second */
741 msleep(100);
742 /* stop the tracing. */
743 tracing_stop();
744 /* check the trace buffer */
745 ret = trace_test_buffer(tr, &count);
746 trace->reset(tr);
747 tracing_start();
749 if (!ret && !count) {
750 printk(KERN_CONT ".. no entries found ..");
751 ret = -1;
754 return ret;
756 #endif /* CONFIG_BRANCH_TRACER */
758 #ifdef CONFIG_HW_BRANCH_TRACER
760 trace_selftest_startup_hw_branches(struct tracer *trace,
761 struct trace_array *tr)
763 struct trace_iterator *iter;
764 struct tracer tracer;
765 unsigned long count;
766 int ret;
768 if (!trace->open) {
769 printk(KERN_CONT "missing open function...");
770 return -1;
773 ret = tracer_init(trace, tr);
774 if (ret) {
775 warn_failed_init_tracer(trace, ret);
776 return ret;
780 * The hw-branch tracer needs to collect the trace from the various
781 * cpu trace buffers - before tracing is stopped.
783 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
784 if (!iter)
785 return -ENOMEM;
787 memcpy(&tracer, trace, sizeof(tracer));
789 iter->trace = &tracer;
790 iter->tr = tr;
791 iter->pos = -1;
792 mutex_init(&iter->mutex);
794 trace->open(iter);
796 mutex_destroy(&iter->mutex);
797 kfree(iter);
799 tracing_stop();
801 ret = trace_test_buffer(tr, &count);
802 trace->reset(tr);
803 tracing_start();
805 if (!ret && !count) {
806 printk(KERN_CONT "no entries found..");
807 ret = -1;
810 return ret;
812 #endif /* CONFIG_HW_BRANCH_TRACER */
814 #ifdef CONFIG_KSYM_TRACER
815 static int ksym_selftest_dummy;
818 trace_selftest_startup_ksym(struct tracer *trace, struct trace_array *tr)
820 unsigned long count;
821 int ret;
823 /* start the tracing */
824 ret = tracer_init(trace, tr);
825 if (ret) {
826 warn_failed_init_tracer(trace, ret);
827 return ret;
830 ksym_selftest_dummy = 0;
831 /* Register the read-write tracing request */
833 ret = process_new_ksym_entry("ksym_selftest_dummy",
834 HW_BREAKPOINT_R | HW_BREAKPOINT_W,
835 (unsigned long)(&ksym_selftest_dummy));
837 if (ret < 0) {
838 printk(KERN_CONT "ksym_trace read-write startup test failed\n");
839 goto ret_path;
841 /* Perform a read and a write operation over the dummy variable to
842 * trigger the tracer
844 if (ksym_selftest_dummy == 0)
845 ksym_selftest_dummy++;
847 /* stop the tracing. */
848 tracing_stop();
849 /* check the trace buffer */
850 ret = trace_test_buffer(tr, &count);
851 trace->reset(tr);
852 tracing_start();
854 /* read & write operations - one each is performed on the dummy variable
855 * triggering two entries in the trace buffer
857 if (!ret && count != 2) {
858 printk(KERN_CONT "Ksym tracer startup test failed");
859 ret = -1;
862 ret_path:
863 return ret;
865 #endif /* CONFIG_KSYM_TRACER */