ftrace: Remove FTRACE_UPDATE_MODIFY_CALL_REGS flag
[platform/kernel/linux-rpi.git] / arch / x86 / kernel / ftrace.c
1 /*
2  * Code for replacing ftrace calls with jumps.
3  *
4  * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
5  *
6  * Thanks goes to Ingo Molnar, for suggesting the idea.
7  * Mathieu Desnoyers, for suggesting postponing the modifications.
8  * Arjan van de Ven, for keeping me straight, and explaining to me
9  * the dangers of modifying code on the run.
10  */
11
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13
14 #include <linux/spinlock.h>
15 #include <linux/hardirq.h>
16 #include <linux/uaccess.h>
17 #include <linux/ftrace.h>
18 #include <linux/percpu.h>
19 #include <linux/sched.h>
20 #include <linux/init.h>
21 #include <linux/list.h>
22 #include <linux/module.h>
23
24 #include <trace/syscall.h>
25
26 #include <asm/cacheflush.h>
27 #include <asm/kprobes.h>
28 #include <asm/ftrace.h>
29 #include <asm/nops.h>
30
31 #ifdef CONFIG_DYNAMIC_FTRACE
32
33 int ftrace_arch_code_modify_prepare(void)
34 {
35         set_kernel_text_rw();
36         set_all_modules_text_rw();
37         return 0;
38 }
39
40 int ftrace_arch_code_modify_post_process(void)
41 {
42         set_all_modules_text_ro();
43         set_kernel_text_ro();
44         return 0;
45 }
46
47 union ftrace_code_union {
48         char code[MCOUNT_INSN_SIZE];
49         struct {
50                 char e8;
51                 int offset;
52         } __attribute__((packed));
53 };
54
55 static int ftrace_calc_offset(long ip, long addr)
56 {
57         return (int)(addr - ip);
58 }
59
60 static unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr)
61 {
62         static union ftrace_code_union calc;
63
64         calc.e8         = 0xe8;
65         calc.offset     = ftrace_calc_offset(ip + MCOUNT_INSN_SIZE, addr);
66
67         /*
68          * No locking needed, this must be called via kstop_machine
69          * which in essence is like running on a uniprocessor machine.
70          */
71         return calc.code;
72 }
73
74 static inline int
75 within(unsigned long addr, unsigned long start, unsigned long end)
76 {
77         return addr >= start && addr < end;
78 }
79
80 static unsigned long text_ip_addr(unsigned long ip)
81 {
82         /*
83          * On x86_64, kernel text mappings are mapped read-only with
84          * CONFIG_DEBUG_RODATA. So we use the kernel identity mapping instead
85          * of the kernel text mapping to modify the kernel text.
86          *
87          * For 32bit kernels, these mappings are same and we can use
88          * kernel identity mapping to modify code.
89          */
90         if (within(ip, (unsigned long)_text, (unsigned long)_etext))
91                 ip = (unsigned long)__va(__pa_symbol(ip));
92
93         return ip;
94 }
95
96 static const unsigned char *ftrace_nop_replace(void)
97 {
98         return ideal_nops[NOP_ATOMIC5];
99 }
100
101 static int
102 ftrace_modify_code_direct(unsigned long ip, unsigned const char *old_code,
103                    unsigned const char *new_code)
104 {
105         unsigned char replaced[MCOUNT_INSN_SIZE];
106
107         /*
108          * Note: Due to modules and __init, code can
109          *  disappear and change, we need to protect against faulting
110          *  as well as code changing. We do this by using the
111          *  probe_kernel_* functions.
112          *
113          * No real locking needed, this code is run through
114          * kstop_machine, or before SMP starts.
115          */
116
117         /* read the text we want to modify */
118         if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
119                 return -EFAULT;
120
121         /* Make sure it is what we expect it to be */
122         if (memcmp(replaced, old_code, MCOUNT_INSN_SIZE) != 0)
123                 return -EINVAL;
124
125         ip = text_ip_addr(ip);
126
127         /* replace the text with the new text */
128         if (probe_kernel_write((void *)ip, new_code, MCOUNT_INSN_SIZE))
129                 return -EPERM;
130
131         sync_core();
132
133         return 0;
134 }
135
136 int ftrace_make_nop(struct module *mod,
137                     struct dyn_ftrace *rec, unsigned long addr)
138 {
139         unsigned const char *new, *old;
140         unsigned long ip = rec->ip;
141
142         old = ftrace_call_replace(ip, addr);
143         new = ftrace_nop_replace();
144
145         /*
146          * On boot up, and when modules are loaded, the MCOUNT_ADDR
147          * is converted to a nop, and will never become MCOUNT_ADDR
148          * again. This code is either running before SMP (on boot up)
149          * or before the code will ever be executed (module load).
150          * We do not want to use the breakpoint version in this case,
151          * just modify the code directly.
152          */
153         if (addr == MCOUNT_ADDR)
154                 return ftrace_modify_code_direct(rec->ip, old, new);
155
156         /* Normal cases use add_brk_on_nop */
157         WARN_ONCE(1, "invalid use of ftrace_make_nop");
158         return -EINVAL;
159 }
160
161 int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr)
162 {
163         unsigned const char *new, *old;
164         unsigned long ip = rec->ip;
165
166         old = ftrace_nop_replace();
167         new = ftrace_call_replace(ip, addr);
168
169         /* Should only be called when module is loaded */
170         return ftrace_modify_code_direct(rec->ip, old, new);
171 }
172
173 /*
174  * The modifying_ftrace_code is used to tell the breakpoint
175  * handler to call ftrace_int3_handler(). If it fails to
176  * call this handler for a breakpoint added by ftrace, then
177  * the kernel may crash.
178  *
179  * As atomic_writes on x86 do not need a barrier, we do not
180  * need to add smp_mb()s for this to work. It is also considered
181  * that we can not read the modifying_ftrace_code before
182  * executing the breakpoint. That would be quite remarkable if
183  * it could do that. Here's the flow that is required:
184  *
185  *   CPU-0                          CPU-1
186  *
187  * atomic_inc(mfc);
188  * write int3s
189  *                              <trap-int3> // implicit (r)mb
190  *                              if (atomic_read(mfc))
191  *                                      call ftrace_int3_handler()
192  *
193  * Then when we are finished:
194  *
195  * atomic_dec(mfc);
196  *
197  * If we hit a breakpoint that was not set by ftrace, it does not
198  * matter if ftrace_int3_handler() is called or not. It will
199  * simply be ignored. But it is crucial that a ftrace nop/caller
200  * breakpoint is handled. No other user should ever place a
201  * breakpoint on an ftrace nop/caller location. It must only
202  * be done by this code.
203  */
204 atomic_t modifying_ftrace_code __read_mostly;
205
206 static int
207 ftrace_modify_code(unsigned long ip, unsigned const char *old_code,
208                    unsigned const char *new_code);
209
210 /*
211  * Should never be called:
212  *  As it is only called by __ftrace_replace_code() which is called by
213  *  ftrace_replace_code() that x86 overrides, and by ftrace_update_code()
214  *  which is called to turn mcount into nops or nops into function calls
215  *  but not to convert a function from not using regs to one that uses
216  *  regs, which ftrace_modify_call() is for.
217  */
218 int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
219                                  unsigned long addr)
220 {
221         WARN_ON(1);
222         return -EINVAL;
223 }
224
225 static unsigned long ftrace_update_func;
226
227 static int update_ftrace_func(unsigned long ip, void *new)
228 {
229         unsigned char old[MCOUNT_INSN_SIZE];
230         int ret;
231
232         memcpy(old, (void *)ip, MCOUNT_INSN_SIZE);
233
234         ftrace_update_func = ip;
235         /* Make sure the breakpoints see the ftrace_update_func update */
236         smp_wmb();
237
238         /* See comment above by declaration of modifying_ftrace_code */
239         atomic_inc(&modifying_ftrace_code);
240
241         ret = ftrace_modify_code(ip, old, new);
242
243         atomic_dec(&modifying_ftrace_code);
244
245         return ret;
246 }
247
248 int ftrace_update_ftrace_func(ftrace_func_t func)
249 {
250         unsigned long ip = (unsigned long)(&ftrace_call);
251         unsigned char *new;
252         int ret;
253
254         new = ftrace_call_replace(ip, (unsigned long)func);
255         ret = update_ftrace_func(ip, new);
256
257         /* Also update the regs callback function */
258         if (!ret) {
259                 ip = (unsigned long)(&ftrace_regs_call);
260                 new = ftrace_call_replace(ip, (unsigned long)func);
261                 ret = update_ftrace_func(ip, new);
262         }
263
264         return ret;
265 }
266
267 static int is_ftrace_caller(unsigned long ip)
268 {
269         if (ip == ftrace_update_func)
270                 return 1;
271
272         return 0;
273 }
274
275 /*
276  * A breakpoint was added to the code address we are about to
277  * modify, and this is the handle that will just skip over it.
278  * We are either changing a nop into a trace call, or a trace
279  * call to a nop. While the change is taking place, we treat
280  * it just like it was a nop.
281  */
282 int ftrace_int3_handler(struct pt_regs *regs)
283 {
284         unsigned long ip;
285
286         if (WARN_ON_ONCE(!regs))
287                 return 0;
288
289         ip = regs->ip - 1;
290         if (!ftrace_location(ip) && !is_ftrace_caller(ip))
291                 return 0;
292
293         regs->ip += MCOUNT_INSN_SIZE - 1;
294
295         return 1;
296 }
297
298 static int ftrace_write(unsigned long ip, const char *val, int size)
299 {
300         /*
301          * On x86_64, kernel text mappings are mapped read-only with
302          * CONFIG_DEBUG_RODATA. So we use the kernel identity mapping instead
303          * of the kernel text mapping to modify the kernel text.
304          *
305          * For 32bit kernels, these mappings are same and we can use
306          * kernel identity mapping to modify code.
307          */
308         if (within(ip, (unsigned long)_text, (unsigned long)_etext))
309                 ip = (unsigned long)__va(__pa_symbol(ip));
310
311         if (probe_kernel_write((void *)ip, val, size))
312                 return -EPERM;
313
314         return 0;
315 }
316
317 static int add_break(unsigned long ip, const char *old)
318 {
319         unsigned char replaced[MCOUNT_INSN_SIZE];
320         unsigned char brk = BREAKPOINT_INSTRUCTION;
321
322         if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
323                 return -EFAULT;
324
325         /* Make sure it is what we expect it to be */
326         if (memcmp(replaced, old, MCOUNT_INSN_SIZE) != 0)
327                 return -EINVAL;
328
329         return ftrace_write(ip, &brk, 1);
330 }
331
332 static int add_brk_on_call(struct dyn_ftrace *rec, unsigned long addr)
333 {
334         unsigned const char *old;
335         unsigned long ip = rec->ip;
336
337         old = ftrace_call_replace(ip, addr);
338
339         return add_break(rec->ip, old);
340 }
341
342
343 static int add_brk_on_nop(struct dyn_ftrace *rec)
344 {
345         unsigned const char *old;
346
347         old = ftrace_nop_replace();
348
349         return add_break(rec->ip, old);
350 }
351
352 static int add_breakpoints(struct dyn_ftrace *rec, int enable)
353 {
354         unsigned long ftrace_addr;
355         int ret;
356
357         ftrace_addr = ftrace_get_addr_curr(rec);
358
359         ret = ftrace_test_record(rec, enable);
360
361         switch (ret) {
362         case FTRACE_UPDATE_IGNORE:
363                 return 0;
364
365         case FTRACE_UPDATE_MAKE_CALL:
366                 /* converting nop to call */
367                 return add_brk_on_nop(rec);
368
369         case FTRACE_UPDATE_MODIFY_CALL:
370         case FTRACE_UPDATE_MAKE_NOP:
371                 /* converting a call to a nop */
372                 return add_brk_on_call(rec, ftrace_addr);
373         }
374         return 0;
375 }
376
377 /*
378  * On error, we need to remove breakpoints. This needs to
379  * be done caefully. If the address does not currently have a
380  * breakpoint, we know we are done. Otherwise, we look at the
381  * remaining 4 bytes of the instruction. If it matches a nop
382  * we replace the breakpoint with the nop. Otherwise we replace
383  * it with the call instruction.
384  */
385 static int remove_breakpoint(struct dyn_ftrace *rec)
386 {
387         unsigned char ins[MCOUNT_INSN_SIZE];
388         unsigned char brk = BREAKPOINT_INSTRUCTION;
389         const unsigned char *nop;
390         unsigned long ftrace_addr;
391         unsigned long ip = rec->ip;
392
393         /* If we fail the read, just give up */
394         if (probe_kernel_read(ins, (void *)ip, MCOUNT_INSN_SIZE))
395                 return -EFAULT;
396
397         /* If this does not have a breakpoint, we are done */
398         if (ins[0] != brk)
399                 return 0;
400
401         nop = ftrace_nop_replace();
402
403         /*
404          * If the last 4 bytes of the instruction do not match
405          * a nop, then we assume that this is a call to ftrace_addr.
406          */
407         if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) != 0) {
408                 /*
409                  * For extra paranoidism, we check if the breakpoint is on
410                  * a call that would actually jump to the ftrace_addr.
411                  * If not, don't touch the breakpoint, we make just create
412                  * a disaster.
413                  */
414                 ftrace_addr = ftrace_get_addr_new(rec);
415                 nop = ftrace_call_replace(ip, ftrace_addr);
416
417                 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) == 0)
418                         goto update;
419
420                 /* Check both ftrace_addr and ftrace_old_addr */
421                 ftrace_addr = ftrace_get_addr_curr(rec);
422                 nop = ftrace_call_replace(ip, ftrace_addr);
423
424                 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) != 0)
425                         return -EINVAL;
426         }
427
428  update:
429         return ftrace_write(ip, nop, 1);
430 }
431
432 static int add_update_code(unsigned long ip, unsigned const char *new)
433 {
434         /* skip breakpoint */
435         ip++;
436         new++;
437         return ftrace_write(ip, new, MCOUNT_INSN_SIZE - 1);
438 }
439
440 static int add_update_call(struct dyn_ftrace *rec, unsigned long addr)
441 {
442         unsigned long ip = rec->ip;
443         unsigned const char *new;
444
445         new = ftrace_call_replace(ip, addr);
446         return add_update_code(ip, new);
447 }
448
449 static int add_update_nop(struct dyn_ftrace *rec)
450 {
451         unsigned long ip = rec->ip;
452         unsigned const char *new;
453
454         new = ftrace_nop_replace();
455         return add_update_code(ip, new);
456 }
457
458 static int add_update(struct dyn_ftrace *rec, int enable)
459 {
460         unsigned long ftrace_addr;
461         int ret;
462
463         ret = ftrace_test_record(rec, enable);
464
465         ftrace_addr  = ftrace_get_addr_new(rec);
466
467         switch (ret) {
468         case FTRACE_UPDATE_IGNORE:
469                 return 0;
470
471         case FTRACE_UPDATE_MODIFY_CALL:
472         case FTRACE_UPDATE_MAKE_CALL:
473                 /* converting nop to call */
474                 return add_update_call(rec, ftrace_addr);
475
476         case FTRACE_UPDATE_MAKE_NOP:
477                 /* converting a call to a nop */
478                 return add_update_nop(rec);
479         }
480
481         return 0;
482 }
483
484 static int finish_update_call(struct dyn_ftrace *rec, unsigned long addr)
485 {
486         unsigned long ip = rec->ip;
487         unsigned const char *new;
488
489         new = ftrace_call_replace(ip, addr);
490
491         return ftrace_write(ip, new, 1);
492 }
493
494 static int finish_update_nop(struct dyn_ftrace *rec)
495 {
496         unsigned long ip = rec->ip;
497         unsigned const char *new;
498
499         new = ftrace_nop_replace();
500
501         return ftrace_write(ip, new, 1);
502 }
503
504 static int finish_update(struct dyn_ftrace *rec, int enable)
505 {
506         unsigned long ftrace_addr;
507         int ret;
508
509         ret = ftrace_update_record(rec, enable);
510
511         ftrace_addr = ftrace_get_addr_new(rec);
512
513         switch (ret) {
514         case FTRACE_UPDATE_IGNORE:
515                 return 0;
516
517         case FTRACE_UPDATE_MODIFY_CALL:
518         case FTRACE_UPDATE_MAKE_CALL:
519                 /* converting nop to call */
520                 return finish_update_call(rec, ftrace_addr);
521
522         case FTRACE_UPDATE_MAKE_NOP:
523                 /* converting a call to a nop */
524                 return finish_update_nop(rec);
525         }
526
527         return 0;
528 }
529
530 static void do_sync_core(void *data)
531 {
532         sync_core();
533 }
534
535 static void run_sync(void)
536 {
537         int enable_irqs = irqs_disabled();
538
539         /* We may be called with interrupts disbled (on bootup). */
540         if (enable_irqs)
541                 local_irq_enable();
542         on_each_cpu(do_sync_core, NULL, 1);
543         if (enable_irqs)
544                 local_irq_disable();
545 }
546
547 void ftrace_replace_code(int enable)
548 {
549         struct ftrace_rec_iter *iter;
550         struct dyn_ftrace *rec;
551         const char *report = "adding breakpoints";
552         int count = 0;
553         int ret;
554
555         for_ftrace_rec_iter(iter) {
556                 rec = ftrace_rec_iter_record(iter);
557
558                 ret = add_breakpoints(rec, enable);
559                 if (ret)
560                         goto remove_breakpoints;
561                 count++;
562         }
563
564         run_sync();
565
566         report = "updating code";
567
568         for_ftrace_rec_iter(iter) {
569                 rec = ftrace_rec_iter_record(iter);
570
571                 ret = add_update(rec, enable);
572                 if (ret)
573                         goto remove_breakpoints;
574         }
575
576         run_sync();
577
578         report = "removing breakpoints";
579
580         for_ftrace_rec_iter(iter) {
581                 rec = ftrace_rec_iter_record(iter);
582
583                 ret = finish_update(rec, enable);
584                 if (ret)
585                         goto remove_breakpoints;
586         }
587
588         run_sync();
589
590         return;
591
592  remove_breakpoints:
593         pr_warn("Failed on %s (%d):\n", report, count);
594         ftrace_bug(ret, rec ? rec->ip : 0);
595         for_ftrace_rec_iter(iter) {
596                 rec = ftrace_rec_iter_record(iter);
597                 /*
598                  * Breakpoints are handled only when this function is in
599                  * progress. The system could not work with them.
600                  */
601                 if (remove_breakpoint(rec))
602                         BUG();
603         }
604         run_sync();
605 }
606
607 static int
608 ftrace_modify_code(unsigned long ip, unsigned const char *old_code,
609                    unsigned const char *new_code)
610 {
611         int ret;
612
613         ret = add_break(ip, old_code);
614         if (ret)
615                 goto out;
616
617         run_sync();
618
619         ret = add_update_code(ip, new_code);
620         if (ret)
621                 goto fail_update;
622
623         run_sync();
624
625         ret = ftrace_write(ip, new_code, 1);
626         /*
627          * The breakpoint is handled only when this function is in progress.
628          * The system could not work if we could not remove it.
629          */
630         BUG_ON(ret);
631  out:
632         run_sync();
633         return ret;
634
635  fail_update:
636         /* Also here the system could not work with the breakpoint */
637         if (ftrace_write(ip, old_code, 1))
638                 BUG();
639         goto out;
640 }
641
642 void arch_ftrace_update_code(int command)
643 {
644         /* See comment above by declaration of modifying_ftrace_code */
645         atomic_inc(&modifying_ftrace_code);
646
647         ftrace_modify_all_code(command);
648
649         atomic_dec(&modifying_ftrace_code);
650 }
651
652 int __init ftrace_dyn_arch_init(void)
653 {
654         return 0;
655 }
656 #endif
657
658 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
659
660 #ifdef CONFIG_DYNAMIC_FTRACE
661 extern void ftrace_graph_call(void);
662
663 static unsigned char *ftrace_jmp_replace(unsigned long ip, unsigned long addr)
664 {
665         static union ftrace_code_union calc;
666
667         /* Jmp not a call (ignore the .e8) */
668         calc.e8         = 0xe9;
669         calc.offset     = ftrace_calc_offset(ip + MCOUNT_INSN_SIZE, addr);
670
671         /*
672          * ftrace external locks synchronize the access to the static variable.
673          */
674         return calc.code;
675 }
676
677 static int ftrace_mod_jmp(unsigned long ip, void *func)
678 {
679         unsigned char *new;
680
681         new = ftrace_jmp_replace(ip, (unsigned long)func);
682
683         return update_ftrace_func(ip, new);
684 }
685
686 int ftrace_enable_ftrace_graph_caller(void)
687 {
688         unsigned long ip = (unsigned long)(&ftrace_graph_call);
689
690         return ftrace_mod_jmp(ip, &ftrace_graph_caller);
691 }
692
693 int ftrace_disable_ftrace_graph_caller(void)
694 {
695         unsigned long ip = (unsigned long)(&ftrace_graph_call);
696
697         return ftrace_mod_jmp(ip, &ftrace_stub);
698 }
699
700 #endif /* !CONFIG_DYNAMIC_FTRACE */
701
702 /*
703  * Hook the return address and push it in the stack of return addrs
704  * in current thread info.
705  */
706 void prepare_ftrace_return(unsigned long *parent, unsigned long self_addr,
707                            unsigned long frame_pointer)
708 {
709         unsigned long old;
710         int faulted;
711         struct ftrace_graph_ent trace;
712         unsigned long return_hooker = (unsigned long)
713                                 &return_to_handler;
714
715         if (unlikely(atomic_read(&current->tracing_graph_pause)))
716                 return;
717
718         /*
719          * Protect against fault, even if it shouldn't
720          * happen. This tool is too much intrusive to
721          * ignore such a protection.
722          */
723         asm volatile(
724                 "1: " _ASM_MOV " (%[parent]), %[old]\n"
725                 "2: " _ASM_MOV " %[return_hooker], (%[parent])\n"
726                 "   movl $0, %[faulted]\n"
727                 "3:\n"
728
729                 ".section .fixup, \"ax\"\n"
730                 "4: movl $1, %[faulted]\n"
731                 "   jmp 3b\n"
732                 ".previous\n"
733
734                 _ASM_EXTABLE(1b, 4b)
735                 _ASM_EXTABLE(2b, 4b)
736
737                 : [old] "=&r" (old), [faulted] "=r" (faulted)
738                 : [parent] "r" (parent), [return_hooker] "r" (return_hooker)
739                 : "memory"
740         );
741
742         if (unlikely(faulted)) {
743                 ftrace_graph_stop();
744                 WARN_ON(1);
745                 return;
746         }
747
748         trace.func = self_addr;
749         trace.depth = current->curr_ret_stack + 1;
750
751         /* Only trace if the calling function expects to */
752         if (!ftrace_graph_entry(&trace)) {
753                 *parent = old;
754                 return;
755         }
756
757         if (ftrace_push_return_trace(old, self_addr, &trace.depth,
758                     frame_pointer) == -EBUSY) {
759                 *parent = old;
760                 return;
761         }
762 }
763 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */