Mention branches and keyring.
[releases.git] / x86 / kernel / ftrace.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Dynamic function tracing support.
4  *
5  * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
6  *
7  * Thanks goes to Ingo Molnar, for suggesting the idea.
8  * Mathieu Desnoyers, for suggesting postponing the modifications.
9  * Arjan van de Ven, for keeping me straight, and explaining to me
10  * the dangers of modifying code on the run.
11  */
12
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14
15 #include <linux/spinlock.h>
16 #include <linux/hardirq.h>
17 #include <linux/uaccess.h>
18 #include <linux/ftrace.h>
19 #include <linux/percpu.h>
20 #include <linux/sched.h>
21 #include <linux/slab.h>
22 #include <linux/init.h>
23 #include <linux/list.h>
24 #include <linux/module.h>
25 #include <linux/memory.h>
26 #include <linux/vmalloc.h>
27
28 #include <trace/syscall.h>
29
30 #include <asm/set_memory.h>
31 #include <asm/kprobes.h>
32 #include <asm/ftrace.h>
33 #include <asm/nops.h>
34 #include <asm/text-patching.h>
35
36 #ifdef CONFIG_DYNAMIC_FTRACE
37
38 static int ftrace_poke_late = 0;
39
40 void ftrace_arch_code_modify_prepare(void)
41     __acquires(&text_mutex)
42 {
43         /*
44          * Need to grab text_mutex to prevent a race from module loading
45          * and live kernel patching from changing the text permissions while
46          * ftrace has it set to "read/write".
47          */
48         mutex_lock(&text_mutex);
49         ftrace_poke_late = 1;
50 }
51
52 void ftrace_arch_code_modify_post_process(void)
53     __releases(&text_mutex)
54 {
55         /*
56          * ftrace_make_{call,nop}() may be called during
57          * module load, and we need to finish the text_poke_queue()
58          * that they do, here.
59          */
60         text_poke_finish();
61         ftrace_poke_late = 0;
62         mutex_unlock(&text_mutex);
63 }
64
65 static const char *ftrace_nop_replace(void)
66 {
67         return x86_nops[5];
68 }
69
70 static const char *ftrace_call_replace(unsigned long ip, unsigned long addr)
71 {
72         return text_gen_insn(CALL_INSN_OPCODE, (void *)ip, (void *)addr);
73 }
74
75 static int ftrace_verify_code(unsigned long ip, const char *old_code)
76 {
77         char cur_code[MCOUNT_INSN_SIZE];
78
79         /*
80          * Note:
81          * We are paranoid about modifying text, as if a bug was to happen, it
82          * could cause us to read or write to someplace that could cause harm.
83          * Carefully read and modify the code with probe_kernel_*(), and make
84          * sure what we read is what we expected it to be before modifying it.
85          */
86         /* read the text we want to modify */
87         if (copy_from_kernel_nofault(cur_code, (void *)ip, MCOUNT_INSN_SIZE)) {
88                 WARN_ON(1);
89                 return -EFAULT;
90         }
91
92         /* Make sure it is what we expect it to be */
93         if (memcmp(cur_code, old_code, MCOUNT_INSN_SIZE) != 0) {
94                 ftrace_expected = old_code;
95                 WARN_ON(1);
96                 return -EINVAL;
97         }
98
99         return 0;
100 }
101
102 /*
103  * Marked __ref because it calls text_poke_early() which is .init.text. That is
104  * ok because that call will happen early, during boot, when .init sections are
105  * still present.
106  */
107 static int __ref
108 ftrace_modify_code_direct(unsigned long ip, const char *old_code,
109                           const char *new_code)
110 {
111         int ret = ftrace_verify_code(ip, old_code);
112         if (ret)
113                 return ret;
114
115         /* replace the text with the new text */
116         if (ftrace_poke_late)
117                 text_poke_queue((void *)ip, new_code, MCOUNT_INSN_SIZE, NULL);
118         else
119                 text_poke_early((void *)ip, new_code, MCOUNT_INSN_SIZE);
120         return 0;
121 }
122
123 int ftrace_make_nop(struct module *mod, struct dyn_ftrace *rec, unsigned long addr)
124 {
125         unsigned long ip = rec->ip;
126         const char *new, *old;
127
128         old = ftrace_call_replace(ip, addr);
129         new = ftrace_nop_replace();
130
131         /*
132          * On boot up, and when modules are loaded, the MCOUNT_ADDR
133          * is converted to a nop, and will never become MCOUNT_ADDR
134          * again. This code is either running before SMP (on boot up)
135          * or before the code will ever be executed (module load).
136          * We do not want to use the breakpoint version in this case,
137          * just modify the code directly.
138          */
139         if (addr == MCOUNT_ADDR)
140                 return ftrace_modify_code_direct(ip, old, new);
141
142         /*
143          * x86 overrides ftrace_replace_code -- this function will never be used
144          * in this case.
145          */
146         WARN_ONCE(1, "invalid use of ftrace_make_nop");
147         return -EINVAL;
148 }
149
150 int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr)
151 {
152         unsigned long ip = rec->ip;
153         const char *new, *old;
154
155         old = ftrace_nop_replace();
156         new = ftrace_call_replace(ip, addr);
157
158         /* Should only be called when module is loaded */
159         return ftrace_modify_code_direct(rec->ip, old, new);
160 }
161
162 /*
163  * Should never be called:
164  *  As it is only called by __ftrace_replace_code() which is called by
165  *  ftrace_replace_code() that x86 overrides, and by ftrace_update_code()
166  *  which is called to turn mcount into nops or nops into function calls
167  *  but not to convert a function from not using regs to one that uses
168  *  regs, which ftrace_modify_call() is for.
169  */
170 int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
171                                  unsigned long addr)
172 {
173         WARN_ON(1);
174         return -EINVAL;
175 }
176
177 int ftrace_update_ftrace_func(ftrace_func_t func)
178 {
179         unsigned long ip;
180         const char *new;
181
182         ip = (unsigned long)(&ftrace_call);
183         new = ftrace_call_replace(ip, (unsigned long)func);
184         text_poke_bp((void *)ip, new, MCOUNT_INSN_SIZE, NULL);
185
186         ip = (unsigned long)(&ftrace_regs_call);
187         new = ftrace_call_replace(ip, (unsigned long)func);
188         text_poke_bp((void *)ip, new, MCOUNT_INSN_SIZE, NULL);
189
190         return 0;
191 }
192
193 void ftrace_replace_code(int enable)
194 {
195         struct ftrace_rec_iter *iter;
196         struct dyn_ftrace *rec;
197         const char *new, *old;
198         int ret;
199
200         for_ftrace_rec_iter(iter) {
201                 rec = ftrace_rec_iter_record(iter);
202
203                 switch (ftrace_test_record(rec, enable)) {
204                 case FTRACE_UPDATE_IGNORE:
205                 default:
206                         continue;
207
208                 case FTRACE_UPDATE_MAKE_CALL:
209                         old = ftrace_nop_replace();
210                         break;
211
212                 case FTRACE_UPDATE_MODIFY_CALL:
213                 case FTRACE_UPDATE_MAKE_NOP:
214                         old = ftrace_call_replace(rec->ip, ftrace_get_addr_curr(rec));
215                         break;
216                 }
217
218                 ret = ftrace_verify_code(rec->ip, old);
219                 if (ret) {
220                         ftrace_expected = old;
221                         ftrace_bug(ret, rec);
222                         ftrace_expected = NULL;
223                         return;
224                 }
225         }
226
227         for_ftrace_rec_iter(iter) {
228                 rec = ftrace_rec_iter_record(iter);
229
230                 switch (ftrace_test_record(rec, enable)) {
231                 case FTRACE_UPDATE_IGNORE:
232                 default:
233                         continue;
234
235                 case FTRACE_UPDATE_MAKE_CALL:
236                 case FTRACE_UPDATE_MODIFY_CALL:
237                         new = ftrace_call_replace(rec->ip, ftrace_get_addr_new(rec));
238                         break;
239
240                 case FTRACE_UPDATE_MAKE_NOP:
241                         new = ftrace_nop_replace();
242                         break;
243                 }
244
245                 text_poke_queue((void *)rec->ip, new, MCOUNT_INSN_SIZE, NULL);
246                 ftrace_update_record(rec, enable);
247         }
248         text_poke_finish();
249 }
250
251 void arch_ftrace_update_code(int command)
252 {
253         ftrace_modify_all_code(command);
254 }
255
256 /* Currently only x86_64 supports dynamic trampolines */
257 #ifdef CONFIG_X86_64
258
259 #ifdef CONFIG_MODULES
260 #include <linux/moduleloader.h>
261 /* Module allocation simplifies allocating memory for code */
262 static inline void *alloc_tramp(unsigned long size)
263 {
264         return module_alloc(size);
265 }
266 static inline void tramp_free(void *tramp)
267 {
268         module_memfree(tramp);
269 }
270 #else
271 /* Trampolines can only be created if modules are supported */
272 static inline void *alloc_tramp(unsigned long size)
273 {
274         return NULL;
275 }
276 static inline void tramp_free(void *tramp) { }
277 #endif
278
279 /* Defined as markers to the end of the ftrace default trampolines */
280 extern void ftrace_regs_caller_end(void);
281 extern void ftrace_regs_caller_ret(void);
282 extern void ftrace_caller_end(void);
283 extern void ftrace_caller_op_ptr(void);
284 extern void ftrace_regs_caller_op_ptr(void);
285 extern void ftrace_regs_caller_jmp(void);
286
287 /* movq function_trace_op(%rip), %rdx */
288 /* 0x48 0x8b 0x15 <offset-to-ftrace_trace_op (4 bytes)> */
289 #define OP_REF_SIZE     7
290
291 /*
292  * The ftrace_ops is passed to the function callback. Since the
293  * trampoline only services a single ftrace_ops, we can pass in
294  * that ops directly.
295  *
296  * The ftrace_op_code_union is used to create a pointer to the
297  * ftrace_ops that will be passed to the callback function.
298  */
299 union ftrace_op_code_union {
300         char code[OP_REF_SIZE];
301         struct {
302                 char op[3];
303                 int offset;
304         } __attribute__((packed));
305 };
306
307 #define RET_SIZE                (IS_ENABLED(CONFIG_RETPOLINE) ? 5 : 1 + IS_ENABLED(CONFIG_SLS))
308
309 static unsigned long
310 create_trampoline(struct ftrace_ops *ops, unsigned int *tramp_size)
311 {
312         unsigned long start_offset;
313         unsigned long end_offset;
314         unsigned long op_offset;
315         unsigned long call_offset;
316         unsigned long jmp_offset;
317         unsigned long offset;
318         unsigned long npages;
319         unsigned long size;
320         unsigned long *ptr;
321         void *trampoline;
322         void *ip;
323         /* 48 8b 15 <offset> is movq <offset>(%rip), %rdx */
324         unsigned const char op_ref[] = { 0x48, 0x8b, 0x15 };
325         unsigned const char retq[] = { RET_INSN_OPCODE, INT3_INSN_OPCODE };
326         union ftrace_op_code_union op_ptr;
327         int ret;
328
329         if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
330                 start_offset = (unsigned long)ftrace_regs_caller;
331                 end_offset = (unsigned long)ftrace_regs_caller_end;
332                 op_offset = (unsigned long)ftrace_regs_caller_op_ptr;
333                 call_offset = (unsigned long)ftrace_regs_call;
334                 jmp_offset = (unsigned long)ftrace_regs_caller_jmp;
335         } else {
336                 start_offset = (unsigned long)ftrace_caller;
337                 end_offset = (unsigned long)ftrace_caller_end;
338                 op_offset = (unsigned long)ftrace_caller_op_ptr;
339                 call_offset = (unsigned long)ftrace_call;
340                 jmp_offset = 0;
341         }
342
343         size = end_offset - start_offset;
344
345         /*
346          * Allocate enough size to store the ftrace_caller code,
347          * the iret , as well as the address of the ftrace_ops this
348          * trampoline is used for.
349          */
350         trampoline = alloc_tramp(size + RET_SIZE + sizeof(void *));
351         if (!trampoline)
352                 return 0;
353
354         *tramp_size = size + RET_SIZE + sizeof(void *);
355         npages = DIV_ROUND_UP(*tramp_size, PAGE_SIZE);
356
357         /* Copy ftrace_caller onto the trampoline memory */
358         ret = copy_from_kernel_nofault(trampoline, (void *)start_offset, size);
359         if (WARN_ON(ret < 0))
360                 goto fail;
361
362         ip = trampoline + size;
363         if (cpu_feature_enabled(X86_FEATURE_RETHUNK))
364                 __text_gen_insn(ip, JMP32_INSN_OPCODE, ip, x86_return_thunk, JMP32_INSN_SIZE);
365         else
366                 memcpy(ip, retq, sizeof(retq));
367
368         /* No need to test direct calls on created trampolines */
369         if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
370                 /* NOP the jnz 1f; but make sure it's a 2 byte jnz */
371                 ip = trampoline + (jmp_offset - start_offset);
372                 if (WARN_ON(*(char *)ip != 0x75))
373                         goto fail;
374                 ret = copy_from_kernel_nofault(ip, x86_nops[2], 2);
375                 if (ret < 0)
376                         goto fail;
377         }
378
379         /*
380          * The address of the ftrace_ops that is used for this trampoline
381          * is stored at the end of the trampoline. This will be used to
382          * load the third parameter for the callback. Basically, that
383          * location at the end of the trampoline takes the place of
384          * the global function_trace_op variable.
385          */
386
387         ptr = (unsigned long *)(trampoline + size + RET_SIZE);
388         *ptr = (unsigned long)ops;
389
390         op_offset -= start_offset;
391         memcpy(&op_ptr, trampoline + op_offset, OP_REF_SIZE);
392
393         /* Are we pointing to the reference? */
394         if (WARN_ON(memcmp(op_ptr.op, op_ref, 3) != 0))
395                 goto fail;
396
397         /* Load the contents of ptr into the callback parameter */
398         offset = (unsigned long)ptr;
399         offset -= (unsigned long)trampoline + op_offset + OP_REF_SIZE;
400
401         op_ptr.offset = offset;
402
403         /* put in the new offset to the ftrace_ops */
404         memcpy(trampoline + op_offset, &op_ptr, OP_REF_SIZE);
405
406         /* put in the call to the function */
407         mutex_lock(&text_mutex);
408         call_offset -= start_offset;
409         memcpy(trampoline + call_offset,
410                text_gen_insn(CALL_INSN_OPCODE,
411                              trampoline + call_offset,
412                              ftrace_ops_get_func(ops)), CALL_INSN_SIZE);
413         mutex_unlock(&text_mutex);
414
415         /* ALLOC_TRAMP flags lets us know we created it */
416         ops->flags |= FTRACE_OPS_FL_ALLOC_TRAMP;
417
418         set_vm_flush_reset_perms(trampoline);
419
420         if (likely(system_state != SYSTEM_BOOTING))
421                 set_memory_ro((unsigned long)trampoline, npages);
422         set_memory_x((unsigned long)trampoline, npages);
423         return (unsigned long)trampoline;
424 fail:
425         tramp_free(trampoline);
426         return 0;
427 }
428
429 void set_ftrace_ops_ro(void)
430 {
431         struct ftrace_ops *ops;
432         unsigned long start_offset;
433         unsigned long end_offset;
434         unsigned long npages;
435         unsigned long size;
436
437         do_for_each_ftrace_op(ops, ftrace_ops_list) {
438                 if (!(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
439                         continue;
440
441                 if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
442                         start_offset = (unsigned long)ftrace_regs_caller;
443                         end_offset = (unsigned long)ftrace_regs_caller_end;
444                 } else {
445                         start_offset = (unsigned long)ftrace_caller;
446                         end_offset = (unsigned long)ftrace_caller_end;
447                 }
448                 size = end_offset - start_offset;
449                 size = size + RET_SIZE + sizeof(void *);
450                 npages = DIV_ROUND_UP(size, PAGE_SIZE);
451                 set_memory_ro((unsigned long)ops->trampoline, npages);
452         } while_for_each_ftrace_op(ops);
453 }
454
455 static unsigned long calc_trampoline_call_offset(bool save_regs)
456 {
457         unsigned long start_offset;
458         unsigned long call_offset;
459
460         if (save_regs) {
461                 start_offset = (unsigned long)ftrace_regs_caller;
462                 call_offset = (unsigned long)ftrace_regs_call;
463         } else {
464                 start_offset = (unsigned long)ftrace_caller;
465                 call_offset = (unsigned long)ftrace_call;
466         }
467
468         return call_offset - start_offset;
469 }
470
471 void arch_ftrace_update_trampoline(struct ftrace_ops *ops)
472 {
473         ftrace_func_t func;
474         unsigned long offset;
475         unsigned long ip;
476         unsigned int size;
477         const char *new;
478
479         if (!ops->trampoline) {
480                 ops->trampoline = create_trampoline(ops, &size);
481                 if (!ops->trampoline)
482                         return;
483                 ops->trampoline_size = size;
484                 return;
485         }
486
487         /*
488          * The ftrace_ops caller may set up its own trampoline.
489          * In such a case, this code must not modify it.
490          */
491         if (!(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
492                 return;
493
494         offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
495         ip = ops->trampoline + offset;
496         func = ftrace_ops_get_func(ops);
497
498         mutex_lock(&text_mutex);
499         /* Do a safe modify in case the trampoline is executing */
500         new = ftrace_call_replace(ip, (unsigned long)func);
501         text_poke_bp((void *)ip, new, MCOUNT_INSN_SIZE, NULL);
502         mutex_unlock(&text_mutex);
503 }
504
505 /* Return the address of the function the trampoline calls */
506 static void *addr_from_call(void *ptr)
507 {
508         union text_poke_insn call;
509         int ret;
510
511         ret = copy_from_kernel_nofault(&call, ptr, CALL_INSN_SIZE);
512         if (WARN_ON_ONCE(ret < 0))
513                 return NULL;
514
515         /* Make sure this is a call */
516         if (WARN_ON_ONCE(call.opcode != CALL_INSN_OPCODE)) {
517                 pr_warn("Expected E8, got %x\n", call.opcode);
518                 return NULL;
519         }
520
521         return ptr + CALL_INSN_SIZE + call.disp;
522 }
523
524 void prepare_ftrace_return(unsigned long ip, unsigned long *parent,
525                            unsigned long frame_pointer);
526
527 /*
528  * If the ops->trampoline was not allocated, then it probably
529  * has a static trampoline func, or is the ftrace caller itself.
530  */
531 static void *static_tramp_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
532 {
533         unsigned long offset;
534         bool save_regs = rec->flags & FTRACE_FL_REGS_EN;
535         void *ptr;
536
537         if (ops && ops->trampoline) {
538 #if !defined(CONFIG_HAVE_DYNAMIC_FTRACE_WITH_ARGS) && \
539         defined(CONFIG_FUNCTION_GRAPH_TRACER)
540                 /*
541                  * We only know about function graph tracer setting as static
542                  * trampoline.
543                  */
544                 if (ops->trampoline == FTRACE_GRAPH_ADDR)
545                         return (void *)prepare_ftrace_return;
546 #endif
547                 return NULL;
548         }
549
550         offset = calc_trampoline_call_offset(save_regs);
551
552         if (save_regs)
553                 ptr = (void *)FTRACE_REGS_ADDR + offset;
554         else
555                 ptr = (void *)FTRACE_ADDR + offset;
556
557         return addr_from_call(ptr);
558 }
559
560 void *arch_ftrace_trampoline_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
561 {
562         unsigned long offset;
563
564         /* If we didn't allocate this trampoline, consider it static */
565         if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
566                 return static_tramp_func(ops, rec);
567
568         offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
569         return addr_from_call((void *)ops->trampoline + offset);
570 }
571
572 void arch_ftrace_trampoline_free(struct ftrace_ops *ops)
573 {
574         if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
575                 return;
576
577         tramp_free((void *)ops->trampoline);
578         ops->trampoline = 0;
579 }
580
581 #endif /* CONFIG_X86_64 */
582 #endif /* CONFIG_DYNAMIC_FTRACE */
583
584 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
585
586 #if defined(CONFIG_DYNAMIC_FTRACE) && !defined(CONFIG_HAVE_DYNAMIC_FTRACE_WITH_ARGS)
587 extern void ftrace_graph_call(void);
588 static const char *ftrace_jmp_replace(unsigned long ip, unsigned long addr)
589 {
590         return text_gen_insn(JMP32_INSN_OPCODE, (void *)ip, (void *)addr);
591 }
592
593 static int ftrace_mod_jmp(unsigned long ip, void *func)
594 {
595         const char *new;
596
597         new = ftrace_jmp_replace(ip, (unsigned long)func);
598         text_poke_bp((void *)ip, new, MCOUNT_INSN_SIZE, NULL);
599         return 0;
600 }
601
602 int ftrace_enable_ftrace_graph_caller(void)
603 {
604         unsigned long ip = (unsigned long)(&ftrace_graph_call);
605
606         return ftrace_mod_jmp(ip, &ftrace_graph_caller);
607 }
608
609 int ftrace_disable_ftrace_graph_caller(void)
610 {
611         unsigned long ip = (unsigned long)(&ftrace_graph_call);
612
613         return ftrace_mod_jmp(ip, &ftrace_stub);
614 }
615 #endif /* CONFIG_DYNAMIC_FTRACE && !CONFIG_HAVE_DYNAMIC_FTRACE_WITH_ARGS */
616
617 /*
618  * Hook the return address and push it in the stack of return addrs
619  * in current thread info.
620  */
621 void prepare_ftrace_return(unsigned long ip, unsigned long *parent,
622                            unsigned long frame_pointer)
623 {
624         unsigned long return_hooker = (unsigned long)&return_to_handler;
625         int bit;
626
627         /*
628          * When resuming from suspend-to-ram, this function can be indirectly
629          * called from early CPU startup code while the CPU is in real mode,
630          * which would fail miserably.  Make sure the stack pointer is a
631          * virtual address.
632          *
633          * This check isn't as accurate as virt_addr_valid(), but it should be
634          * good enough for this purpose, and it's fast.
635          */
636         if (unlikely((long)__builtin_frame_address(0) >= 0))
637                 return;
638
639         if (unlikely(ftrace_graph_is_dead()))
640                 return;
641
642         if (unlikely(atomic_read(&current->tracing_graph_pause)))
643                 return;
644
645         bit = ftrace_test_recursion_trylock(ip, *parent);
646         if (bit < 0)
647                 return;
648
649         if (!function_graph_enter(*parent, ip, frame_pointer, parent))
650                 *parent = return_hooker;
651
652         ftrace_test_recursion_unlock(bit);
653 }
654
655 #ifdef CONFIG_HAVE_DYNAMIC_FTRACE_WITH_ARGS
656 void ftrace_graph_func(unsigned long ip, unsigned long parent_ip,
657                        struct ftrace_ops *op, struct ftrace_regs *fregs)
658 {
659         struct pt_regs *regs = &fregs->regs;
660         unsigned long *stack = (unsigned long *)kernel_stack_pointer(regs);
661
662         prepare_ftrace_return(ip, (unsigned long *)stack, 0);
663 }
664 #endif
665
666 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */