]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - arch/x86/kernel/ftrace.c
x86: use set_memory.h header
[mirror_ubuntu-bionic-kernel.git] / arch / x86 / kernel / ftrace.c
CommitLineData
3d083395 1/*
9d2099ab 2 * Dynamic function tracing support.
3d083395
SR
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
3bb258bf
JP
12#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13
3d083395
SR
14#include <linux/spinlock.h>
15#include <linux/hardirq.h>
6f93fc07 16#include <linux/uaccess.h>
3d083395
SR
17#include <linux/ftrace.h>
18#include <linux/percpu.h>
19b3e967 19#include <linux/sched.h>
f3bea491 20#include <linux/slab.h>
3d083395
SR
21#include <linux/init.h>
22#include <linux/list.h>
84e1c6bb 23#include <linux/module.h>
3d083395 24
47788c58
FW
25#include <trace/syscall.h>
26
d1163651 27#include <asm/set_memory.h>
59a094c9 28#include <asm/kprobes.h>
395a59d0 29#include <asm/ftrace.h>
732f3ca7 30#include <asm/nops.h>
3d083395 31
caf4b323 32#ifdef CONFIG_DYNAMIC_FTRACE
3d083395 33
16239630
SR
34int ftrace_arch_code_modify_prepare(void)
35{
36 set_kernel_text_rw();
84e1c6bb 37 set_all_modules_text_rw();
16239630
SR
38 return 0;
39}
40
41int ftrace_arch_code_modify_post_process(void)
42{
84e1c6bb 43 set_all_modules_text_ro();
16239630
SR
44 set_kernel_text_ro();
45 return 0;
46}
47
3d083395 48union ftrace_code_union {
395a59d0 49 char code[MCOUNT_INSN_SIZE];
3d083395 50 struct {
15d5b02c 51 unsigned char e8;
3d083395
SR
52 int offset;
53 } __attribute__((packed));
54};
55
15adc048 56static int ftrace_calc_offset(long ip, long addr)
3c1720f0
SR
57{
58 return (int)(addr - ip);
59}
3d083395 60
31e88909 61static unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr)
3c1720f0
SR
62{
63 static union ftrace_code_union calc;
3d083395 64
3c1720f0 65 calc.e8 = 0xe8;
395a59d0 66 calc.offset = ftrace_calc_offset(ip + MCOUNT_INSN_SIZE, addr);
3c1720f0
SR
67
68 /*
69 * No locking needed, this must be called via kstop_machine
70 * which in essence is like running on a uniprocessor machine.
71 */
72 return calc.code;
3d083395
SR
73}
74
55ca3cc1
SS
75static inline int
76within(unsigned long addr, unsigned long start, unsigned long end)
77{
78 return addr >= start && addr < end;
79}
80
87fbb2ac 81static unsigned long text_ip_addr(unsigned long ip)
17666f02 82{
55ca3cc1 83 /*
9ccaf77c
KC
84 * On x86_64, kernel text mappings are mapped read-only, so we use
85 * the kernel identity mapping instead of the kernel text mapping
86 * to modify the kernel text.
55ca3cc1
SS
87 *
88 * For 32bit kernels, these mappings are same and we can use
89 * kernel identity mapping to modify code.
90 */
91 if (within(ip, (unsigned long)_text, (unsigned long)_etext))
217f155e 92 ip = (unsigned long)__va(__pa_symbol(ip));
55ca3cc1 93
87fbb2ac 94 return ip;
17666f02
SR
95}
96
dc326fca 97static const unsigned char *ftrace_nop_replace(void)
caf4b323 98{
dc326fca 99 return ideal_nops[NOP_ATOMIC5];
caf4b323
FW
100}
101
31e88909 102static int
8a4d0a68 103ftrace_modify_code_direct(unsigned long ip, unsigned const char *old_code,
0d098a7d 104 unsigned const char *new_code)
3d083395 105{
6f93fc07 106 unsigned char replaced[MCOUNT_INSN_SIZE];
3d083395 107
b05086c7
SRRH
108 ftrace_expected = old_code;
109
3d083395 110 /*
c5d641f9
LB
111 * Note:
112 * We are paranoid about modifying text, as if a bug was to happen, it
113 * could cause us to read or write to someplace that could cause harm.
114 * Carefully read and modify the code with probe_kernel_*(), and make
115 * sure what we read is what we expected it to be before modifying it.
3d083395 116 */
76aefee5
SR
117
118 /* read the text we want to modify */
ab9a0918 119 if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
593eb8a2 120 return -EFAULT;
6f93fc07 121
76aefee5 122 /* Make sure it is what we expect it to be */
6f93fc07 123 if (memcmp(replaced, old_code, MCOUNT_INSN_SIZE) != 0)
593eb8a2 124 return -EINVAL;
3d083395 125
87fbb2ac
SRRH
126 ip = text_ip_addr(ip);
127
76aefee5 128 /* replace the text with the new text */
87fbb2ac 129 if (probe_kernel_write((void *)ip, new_code, MCOUNT_INSN_SIZE))
593eb8a2 130 return -EPERM;
6f93fc07
SR
131
132 sync_core();
3d083395 133
6f93fc07 134 return 0;
3d083395
SR
135}
136
31e88909
SR
137int ftrace_make_nop(struct module *mod,
138 struct dyn_ftrace *rec, unsigned long addr)
139{
0d098a7d 140 unsigned const char *new, *old;
31e88909
SR
141 unsigned long ip = rec->ip;
142
143 old = ftrace_call_replace(ip, addr);
144 new = ftrace_nop_replace();
145
8a4d0a68
SR
146 /*
147 * On boot up, and when modules are loaded, the MCOUNT_ADDR
148 * is converted to a nop, and will never become MCOUNT_ADDR
149 * again. This code is either running before SMP (on boot up)
150 * or before the code will ever be executed (module load).
151 * We do not want to use the breakpoint version in this case,
152 * just modify the code directly.
153 */
154 if (addr == MCOUNT_ADDR)
155 return ftrace_modify_code_direct(rec->ip, old, new);
156
b05086c7
SRRH
157 ftrace_expected = NULL;
158
8a4d0a68
SR
159 /* Normal cases use add_brk_on_nop */
160 WARN_ONCE(1, "invalid use of ftrace_make_nop");
161 return -EINVAL;
31e88909
SR
162}
163
164int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr)
165{
0d098a7d 166 unsigned const char *new, *old;
31e88909
SR
167 unsigned long ip = rec->ip;
168
169 old = ftrace_nop_replace();
170 new = ftrace_call_replace(ip, addr);
171
8a4d0a68
SR
172 /* Should only be called when module is loaded */
173 return ftrace_modify_code_direct(rec->ip, old, new);
d61f82d0
SR
174}
175
a192cd04
SR
176/*
177 * The modifying_ftrace_code is used to tell the breakpoint
178 * handler to call ftrace_int3_handler(). If it fails to
179 * call this handler for a breakpoint added by ftrace, then
180 * the kernel may crash.
181 *
182 * As atomic_writes on x86 do not need a barrier, we do not
183 * need to add smp_mb()s for this to work. It is also considered
184 * that we can not read the modifying_ftrace_code before
185 * executing the breakpoint. That would be quite remarkable if
186 * it could do that. Here's the flow that is required:
187 *
188 * CPU-0 CPU-1
189 *
190 * atomic_inc(mfc);
191 * write int3s
192 * <trap-int3> // implicit (r)mb
193 * if (atomic_read(mfc))
194 * call ftrace_int3_handler()
195 *
196 * Then when we are finished:
197 *
198 * atomic_dec(mfc);
199 *
200 * If we hit a breakpoint that was not set by ftrace, it does not
201 * matter if ftrace_int3_handler() is called or not. It will
202 * simply be ignored. But it is crucial that a ftrace nop/caller
203 * breakpoint is handled. No other user should ever place a
204 * breakpoint on an ftrace nop/caller location. It must only
205 * be done by this code.
206 */
207atomic_t modifying_ftrace_code __read_mostly;
08d636b6 208
8a4d0a68
SR
209static int
210ftrace_modify_code(unsigned long ip, unsigned const char *old_code,
211 unsigned const char *new_code);
212
08f6fba5
SR
213/*
214 * Should never be called:
215 * As it is only called by __ftrace_replace_code() which is called by
216 * ftrace_replace_code() that x86 overrides, and by ftrace_update_code()
217 * which is called to turn mcount into nops or nops into function calls
218 * but not to convert a function from not using regs to one that uses
219 * regs, which ftrace_modify_call() is for.
220 */
221int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
222 unsigned long addr)
223{
224 WARN_ON(1);
b05086c7 225 ftrace_expected = NULL;
08f6fba5
SR
226 return -EINVAL;
227}
08f6fba5 228
87fbb2ac
SRRH
229static unsigned long ftrace_update_func;
230
231static int update_ftrace_func(unsigned long ip, void *new)
8a4d0a68 232{
87fbb2ac 233 unsigned char old[MCOUNT_INSN_SIZE];
8a4d0a68
SR
234 int ret;
235
87fbb2ac
SRRH
236 memcpy(old, (void *)ip, MCOUNT_INSN_SIZE);
237
238 ftrace_update_func = ip;
239 /* Make sure the breakpoints see the ftrace_update_func update */
240 smp_wmb();
8a4d0a68
SR
241
242 /* See comment above by declaration of modifying_ftrace_code */
243 atomic_inc(&modifying_ftrace_code);
244
245 ret = ftrace_modify_code(ip, old, new);
246
87fbb2ac
SRRH
247 atomic_dec(&modifying_ftrace_code);
248
249 return ret;
250}
251
252int ftrace_update_ftrace_func(ftrace_func_t func)
253{
254 unsigned long ip = (unsigned long)(&ftrace_call);
255 unsigned char *new;
256 int ret;
257
258 new = ftrace_call_replace(ip, (unsigned long)func);
259 ret = update_ftrace_func(ip, new);
260
08f6fba5
SR
261 /* Also update the regs callback function */
262 if (!ret) {
263 ip = (unsigned long)(&ftrace_regs_call);
08f6fba5 264 new = ftrace_call_replace(ip, (unsigned long)func);
87fbb2ac 265 ret = update_ftrace_func(ip, new);
08f6fba5 266 }
08f6fba5 267
8a4d0a68
SR
268 return ret;
269}
270
ab4ead02
KH
271static int is_ftrace_caller(unsigned long ip)
272{
87fbb2ac 273 if (ip == ftrace_update_func)
ab4ead02
KH
274 return 1;
275
276 return 0;
277}
278
08d636b6
SR
279/*
280 * A breakpoint was added to the code address we are about to
281 * modify, and this is the handle that will just skip over it.
282 * We are either changing a nop into a trace call, or a trace
283 * call to a nop. While the change is taking place, we treat
284 * it just like it was a nop.
285 */
286int ftrace_int3_handler(struct pt_regs *regs)
287{
ab4ead02
KH
288 unsigned long ip;
289
08d636b6
SR
290 if (WARN_ON_ONCE(!regs))
291 return 0;
292
ab4ead02
KH
293 ip = regs->ip - 1;
294 if (!ftrace_location(ip) && !is_ftrace_caller(ip))
08d636b6
SR
295 return 0;
296
297 regs->ip += MCOUNT_INSN_SIZE - 1;
298
299 return 1;
300}
301
302static int ftrace_write(unsigned long ip, const char *val, int size)
303{
964f7b6b 304 ip = text_ip_addr(ip);
08d636b6 305
92550405
SRRH
306 if (probe_kernel_write((void *)ip, val, size))
307 return -EPERM;
308
309 return 0;
08d636b6
SR
310}
311
312static int add_break(unsigned long ip, const char *old)
313{
314 unsigned char replaced[MCOUNT_INSN_SIZE];
315 unsigned char brk = BREAKPOINT_INSTRUCTION;
316
317 if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
318 return -EFAULT;
319
b05086c7
SRRH
320 ftrace_expected = old;
321
08d636b6
SR
322 /* Make sure it is what we expect it to be */
323 if (memcmp(replaced, old, MCOUNT_INSN_SIZE) != 0)
324 return -EINVAL;
325
92550405 326 return ftrace_write(ip, &brk, 1);
08d636b6
SR
327}
328
329static int add_brk_on_call(struct dyn_ftrace *rec, unsigned long addr)
330{
331 unsigned const char *old;
332 unsigned long ip = rec->ip;
333
334 old = ftrace_call_replace(ip, addr);
335
336 return add_break(rec->ip, old);
337}
338
339
340static int add_brk_on_nop(struct dyn_ftrace *rec)
341{
342 unsigned const char *old;
343
344 old = ftrace_nop_replace();
345
346 return add_break(rec->ip, old);
347}
348
349static int add_breakpoints(struct dyn_ftrace *rec, int enable)
350{
351 unsigned long ftrace_addr;
352 int ret;
353
7413af1f 354 ftrace_addr = ftrace_get_addr_curr(rec);
08d636b6 355
94792ea0 356 ret = ftrace_test_record(rec, enable);
08d636b6
SR
357
358 switch (ret) {
359 case FTRACE_UPDATE_IGNORE:
360 return 0;
361
362 case FTRACE_UPDATE_MAKE_CALL:
363 /* converting nop to call */
364 return add_brk_on_nop(rec);
365
08f6fba5 366 case FTRACE_UPDATE_MODIFY_CALL:
08d636b6
SR
367 case FTRACE_UPDATE_MAKE_NOP:
368 /* converting a call to a nop */
369 return add_brk_on_call(rec, ftrace_addr);
370 }
371 return 0;
372}
373
374/*
375 * On error, we need to remove breakpoints. This needs to
376 * be done caefully. If the address does not currently have a
377 * breakpoint, we know we are done. Otherwise, we look at the
378 * remaining 4 bytes of the instruction. If it matches a nop
379 * we replace the breakpoint with the nop. Otherwise we replace
380 * it with the call instruction.
381 */
382static int remove_breakpoint(struct dyn_ftrace *rec)
383{
384 unsigned char ins[MCOUNT_INSN_SIZE];
385 unsigned char brk = BREAKPOINT_INSTRUCTION;
386 const unsigned char *nop;
387 unsigned long ftrace_addr;
388 unsigned long ip = rec->ip;
389
390 /* If we fail the read, just give up */
391 if (probe_kernel_read(ins, (void *)ip, MCOUNT_INSN_SIZE))
392 return -EFAULT;
393
394 /* If this does not have a breakpoint, we are done */
395 if (ins[0] != brk)
7f11f5ec 396 return 0;
08d636b6
SR
397
398 nop = ftrace_nop_replace();
399
400 /*
401 * If the last 4 bytes of the instruction do not match
402 * a nop, then we assume that this is a call to ftrace_addr.
403 */
404 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) != 0) {
405 /*
406 * For extra paranoidism, we check if the breakpoint is on
407 * a call that would actually jump to the ftrace_addr.
408 * If not, don't touch the breakpoint, we make just create
409 * a disaster.
410 */
7413af1f 411 ftrace_addr = ftrace_get_addr_new(rec);
08f6fba5
SR
412 nop = ftrace_call_replace(ip, ftrace_addr);
413
414 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) == 0)
415 goto update;
416
417 /* Check both ftrace_addr and ftrace_old_addr */
7413af1f 418 ftrace_addr = ftrace_get_addr_curr(rec);
08d636b6
SR
419 nop = ftrace_call_replace(ip, ftrace_addr);
420
b05086c7
SRRH
421 ftrace_expected = nop;
422
08d636b6
SR
423 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) != 0)
424 return -EINVAL;
425 }
426
08f6fba5 427 update:
c932c6b7 428 return ftrace_write(ip, nop, 1);
08d636b6
SR
429}
430
431static int add_update_code(unsigned long ip, unsigned const char *new)
432{
433 /* skip breakpoint */
434 ip++;
435 new++;
92550405 436 return ftrace_write(ip, new, MCOUNT_INSN_SIZE - 1);
08d636b6
SR
437}
438
439static int add_update_call(struct dyn_ftrace *rec, unsigned long addr)
440{
441 unsigned long ip = rec->ip;
442 unsigned const char *new;
443
444 new = ftrace_call_replace(ip, addr);
445 return add_update_code(ip, new);
446}
447
448static int add_update_nop(struct dyn_ftrace *rec)
449{
450 unsigned long ip = rec->ip;
451 unsigned const char *new;
452
453 new = ftrace_nop_replace();
454 return add_update_code(ip, new);
455}
456
457static int add_update(struct dyn_ftrace *rec, int enable)
458{
459 unsigned long ftrace_addr;
460 int ret;
461
462 ret = ftrace_test_record(rec, enable);
463
7413af1f 464 ftrace_addr = ftrace_get_addr_new(rec);
08d636b6
SR
465
466 switch (ret) {
467 case FTRACE_UPDATE_IGNORE:
468 return 0;
469
08f6fba5 470 case FTRACE_UPDATE_MODIFY_CALL:
08d636b6
SR
471 case FTRACE_UPDATE_MAKE_CALL:
472 /* converting nop to call */
473 return add_update_call(rec, ftrace_addr);
474
475 case FTRACE_UPDATE_MAKE_NOP:
476 /* converting a call to a nop */
477 return add_update_nop(rec);
478 }
479
480 return 0;
481}
482
483static int finish_update_call(struct dyn_ftrace *rec, unsigned long addr)
484{
485 unsigned long ip = rec->ip;
486 unsigned const char *new;
487
488 new = ftrace_call_replace(ip, addr);
489
92550405 490 return ftrace_write(ip, new, 1);
08d636b6
SR
491}
492
493static int finish_update_nop(struct dyn_ftrace *rec)
494{
495 unsigned long ip = rec->ip;
496 unsigned const char *new;
497
498 new = ftrace_nop_replace();
499
92550405 500 return ftrace_write(ip, new, 1);
08d636b6
SR
501}
502
503static int finish_update(struct dyn_ftrace *rec, int enable)
504{
505 unsigned long ftrace_addr;
506 int ret;
507
508 ret = ftrace_update_record(rec, enable);
509
7413af1f 510 ftrace_addr = ftrace_get_addr_new(rec);
08d636b6
SR
511
512 switch (ret) {
513 case FTRACE_UPDATE_IGNORE:
514 return 0;
515
08f6fba5 516 case FTRACE_UPDATE_MODIFY_CALL:
08d636b6
SR
517 case FTRACE_UPDATE_MAKE_CALL:
518 /* converting nop to call */
519 return finish_update_call(rec, ftrace_addr);
520
521 case FTRACE_UPDATE_MAKE_NOP:
522 /* converting a call to a nop */
523 return finish_update_nop(rec);
524 }
525
526 return 0;
527}
528
529static void do_sync_core(void *data)
530{
531 sync_core();
532}
533
534static void run_sync(void)
535{
2b87965a
SRV
536 int enable_irqs;
537
538 /* No need to sync if there's only one CPU */
539 if (num_online_cpus() == 1)
540 return;
541
542 enable_irqs = irqs_disabled();
08d636b6 543
8a1115ff 544 /* We may be called with interrupts disabled (on bootup). */
08d636b6
SR
545 if (enable_irqs)
546 local_irq_enable();
547 on_each_cpu(do_sync_core, NULL, 1);
548 if (enable_irqs)
549 local_irq_disable();
550}
551
e4f5d544 552void ftrace_replace_code(int enable)
08d636b6
SR
553{
554 struct ftrace_rec_iter *iter;
555 struct dyn_ftrace *rec;
556 const char *report = "adding breakpoints";
557 int count = 0;
558 int ret;
559
560 for_ftrace_rec_iter(iter) {
561 rec = ftrace_rec_iter_record(iter);
562
563 ret = add_breakpoints(rec, enable);
564 if (ret)
565 goto remove_breakpoints;
566 count++;
567 }
568
569 run_sync();
570
571 report = "updating code";
883a1e86 572 count = 0;
08d636b6
SR
573
574 for_ftrace_rec_iter(iter) {
575 rec = ftrace_rec_iter_record(iter);
576
577 ret = add_update(rec, enable);
578 if (ret)
579 goto remove_breakpoints;
883a1e86 580 count++;
08d636b6
SR
581 }
582
583 run_sync();
584
585 report = "removing breakpoints";
883a1e86 586 count = 0;
08d636b6
SR
587
588 for_ftrace_rec_iter(iter) {
589 rec = ftrace_rec_iter_record(iter);
590
591 ret = finish_update(rec, enable);
592 if (ret)
593 goto remove_breakpoints;
883a1e86 594 count++;
08d636b6
SR
595 }
596
597 run_sync();
598
599 return;
600
601 remove_breakpoints:
74bb8c45 602 pr_warn("Failed on %s (%d):\n", report, count);
4fd3279b 603 ftrace_bug(ret, rec);
08d636b6
SR
604 for_ftrace_rec_iter(iter) {
605 rec = ftrace_rec_iter_record(iter);
7f11f5ec
PM
606 /*
607 * Breakpoints are handled only when this function is in
608 * progress. The system could not work with them.
609 */
610 if (remove_breakpoint(rec))
611 BUG();
08d636b6 612 }
c932c6b7 613 run_sync();
08d636b6
SR
614}
615
8a4d0a68
SR
616static int
617ftrace_modify_code(unsigned long ip, unsigned const char *old_code,
618 unsigned const char *new_code)
619{
620 int ret;
621
622 ret = add_break(ip, old_code);
623 if (ret)
624 goto out;
625
626 run_sync();
627
628 ret = add_update_code(ip, new_code);
629 if (ret)
630 goto fail_update;
631
632 run_sync();
633
634 ret = ftrace_write(ip, new_code, 1);
7f11f5ec
PM
635 /*
636 * The breakpoint is handled only when this function is in progress.
637 * The system could not work if we could not remove it.
638 */
639 BUG_ON(ret);
8a4d0a68 640 out:
12729f14 641 run_sync();
8a4d0a68
SR
642 return ret;
643
644 fail_update:
7f11f5ec
PM
645 /* Also here the system could not work with the breakpoint */
646 if (ftrace_write(ip, old_code, 1))
647 BUG();
8a4d0a68
SR
648 goto out;
649}
650
08d636b6
SR
651void arch_ftrace_update_code(int command)
652{
a192cd04
SR
653 /* See comment above by declaration of modifying_ftrace_code */
654 atomic_inc(&modifying_ftrace_code);
08d636b6 655
e4f5d544 656 ftrace_modify_all_code(command);
08d636b6 657
a192cd04 658 atomic_dec(&modifying_ftrace_code);
08d636b6
SR
659}
660
3a36cb11 661int __init ftrace_dyn_arch_init(void)
3d083395 662{
3d083395
SR
663 return 0;
664}
5a45cfe1 665
f3bea491 666#if defined(CONFIG_X86_64) || defined(CONFIG_FUNCTION_GRAPH_TRACER)
87fbb2ac 667static unsigned char *ftrace_jmp_replace(unsigned long ip, unsigned long addr)
5a45cfe1 668{
87fbb2ac 669 static union ftrace_code_union calc;
5a45cfe1 670
87fbb2ac
SRRH
671 /* Jmp not a call (ignore the .e8) */
672 calc.e8 = 0xe9;
673 calc.offset = ftrace_calc_offset(ip + MCOUNT_INSN_SIZE, addr);
5a45cfe1 674
87fbb2ac
SRRH
675 /*
676 * ftrace external locks synchronize the access to the static variable.
677 */
678 return calc.code;
679}
f3bea491
SRRH
680#endif
681
682/* Currently only x86_64 supports dynamic trampolines */
683#ifdef CONFIG_X86_64
684
685#ifdef CONFIG_MODULES
686#include <linux/moduleloader.h>
687/* Module allocation simplifies allocating memory for code */
688static inline void *alloc_tramp(unsigned long size)
689{
690 return module_alloc(size);
691}
692static inline void tramp_free(void *tramp)
693{
be1f221c 694 module_memfree(tramp);
f3bea491
SRRH
695}
696#else
697/* Trampolines can only be created if modules are supported */
698static inline void *alloc_tramp(unsigned long size)
699{
700 return NULL;
701}
702static inline void tramp_free(void *tramp) { }
703#endif
704
705/* Defined as markers to the end of the ftrace default trampolines */
f3bea491 706extern void ftrace_regs_caller_end(void);
f1b92bb6 707extern void ftrace_epilogue(void);
f3bea491
SRRH
708extern void ftrace_caller_op_ptr(void);
709extern void ftrace_regs_caller_op_ptr(void);
710
711/* movq function_trace_op(%rip), %rdx */
712/* 0x48 0x8b 0x15 <offset-to-ftrace_trace_op (4 bytes)> */
713#define OP_REF_SIZE 7
714
715/*
716 * The ftrace_ops is passed to the function callback. Since the
717 * trampoline only services a single ftrace_ops, we can pass in
718 * that ops directly.
719 *
720 * The ftrace_op_code_union is used to create a pointer to the
721 * ftrace_ops that will be passed to the callback function.
722 */
723union ftrace_op_code_union {
724 char code[OP_REF_SIZE];
725 struct {
726 char op[3];
727 int offset;
728 } __attribute__((packed));
729};
730
aec0be2d
SRRH
731static unsigned long
732create_trampoline(struct ftrace_ops *ops, unsigned int *tramp_size)
f3bea491
SRRH
733{
734 unsigned const char *jmp;
735 unsigned long start_offset;
736 unsigned long end_offset;
737 unsigned long op_offset;
738 unsigned long offset;
739 unsigned long size;
740 unsigned long ip;
741 unsigned long *ptr;
742 void *trampoline;
743 /* 48 8b 15 <offset> is movq <offset>(%rip), %rdx */
744 unsigned const char op_ref[] = { 0x48, 0x8b, 0x15 };
745 union ftrace_op_code_union op_ptr;
746 int ret;
747
748 if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
749 start_offset = (unsigned long)ftrace_regs_caller;
750 end_offset = (unsigned long)ftrace_regs_caller_end;
751 op_offset = (unsigned long)ftrace_regs_caller_op_ptr;
752 } else {
753 start_offset = (unsigned long)ftrace_caller;
f1b92bb6 754 end_offset = (unsigned long)ftrace_epilogue;
f3bea491
SRRH
755 op_offset = (unsigned long)ftrace_caller_op_ptr;
756 }
757
758 size = end_offset - start_offset;
759
760 /*
761 * Allocate enough size to store the ftrace_caller code,
f1b92bb6 762 * the jmp to ftrace_epilogue, as well as the address of
f3bea491
SRRH
763 * the ftrace_ops this trampoline is used for.
764 */
765 trampoline = alloc_tramp(size + MCOUNT_INSN_SIZE + sizeof(void *));
766 if (!trampoline)
767 return 0;
768
aec0be2d
SRRH
769 *tramp_size = size + MCOUNT_INSN_SIZE + sizeof(void *);
770
f3bea491
SRRH
771 /* Copy ftrace_caller onto the trampoline memory */
772 ret = probe_kernel_read(trampoline, (void *)start_offset, size);
773 if (WARN_ON(ret < 0)) {
774 tramp_free(trampoline);
775 return 0;
776 }
777
778 ip = (unsigned long)trampoline + size;
779
f1b92bb6
BP
780 /* The trampoline ends with a jmp to ftrace_epilogue */
781 jmp = ftrace_jmp_replace(ip, (unsigned long)ftrace_epilogue);
f3bea491
SRRH
782 memcpy(trampoline + size, jmp, MCOUNT_INSN_SIZE);
783
784 /*
785 * The address of the ftrace_ops that is used for this trampoline
786 * is stored at the end of the trampoline. This will be used to
787 * load the third parameter for the callback. Basically, that
788 * location at the end of the trampoline takes the place of
789 * the global function_trace_op variable.
790 */
791
792 ptr = (unsigned long *)(trampoline + size + MCOUNT_INSN_SIZE);
793 *ptr = (unsigned long)ops;
794
795 op_offset -= start_offset;
796 memcpy(&op_ptr, trampoline + op_offset, OP_REF_SIZE);
797
798 /* Are we pointing to the reference? */
799 if (WARN_ON(memcmp(op_ptr.op, op_ref, 3) != 0)) {
800 tramp_free(trampoline);
801 return 0;
802 }
803
804 /* Load the contents of ptr into the callback parameter */
805 offset = (unsigned long)ptr;
806 offset -= (unsigned long)trampoline + op_offset + OP_REF_SIZE;
807
808 op_ptr.offset = offset;
809
810 /* put in the new offset to the ftrace_ops */
811 memcpy(trampoline + op_offset, &op_ptr, OP_REF_SIZE);
812
813 /* ALLOC_TRAMP flags lets us know we created it */
814 ops->flags |= FTRACE_OPS_FL_ALLOC_TRAMP;
815
816 return (unsigned long)trampoline;
817}
818
15d5b02c
SRRH
819static unsigned long calc_trampoline_call_offset(bool save_regs)
820{
821 unsigned long start_offset;
822 unsigned long call_offset;
823
824 if (save_regs) {
825 start_offset = (unsigned long)ftrace_regs_caller;
826 call_offset = (unsigned long)ftrace_regs_call;
827 } else {
828 start_offset = (unsigned long)ftrace_caller;
829 call_offset = (unsigned long)ftrace_call;
830 }
831
832 return call_offset - start_offset;
833}
834
f3bea491
SRRH
835void arch_ftrace_update_trampoline(struct ftrace_ops *ops)
836{
837 ftrace_func_t func;
838 unsigned char *new;
f3bea491
SRRH
839 unsigned long offset;
840 unsigned long ip;
aec0be2d 841 unsigned int size;
f3bea491
SRRH
842 int ret;
843
844 if (ops->trampoline) {
845 /*
846 * The ftrace_ops caller may set up its own trampoline.
847 * In such a case, this code must not modify it.
848 */
849 if (!(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
850 return;
851 } else {
aec0be2d 852 ops->trampoline = create_trampoline(ops, &size);
f3bea491
SRRH
853 if (!ops->trampoline)
854 return;
aec0be2d 855 ops->trampoline_size = size;
f3bea491
SRRH
856 }
857
15d5b02c 858 offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
f3bea491
SRRH
859 ip = ops->trampoline + offset;
860
861 func = ftrace_ops_get_func(ops);
862
863 /* Do a safe modify in case the trampoline is executing */
864 new = ftrace_call_replace(ip, (unsigned long)func);
865 ret = update_ftrace_func(ip, new);
866
867 /* The update should never fail */
868 WARN_ON(ret);
869}
15d5b02c
SRRH
870
871/* Return the address of the function the trampoline calls */
872static void *addr_from_call(void *ptr)
873{
874 union ftrace_code_union calc;
875 int ret;
876
877 ret = probe_kernel_read(&calc, ptr, MCOUNT_INSN_SIZE);
878 if (WARN_ON_ONCE(ret < 0))
879 return NULL;
880
881 /* Make sure this is a call */
882 if (WARN_ON_ONCE(calc.e8 != 0xe8)) {
883 pr_warn("Expected e8, got %x\n", calc.e8);
884 return NULL;
885 }
886
887 return ptr + MCOUNT_INSN_SIZE + calc.offset;
888}
889
6a06bdbf 890void prepare_ftrace_return(unsigned long self_addr, unsigned long *parent,
15d5b02c
SRRH
891 unsigned long frame_pointer);
892
893/*
894 * If the ops->trampoline was not allocated, then it probably
895 * has a static trampoline func, or is the ftrace caller itself.
896 */
897static void *static_tramp_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
898{
899 unsigned long offset;
900 bool save_regs = rec->flags & FTRACE_FL_REGS_EN;
901 void *ptr;
902
903 if (ops && ops->trampoline) {
904#ifdef CONFIG_FUNCTION_GRAPH_TRACER
905 /*
906 * We only know about function graph tracer setting as static
907 * trampoline.
908 */
909 if (ops->trampoline == FTRACE_GRAPH_ADDR)
910 return (void *)prepare_ftrace_return;
911#endif
912 return NULL;
913 }
914
915 offset = calc_trampoline_call_offset(save_regs);
916
917 if (save_regs)
918 ptr = (void *)FTRACE_REGS_ADDR + offset;
919 else
920 ptr = (void *)FTRACE_ADDR + offset;
921
922 return addr_from_call(ptr);
923}
924
925void *arch_ftrace_trampoline_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
926{
927 unsigned long offset;
928
929 /* If we didn't allocate this trampoline, consider it static */
930 if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
931 return static_tramp_func(ops, rec);
932
933 offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
934 return addr_from_call((void *)ops->trampoline + offset);
935}
936
12cce594
SRRH
937void arch_ftrace_trampoline_free(struct ftrace_ops *ops)
938{
939 if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
940 return;
941
942 tramp_free((void *)ops->trampoline);
943 ops->trampoline = 0;
944}
15d5b02c 945
f3bea491
SRRH
946#endif /* CONFIG_X86_64 */
947#endif /* CONFIG_DYNAMIC_FTRACE */
948
949#ifdef CONFIG_FUNCTION_GRAPH_TRACER
950
951#ifdef CONFIG_DYNAMIC_FTRACE
952extern void ftrace_graph_call(void);
5a45cfe1 953
87fbb2ac
SRRH
954static int ftrace_mod_jmp(unsigned long ip, void *func)
955{
956 unsigned char *new;
5a45cfe1 957
87fbb2ac 958 new = ftrace_jmp_replace(ip, (unsigned long)func);
5a45cfe1 959
87fbb2ac 960 return update_ftrace_func(ip, new);
5a45cfe1
SR
961}
962
963int ftrace_enable_ftrace_graph_caller(void)
964{
965 unsigned long ip = (unsigned long)(&ftrace_graph_call);
5a45cfe1 966
87fbb2ac 967 return ftrace_mod_jmp(ip, &ftrace_graph_caller);
5a45cfe1
SR
968}
969
970int ftrace_disable_ftrace_graph_caller(void)
971{
972 unsigned long ip = (unsigned long)(&ftrace_graph_call);
5a45cfe1 973
87fbb2ac 974 return ftrace_mod_jmp(ip, &ftrace_stub);
5a45cfe1
SR
975}
976
e7d3737e
FW
977#endif /* !CONFIG_DYNAMIC_FTRACE */
978
e7d3737e
FW
979/*
980 * Hook the return address and push it in the stack of return addrs
981 * in current thread info.
982 */
6a06bdbf 983void prepare_ftrace_return(unsigned long self_addr, unsigned long *parent,
71e308a2 984 unsigned long frame_pointer)
e7d3737e
FW
985{
986 unsigned long old;
e7d3737e 987 int faulted;
287b6e68 988 struct ftrace_graph_ent trace;
e7d3737e
FW
989 unsigned long return_hooker = (unsigned long)
990 &return_to_handler;
991
34a477e5
JP
992 /*
993 * When resuming from suspend-to-ram, this function can be indirectly
994 * called from early CPU startup code while the CPU is in real mode,
995 * which would fail miserably. Make sure the stack pointer is a
996 * virtual address.
997 *
998 * This check isn't as accurate as virt_addr_valid(), but it should be
999 * good enough for this purpose, and it's fast.
1000 */
1001 if (unlikely((long)__builtin_frame_address(0) >= 0))
1002 return;
1003
84b2bc7f
SRRH
1004 if (unlikely(ftrace_graph_is_dead()))
1005 return;
1006
380c4b14 1007 if (unlikely(atomic_read(&current->tracing_graph_pause)))
e7d3737e
FW
1008 return;
1009
1010 /*
1011 * Protect against fault, even if it shouldn't
1012 * happen. This tool is too much intrusive to
1013 * ignore such a protection.
1014 */
1015 asm volatile(
96665788
SR
1016 "1: " _ASM_MOV " (%[parent]), %[old]\n"
1017 "2: " _ASM_MOV " %[return_hooker], (%[parent])\n"
e7d3737e 1018 " movl $0, %[faulted]\n"
e3944bfa 1019 "3:\n"
e7d3737e
FW
1020
1021 ".section .fixup, \"ax\"\n"
e3944bfa
SR
1022 "4: movl $1, %[faulted]\n"
1023 " jmp 3b\n"
e7d3737e
FW
1024 ".previous\n"
1025
e3944bfa
SR
1026 _ASM_EXTABLE(1b, 4b)
1027 _ASM_EXTABLE(2b, 4b)
e7d3737e 1028
aa512a27 1029 : [old] "=&r" (old), [faulted] "=r" (faulted)
96665788 1030 : [parent] "r" (parent), [return_hooker] "r" (return_hooker)
e7d3737e
FW
1031 : "memory"
1032 );
1033
14a866c5
SR
1034 if (unlikely(faulted)) {
1035 ftrace_graph_stop();
1036 WARN_ON(1);
e7d3737e
FW
1037 return;
1038 }
1039
287b6e68 1040 trace.func = self_addr;
722b3c74 1041 trace.depth = current->curr_ret_stack + 1;
287b6e68 1042
e49dc19c
SR
1043 /* Only trace if the calling function expects to */
1044 if (!ftrace_graph_entry(&trace)) {
e49dc19c 1045 *parent = old;
722b3c74
SR
1046 return;
1047 }
1048
1049 if (ftrace_push_return_trace(old, self_addr, &trace.depth,
471bd10f 1050 frame_pointer, parent) == -EBUSY) {
722b3c74
SR
1051 *parent = old;
1052 return;
e49dc19c 1053 }
e7d3737e 1054}
fb52607a 1055#endif /* CONFIG_FUNCTION_GRAPH_TRACER */