blob: 4a5d35dc490b2d4cbfd3685dee71fc12df18dace [file] [log] [blame]
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001// SPDX-License-Identifier: GPL-2.0
2/*
3 * Infrastructure for profiling code inserted by 'gcc -pg'.
4 *
5 * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
6 * Copyright (C) 2004-2008 Ingo Molnar <mingo@redhat.com>
7 *
8 * Originally ported from the -rt patch by:
9 * Copyright (C) 2007 Arnaldo Carvalho de Melo <acme@redhat.com>
10 *
11 * Based on code in the latency_tracer, that is:
12 *
13 * Copyright (C) 2004-2006 Ingo Molnar
14 * Copyright (C) 2004 Nadia Yvette Chambers
15 */
16
17#include <linux/stop_machine.h>
18#include <linux/clocksource.h>
19#include <linux/sched/task.h>
20#include <linux/kallsyms.h>
David Brazdil0f672f62019-12-10 10:32:29 +000021#include <linux/security.h>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000022#include <linux/seq_file.h>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000023#include <linux/tracefs.h>
24#include <linux/hardirq.h>
25#include <linux/kthread.h>
26#include <linux/uaccess.h>
27#include <linux/bsearch.h>
28#include <linux/module.h>
29#include <linux/ftrace.h>
30#include <linux/sysctl.h>
31#include <linux/slab.h>
32#include <linux/ctype.h>
33#include <linux/sort.h>
34#include <linux/list.h>
35#include <linux/hash.h>
36#include <linux/rcupdate.h>
David Brazdil0f672f62019-12-10 10:32:29 +000037#include <linux/kprobes.h>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000038
39#include <trace/events/sched.h>
40
41#include <asm/sections.h>
42#include <asm/setup.h>
43
David Brazdil0f672f62019-12-10 10:32:29 +000044#include "ftrace_internal.h"
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000045#include "trace_output.h"
46#include "trace_stat.h"
47
48#define FTRACE_WARN_ON(cond) \
49 ({ \
50 int ___r = cond; \
51 if (WARN_ON(___r)) \
52 ftrace_kill(); \
53 ___r; \
54 })
55
56#define FTRACE_WARN_ON_ONCE(cond) \
57 ({ \
58 int ___r = cond; \
59 if (WARN_ON_ONCE(___r)) \
60 ftrace_kill(); \
61 ___r; \
62 })
63
64/* hash bits for specific function selection */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000065#define FTRACE_HASH_DEFAULT_BITS 10
66#define FTRACE_HASH_MAX_BITS 12
67
68#ifdef CONFIG_DYNAMIC_FTRACE
69#define INIT_OPS_HASH(opsname) \
70 .func_hash = &opsname.local_hash, \
71 .local_hash.regex_lock = __MUTEX_INITIALIZER(opsname.local_hash.regex_lock),
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000072#else
73#define INIT_OPS_HASH(opsname)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000074#endif
75
David Brazdil0f672f62019-12-10 10:32:29 +000076enum {
77 FTRACE_MODIFY_ENABLE_FL = (1 << 0),
78 FTRACE_MODIFY_MAY_SLEEP_FL = (1 << 1),
79};
80
81struct ftrace_ops ftrace_list_end __read_mostly = {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000082 .func = ftrace_stub,
83 .flags = FTRACE_OPS_FL_RECURSION_SAFE | FTRACE_OPS_FL_STUB,
84 INIT_OPS_HASH(ftrace_list_end)
85};
86
87/* ftrace_enabled is a method to turn ftrace on or off */
88int ftrace_enabled __read_mostly;
89static int last_ftrace_enabled;
90
91/* Current function tracing op */
92struct ftrace_ops *function_trace_op __read_mostly = &ftrace_list_end;
93/* What to set function_trace_op to */
94static struct ftrace_ops *set_function_trace_op;
95
96static bool ftrace_pids_enabled(struct ftrace_ops *ops)
97{
98 struct trace_array *tr;
99
100 if (!(ops->flags & FTRACE_OPS_FL_PID) || !ops->private)
101 return false;
102
103 tr = ops->private;
104
Olivier Deprez157378f2022-04-04 15:47:50 +0200105 return tr->function_pids != NULL || tr->function_no_pids != NULL;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000106}
107
108static void ftrace_update_trampoline(struct ftrace_ops *ops);
109
110/*
111 * ftrace_disabled is set when an anomaly is discovered.
112 * ftrace_disabled is much stronger than ftrace_enabled.
113 */
114static int ftrace_disabled __read_mostly;
115
David Brazdil0f672f62019-12-10 10:32:29 +0000116DEFINE_MUTEX(ftrace_lock);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000117
David Brazdil0f672f62019-12-10 10:32:29 +0000118struct ftrace_ops __rcu *ftrace_ops_list __read_mostly = &ftrace_list_end;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000119ftrace_func_t ftrace_trace_function __read_mostly = ftrace_stub;
David Brazdil0f672f62019-12-10 10:32:29 +0000120struct ftrace_ops global_ops;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000121
122#if ARCH_SUPPORTS_FTRACE_OPS
123static void ftrace_ops_list_func(unsigned long ip, unsigned long parent_ip,
124 struct ftrace_ops *op, struct pt_regs *regs);
125#else
126/* See comment below, where ftrace_ops_list_func is defined */
127static void ftrace_ops_no_ops(unsigned long ip, unsigned long parent_ip);
128#define ftrace_ops_list_func ((ftrace_func_t)ftrace_ops_no_ops)
129#endif
130
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000131static inline void ftrace_ops_init(struct ftrace_ops *ops)
132{
133#ifdef CONFIG_DYNAMIC_FTRACE
134 if (!(ops->flags & FTRACE_OPS_FL_INITIALIZED)) {
135 mutex_init(&ops->local_hash.regex_lock);
136 ops->func_hash = &ops->local_hash;
137 ops->flags |= FTRACE_OPS_FL_INITIALIZED;
138 }
139#endif
140}
141
142static void ftrace_pid_func(unsigned long ip, unsigned long parent_ip,
143 struct ftrace_ops *op, struct pt_regs *regs)
144{
145 struct trace_array *tr = op->private;
Olivier Deprez157378f2022-04-04 15:47:50 +0200146 int pid;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000147
Olivier Deprez157378f2022-04-04 15:47:50 +0200148 if (tr) {
149 pid = this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid);
150 if (pid == FTRACE_PID_IGNORE)
151 return;
152 if (pid != FTRACE_PID_TRACE &&
153 pid != current->pid)
154 return;
155 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000156
157 op->saved_func(ip, parent_ip, op, regs);
158}
159
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000160static void ftrace_sync_ipi(void *data)
161{
162 /* Probably not needed, but do it anyway */
163 smp_rmb();
164}
165
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000166static ftrace_func_t ftrace_ops_get_list_func(struct ftrace_ops *ops)
167{
168 /*
169 * If this is a dynamic, RCU, or per CPU ops, or we force list func,
170 * then it needs to call the list anyway.
171 */
172 if (ops->flags & (FTRACE_OPS_FL_DYNAMIC | FTRACE_OPS_FL_RCU) ||
173 FTRACE_FORCE_LIST_FUNC)
174 return ftrace_ops_list_func;
175
176 return ftrace_ops_get_func(ops);
177}
178
179static void update_ftrace_function(void)
180{
181 ftrace_func_t func;
182
183 /*
184 * Prepare the ftrace_ops that the arch callback will use.
185 * If there's only one ftrace_ops registered, the ftrace_ops_list
186 * will point to the ops we want.
187 */
188 set_function_trace_op = rcu_dereference_protected(ftrace_ops_list,
189 lockdep_is_held(&ftrace_lock));
190
191 /* If there's no ftrace_ops registered, just call the stub function */
192 if (set_function_trace_op == &ftrace_list_end) {
193 func = ftrace_stub;
194
195 /*
196 * If we are at the end of the list and this ops is
197 * recursion safe and not dynamic and the arch supports passing ops,
198 * then have the mcount trampoline call the function directly.
199 */
200 } else if (rcu_dereference_protected(ftrace_ops_list->next,
201 lockdep_is_held(&ftrace_lock)) == &ftrace_list_end) {
202 func = ftrace_ops_get_list_func(ftrace_ops_list);
203
204 } else {
205 /* Just use the default ftrace_ops */
206 set_function_trace_op = &ftrace_list_end;
207 func = ftrace_ops_list_func;
208 }
209
210 update_function_graph_func();
211
212 /* If there's no change, then do nothing more here */
213 if (ftrace_trace_function == func)
214 return;
215
216 /*
217 * If we are using the list function, it doesn't care
218 * about the function_trace_ops.
219 */
220 if (func == ftrace_ops_list_func) {
221 ftrace_trace_function = func;
222 /*
223 * Don't even bother setting function_trace_ops,
224 * it would be racy to do so anyway.
225 */
226 return;
227 }
228
229#ifndef CONFIG_DYNAMIC_FTRACE
230 /*
231 * For static tracing, we need to be a bit more careful.
232 * The function change takes affect immediately. Thus,
Olivier Deprez157378f2022-04-04 15:47:50 +0200233 * we need to coordinate the setting of the function_trace_ops
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000234 * with the setting of the ftrace_trace_function.
235 *
236 * Set the function to the list ops, which will call the
237 * function we want, albeit indirectly, but it handles the
238 * ftrace_ops and doesn't depend on function_trace_op.
239 */
240 ftrace_trace_function = ftrace_ops_list_func;
241 /*
242 * Make sure all CPUs see this. Yes this is slow, but static
243 * tracing is slow and nasty to have enabled.
244 */
Olivier Deprez157378f2022-04-04 15:47:50 +0200245 synchronize_rcu_tasks_rude();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000246 /* Now all cpus are using the list ops. */
247 function_trace_op = set_function_trace_op;
248 /* Make sure the function_trace_op is visible on all CPUs */
249 smp_wmb();
250 /* Nasty way to force a rmb on all cpus */
251 smp_call_function(ftrace_sync_ipi, NULL, 1);
252 /* OK, we are all set to update the ftrace_trace_function now! */
253#endif /* !CONFIG_DYNAMIC_FTRACE */
254
255 ftrace_trace_function = func;
256}
257
258static void add_ftrace_ops(struct ftrace_ops __rcu **list,
259 struct ftrace_ops *ops)
260{
261 rcu_assign_pointer(ops->next, *list);
262
263 /*
264 * We are entering ops into the list but another
265 * CPU might be walking that list. We need to make sure
266 * the ops->next pointer is valid before another CPU sees
267 * the ops pointer included into the list.
268 */
269 rcu_assign_pointer(*list, ops);
270}
271
272static int remove_ftrace_ops(struct ftrace_ops __rcu **list,
273 struct ftrace_ops *ops)
274{
275 struct ftrace_ops **p;
276
277 /*
278 * If we are removing the last function, then simply point
279 * to the ftrace_stub.
280 */
281 if (rcu_dereference_protected(*list,
282 lockdep_is_held(&ftrace_lock)) == ops &&
283 rcu_dereference_protected(ops->next,
284 lockdep_is_held(&ftrace_lock)) == &ftrace_list_end) {
285 *list = &ftrace_list_end;
286 return 0;
287 }
288
289 for (p = list; *p != &ftrace_list_end; p = &(*p)->next)
290 if (*p == ops)
291 break;
292
293 if (*p != ops)
294 return -1;
295
296 *p = (*p)->next;
297 return 0;
298}
299
300static void ftrace_update_trampoline(struct ftrace_ops *ops);
301
David Brazdil0f672f62019-12-10 10:32:29 +0000302int __register_ftrace_function(struct ftrace_ops *ops)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000303{
304 if (ops->flags & FTRACE_OPS_FL_DELETED)
305 return -EINVAL;
306
307 if (WARN_ON(ops->flags & FTRACE_OPS_FL_ENABLED))
308 return -EBUSY;
309
310#ifndef CONFIG_DYNAMIC_FTRACE_WITH_REGS
311 /*
312 * If the ftrace_ops specifies SAVE_REGS, then it only can be used
313 * if the arch supports it, or SAVE_REGS_IF_SUPPORTED is also set.
314 * Setting SAVE_REGS_IF_SUPPORTED makes SAVE_REGS irrelevant.
315 */
316 if (ops->flags & FTRACE_OPS_FL_SAVE_REGS &&
317 !(ops->flags & FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED))
318 return -EINVAL;
319
320 if (ops->flags & FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED)
321 ops->flags |= FTRACE_OPS_FL_SAVE_REGS;
322#endif
Olivier Deprez157378f2022-04-04 15:47:50 +0200323 if (!ftrace_enabled && (ops->flags & FTRACE_OPS_FL_PERMANENT))
324 return -EBUSY;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000325
326 if (!core_kernel_data((unsigned long)ops))
327 ops->flags |= FTRACE_OPS_FL_DYNAMIC;
328
329 add_ftrace_ops(&ftrace_ops_list, ops);
330
331 /* Always save the function, and reset at unregistering */
332 ops->saved_func = ops->func;
333
334 if (ftrace_pids_enabled(ops))
335 ops->func = ftrace_pid_func;
336
337 ftrace_update_trampoline(ops);
338
339 if (ftrace_enabled)
340 update_ftrace_function();
341
342 return 0;
343}
344
David Brazdil0f672f62019-12-10 10:32:29 +0000345int __unregister_ftrace_function(struct ftrace_ops *ops)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000346{
347 int ret;
348
349 if (WARN_ON(!(ops->flags & FTRACE_OPS_FL_ENABLED)))
350 return -EBUSY;
351
352 ret = remove_ftrace_ops(&ftrace_ops_list, ops);
353
354 if (ret < 0)
355 return ret;
356
357 if (ftrace_enabled)
358 update_ftrace_function();
359
360 ops->func = ops->saved_func;
361
362 return 0;
363}
364
365static void ftrace_update_pid_func(void)
366{
367 struct ftrace_ops *op;
368
369 /* Only do something if we are tracing something */
370 if (ftrace_trace_function == ftrace_stub)
371 return;
372
373 do_for_each_ftrace_op(op, ftrace_ops_list) {
374 if (op->flags & FTRACE_OPS_FL_PID) {
375 op->func = ftrace_pids_enabled(op) ?
376 ftrace_pid_func : op->saved_func;
377 ftrace_update_trampoline(op);
378 }
379 } while_for_each_ftrace_op(op);
380
381 update_ftrace_function();
382}
383
384#ifdef CONFIG_FUNCTION_PROFILER
385struct ftrace_profile {
386 struct hlist_node node;
387 unsigned long ip;
388 unsigned long counter;
389#ifdef CONFIG_FUNCTION_GRAPH_TRACER
390 unsigned long long time;
391 unsigned long long time_squared;
392#endif
393};
394
395struct ftrace_profile_page {
396 struct ftrace_profile_page *next;
397 unsigned long index;
398 struct ftrace_profile records[];
399};
400
401struct ftrace_profile_stat {
402 atomic_t disabled;
403 struct hlist_head *hash;
404 struct ftrace_profile_page *pages;
405 struct ftrace_profile_page *start;
406 struct tracer_stat stat;
407};
408
409#define PROFILE_RECORDS_SIZE \
410 (PAGE_SIZE - offsetof(struct ftrace_profile_page, records))
411
412#define PROFILES_PER_PAGE \
413 (PROFILE_RECORDS_SIZE / sizeof(struct ftrace_profile))
414
415static int ftrace_profile_enabled __read_mostly;
416
417/* ftrace_profile_lock - synchronize the enable and disable of the profiler */
418static DEFINE_MUTEX(ftrace_profile_lock);
419
420static DEFINE_PER_CPU(struct ftrace_profile_stat, ftrace_profile_stats);
421
422#define FTRACE_PROFILE_HASH_BITS 10
423#define FTRACE_PROFILE_HASH_SIZE (1 << FTRACE_PROFILE_HASH_BITS)
424
425static void *
426function_stat_next(void *v, int idx)
427{
428 struct ftrace_profile *rec = v;
429 struct ftrace_profile_page *pg;
430
431 pg = (struct ftrace_profile_page *)((unsigned long)rec & PAGE_MASK);
432
433 again:
434 if (idx != 0)
435 rec++;
436
437 if ((void *)rec >= (void *)&pg->records[pg->index]) {
438 pg = pg->next;
439 if (!pg)
440 return NULL;
441 rec = &pg->records[0];
442 if (!rec->counter)
443 goto again;
444 }
445
446 return rec;
447}
448
449static void *function_stat_start(struct tracer_stat *trace)
450{
451 struct ftrace_profile_stat *stat =
452 container_of(trace, struct ftrace_profile_stat, stat);
453
454 if (!stat || !stat->start)
455 return NULL;
456
457 return function_stat_next(&stat->start->records[0], 0);
458}
459
460#ifdef CONFIG_FUNCTION_GRAPH_TRACER
461/* function graph compares on total time */
Olivier Deprez157378f2022-04-04 15:47:50 +0200462static int function_stat_cmp(const void *p1, const void *p2)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000463{
Olivier Deprez157378f2022-04-04 15:47:50 +0200464 const struct ftrace_profile *a = p1;
465 const struct ftrace_profile *b = p2;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000466
467 if (a->time < b->time)
468 return -1;
469 if (a->time > b->time)
470 return 1;
471 else
472 return 0;
473}
474#else
475/* not function graph compares against hits */
Olivier Deprez157378f2022-04-04 15:47:50 +0200476static int function_stat_cmp(const void *p1, const void *p2)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000477{
Olivier Deprez157378f2022-04-04 15:47:50 +0200478 const struct ftrace_profile *a = p1;
479 const struct ftrace_profile *b = p2;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000480
481 if (a->counter < b->counter)
482 return -1;
483 if (a->counter > b->counter)
484 return 1;
485 else
486 return 0;
487}
488#endif
489
490static int function_stat_headers(struct seq_file *m)
491{
492#ifdef CONFIG_FUNCTION_GRAPH_TRACER
493 seq_puts(m, " Function "
494 "Hit Time Avg s^2\n"
495 " -------- "
496 "--- ---- --- ---\n");
497#else
498 seq_puts(m, " Function Hit\n"
499 " -------- ---\n");
500#endif
501 return 0;
502}
503
504static int function_stat_show(struct seq_file *m, void *v)
505{
506 struct ftrace_profile *rec = v;
507 char str[KSYM_SYMBOL_LEN];
508 int ret = 0;
509#ifdef CONFIG_FUNCTION_GRAPH_TRACER
510 static struct trace_seq s;
511 unsigned long long avg;
512 unsigned long long stddev;
513#endif
514 mutex_lock(&ftrace_profile_lock);
515
516 /* we raced with function_profile_reset() */
517 if (unlikely(rec->counter == 0)) {
518 ret = -EBUSY;
519 goto out;
520 }
521
522#ifdef CONFIG_FUNCTION_GRAPH_TRACER
Olivier Deprez0e641232021-09-23 10:07:05 +0200523 avg = div64_ul(rec->time, rec->counter);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000524 if (tracing_thresh && (avg < tracing_thresh))
525 goto out;
526#endif
527
528 kallsyms_lookup(rec->ip, NULL, NULL, NULL, str);
529 seq_printf(m, " %-30.30s %10lu", str, rec->counter);
530
531#ifdef CONFIG_FUNCTION_GRAPH_TRACER
532 seq_puts(m, " ");
533
534 /* Sample standard deviation (s^2) */
535 if (rec->counter <= 1)
536 stddev = 0;
537 else {
538 /*
539 * Apply Welford's method:
540 * s^2 = 1 / (n * (n-1)) * (n * \Sum (x_i)^2 - (\Sum x_i)^2)
541 */
542 stddev = rec->counter * rec->time_squared -
543 rec->time * rec->time;
544
545 /*
546 * Divide only 1000 for ns^2 -> us^2 conversion.
547 * trace_print_graph_duration will divide 1000 again.
548 */
Olivier Deprez0e641232021-09-23 10:07:05 +0200549 stddev = div64_ul(stddev,
550 rec->counter * (rec->counter - 1) * 1000);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000551 }
552
553 trace_seq_init(&s);
554 trace_print_graph_duration(rec->time, &s);
555 trace_seq_puts(&s, " ");
556 trace_print_graph_duration(avg, &s);
557 trace_seq_puts(&s, " ");
558 trace_print_graph_duration(stddev, &s);
559 trace_print_seq(m, &s);
560#endif
561 seq_putc(m, '\n');
562out:
563 mutex_unlock(&ftrace_profile_lock);
564
565 return ret;
566}
567
568static void ftrace_profile_reset(struct ftrace_profile_stat *stat)
569{
570 struct ftrace_profile_page *pg;
571
572 pg = stat->pages = stat->start;
573
574 while (pg) {
575 memset(pg->records, 0, PROFILE_RECORDS_SIZE);
576 pg->index = 0;
577 pg = pg->next;
578 }
579
580 memset(stat->hash, 0,
581 FTRACE_PROFILE_HASH_SIZE * sizeof(struct hlist_head));
582}
583
584int ftrace_profile_pages_init(struct ftrace_profile_stat *stat)
585{
586 struct ftrace_profile_page *pg;
587 int functions;
588 int pages;
589 int i;
590
591 /* If we already allocated, do nothing */
592 if (stat->pages)
593 return 0;
594
595 stat->pages = (void *)get_zeroed_page(GFP_KERNEL);
596 if (!stat->pages)
597 return -ENOMEM;
598
599#ifdef CONFIG_DYNAMIC_FTRACE
600 functions = ftrace_update_tot_cnt;
601#else
602 /*
603 * We do not know the number of functions that exist because
604 * dynamic tracing is what counts them. With past experience
605 * we have around 20K functions. That should be more than enough.
606 * It is highly unlikely we will execute every function in
607 * the kernel.
608 */
609 functions = 20000;
610#endif
611
612 pg = stat->start = stat->pages;
613
614 pages = DIV_ROUND_UP(functions, PROFILES_PER_PAGE);
615
616 for (i = 1; i < pages; i++) {
617 pg->next = (void *)get_zeroed_page(GFP_KERNEL);
618 if (!pg->next)
619 goto out_free;
620 pg = pg->next;
621 }
622
623 return 0;
624
625 out_free:
626 pg = stat->start;
627 while (pg) {
628 unsigned long tmp = (unsigned long)pg;
629
630 pg = pg->next;
631 free_page(tmp);
632 }
633
634 stat->pages = NULL;
635 stat->start = NULL;
636
637 return -ENOMEM;
638}
639
640static int ftrace_profile_init_cpu(int cpu)
641{
642 struct ftrace_profile_stat *stat;
643 int size;
644
645 stat = &per_cpu(ftrace_profile_stats, cpu);
646
647 if (stat->hash) {
648 /* If the profile is already created, simply reset it */
649 ftrace_profile_reset(stat);
650 return 0;
651 }
652
653 /*
654 * We are profiling all functions, but usually only a few thousand
655 * functions are hit. We'll make a hash of 1024 items.
656 */
657 size = FTRACE_PROFILE_HASH_SIZE;
658
659 stat->hash = kcalloc(size, sizeof(struct hlist_head), GFP_KERNEL);
660
661 if (!stat->hash)
662 return -ENOMEM;
663
664 /* Preallocate the function profiling pages */
665 if (ftrace_profile_pages_init(stat) < 0) {
666 kfree(stat->hash);
667 stat->hash = NULL;
668 return -ENOMEM;
669 }
670
671 return 0;
672}
673
674static int ftrace_profile_init(void)
675{
676 int cpu;
677 int ret = 0;
678
679 for_each_possible_cpu(cpu) {
680 ret = ftrace_profile_init_cpu(cpu);
681 if (ret)
682 break;
683 }
684
685 return ret;
686}
687
688/* interrupts must be disabled */
689static struct ftrace_profile *
690ftrace_find_profiled_func(struct ftrace_profile_stat *stat, unsigned long ip)
691{
692 struct ftrace_profile *rec;
693 struct hlist_head *hhd;
694 unsigned long key;
695
696 key = hash_long(ip, FTRACE_PROFILE_HASH_BITS);
697 hhd = &stat->hash[key];
698
699 if (hlist_empty(hhd))
700 return NULL;
701
702 hlist_for_each_entry_rcu_notrace(rec, hhd, node) {
703 if (rec->ip == ip)
704 return rec;
705 }
706
707 return NULL;
708}
709
710static void ftrace_add_profile(struct ftrace_profile_stat *stat,
711 struct ftrace_profile *rec)
712{
713 unsigned long key;
714
715 key = hash_long(rec->ip, FTRACE_PROFILE_HASH_BITS);
716 hlist_add_head_rcu(&rec->node, &stat->hash[key]);
717}
718
719/*
720 * The memory is already allocated, this simply finds a new record to use.
721 */
722static struct ftrace_profile *
723ftrace_profile_alloc(struct ftrace_profile_stat *stat, unsigned long ip)
724{
725 struct ftrace_profile *rec = NULL;
726
727 /* prevent recursion (from NMIs) */
728 if (atomic_inc_return(&stat->disabled) != 1)
729 goto out;
730
731 /*
732 * Try to find the function again since an NMI
733 * could have added it
734 */
735 rec = ftrace_find_profiled_func(stat, ip);
736 if (rec)
737 goto out;
738
739 if (stat->pages->index == PROFILES_PER_PAGE) {
740 if (!stat->pages->next)
741 goto out;
742 stat->pages = stat->pages->next;
743 }
744
745 rec = &stat->pages->records[stat->pages->index++];
746 rec->ip = ip;
747 ftrace_add_profile(stat, rec);
748
749 out:
750 atomic_dec(&stat->disabled);
751
752 return rec;
753}
754
755static void
756function_profile_call(unsigned long ip, unsigned long parent_ip,
757 struct ftrace_ops *ops, struct pt_regs *regs)
758{
759 struct ftrace_profile_stat *stat;
760 struct ftrace_profile *rec;
761 unsigned long flags;
762
763 if (!ftrace_profile_enabled)
764 return;
765
766 local_irq_save(flags);
767
768 stat = this_cpu_ptr(&ftrace_profile_stats);
769 if (!stat->hash || !ftrace_profile_enabled)
770 goto out;
771
772 rec = ftrace_find_profiled_func(stat, ip);
773 if (!rec) {
774 rec = ftrace_profile_alloc(stat, ip);
775 if (!rec)
776 goto out;
777 }
778
779 rec->counter++;
780 out:
781 local_irq_restore(flags);
782}
783
784#ifdef CONFIG_FUNCTION_GRAPH_TRACER
David Brazdil0f672f62019-12-10 10:32:29 +0000785static bool fgraph_graph_time = true;
786
787void ftrace_graph_graph_time_control(bool enable)
788{
789 fgraph_graph_time = enable;
790}
791
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000792static int profile_graph_entry(struct ftrace_graph_ent *trace)
793{
David Brazdil0f672f62019-12-10 10:32:29 +0000794 struct ftrace_ret_stack *ret_stack;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000795
796 function_profile_call(trace->func, 0, NULL, NULL);
797
798 /* If function graph is shutting down, ret_stack can be NULL */
799 if (!current->ret_stack)
800 return 0;
801
David Brazdil0f672f62019-12-10 10:32:29 +0000802 ret_stack = ftrace_graph_get_ret_stack(current, 0);
803 if (ret_stack)
804 ret_stack->subtime = 0;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000805
806 return 1;
807}
808
809static void profile_graph_return(struct ftrace_graph_ret *trace)
810{
David Brazdil0f672f62019-12-10 10:32:29 +0000811 struct ftrace_ret_stack *ret_stack;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000812 struct ftrace_profile_stat *stat;
813 unsigned long long calltime;
814 struct ftrace_profile *rec;
815 unsigned long flags;
816
817 local_irq_save(flags);
818 stat = this_cpu_ptr(&ftrace_profile_stats);
819 if (!stat->hash || !ftrace_profile_enabled)
820 goto out;
821
822 /* If the calltime was zero'd ignore it */
823 if (!trace->calltime)
824 goto out;
825
826 calltime = trace->rettime - trace->calltime;
827
828 if (!fgraph_graph_time) {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000829
830 /* Append this call time to the parent time to subtract */
David Brazdil0f672f62019-12-10 10:32:29 +0000831 ret_stack = ftrace_graph_get_ret_stack(current, 1);
832 if (ret_stack)
833 ret_stack->subtime += calltime;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000834
David Brazdil0f672f62019-12-10 10:32:29 +0000835 ret_stack = ftrace_graph_get_ret_stack(current, 0);
836 if (ret_stack && ret_stack->subtime < calltime)
837 calltime -= ret_stack->subtime;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000838 else
839 calltime = 0;
840 }
841
842 rec = ftrace_find_profiled_func(stat, trace->func);
843 if (rec) {
844 rec->time += calltime;
845 rec->time_squared += calltime * calltime;
846 }
847
848 out:
849 local_irq_restore(flags);
850}
851
David Brazdil0f672f62019-12-10 10:32:29 +0000852static struct fgraph_ops fprofiler_ops = {
853 .entryfunc = &profile_graph_entry,
854 .retfunc = &profile_graph_return,
855};
856
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000857static int register_ftrace_profiler(void)
858{
David Brazdil0f672f62019-12-10 10:32:29 +0000859 return register_ftrace_graph(&fprofiler_ops);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000860}
861
862static void unregister_ftrace_profiler(void)
863{
David Brazdil0f672f62019-12-10 10:32:29 +0000864 unregister_ftrace_graph(&fprofiler_ops);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000865}
866#else
867static struct ftrace_ops ftrace_profile_ops __read_mostly = {
868 .func = function_profile_call,
869 .flags = FTRACE_OPS_FL_RECURSION_SAFE | FTRACE_OPS_FL_INITIALIZED,
870 INIT_OPS_HASH(ftrace_profile_ops)
871};
872
873static int register_ftrace_profiler(void)
874{
875 return register_ftrace_function(&ftrace_profile_ops);
876}
877
878static void unregister_ftrace_profiler(void)
879{
880 unregister_ftrace_function(&ftrace_profile_ops);
881}
882#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
883
884static ssize_t
885ftrace_profile_write(struct file *filp, const char __user *ubuf,
886 size_t cnt, loff_t *ppos)
887{
888 unsigned long val;
889 int ret;
890
891 ret = kstrtoul_from_user(ubuf, cnt, 10, &val);
892 if (ret)
893 return ret;
894
895 val = !!val;
896
897 mutex_lock(&ftrace_profile_lock);
898 if (ftrace_profile_enabled ^ val) {
899 if (val) {
900 ret = ftrace_profile_init();
901 if (ret < 0) {
902 cnt = ret;
903 goto out;
904 }
905
906 ret = register_ftrace_profiler();
907 if (ret < 0) {
908 cnt = ret;
909 goto out;
910 }
911 ftrace_profile_enabled = 1;
912 } else {
913 ftrace_profile_enabled = 0;
914 /*
915 * unregister_ftrace_profiler calls stop_machine
David Brazdil0f672f62019-12-10 10:32:29 +0000916 * so this acts like an synchronize_rcu.
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000917 */
918 unregister_ftrace_profiler();
919 }
920 }
921 out:
922 mutex_unlock(&ftrace_profile_lock);
923
924 *ppos += cnt;
925
926 return cnt;
927}
928
929static ssize_t
930ftrace_profile_read(struct file *filp, char __user *ubuf,
931 size_t cnt, loff_t *ppos)
932{
933 char buf[64]; /* big enough to hold a number */
934 int r;
935
936 r = sprintf(buf, "%u\n", ftrace_profile_enabled);
937 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
938}
939
940static const struct file_operations ftrace_profile_fops = {
941 .open = tracing_open_generic,
942 .read = ftrace_profile_read,
943 .write = ftrace_profile_write,
944 .llseek = default_llseek,
945};
946
947/* used to initialize the real stat files */
948static struct tracer_stat function_stats __initdata = {
949 .name = "functions",
950 .stat_start = function_stat_start,
951 .stat_next = function_stat_next,
952 .stat_cmp = function_stat_cmp,
953 .stat_headers = function_stat_headers,
954 .stat_show = function_stat_show
955};
956
957static __init void ftrace_profile_tracefs(struct dentry *d_tracer)
958{
959 struct ftrace_profile_stat *stat;
960 struct dentry *entry;
961 char *name;
962 int ret;
963 int cpu;
964
965 for_each_possible_cpu(cpu) {
966 stat = &per_cpu(ftrace_profile_stats, cpu);
967
968 name = kasprintf(GFP_KERNEL, "function%d", cpu);
969 if (!name) {
970 /*
971 * The files created are permanent, if something happens
972 * we still do not free memory.
973 */
974 WARN(1,
975 "Could not allocate stat file for cpu %d\n",
976 cpu);
977 return;
978 }
979 stat->stat = function_stats;
980 stat->stat.name = name;
981 ret = register_stat_tracer(&stat->stat);
982 if (ret) {
983 WARN(1,
984 "Could not register function stat for cpu %d\n",
985 cpu);
986 kfree(name);
987 return;
988 }
989 }
990
991 entry = tracefs_create_file("function_profile_enabled", 0644,
992 d_tracer, NULL, &ftrace_profile_fops);
993 if (!entry)
994 pr_warn("Could not create tracefs 'function_profile_enabled' entry\n");
995}
996
997#else /* CONFIG_FUNCTION_PROFILER */
998static __init void ftrace_profile_tracefs(struct dentry *d_tracer)
999{
1000}
1001#endif /* CONFIG_FUNCTION_PROFILER */
1002
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001003#ifdef CONFIG_DYNAMIC_FTRACE
1004
1005static struct ftrace_ops *removed_ops;
1006
1007/*
1008 * Set when doing a global update, like enabling all recs or disabling them.
1009 * It is not set when just updating a single ftrace_ops.
1010 */
1011static bool update_all_ops;
1012
1013#ifndef CONFIG_FTRACE_MCOUNT_RECORD
1014# error Dynamic ftrace depends on MCOUNT_RECORD
1015#endif
1016
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001017struct ftrace_func_probe {
1018 struct ftrace_probe_ops *probe_ops;
1019 struct ftrace_ops ops;
1020 struct trace_array *tr;
1021 struct list_head list;
1022 void *data;
1023 int ref;
1024};
1025
1026/*
1027 * We make these constant because no one should touch them,
1028 * but they are used as the default "empty hash", to avoid allocating
1029 * it all the time. These are in a read only section such that if
1030 * anyone does try to modify it, it will cause an exception.
1031 */
1032static const struct hlist_head empty_buckets[1];
1033static const struct ftrace_hash empty_hash = {
1034 .buckets = (struct hlist_head *)empty_buckets,
1035};
1036#define EMPTY_HASH ((struct ftrace_hash *)&empty_hash)
1037
David Brazdil0f672f62019-12-10 10:32:29 +00001038struct ftrace_ops global_ops = {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001039 .func = ftrace_stub,
1040 .local_hash.notrace_hash = EMPTY_HASH,
1041 .local_hash.filter_hash = EMPTY_HASH,
1042 INIT_OPS_HASH(global_ops)
1043 .flags = FTRACE_OPS_FL_RECURSION_SAFE |
1044 FTRACE_OPS_FL_INITIALIZED |
1045 FTRACE_OPS_FL_PID,
1046};
1047
1048/*
1049 * Used by the stack undwinder to know about dynamic ftrace trampolines.
1050 */
1051struct ftrace_ops *ftrace_ops_trampoline(unsigned long addr)
1052{
1053 struct ftrace_ops *op = NULL;
1054
1055 /*
1056 * Some of the ops may be dynamically allocated,
David Brazdil0f672f62019-12-10 10:32:29 +00001057 * they are freed after a synchronize_rcu().
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001058 */
1059 preempt_disable_notrace();
1060
1061 do_for_each_ftrace_op(op, ftrace_ops_list) {
1062 /*
1063 * This is to check for dynamically allocated trampolines.
1064 * Trampolines that are in kernel text will have
1065 * core_kernel_text() return true.
1066 */
1067 if (op->trampoline && op->trampoline_size)
1068 if (addr >= op->trampoline &&
1069 addr < op->trampoline + op->trampoline_size) {
1070 preempt_enable_notrace();
1071 return op;
1072 }
1073 } while_for_each_ftrace_op(op);
1074 preempt_enable_notrace();
1075
1076 return NULL;
1077}
1078
1079/*
1080 * This is used by __kernel_text_address() to return true if the
1081 * address is on a dynamically allocated trampoline that would
1082 * not return true for either core_kernel_text() or
1083 * is_module_text_address().
1084 */
1085bool is_ftrace_trampoline(unsigned long addr)
1086{
1087 return ftrace_ops_trampoline(addr) != NULL;
1088}
1089
1090struct ftrace_page {
1091 struct ftrace_page *next;
1092 struct dyn_ftrace *records;
1093 int index;
1094 int size;
1095};
1096
1097#define ENTRY_SIZE sizeof(struct dyn_ftrace)
1098#define ENTRIES_PER_PAGE (PAGE_SIZE / ENTRY_SIZE)
1099
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001100static struct ftrace_page *ftrace_pages_start;
1101static struct ftrace_page *ftrace_pages;
1102
1103static __always_inline unsigned long
1104ftrace_hash_key(struct ftrace_hash *hash, unsigned long ip)
1105{
1106 if (hash->size_bits > 0)
1107 return hash_long(ip, hash->size_bits);
1108
1109 return 0;
1110}
1111
1112/* Only use this function if ftrace_hash_empty() has already been tested */
1113static __always_inline struct ftrace_func_entry *
1114__ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip)
1115{
1116 unsigned long key;
1117 struct ftrace_func_entry *entry;
1118 struct hlist_head *hhd;
1119
1120 key = ftrace_hash_key(hash, ip);
1121 hhd = &hash->buckets[key];
1122
1123 hlist_for_each_entry_rcu_notrace(entry, hhd, hlist) {
1124 if (entry->ip == ip)
1125 return entry;
1126 }
1127 return NULL;
1128}
1129
1130/**
1131 * ftrace_lookup_ip - Test to see if an ip exists in an ftrace_hash
1132 * @hash: The hash to look at
1133 * @ip: The instruction pointer to test
1134 *
1135 * Search a given @hash to see if a given instruction pointer (@ip)
1136 * exists in it.
1137 *
1138 * Returns the entry that holds the @ip if found. NULL otherwise.
1139 */
1140struct ftrace_func_entry *
1141ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip)
1142{
1143 if (ftrace_hash_empty(hash))
1144 return NULL;
1145
1146 return __ftrace_lookup_ip(hash, ip);
1147}
1148
1149static void __add_hash_entry(struct ftrace_hash *hash,
1150 struct ftrace_func_entry *entry)
1151{
1152 struct hlist_head *hhd;
1153 unsigned long key;
1154
1155 key = ftrace_hash_key(hash, entry->ip);
1156 hhd = &hash->buckets[key];
1157 hlist_add_head(&entry->hlist, hhd);
1158 hash->count++;
1159}
1160
1161static int add_hash_entry(struct ftrace_hash *hash, unsigned long ip)
1162{
1163 struct ftrace_func_entry *entry;
1164
1165 entry = kmalloc(sizeof(*entry), GFP_KERNEL);
1166 if (!entry)
1167 return -ENOMEM;
1168
1169 entry->ip = ip;
1170 __add_hash_entry(hash, entry);
1171
1172 return 0;
1173}
1174
1175static void
1176free_hash_entry(struct ftrace_hash *hash,
1177 struct ftrace_func_entry *entry)
1178{
1179 hlist_del(&entry->hlist);
1180 kfree(entry);
1181 hash->count--;
1182}
1183
1184static void
1185remove_hash_entry(struct ftrace_hash *hash,
1186 struct ftrace_func_entry *entry)
1187{
1188 hlist_del_rcu(&entry->hlist);
1189 hash->count--;
1190}
1191
1192static void ftrace_hash_clear(struct ftrace_hash *hash)
1193{
1194 struct hlist_head *hhd;
1195 struct hlist_node *tn;
1196 struct ftrace_func_entry *entry;
1197 int size = 1 << hash->size_bits;
1198 int i;
1199
1200 if (!hash->count)
1201 return;
1202
1203 for (i = 0; i < size; i++) {
1204 hhd = &hash->buckets[i];
1205 hlist_for_each_entry_safe(entry, tn, hhd, hlist)
1206 free_hash_entry(hash, entry);
1207 }
1208 FTRACE_WARN_ON(hash->count);
1209}
1210
1211static void free_ftrace_mod(struct ftrace_mod_load *ftrace_mod)
1212{
1213 list_del(&ftrace_mod->list);
1214 kfree(ftrace_mod->module);
1215 kfree(ftrace_mod->func);
1216 kfree(ftrace_mod);
1217}
1218
1219static void clear_ftrace_mod_list(struct list_head *head)
1220{
1221 struct ftrace_mod_load *p, *n;
1222
1223 /* stack tracer isn't supported yet */
1224 if (!head)
1225 return;
1226
1227 mutex_lock(&ftrace_lock);
1228 list_for_each_entry_safe(p, n, head, list)
1229 free_ftrace_mod(p);
1230 mutex_unlock(&ftrace_lock);
1231}
1232
1233static void free_ftrace_hash(struct ftrace_hash *hash)
1234{
1235 if (!hash || hash == EMPTY_HASH)
1236 return;
1237 ftrace_hash_clear(hash);
1238 kfree(hash->buckets);
1239 kfree(hash);
1240}
1241
1242static void __free_ftrace_hash_rcu(struct rcu_head *rcu)
1243{
1244 struct ftrace_hash *hash;
1245
1246 hash = container_of(rcu, struct ftrace_hash, rcu);
1247 free_ftrace_hash(hash);
1248}
1249
1250static void free_ftrace_hash_rcu(struct ftrace_hash *hash)
1251{
1252 if (!hash || hash == EMPTY_HASH)
1253 return;
David Brazdil0f672f62019-12-10 10:32:29 +00001254 call_rcu(&hash->rcu, __free_ftrace_hash_rcu);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001255}
1256
1257void ftrace_free_filter(struct ftrace_ops *ops)
1258{
1259 ftrace_ops_init(ops);
1260 free_ftrace_hash(ops->func_hash->filter_hash);
1261 free_ftrace_hash(ops->func_hash->notrace_hash);
1262}
1263
1264static struct ftrace_hash *alloc_ftrace_hash(int size_bits)
1265{
1266 struct ftrace_hash *hash;
1267 int size;
1268
1269 hash = kzalloc(sizeof(*hash), GFP_KERNEL);
1270 if (!hash)
1271 return NULL;
1272
1273 size = 1 << size_bits;
1274 hash->buckets = kcalloc(size, sizeof(*hash->buckets), GFP_KERNEL);
1275
1276 if (!hash->buckets) {
1277 kfree(hash);
1278 return NULL;
1279 }
1280
1281 hash->size_bits = size_bits;
1282
1283 return hash;
1284}
1285
1286
1287static int ftrace_add_mod(struct trace_array *tr,
1288 const char *func, const char *module,
1289 int enable)
1290{
1291 struct ftrace_mod_load *ftrace_mod;
1292 struct list_head *mod_head = enable ? &tr->mod_trace : &tr->mod_notrace;
1293
1294 ftrace_mod = kzalloc(sizeof(*ftrace_mod), GFP_KERNEL);
1295 if (!ftrace_mod)
1296 return -ENOMEM;
1297
1298 ftrace_mod->func = kstrdup(func, GFP_KERNEL);
1299 ftrace_mod->module = kstrdup(module, GFP_KERNEL);
1300 ftrace_mod->enable = enable;
1301
1302 if (!ftrace_mod->func || !ftrace_mod->module)
1303 goto out_free;
1304
1305 list_add(&ftrace_mod->list, mod_head);
1306
1307 return 0;
1308
1309 out_free:
1310 free_ftrace_mod(ftrace_mod);
1311
1312 return -ENOMEM;
1313}
1314
1315static struct ftrace_hash *
1316alloc_and_copy_ftrace_hash(int size_bits, struct ftrace_hash *hash)
1317{
1318 struct ftrace_func_entry *entry;
1319 struct ftrace_hash *new_hash;
1320 int size;
1321 int ret;
1322 int i;
1323
1324 new_hash = alloc_ftrace_hash(size_bits);
1325 if (!new_hash)
1326 return NULL;
1327
1328 if (hash)
1329 new_hash->flags = hash->flags;
1330
1331 /* Empty hash? */
1332 if (ftrace_hash_empty(hash))
1333 return new_hash;
1334
1335 size = 1 << hash->size_bits;
1336 for (i = 0; i < size; i++) {
1337 hlist_for_each_entry(entry, &hash->buckets[i], hlist) {
1338 ret = add_hash_entry(new_hash, entry->ip);
1339 if (ret < 0)
1340 goto free_hash;
1341 }
1342 }
1343
1344 FTRACE_WARN_ON(new_hash->count != hash->count);
1345
1346 return new_hash;
1347
1348 free_hash:
1349 free_ftrace_hash(new_hash);
1350 return NULL;
1351}
1352
1353static void
1354ftrace_hash_rec_disable_modify(struct ftrace_ops *ops, int filter_hash);
1355static void
1356ftrace_hash_rec_enable_modify(struct ftrace_ops *ops, int filter_hash);
1357
1358static int ftrace_hash_ipmodify_update(struct ftrace_ops *ops,
1359 struct ftrace_hash *new_hash);
1360
Olivier Deprez157378f2022-04-04 15:47:50 +02001361static struct ftrace_hash *dup_hash(struct ftrace_hash *src, int size)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001362{
1363 struct ftrace_func_entry *entry;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001364 struct ftrace_hash *new_hash;
Olivier Deprez157378f2022-04-04 15:47:50 +02001365 struct hlist_head *hhd;
1366 struct hlist_node *tn;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001367 int bits = 0;
1368 int i;
1369
1370 /*
Olivier Deprez157378f2022-04-04 15:47:50 +02001371 * Use around half the size (max bit of it), but
1372 * a minimum of 2 is fine (as size of 0 or 1 both give 1 for bits).
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001373 */
Olivier Deprez157378f2022-04-04 15:47:50 +02001374 bits = fls(size / 2);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001375
1376 /* Don't allocate too much */
1377 if (bits > FTRACE_HASH_MAX_BITS)
1378 bits = FTRACE_HASH_MAX_BITS;
1379
1380 new_hash = alloc_ftrace_hash(bits);
1381 if (!new_hash)
1382 return NULL;
1383
1384 new_hash->flags = src->flags;
1385
1386 size = 1 << src->size_bits;
1387 for (i = 0; i < size; i++) {
1388 hhd = &src->buckets[i];
1389 hlist_for_each_entry_safe(entry, tn, hhd, hlist) {
1390 remove_hash_entry(src, entry);
1391 __add_hash_entry(new_hash, entry);
1392 }
1393 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001394 return new_hash;
1395}
1396
Olivier Deprez157378f2022-04-04 15:47:50 +02001397static struct ftrace_hash *
1398__ftrace_hash_move(struct ftrace_hash *src)
1399{
1400 int size = src->count;
1401
1402 /*
1403 * If the new source is empty, just return the empty_hash.
1404 */
1405 if (ftrace_hash_empty(src))
1406 return EMPTY_HASH;
1407
1408 return dup_hash(src, size);
1409}
1410
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001411static int
1412ftrace_hash_move(struct ftrace_ops *ops, int enable,
1413 struct ftrace_hash **dst, struct ftrace_hash *src)
1414{
1415 struct ftrace_hash *new_hash;
1416 int ret;
1417
1418 /* Reject setting notrace hash on IPMODIFY ftrace_ops */
1419 if (ops->flags & FTRACE_OPS_FL_IPMODIFY && !enable)
1420 return -EINVAL;
1421
1422 new_hash = __ftrace_hash_move(src);
1423 if (!new_hash)
1424 return -ENOMEM;
1425
1426 /* Make sure this can be applied if it is IPMODIFY ftrace_ops */
1427 if (enable) {
1428 /* IPMODIFY should be updated only when filter_hash updating */
1429 ret = ftrace_hash_ipmodify_update(ops, new_hash);
1430 if (ret < 0) {
1431 free_ftrace_hash(new_hash);
1432 return ret;
1433 }
1434 }
1435
1436 /*
1437 * Remove the current set, update the hash and add
1438 * them back.
1439 */
1440 ftrace_hash_rec_disable_modify(ops, enable);
1441
1442 rcu_assign_pointer(*dst, new_hash);
1443
1444 ftrace_hash_rec_enable_modify(ops, enable);
1445
1446 return 0;
1447}
1448
1449static bool hash_contains_ip(unsigned long ip,
1450 struct ftrace_ops_hash *hash)
1451{
1452 /*
1453 * The function record is a match if it exists in the filter
Olivier Deprez157378f2022-04-04 15:47:50 +02001454 * hash and not in the notrace hash. Note, an empty hash is
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001455 * considered a match for the filter hash, but an empty
1456 * notrace hash is considered not in the notrace hash.
1457 */
1458 return (ftrace_hash_empty(hash->filter_hash) ||
1459 __ftrace_lookup_ip(hash->filter_hash, ip)) &&
1460 (ftrace_hash_empty(hash->notrace_hash) ||
1461 !__ftrace_lookup_ip(hash->notrace_hash, ip));
1462}
1463
1464/*
1465 * Test the hashes for this ops to see if we want to call
1466 * the ops->func or not.
1467 *
1468 * It's a match if the ip is in the ops->filter_hash or
1469 * the filter_hash does not exist or is empty,
1470 * AND
1471 * the ip is not in the ops->notrace_hash.
1472 *
1473 * This needs to be called with preemption disabled as
David Brazdil0f672f62019-12-10 10:32:29 +00001474 * the hashes are freed with call_rcu().
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001475 */
David Brazdil0f672f62019-12-10 10:32:29 +00001476int
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001477ftrace_ops_test(struct ftrace_ops *ops, unsigned long ip, void *regs)
1478{
1479 struct ftrace_ops_hash hash;
1480 int ret;
1481
1482#ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
1483 /*
1484 * There's a small race when adding ops that the ftrace handler
1485 * that wants regs, may be called without them. We can not
1486 * allow that handler to be called if regs is NULL.
1487 */
1488 if (regs == NULL && (ops->flags & FTRACE_OPS_FL_SAVE_REGS))
1489 return 0;
1490#endif
1491
1492 rcu_assign_pointer(hash.filter_hash, ops->func_hash->filter_hash);
1493 rcu_assign_pointer(hash.notrace_hash, ops->func_hash->notrace_hash);
1494
1495 if (hash_contains_ip(ip, &hash))
1496 ret = 1;
1497 else
1498 ret = 0;
1499
1500 return ret;
1501}
1502
1503/*
1504 * This is a double for. Do not use 'break' to break out of the loop,
1505 * you must use a goto.
1506 */
1507#define do_for_each_ftrace_rec(pg, rec) \
1508 for (pg = ftrace_pages_start; pg; pg = pg->next) { \
1509 int _____i; \
1510 for (_____i = 0; _____i < pg->index; _____i++) { \
1511 rec = &pg->records[_____i];
1512
1513#define while_for_each_ftrace_rec() \
1514 } \
1515 }
1516
1517
1518static int ftrace_cmp_recs(const void *a, const void *b)
1519{
1520 const struct dyn_ftrace *key = a;
1521 const struct dyn_ftrace *rec = b;
1522
1523 if (key->flags < rec->ip)
1524 return -1;
1525 if (key->ip >= rec->ip + MCOUNT_INSN_SIZE)
1526 return 1;
1527 return 0;
1528}
1529
Olivier Deprez157378f2022-04-04 15:47:50 +02001530static struct dyn_ftrace *lookup_rec(unsigned long start, unsigned long end)
1531{
1532 struct ftrace_page *pg;
1533 struct dyn_ftrace *rec = NULL;
1534 struct dyn_ftrace key;
1535
1536 key.ip = start;
1537 key.flags = end; /* overload flags, as it is unsigned long */
1538
1539 for (pg = ftrace_pages_start; pg; pg = pg->next) {
1540 if (end < pg->records[0].ip ||
1541 start >= (pg->records[pg->index - 1].ip + MCOUNT_INSN_SIZE))
1542 continue;
1543 rec = bsearch(&key, pg->records, pg->index,
1544 sizeof(struct dyn_ftrace),
1545 ftrace_cmp_recs);
1546 if (rec)
1547 break;
1548 }
1549 return rec;
1550}
1551
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001552/**
1553 * ftrace_location_range - return the first address of a traced location
1554 * if it touches the given ip range
1555 * @start: start of range to search.
1556 * @end: end of range to search (inclusive). @end points to the last byte
1557 * to check.
1558 *
1559 * Returns rec->ip if the related ftrace location is a least partly within
1560 * the given address range. That is, the first address of the instruction
1561 * that is either a NOP or call to the function tracer. It checks the ftrace
1562 * internal tables to determine if the address belongs or not.
1563 */
1564unsigned long ftrace_location_range(unsigned long start, unsigned long end)
1565{
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001566 struct dyn_ftrace *rec;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001567
Olivier Deprez157378f2022-04-04 15:47:50 +02001568 rec = lookup_rec(start, end);
1569 if (rec)
1570 return rec->ip;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001571
1572 return 0;
1573}
1574
1575/**
1576 * ftrace_location - return true if the ip giving is a traced location
1577 * @ip: the instruction pointer to check
1578 *
1579 * Returns rec->ip if @ip given is a pointer to a ftrace location.
1580 * That is, the instruction that is either a NOP or call to
1581 * the function tracer. It checks the ftrace internal tables to
1582 * determine if the address belongs or not.
1583 */
1584unsigned long ftrace_location(unsigned long ip)
1585{
1586 return ftrace_location_range(ip, ip);
1587}
1588
1589/**
1590 * ftrace_text_reserved - return true if range contains an ftrace location
1591 * @start: start of range to search
1592 * @end: end of range to search (inclusive). @end points to the last byte to check.
1593 *
1594 * Returns 1 if @start and @end contains a ftrace location.
1595 * That is, the instruction that is either a NOP or call to
1596 * the function tracer. It checks the ftrace internal tables to
1597 * determine if the address belongs or not.
1598 */
1599int ftrace_text_reserved(const void *start, const void *end)
1600{
1601 unsigned long ret;
1602
1603 ret = ftrace_location_range((unsigned long)start,
1604 (unsigned long)end);
1605
1606 return (int)!!ret;
1607}
1608
1609/* Test if ops registered to this rec needs regs */
1610static bool test_rec_ops_needs_regs(struct dyn_ftrace *rec)
1611{
1612 struct ftrace_ops *ops;
1613 bool keep_regs = false;
1614
1615 for (ops = ftrace_ops_list;
1616 ops != &ftrace_list_end; ops = ops->next) {
1617 /* pass rec in as regs to have non-NULL val */
1618 if (ftrace_ops_test(ops, rec->ip, rec)) {
1619 if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
1620 keep_regs = true;
1621 break;
1622 }
1623 }
1624 }
1625
1626 return keep_regs;
1627}
1628
David Brazdil0f672f62019-12-10 10:32:29 +00001629static struct ftrace_ops *
1630ftrace_find_tramp_ops_any(struct dyn_ftrace *rec);
1631static struct ftrace_ops *
Olivier Deprez0e641232021-09-23 10:07:05 +02001632ftrace_find_tramp_ops_any_other(struct dyn_ftrace *rec, struct ftrace_ops *op_exclude);
1633static struct ftrace_ops *
David Brazdil0f672f62019-12-10 10:32:29 +00001634ftrace_find_tramp_ops_next(struct dyn_ftrace *rec, struct ftrace_ops *ops);
1635
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001636static bool __ftrace_hash_rec_update(struct ftrace_ops *ops,
1637 int filter_hash,
1638 bool inc)
1639{
1640 struct ftrace_hash *hash;
1641 struct ftrace_hash *other_hash;
1642 struct ftrace_page *pg;
1643 struct dyn_ftrace *rec;
1644 bool update = false;
1645 int count = 0;
1646 int all = false;
1647
1648 /* Only update if the ops has been registered */
1649 if (!(ops->flags & FTRACE_OPS_FL_ENABLED))
1650 return false;
1651
1652 /*
1653 * In the filter_hash case:
1654 * If the count is zero, we update all records.
1655 * Otherwise we just update the items in the hash.
1656 *
1657 * In the notrace_hash case:
1658 * We enable the update in the hash.
1659 * As disabling notrace means enabling the tracing,
1660 * and enabling notrace means disabling, the inc variable
1661 * gets inversed.
1662 */
1663 if (filter_hash) {
1664 hash = ops->func_hash->filter_hash;
1665 other_hash = ops->func_hash->notrace_hash;
1666 if (ftrace_hash_empty(hash))
1667 all = true;
1668 } else {
1669 inc = !inc;
1670 hash = ops->func_hash->notrace_hash;
1671 other_hash = ops->func_hash->filter_hash;
1672 /*
1673 * If the notrace hash has no items,
1674 * then there's nothing to do.
1675 */
1676 if (ftrace_hash_empty(hash))
1677 return false;
1678 }
1679
1680 do_for_each_ftrace_rec(pg, rec) {
1681 int in_other_hash = 0;
1682 int in_hash = 0;
1683 int match = 0;
1684
1685 if (rec->flags & FTRACE_FL_DISABLED)
1686 continue;
1687
1688 if (all) {
1689 /*
1690 * Only the filter_hash affects all records.
1691 * Update if the record is not in the notrace hash.
1692 */
1693 if (!other_hash || !ftrace_lookup_ip(other_hash, rec->ip))
1694 match = 1;
1695 } else {
1696 in_hash = !!ftrace_lookup_ip(hash, rec->ip);
1697 in_other_hash = !!ftrace_lookup_ip(other_hash, rec->ip);
1698
1699 /*
1700 * If filter_hash is set, we want to match all functions
1701 * that are in the hash but not in the other hash.
1702 *
1703 * If filter_hash is not set, then we are decrementing.
1704 * That means we match anything that is in the hash
1705 * and also in the other_hash. That is, we need to turn
1706 * off functions in the other hash because they are disabled
1707 * by this hash.
1708 */
1709 if (filter_hash && in_hash && !in_other_hash)
1710 match = 1;
1711 else if (!filter_hash && in_hash &&
1712 (in_other_hash || ftrace_hash_empty(other_hash)))
1713 match = 1;
1714 }
1715 if (!match)
1716 continue;
1717
1718 if (inc) {
1719 rec->flags++;
1720 if (FTRACE_WARN_ON(ftrace_rec_count(rec) == FTRACE_REF_MAX))
1721 return false;
1722
Olivier Deprez157378f2022-04-04 15:47:50 +02001723 if (ops->flags & FTRACE_OPS_FL_DIRECT)
1724 rec->flags |= FTRACE_FL_DIRECT;
1725
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001726 /*
1727 * If there's only a single callback registered to a
1728 * function, and the ops has a trampoline registered
1729 * for it, then we can call it directly.
1730 */
1731 if (ftrace_rec_count(rec) == 1 && ops->trampoline)
1732 rec->flags |= FTRACE_FL_TRAMP;
1733 else
1734 /*
1735 * If we are adding another function callback
1736 * to this function, and the previous had a
1737 * custom trampoline in use, then we need to go
1738 * back to the default trampoline.
1739 */
1740 rec->flags &= ~FTRACE_FL_TRAMP;
1741
1742 /*
1743 * If any ops wants regs saved for this function
1744 * then all ops will get saved regs.
1745 */
1746 if (ops->flags & FTRACE_OPS_FL_SAVE_REGS)
1747 rec->flags |= FTRACE_FL_REGS;
1748 } else {
1749 if (FTRACE_WARN_ON(ftrace_rec_count(rec) == 0))
1750 return false;
1751 rec->flags--;
1752
1753 /*
Olivier Deprez157378f2022-04-04 15:47:50 +02001754 * Only the internal direct_ops should have the
1755 * DIRECT flag set. Thus, if it is removing a
1756 * function, then that function should no longer
1757 * be direct.
1758 */
1759 if (ops->flags & FTRACE_OPS_FL_DIRECT)
1760 rec->flags &= ~FTRACE_FL_DIRECT;
1761
1762 /*
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001763 * If the rec had REGS enabled and the ops that is
1764 * being removed had REGS set, then see if there is
1765 * still any ops for this record that wants regs.
1766 * If not, we can stop recording them.
1767 */
1768 if (ftrace_rec_count(rec) > 0 &&
1769 rec->flags & FTRACE_FL_REGS &&
1770 ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
1771 if (!test_rec_ops_needs_regs(rec))
1772 rec->flags &= ~FTRACE_FL_REGS;
1773 }
1774
1775 /*
David Brazdil0f672f62019-12-10 10:32:29 +00001776 * The TRAMP needs to be set only if rec count
1777 * is decremented to one, and the ops that is
1778 * left has a trampoline. As TRAMP can only be
1779 * enabled if there is only a single ops attached
1780 * to it.
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001781 */
David Brazdil0f672f62019-12-10 10:32:29 +00001782 if (ftrace_rec_count(rec) == 1 &&
Olivier Deprez0e641232021-09-23 10:07:05 +02001783 ftrace_find_tramp_ops_any_other(rec, ops))
David Brazdil0f672f62019-12-10 10:32:29 +00001784 rec->flags |= FTRACE_FL_TRAMP;
1785 else
1786 rec->flags &= ~FTRACE_FL_TRAMP;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001787
1788 /*
1789 * flags will be cleared in ftrace_check_record()
1790 * if rec count is zero.
1791 */
1792 }
1793 count++;
1794
1795 /* Must match FTRACE_UPDATE_CALLS in ftrace_modify_all_code() */
David Brazdil0f672f62019-12-10 10:32:29 +00001796 update |= ftrace_test_record(rec, true) != FTRACE_UPDATE_IGNORE;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001797
1798 /* Shortcut, if we handled all records, we are done. */
1799 if (!all && count == hash->count)
1800 return update;
1801 } while_for_each_ftrace_rec();
1802
1803 return update;
1804}
1805
1806static bool ftrace_hash_rec_disable(struct ftrace_ops *ops,
1807 int filter_hash)
1808{
1809 return __ftrace_hash_rec_update(ops, filter_hash, 0);
1810}
1811
1812static bool ftrace_hash_rec_enable(struct ftrace_ops *ops,
1813 int filter_hash)
1814{
1815 return __ftrace_hash_rec_update(ops, filter_hash, 1);
1816}
1817
1818static void ftrace_hash_rec_update_modify(struct ftrace_ops *ops,
1819 int filter_hash, int inc)
1820{
1821 struct ftrace_ops *op;
1822
1823 __ftrace_hash_rec_update(ops, filter_hash, inc);
1824
1825 if (ops->func_hash != &global_ops.local_hash)
1826 return;
1827
1828 /*
1829 * If the ops shares the global_ops hash, then we need to update
1830 * all ops that are enabled and use this hash.
1831 */
1832 do_for_each_ftrace_op(op, ftrace_ops_list) {
1833 /* Already done */
1834 if (op == ops)
1835 continue;
1836 if (op->func_hash == &global_ops.local_hash)
1837 __ftrace_hash_rec_update(op, filter_hash, inc);
1838 } while_for_each_ftrace_op(op);
1839}
1840
1841static void ftrace_hash_rec_disable_modify(struct ftrace_ops *ops,
1842 int filter_hash)
1843{
1844 ftrace_hash_rec_update_modify(ops, filter_hash, 0);
1845}
1846
1847static void ftrace_hash_rec_enable_modify(struct ftrace_ops *ops,
1848 int filter_hash)
1849{
1850 ftrace_hash_rec_update_modify(ops, filter_hash, 1);
1851}
1852
1853/*
1854 * Try to update IPMODIFY flag on each ftrace_rec. Return 0 if it is OK
1855 * or no-needed to update, -EBUSY if it detects a conflict of the flag
1856 * on a ftrace_rec, and -EINVAL if the new_hash tries to trace all recs.
1857 * Note that old_hash and new_hash has below meanings
1858 * - If the hash is NULL, it hits all recs (if IPMODIFY is set, this is rejected)
1859 * - If the hash is EMPTY_HASH, it hits nothing
1860 * - Anything else hits the recs which match the hash entries.
1861 */
1862static int __ftrace_hash_update_ipmodify(struct ftrace_ops *ops,
1863 struct ftrace_hash *old_hash,
1864 struct ftrace_hash *new_hash)
1865{
1866 struct ftrace_page *pg;
1867 struct dyn_ftrace *rec, *end = NULL;
1868 int in_old, in_new;
1869
1870 /* Only update if the ops has been registered */
1871 if (!(ops->flags & FTRACE_OPS_FL_ENABLED))
1872 return 0;
1873
1874 if (!(ops->flags & FTRACE_OPS_FL_IPMODIFY))
1875 return 0;
1876
1877 /*
1878 * Since the IPMODIFY is a very address sensitive action, we do not
1879 * allow ftrace_ops to set all functions to new hash.
1880 */
1881 if (!new_hash || !old_hash)
1882 return -EINVAL;
1883
1884 /* Update rec->flags */
1885 do_for_each_ftrace_rec(pg, rec) {
1886
1887 if (rec->flags & FTRACE_FL_DISABLED)
1888 continue;
1889
1890 /* We need to update only differences of filter_hash */
1891 in_old = !!ftrace_lookup_ip(old_hash, rec->ip);
1892 in_new = !!ftrace_lookup_ip(new_hash, rec->ip);
1893 if (in_old == in_new)
1894 continue;
1895
1896 if (in_new) {
1897 /* New entries must ensure no others are using it */
1898 if (rec->flags & FTRACE_FL_IPMODIFY)
1899 goto rollback;
1900 rec->flags |= FTRACE_FL_IPMODIFY;
1901 } else /* Removed entry */
1902 rec->flags &= ~FTRACE_FL_IPMODIFY;
1903 } while_for_each_ftrace_rec();
1904
1905 return 0;
1906
1907rollback:
1908 end = rec;
1909
1910 /* Roll back what we did above */
1911 do_for_each_ftrace_rec(pg, rec) {
1912
1913 if (rec->flags & FTRACE_FL_DISABLED)
1914 continue;
1915
1916 if (rec == end)
1917 goto err_out;
1918
1919 in_old = !!ftrace_lookup_ip(old_hash, rec->ip);
1920 in_new = !!ftrace_lookup_ip(new_hash, rec->ip);
1921 if (in_old == in_new)
1922 continue;
1923
1924 if (in_new)
1925 rec->flags &= ~FTRACE_FL_IPMODIFY;
1926 else
1927 rec->flags |= FTRACE_FL_IPMODIFY;
1928 } while_for_each_ftrace_rec();
1929
1930err_out:
1931 return -EBUSY;
1932}
1933
1934static int ftrace_hash_ipmodify_enable(struct ftrace_ops *ops)
1935{
1936 struct ftrace_hash *hash = ops->func_hash->filter_hash;
1937
1938 if (ftrace_hash_empty(hash))
1939 hash = NULL;
1940
1941 return __ftrace_hash_update_ipmodify(ops, EMPTY_HASH, hash);
1942}
1943
1944/* Disabling always succeeds */
1945static void ftrace_hash_ipmodify_disable(struct ftrace_ops *ops)
1946{
1947 struct ftrace_hash *hash = ops->func_hash->filter_hash;
1948
1949 if (ftrace_hash_empty(hash))
1950 hash = NULL;
1951
1952 __ftrace_hash_update_ipmodify(ops, hash, EMPTY_HASH);
1953}
1954
1955static int ftrace_hash_ipmodify_update(struct ftrace_ops *ops,
1956 struct ftrace_hash *new_hash)
1957{
1958 struct ftrace_hash *old_hash = ops->func_hash->filter_hash;
1959
1960 if (ftrace_hash_empty(old_hash))
1961 old_hash = NULL;
1962
1963 if (ftrace_hash_empty(new_hash))
1964 new_hash = NULL;
1965
1966 return __ftrace_hash_update_ipmodify(ops, old_hash, new_hash);
1967}
1968
1969static void print_ip_ins(const char *fmt, const unsigned char *p)
1970{
Olivier Deprez0e641232021-09-23 10:07:05 +02001971 char ins[MCOUNT_INSN_SIZE];
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001972 int i;
1973
Olivier Deprez157378f2022-04-04 15:47:50 +02001974 if (copy_from_kernel_nofault(ins, p, MCOUNT_INSN_SIZE)) {
Olivier Deprez0e641232021-09-23 10:07:05 +02001975 printk(KERN_CONT "%s[FAULT] %px\n", fmt, p);
1976 return;
1977 }
1978
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001979 printk(KERN_CONT "%s", fmt);
1980
1981 for (i = 0; i < MCOUNT_INSN_SIZE; i++)
Olivier Deprez0e641232021-09-23 10:07:05 +02001982 printk(KERN_CONT "%s%02x", i ? ":" : "", ins[i]);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001983}
1984
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001985enum ftrace_bug_type ftrace_bug_type;
1986const void *ftrace_expected;
1987
1988static void print_bug_type(void)
1989{
1990 switch (ftrace_bug_type) {
1991 case FTRACE_BUG_UNKNOWN:
1992 break;
1993 case FTRACE_BUG_INIT:
1994 pr_info("Initializing ftrace call sites\n");
1995 break;
1996 case FTRACE_BUG_NOP:
1997 pr_info("Setting ftrace call site to NOP\n");
1998 break;
1999 case FTRACE_BUG_CALL:
2000 pr_info("Setting ftrace call site to call ftrace function\n");
2001 break;
2002 case FTRACE_BUG_UPDATE:
2003 pr_info("Updating ftrace call site to call a different ftrace function\n");
2004 break;
2005 }
2006}
2007
2008/**
2009 * ftrace_bug - report and shutdown function tracer
2010 * @failed: The failed type (EFAULT, EINVAL, EPERM)
2011 * @rec: The record that failed
2012 *
2013 * The arch code that enables or disables the function tracing
2014 * can call ftrace_bug() when it has detected a problem in
2015 * modifying the code. @failed should be one of either:
2016 * EFAULT - if the problem happens on reading the @ip address
2017 * EINVAL - if what is read at @ip is not what was expected
David Brazdil0f672f62019-12-10 10:32:29 +00002018 * EPERM - if the problem happens on writing to the @ip address
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002019 */
2020void ftrace_bug(int failed, struct dyn_ftrace *rec)
2021{
2022 unsigned long ip = rec ? rec->ip : 0;
2023
Olivier Deprez157378f2022-04-04 15:47:50 +02002024 pr_info("------------[ ftrace bug ]------------\n");
2025
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002026 switch (failed) {
2027 case -EFAULT:
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002028 pr_info("ftrace faulted on modifying ");
Olivier Deprez157378f2022-04-04 15:47:50 +02002029 print_ip_sym(KERN_INFO, ip);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002030 break;
2031 case -EINVAL:
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002032 pr_info("ftrace failed to modify ");
Olivier Deprez157378f2022-04-04 15:47:50 +02002033 print_ip_sym(KERN_INFO, ip);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002034 print_ip_ins(" actual: ", (unsigned char *)ip);
2035 pr_cont("\n");
2036 if (ftrace_expected) {
2037 print_ip_ins(" expected: ", ftrace_expected);
2038 pr_cont("\n");
2039 }
2040 break;
2041 case -EPERM:
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002042 pr_info("ftrace faulted on writing ");
Olivier Deprez157378f2022-04-04 15:47:50 +02002043 print_ip_sym(KERN_INFO, ip);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002044 break;
2045 default:
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002046 pr_info("ftrace faulted on unknown error ");
Olivier Deprez157378f2022-04-04 15:47:50 +02002047 print_ip_sym(KERN_INFO, ip);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002048 }
2049 print_bug_type();
2050 if (rec) {
2051 struct ftrace_ops *ops = NULL;
2052
2053 pr_info("ftrace record flags: %lx\n", rec->flags);
2054 pr_cont(" (%ld)%s", ftrace_rec_count(rec),
2055 rec->flags & FTRACE_FL_REGS ? " R" : " ");
2056 if (rec->flags & FTRACE_FL_TRAMP_EN) {
2057 ops = ftrace_find_tramp_ops_any(rec);
2058 if (ops) {
2059 do {
2060 pr_cont("\ttramp: %pS (%pS)",
2061 (void *)ops->trampoline,
2062 (void *)ops->func);
2063 ops = ftrace_find_tramp_ops_next(rec, ops);
2064 } while (ops);
2065 } else
2066 pr_cont("\ttramp: ERROR!");
2067
2068 }
2069 ip = ftrace_get_addr_curr(rec);
2070 pr_cont("\n expected tramp: %lx\n", ip);
2071 }
Olivier Deprez157378f2022-04-04 15:47:50 +02002072
2073 FTRACE_WARN_ON_ONCE(1);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002074}
2075
David Brazdil0f672f62019-12-10 10:32:29 +00002076static int ftrace_check_record(struct dyn_ftrace *rec, bool enable, bool update)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002077{
2078 unsigned long flag = 0UL;
2079
2080 ftrace_bug_type = FTRACE_BUG_UNKNOWN;
2081
2082 if (rec->flags & FTRACE_FL_DISABLED)
2083 return FTRACE_UPDATE_IGNORE;
2084
2085 /*
2086 * If we are updating calls:
2087 *
2088 * If the record has a ref count, then we need to enable it
2089 * because someone is using it.
2090 *
2091 * Otherwise we make sure its disabled.
2092 *
2093 * If we are disabling calls, then disable all records that
2094 * are enabled.
2095 */
2096 if (enable && ftrace_rec_count(rec))
2097 flag = FTRACE_FL_ENABLED;
2098
2099 /*
2100 * If enabling and the REGS flag does not match the REGS_EN, or
2101 * the TRAMP flag doesn't match the TRAMP_EN, then do not ignore
2102 * this record. Set flags to fail the compare against ENABLED.
Olivier Deprez157378f2022-04-04 15:47:50 +02002103 * Same for direct calls.
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002104 */
2105 if (flag) {
Olivier Deprez157378f2022-04-04 15:47:50 +02002106 if (!(rec->flags & FTRACE_FL_REGS) !=
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002107 !(rec->flags & FTRACE_FL_REGS_EN))
2108 flag |= FTRACE_FL_REGS;
2109
Olivier Deprez157378f2022-04-04 15:47:50 +02002110 if (!(rec->flags & FTRACE_FL_TRAMP) !=
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002111 !(rec->flags & FTRACE_FL_TRAMP_EN))
2112 flag |= FTRACE_FL_TRAMP;
Olivier Deprez157378f2022-04-04 15:47:50 +02002113
2114 /*
2115 * Direct calls are special, as count matters.
2116 * We must test the record for direct, if the
2117 * DIRECT and DIRECT_EN do not match, but only
2118 * if the count is 1. That's because, if the
2119 * count is something other than one, we do not
2120 * want the direct enabled (it will be done via the
2121 * direct helper). But if DIRECT_EN is set, and
2122 * the count is not one, we need to clear it.
2123 */
2124 if (ftrace_rec_count(rec) == 1) {
2125 if (!(rec->flags & FTRACE_FL_DIRECT) !=
2126 !(rec->flags & FTRACE_FL_DIRECT_EN))
2127 flag |= FTRACE_FL_DIRECT;
2128 } else if (rec->flags & FTRACE_FL_DIRECT_EN) {
2129 flag |= FTRACE_FL_DIRECT;
2130 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002131 }
2132
2133 /* If the state of this record hasn't changed, then do nothing */
2134 if ((rec->flags & FTRACE_FL_ENABLED) == flag)
2135 return FTRACE_UPDATE_IGNORE;
2136
2137 if (flag) {
2138 /* Save off if rec is being enabled (for return value) */
2139 flag ^= rec->flags & FTRACE_FL_ENABLED;
2140
2141 if (update) {
2142 rec->flags |= FTRACE_FL_ENABLED;
2143 if (flag & FTRACE_FL_REGS) {
2144 if (rec->flags & FTRACE_FL_REGS)
2145 rec->flags |= FTRACE_FL_REGS_EN;
2146 else
2147 rec->flags &= ~FTRACE_FL_REGS_EN;
2148 }
2149 if (flag & FTRACE_FL_TRAMP) {
2150 if (rec->flags & FTRACE_FL_TRAMP)
2151 rec->flags |= FTRACE_FL_TRAMP_EN;
2152 else
2153 rec->flags &= ~FTRACE_FL_TRAMP_EN;
2154 }
Olivier Deprez157378f2022-04-04 15:47:50 +02002155 if (flag & FTRACE_FL_DIRECT) {
2156 /*
2157 * If there's only one user (direct_ops helper)
2158 * then we can call the direct function
2159 * directly (no ftrace trampoline).
2160 */
2161 if (ftrace_rec_count(rec) == 1) {
2162 if (rec->flags & FTRACE_FL_DIRECT)
2163 rec->flags |= FTRACE_FL_DIRECT_EN;
2164 else
2165 rec->flags &= ~FTRACE_FL_DIRECT_EN;
2166 } else {
2167 /*
2168 * Can only call directly if there's
2169 * only one callback to the function.
2170 */
2171 rec->flags &= ~FTRACE_FL_DIRECT_EN;
2172 }
2173 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002174 }
2175
2176 /*
2177 * If this record is being updated from a nop, then
2178 * return UPDATE_MAKE_CALL.
2179 * Otherwise,
2180 * return UPDATE_MODIFY_CALL to tell the caller to convert
2181 * from the save regs, to a non-save regs function or
2182 * vice versa, or from a trampoline call.
2183 */
2184 if (flag & FTRACE_FL_ENABLED) {
2185 ftrace_bug_type = FTRACE_BUG_CALL;
2186 return FTRACE_UPDATE_MAKE_CALL;
2187 }
2188
2189 ftrace_bug_type = FTRACE_BUG_UPDATE;
2190 return FTRACE_UPDATE_MODIFY_CALL;
2191 }
2192
2193 if (update) {
2194 /* If there's no more users, clear all flags */
2195 if (!ftrace_rec_count(rec))
2196 rec->flags = 0;
2197 else
2198 /*
2199 * Just disable the record, but keep the ops TRAMP
2200 * and REGS states. The _EN flags must be disabled though.
2201 */
2202 rec->flags &= ~(FTRACE_FL_ENABLED | FTRACE_FL_TRAMP_EN |
Olivier Deprez157378f2022-04-04 15:47:50 +02002203 FTRACE_FL_REGS_EN | FTRACE_FL_DIRECT_EN);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002204 }
2205
2206 ftrace_bug_type = FTRACE_BUG_NOP;
2207 return FTRACE_UPDATE_MAKE_NOP;
2208}
2209
2210/**
2211 * ftrace_update_record, set a record that now is tracing or not
2212 * @rec: the record to update
David Brazdil0f672f62019-12-10 10:32:29 +00002213 * @enable: set to true if the record is tracing, false to force disable
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002214 *
2215 * The records that represent all functions that can be traced need
2216 * to be updated when tracing has been enabled.
2217 */
David Brazdil0f672f62019-12-10 10:32:29 +00002218int ftrace_update_record(struct dyn_ftrace *rec, bool enable)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002219{
David Brazdil0f672f62019-12-10 10:32:29 +00002220 return ftrace_check_record(rec, enable, true);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002221}
2222
2223/**
2224 * ftrace_test_record, check if the record has been enabled or not
2225 * @rec: the record to test
David Brazdil0f672f62019-12-10 10:32:29 +00002226 * @enable: set to true to check if enabled, false if it is disabled
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002227 *
2228 * The arch code may need to test if a record is already set to
2229 * tracing to determine how to modify the function code that it
2230 * represents.
2231 */
David Brazdil0f672f62019-12-10 10:32:29 +00002232int ftrace_test_record(struct dyn_ftrace *rec, bool enable)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002233{
David Brazdil0f672f62019-12-10 10:32:29 +00002234 return ftrace_check_record(rec, enable, false);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002235}
2236
2237static struct ftrace_ops *
2238ftrace_find_tramp_ops_any(struct dyn_ftrace *rec)
2239{
2240 struct ftrace_ops *op;
2241 unsigned long ip = rec->ip;
2242
2243 do_for_each_ftrace_op(op, ftrace_ops_list) {
2244
2245 if (!op->trampoline)
2246 continue;
2247
2248 if (hash_contains_ip(ip, op->func_hash))
2249 return op;
2250 } while_for_each_ftrace_op(op);
2251
2252 return NULL;
2253}
2254
2255static struct ftrace_ops *
Olivier Deprez0e641232021-09-23 10:07:05 +02002256ftrace_find_tramp_ops_any_other(struct dyn_ftrace *rec, struct ftrace_ops *op_exclude)
2257{
2258 struct ftrace_ops *op;
2259 unsigned long ip = rec->ip;
2260
2261 do_for_each_ftrace_op(op, ftrace_ops_list) {
2262
2263 if (op == op_exclude || !op->trampoline)
2264 continue;
2265
2266 if (hash_contains_ip(ip, op->func_hash))
2267 return op;
2268 } while_for_each_ftrace_op(op);
2269
2270 return NULL;
2271}
2272
2273static struct ftrace_ops *
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002274ftrace_find_tramp_ops_next(struct dyn_ftrace *rec,
2275 struct ftrace_ops *op)
2276{
2277 unsigned long ip = rec->ip;
2278
2279 while_for_each_ftrace_op(op) {
2280
2281 if (!op->trampoline)
2282 continue;
2283
2284 if (hash_contains_ip(ip, op->func_hash))
2285 return op;
Olivier Deprez157378f2022-04-04 15:47:50 +02002286 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002287
2288 return NULL;
2289}
2290
2291static struct ftrace_ops *
2292ftrace_find_tramp_ops_curr(struct dyn_ftrace *rec)
2293{
2294 struct ftrace_ops *op;
2295 unsigned long ip = rec->ip;
2296
2297 /*
2298 * Need to check removed ops first.
2299 * If they are being removed, and this rec has a tramp,
2300 * and this rec is in the ops list, then it would be the
2301 * one with the tramp.
2302 */
2303 if (removed_ops) {
2304 if (hash_contains_ip(ip, &removed_ops->old_hash))
2305 return removed_ops;
2306 }
2307
2308 /*
2309 * Need to find the current trampoline for a rec.
2310 * Now, a trampoline is only attached to a rec if there
2311 * was a single 'ops' attached to it. But this can be called
2312 * when we are adding another op to the rec or removing the
2313 * current one. Thus, if the op is being added, we can
2314 * ignore it because it hasn't attached itself to the rec
2315 * yet.
2316 *
2317 * If an ops is being modified (hooking to different functions)
2318 * then we don't care about the new functions that are being
2319 * added, just the old ones (that are probably being removed).
2320 *
2321 * If we are adding an ops to a function that already is using
2322 * a trampoline, it needs to be removed (trampolines are only
2323 * for single ops connected), then an ops that is not being
2324 * modified also needs to be checked.
2325 */
2326 do_for_each_ftrace_op(op, ftrace_ops_list) {
2327
2328 if (!op->trampoline)
2329 continue;
2330
2331 /*
2332 * If the ops is being added, it hasn't gotten to
2333 * the point to be removed from this tree yet.
2334 */
2335 if (op->flags & FTRACE_OPS_FL_ADDING)
2336 continue;
2337
2338
2339 /*
2340 * If the ops is being modified and is in the old
2341 * hash, then it is probably being removed from this
2342 * function.
2343 */
2344 if ((op->flags & FTRACE_OPS_FL_MODIFYING) &&
2345 hash_contains_ip(ip, &op->old_hash))
2346 return op;
2347 /*
2348 * If the ops is not being added or modified, and it's
2349 * in its normal filter hash, then this must be the one
2350 * we want!
2351 */
2352 if (!(op->flags & FTRACE_OPS_FL_MODIFYING) &&
2353 hash_contains_ip(ip, op->func_hash))
2354 return op;
2355
2356 } while_for_each_ftrace_op(op);
2357
2358 return NULL;
2359}
2360
2361static struct ftrace_ops *
2362ftrace_find_tramp_ops_new(struct dyn_ftrace *rec)
2363{
2364 struct ftrace_ops *op;
2365 unsigned long ip = rec->ip;
2366
2367 do_for_each_ftrace_op(op, ftrace_ops_list) {
2368 /* pass rec in as regs to have non-NULL val */
2369 if (hash_contains_ip(ip, op->func_hash))
2370 return op;
2371 } while_for_each_ftrace_op(op);
2372
2373 return NULL;
2374}
2375
Olivier Deprez157378f2022-04-04 15:47:50 +02002376#ifdef CONFIG_DYNAMIC_FTRACE_WITH_DIRECT_CALLS
2377/* Protected by rcu_tasks for reading, and direct_mutex for writing */
2378static struct ftrace_hash *direct_functions = EMPTY_HASH;
2379static DEFINE_MUTEX(direct_mutex);
2380int ftrace_direct_func_count;
2381
2382/*
2383 * Search the direct_functions hash to see if the given instruction pointer
2384 * has a direct caller attached to it.
2385 */
2386unsigned long ftrace_find_rec_direct(unsigned long ip)
2387{
2388 struct ftrace_func_entry *entry;
2389
2390 entry = __ftrace_lookup_ip(direct_functions, ip);
2391 if (!entry)
2392 return 0;
2393
2394 return entry->direct;
2395}
2396
2397static void call_direct_funcs(unsigned long ip, unsigned long pip,
2398 struct ftrace_ops *ops, struct pt_regs *regs)
2399{
2400 unsigned long addr;
2401
2402 addr = ftrace_find_rec_direct(ip);
2403 if (!addr)
2404 return;
2405
2406 arch_ftrace_set_direct_caller(regs, addr);
2407}
2408
2409struct ftrace_ops direct_ops = {
2410 .func = call_direct_funcs,
2411 .flags = FTRACE_OPS_FL_IPMODIFY | FTRACE_OPS_FL_RECURSION_SAFE
2412 | FTRACE_OPS_FL_DIRECT | FTRACE_OPS_FL_SAVE_REGS
2413 | FTRACE_OPS_FL_PERMANENT,
2414 /*
2415 * By declaring the main trampoline as this trampoline
2416 * it will never have one allocated for it. Allocated
2417 * trampolines should not call direct functions.
2418 * The direct_ops should only be called by the builtin
2419 * ftrace_regs_caller trampoline.
2420 */
2421 .trampoline = FTRACE_REGS_ADDR,
2422};
2423#endif /* CONFIG_DYNAMIC_FTRACE_WITH_DIRECT_CALLS */
2424
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002425/**
2426 * ftrace_get_addr_new - Get the call address to set to
2427 * @rec: The ftrace record descriptor
2428 *
2429 * If the record has the FTRACE_FL_REGS set, that means that it
2430 * wants to convert to a callback that saves all regs. If FTRACE_FL_REGS
Olivier Deprez157378f2022-04-04 15:47:50 +02002431 * is not set, then it wants to convert to the normal callback.
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002432 *
2433 * Returns the address of the trampoline to set to
2434 */
2435unsigned long ftrace_get_addr_new(struct dyn_ftrace *rec)
2436{
2437 struct ftrace_ops *ops;
Olivier Deprez157378f2022-04-04 15:47:50 +02002438 unsigned long addr;
2439
2440 if ((rec->flags & FTRACE_FL_DIRECT) &&
2441 (ftrace_rec_count(rec) == 1)) {
2442 addr = ftrace_find_rec_direct(rec->ip);
2443 if (addr)
2444 return addr;
2445 WARN_ON_ONCE(1);
2446 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002447
2448 /* Trampolines take precedence over regs */
2449 if (rec->flags & FTRACE_FL_TRAMP) {
2450 ops = ftrace_find_tramp_ops_new(rec);
2451 if (FTRACE_WARN_ON(!ops || !ops->trampoline)) {
2452 pr_warn("Bad trampoline accounting at: %p (%pS) (%lx)\n",
2453 (void *)rec->ip, (void *)rec->ip, rec->flags);
2454 /* Ftrace is shutting down, return anything */
2455 return (unsigned long)FTRACE_ADDR;
2456 }
2457 return ops->trampoline;
2458 }
2459
2460 if (rec->flags & FTRACE_FL_REGS)
2461 return (unsigned long)FTRACE_REGS_ADDR;
2462 else
2463 return (unsigned long)FTRACE_ADDR;
2464}
2465
2466/**
2467 * ftrace_get_addr_curr - Get the call address that is already there
2468 * @rec: The ftrace record descriptor
2469 *
2470 * The FTRACE_FL_REGS_EN is set when the record already points to
2471 * a function that saves all the regs. Basically the '_EN' version
2472 * represents the current state of the function.
2473 *
2474 * Returns the address of the trampoline that is currently being called
2475 */
2476unsigned long ftrace_get_addr_curr(struct dyn_ftrace *rec)
2477{
2478 struct ftrace_ops *ops;
Olivier Deprez157378f2022-04-04 15:47:50 +02002479 unsigned long addr;
2480
2481 /* Direct calls take precedence over trampolines */
2482 if (rec->flags & FTRACE_FL_DIRECT_EN) {
2483 addr = ftrace_find_rec_direct(rec->ip);
2484 if (addr)
2485 return addr;
2486 WARN_ON_ONCE(1);
2487 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002488
2489 /* Trampolines take precedence over regs */
2490 if (rec->flags & FTRACE_FL_TRAMP_EN) {
2491 ops = ftrace_find_tramp_ops_curr(rec);
2492 if (FTRACE_WARN_ON(!ops)) {
2493 pr_warn("Bad trampoline accounting at: %p (%pS)\n",
2494 (void *)rec->ip, (void *)rec->ip);
2495 /* Ftrace is shutting down, return anything */
2496 return (unsigned long)FTRACE_ADDR;
2497 }
2498 return ops->trampoline;
2499 }
2500
2501 if (rec->flags & FTRACE_FL_REGS_EN)
2502 return (unsigned long)FTRACE_REGS_ADDR;
2503 else
2504 return (unsigned long)FTRACE_ADDR;
2505}
2506
2507static int
David Brazdil0f672f62019-12-10 10:32:29 +00002508__ftrace_replace_code(struct dyn_ftrace *rec, bool enable)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002509{
2510 unsigned long ftrace_old_addr;
2511 unsigned long ftrace_addr;
2512 int ret;
2513
2514 ftrace_addr = ftrace_get_addr_new(rec);
2515
2516 /* This needs to be done before we call ftrace_update_record */
2517 ftrace_old_addr = ftrace_get_addr_curr(rec);
2518
2519 ret = ftrace_update_record(rec, enable);
2520
2521 ftrace_bug_type = FTRACE_BUG_UNKNOWN;
2522
2523 switch (ret) {
2524 case FTRACE_UPDATE_IGNORE:
2525 return 0;
2526
2527 case FTRACE_UPDATE_MAKE_CALL:
2528 ftrace_bug_type = FTRACE_BUG_CALL;
2529 return ftrace_make_call(rec, ftrace_addr);
2530
2531 case FTRACE_UPDATE_MAKE_NOP:
2532 ftrace_bug_type = FTRACE_BUG_NOP;
2533 return ftrace_make_nop(NULL, rec, ftrace_old_addr);
2534
2535 case FTRACE_UPDATE_MODIFY_CALL:
2536 ftrace_bug_type = FTRACE_BUG_UPDATE;
2537 return ftrace_modify_call(rec, ftrace_old_addr, ftrace_addr);
2538 }
2539
David Brazdil0f672f62019-12-10 10:32:29 +00002540 return -1; /* unknown ftrace bug */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002541}
2542
David Brazdil0f672f62019-12-10 10:32:29 +00002543void __weak ftrace_replace_code(int mod_flags)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002544{
2545 struct dyn_ftrace *rec;
2546 struct ftrace_page *pg;
David Brazdil0f672f62019-12-10 10:32:29 +00002547 bool enable = mod_flags & FTRACE_MODIFY_ENABLE_FL;
2548 int schedulable = mod_flags & FTRACE_MODIFY_MAY_SLEEP_FL;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002549 int failed;
2550
2551 if (unlikely(ftrace_disabled))
2552 return;
2553
2554 do_for_each_ftrace_rec(pg, rec) {
2555
2556 if (rec->flags & FTRACE_FL_DISABLED)
2557 continue;
2558
2559 failed = __ftrace_replace_code(rec, enable);
2560 if (failed) {
2561 ftrace_bug(failed, rec);
2562 /* Stop processing */
2563 return;
2564 }
David Brazdil0f672f62019-12-10 10:32:29 +00002565 if (schedulable)
2566 cond_resched();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002567 } while_for_each_ftrace_rec();
2568}
2569
2570struct ftrace_rec_iter {
2571 struct ftrace_page *pg;
2572 int index;
2573};
2574
2575/**
2576 * ftrace_rec_iter_start, start up iterating over traced functions
2577 *
2578 * Returns an iterator handle that is used to iterate over all
2579 * the records that represent address locations where functions
2580 * are traced.
2581 *
2582 * May return NULL if no records are available.
2583 */
2584struct ftrace_rec_iter *ftrace_rec_iter_start(void)
2585{
2586 /*
2587 * We only use a single iterator.
2588 * Protected by the ftrace_lock mutex.
2589 */
2590 static struct ftrace_rec_iter ftrace_rec_iter;
2591 struct ftrace_rec_iter *iter = &ftrace_rec_iter;
2592
2593 iter->pg = ftrace_pages_start;
2594 iter->index = 0;
2595
2596 /* Could have empty pages */
2597 while (iter->pg && !iter->pg->index)
2598 iter->pg = iter->pg->next;
2599
2600 if (!iter->pg)
2601 return NULL;
2602
2603 return iter;
2604}
2605
2606/**
2607 * ftrace_rec_iter_next, get the next record to process.
2608 * @iter: The handle to the iterator.
2609 *
2610 * Returns the next iterator after the given iterator @iter.
2611 */
2612struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter)
2613{
2614 iter->index++;
2615
2616 if (iter->index >= iter->pg->index) {
2617 iter->pg = iter->pg->next;
2618 iter->index = 0;
2619
2620 /* Could have empty pages */
2621 while (iter->pg && !iter->pg->index)
2622 iter->pg = iter->pg->next;
2623 }
2624
2625 if (!iter->pg)
2626 return NULL;
2627
2628 return iter;
2629}
2630
2631/**
2632 * ftrace_rec_iter_record, get the record at the iterator location
2633 * @iter: The current iterator location
2634 *
2635 * Returns the record that the current @iter is at.
2636 */
2637struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter)
2638{
2639 return &iter->pg->records[iter->index];
2640}
2641
2642static int
Olivier Deprez157378f2022-04-04 15:47:50 +02002643ftrace_nop_initialize(struct module *mod, struct dyn_ftrace *rec)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002644{
2645 int ret;
2646
2647 if (unlikely(ftrace_disabled))
2648 return 0;
2649
Olivier Deprez157378f2022-04-04 15:47:50 +02002650 ret = ftrace_init_nop(mod, rec);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002651 if (ret) {
2652 ftrace_bug_type = FTRACE_BUG_INIT;
2653 ftrace_bug(ret, rec);
2654 return 0;
2655 }
2656 return 1;
2657}
2658
2659/*
2660 * archs can override this function if they must do something
2661 * before the modifying code is performed.
2662 */
2663int __weak ftrace_arch_code_modify_prepare(void)
2664{
2665 return 0;
2666}
2667
2668/*
2669 * archs can override this function if they must do something
2670 * after the modifying code is performed.
2671 */
2672int __weak ftrace_arch_code_modify_post_process(void)
2673{
2674 return 0;
2675}
2676
2677void ftrace_modify_all_code(int command)
2678{
2679 int update = command & FTRACE_UPDATE_TRACE_FUNC;
David Brazdil0f672f62019-12-10 10:32:29 +00002680 int mod_flags = 0;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002681 int err = 0;
2682
David Brazdil0f672f62019-12-10 10:32:29 +00002683 if (command & FTRACE_MAY_SLEEP)
2684 mod_flags = FTRACE_MODIFY_MAY_SLEEP_FL;
2685
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002686 /*
2687 * If the ftrace_caller calls a ftrace_ops func directly,
2688 * we need to make sure that it only traces functions it
2689 * expects to trace. When doing the switch of functions,
2690 * we need to update to the ftrace_ops_list_func first
2691 * before the transition between old and new calls are set,
2692 * as the ftrace_ops_list_func will check the ops hashes
2693 * to make sure the ops are having the right functions
2694 * traced.
2695 */
2696 if (update) {
2697 err = ftrace_update_ftrace_func(ftrace_ops_list_func);
2698 if (FTRACE_WARN_ON(err))
2699 return;
2700 }
2701
2702 if (command & FTRACE_UPDATE_CALLS)
David Brazdil0f672f62019-12-10 10:32:29 +00002703 ftrace_replace_code(mod_flags | FTRACE_MODIFY_ENABLE_FL);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002704 else if (command & FTRACE_DISABLE_CALLS)
David Brazdil0f672f62019-12-10 10:32:29 +00002705 ftrace_replace_code(mod_flags);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002706
2707 if (update && ftrace_trace_function != ftrace_ops_list_func) {
2708 function_trace_op = set_function_trace_op;
2709 smp_wmb();
2710 /* If irqs are disabled, we are in stop machine */
2711 if (!irqs_disabled())
2712 smp_call_function(ftrace_sync_ipi, NULL, 1);
2713 err = ftrace_update_ftrace_func(ftrace_trace_function);
2714 if (FTRACE_WARN_ON(err))
2715 return;
2716 }
2717
2718 if (command & FTRACE_START_FUNC_RET)
2719 err = ftrace_enable_ftrace_graph_caller();
2720 else if (command & FTRACE_STOP_FUNC_RET)
2721 err = ftrace_disable_ftrace_graph_caller();
2722 FTRACE_WARN_ON(err);
2723}
2724
2725static int __ftrace_modify_code(void *data)
2726{
2727 int *command = data;
2728
2729 ftrace_modify_all_code(*command);
2730
2731 return 0;
2732}
2733
2734/**
2735 * ftrace_run_stop_machine, go back to the stop machine method
2736 * @command: The command to tell ftrace what to do
2737 *
2738 * If an arch needs to fall back to the stop machine method, the
2739 * it can call this function.
2740 */
2741void ftrace_run_stop_machine(int command)
2742{
2743 stop_machine(__ftrace_modify_code, &command, NULL);
2744}
2745
2746/**
2747 * arch_ftrace_update_code, modify the code to trace or not trace
2748 * @command: The command that needs to be done
2749 *
2750 * Archs can override this function if it does not need to
2751 * run stop_machine() to modify code.
2752 */
2753void __weak arch_ftrace_update_code(int command)
2754{
2755 ftrace_run_stop_machine(command);
2756}
2757
2758static void ftrace_run_update_code(int command)
2759{
2760 int ret;
2761
2762 ret = ftrace_arch_code_modify_prepare();
2763 FTRACE_WARN_ON(ret);
2764 if (ret)
2765 return;
2766
2767 /*
2768 * By default we use stop_machine() to modify the code.
2769 * But archs can do what ever they want as long as it
2770 * is safe. The stop_machine() is the safest, but also
2771 * produces the most overhead.
2772 */
2773 arch_ftrace_update_code(command);
2774
2775 ret = ftrace_arch_code_modify_post_process();
2776 FTRACE_WARN_ON(ret);
2777}
2778
2779static void ftrace_run_modify_code(struct ftrace_ops *ops, int command,
2780 struct ftrace_ops_hash *old_hash)
2781{
2782 ops->flags |= FTRACE_OPS_FL_MODIFYING;
2783 ops->old_hash.filter_hash = old_hash->filter_hash;
2784 ops->old_hash.notrace_hash = old_hash->notrace_hash;
2785 ftrace_run_update_code(command);
2786 ops->old_hash.filter_hash = NULL;
2787 ops->old_hash.notrace_hash = NULL;
2788 ops->flags &= ~FTRACE_OPS_FL_MODIFYING;
2789}
2790
2791static ftrace_func_t saved_ftrace_func;
2792static int ftrace_start_up;
2793
2794void __weak arch_ftrace_trampoline_free(struct ftrace_ops *ops)
2795{
2796}
2797
Olivier Deprez157378f2022-04-04 15:47:50 +02002798/* List of trace_ops that have allocated trampolines */
2799static LIST_HEAD(ftrace_ops_trampoline_list);
2800
2801static void ftrace_add_trampoline_to_kallsyms(struct ftrace_ops *ops)
2802{
2803 lockdep_assert_held(&ftrace_lock);
2804 list_add_rcu(&ops->list, &ftrace_ops_trampoline_list);
2805}
2806
2807static void ftrace_remove_trampoline_from_kallsyms(struct ftrace_ops *ops)
2808{
2809 lockdep_assert_held(&ftrace_lock);
2810 list_del_rcu(&ops->list);
2811 synchronize_rcu();
2812}
2813
2814/*
2815 * "__builtin__ftrace" is used as a module name in /proc/kallsyms for symbols
2816 * for pages allocated for ftrace purposes, even though "__builtin__ftrace" is
2817 * not a module.
2818 */
2819#define FTRACE_TRAMPOLINE_MOD "__builtin__ftrace"
2820#define FTRACE_TRAMPOLINE_SYM "ftrace_trampoline"
2821
2822static void ftrace_trampoline_free(struct ftrace_ops *ops)
2823{
2824 if (ops && (ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP) &&
2825 ops->trampoline) {
2826 /*
2827 * Record the text poke event before the ksymbol unregister
2828 * event.
2829 */
2830 perf_event_text_poke((void *)ops->trampoline,
2831 (void *)ops->trampoline,
2832 ops->trampoline_size, NULL, 0);
2833 perf_event_ksymbol(PERF_RECORD_KSYMBOL_TYPE_OOL,
2834 ops->trampoline, ops->trampoline_size,
2835 true, FTRACE_TRAMPOLINE_SYM);
2836 /* Remove from kallsyms after the perf events */
2837 ftrace_remove_trampoline_from_kallsyms(ops);
2838 }
2839
2840 arch_ftrace_trampoline_free(ops);
2841}
2842
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002843static void ftrace_startup_enable(int command)
2844{
2845 if (saved_ftrace_func != ftrace_trace_function) {
2846 saved_ftrace_func = ftrace_trace_function;
2847 command |= FTRACE_UPDATE_TRACE_FUNC;
2848 }
2849
2850 if (!command || !ftrace_enabled)
2851 return;
2852
2853 ftrace_run_update_code(command);
2854}
2855
2856static void ftrace_startup_all(int command)
2857{
2858 update_all_ops = true;
2859 ftrace_startup_enable(command);
2860 update_all_ops = false;
2861}
2862
David Brazdil0f672f62019-12-10 10:32:29 +00002863int ftrace_startup(struct ftrace_ops *ops, int command)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002864{
2865 int ret;
2866
2867 if (unlikely(ftrace_disabled))
2868 return -ENODEV;
2869
2870 ret = __register_ftrace_function(ops);
2871 if (ret)
2872 return ret;
2873
2874 ftrace_start_up++;
2875
2876 /*
2877 * Note that ftrace probes uses this to start up
2878 * and modify functions it will probe. But we still
2879 * set the ADDING flag for modification, as probes
2880 * do not have trampolines. If they add them in the
2881 * future, then the probes will need to distinguish
2882 * between adding and updating probes.
2883 */
2884 ops->flags |= FTRACE_OPS_FL_ENABLED | FTRACE_OPS_FL_ADDING;
2885
2886 ret = ftrace_hash_ipmodify_enable(ops);
2887 if (ret < 0) {
2888 /* Rollback registration process */
2889 __unregister_ftrace_function(ops);
2890 ftrace_start_up--;
2891 ops->flags &= ~FTRACE_OPS_FL_ENABLED;
Olivier Deprez157378f2022-04-04 15:47:50 +02002892 if (ops->flags & FTRACE_OPS_FL_DYNAMIC)
2893 ftrace_trampoline_free(ops);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002894 return ret;
2895 }
2896
2897 if (ftrace_hash_rec_enable(ops, 1))
2898 command |= FTRACE_UPDATE_CALLS;
2899
2900 ftrace_startup_enable(command);
2901
2902 ops->flags &= ~FTRACE_OPS_FL_ADDING;
2903
2904 return 0;
2905}
2906
David Brazdil0f672f62019-12-10 10:32:29 +00002907int ftrace_shutdown(struct ftrace_ops *ops, int command)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002908{
2909 int ret;
2910
2911 if (unlikely(ftrace_disabled))
2912 return -ENODEV;
2913
2914 ret = __unregister_ftrace_function(ops);
2915 if (ret)
2916 return ret;
2917
2918 ftrace_start_up--;
2919 /*
2920 * Just warn in case of unbalance, no need to kill ftrace, it's not
2921 * critical but the ftrace_call callers may be never nopped again after
2922 * further ftrace uses.
2923 */
2924 WARN_ON_ONCE(ftrace_start_up < 0);
2925
2926 /* Disabling ipmodify never fails */
2927 ftrace_hash_ipmodify_disable(ops);
2928
2929 if (ftrace_hash_rec_disable(ops, 1))
2930 command |= FTRACE_UPDATE_CALLS;
2931
2932 ops->flags &= ~FTRACE_OPS_FL_ENABLED;
2933
2934 if (saved_ftrace_func != ftrace_trace_function) {
2935 saved_ftrace_func = ftrace_trace_function;
2936 command |= FTRACE_UPDATE_TRACE_FUNC;
2937 }
2938
2939 if (!command || !ftrace_enabled) {
2940 /*
2941 * If these are dynamic or per_cpu ops, they still
2942 * need their data freed. Since, function tracing is
2943 * not currently active, we can just free them
2944 * without synchronizing all CPUs.
2945 */
2946 if (ops->flags & FTRACE_OPS_FL_DYNAMIC)
2947 goto free_ops;
2948
2949 return 0;
2950 }
2951
2952 /*
2953 * If the ops uses a trampoline, then it needs to be
2954 * tested first on update.
2955 */
2956 ops->flags |= FTRACE_OPS_FL_REMOVING;
2957 removed_ops = ops;
2958
2959 /* The trampoline logic checks the old hashes */
2960 ops->old_hash.filter_hash = ops->func_hash->filter_hash;
2961 ops->old_hash.notrace_hash = ops->func_hash->notrace_hash;
2962
2963 ftrace_run_update_code(command);
2964
2965 /*
2966 * If there's no more ops registered with ftrace, run a
2967 * sanity check to make sure all rec flags are cleared.
2968 */
2969 if (rcu_dereference_protected(ftrace_ops_list,
2970 lockdep_is_held(&ftrace_lock)) == &ftrace_list_end) {
2971 struct ftrace_page *pg;
2972 struct dyn_ftrace *rec;
2973
2974 do_for_each_ftrace_rec(pg, rec) {
2975 if (FTRACE_WARN_ON_ONCE(rec->flags & ~FTRACE_FL_DISABLED))
2976 pr_warn(" %pS flags:%lx\n",
2977 (void *)rec->ip, rec->flags);
2978 } while_for_each_ftrace_rec();
2979 }
2980
2981 ops->old_hash.filter_hash = NULL;
2982 ops->old_hash.notrace_hash = NULL;
2983
2984 removed_ops = NULL;
2985 ops->flags &= ~FTRACE_OPS_FL_REMOVING;
2986
2987 /*
2988 * Dynamic ops may be freed, we must make sure that all
2989 * callers are done before leaving this function.
2990 * The same goes for freeing the per_cpu data of the per_cpu
2991 * ops.
2992 */
2993 if (ops->flags & FTRACE_OPS_FL_DYNAMIC) {
2994 /*
2995 * We need to do a hard force of sched synchronization.
2996 * This is because we use preempt_disable() to do RCU, but
2997 * the function tracers can be called where RCU is not watching
2998 * (like before user_exit()). We can not rely on the RCU
2999 * infrastructure to do the synchronization, thus we must do it
3000 * ourselves.
3001 */
Olivier Deprez157378f2022-04-04 15:47:50 +02003002 synchronize_rcu_tasks_rude();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003003
3004 /*
Olivier Deprez157378f2022-04-04 15:47:50 +02003005 * When the kernel is preemptive, tasks can be preempted
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003006 * while on a ftrace trampoline. Just scheduling a task on
3007 * a CPU is not good enough to flush them. Calling
3008 * synchornize_rcu_tasks() will wait for those tasks to
3009 * execute and either schedule voluntarily or enter user space.
3010 */
David Brazdil0f672f62019-12-10 10:32:29 +00003011 if (IS_ENABLED(CONFIG_PREEMPTION))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003012 synchronize_rcu_tasks();
3013
3014 free_ops:
Olivier Deprez157378f2022-04-04 15:47:50 +02003015 ftrace_trampoline_free(ops);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003016 }
3017
3018 return 0;
3019}
3020
3021static void ftrace_startup_sysctl(void)
3022{
3023 int command;
3024
3025 if (unlikely(ftrace_disabled))
3026 return;
3027
3028 /* Force update next time */
3029 saved_ftrace_func = NULL;
3030 /* ftrace_start_up is true if we want ftrace running */
3031 if (ftrace_start_up) {
3032 command = FTRACE_UPDATE_CALLS;
3033 if (ftrace_graph_active)
3034 command |= FTRACE_START_FUNC_RET;
3035 ftrace_startup_enable(command);
3036 }
3037}
3038
3039static void ftrace_shutdown_sysctl(void)
3040{
3041 int command;
3042
3043 if (unlikely(ftrace_disabled))
3044 return;
3045
3046 /* ftrace_start_up is true if ftrace is running */
3047 if (ftrace_start_up) {
3048 command = FTRACE_DISABLE_CALLS;
3049 if (ftrace_graph_active)
3050 command |= FTRACE_STOP_FUNC_RET;
3051 ftrace_run_update_code(command);
3052 }
3053}
3054
3055static u64 ftrace_update_time;
3056unsigned long ftrace_update_tot_cnt;
Olivier Deprez157378f2022-04-04 15:47:50 +02003057unsigned long ftrace_number_of_pages;
3058unsigned long ftrace_number_of_groups;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003059
3060static inline int ops_traces_mod(struct ftrace_ops *ops)
3061{
3062 /*
3063 * Filter_hash being empty will default to trace module.
3064 * But notrace hash requires a test of individual module functions.
3065 */
3066 return ftrace_hash_empty(ops->func_hash->filter_hash) &&
3067 ftrace_hash_empty(ops->func_hash->notrace_hash);
3068}
3069
3070/*
3071 * Check if the current ops references the record.
3072 *
3073 * If the ops traces all functions, then it was already accounted for.
3074 * If the ops does not trace the current record function, skip it.
3075 * If the ops ignores the function via notrace filter, skip it.
3076 */
3077static inline bool
3078ops_references_rec(struct ftrace_ops *ops, struct dyn_ftrace *rec)
3079{
3080 /* If ops isn't enabled, ignore it */
3081 if (!(ops->flags & FTRACE_OPS_FL_ENABLED))
3082 return false;
3083
3084 /* If ops traces all then it includes this function */
3085 if (ops_traces_mod(ops))
3086 return true;
3087
3088 /* The function must be in the filter */
3089 if (!ftrace_hash_empty(ops->func_hash->filter_hash) &&
3090 !__ftrace_lookup_ip(ops->func_hash->filter_hash, rec->ip))
3091 return false;
3092
3093 /* If in notrace hash, we ignore it too */
3094 if (ftrace_lookup_ip(ops->func_hash->notrace_hash, rec->ip))
3095 return false;
3096
3097 return true;
3098}
3099
3100static int ftrace_update_code(struct module *mod, struct ftrace_page *new_pgs)
3101{
3102 struct ftrace_page *pg;
3103 struct dyn_ftrace *p;
3104 u64 start, stop;
3105 unsigned long update_cnt = 0;
3106 unsigned long rec_flags = 0;
3107 int i;
3108
3109 start = ftrace_now(raw_smp_processor_id());
3110
3111 /*
3112 * When a module is loaded, this function is called to convert
3113 * the calls to mcount in its text to nops, and also to create
3114 * an entry in the ftrace data. Now, if ftrace is activated
3115 * after this call, but before the module sets its text to
3116 * read-only, the modification of enabling ftrace can fail if
3117 * the read-only is done while ftrace is converting the calls.
3118 * To prevent this, the module's records are set as disabled
3119 * and will be enabled after the call to set the module's text
3120 * to read-only.
3121 */
3122 if (mod)
3123 rec_flags |= FTRACE_FL_DISABLED;
3124
3125 for (pg = new_pgs; pg; pg = pg->next) {
3126
3127 for (i = 0; i < pg->index; i++) {
3128
3129 /* If something went wrong, bail without enabling anything */
3130 if (unlikely(ftrace_disabled))
3131 return -1;
3132
3133 p = &pg->records[i];
3134 p->flags = rec_flags;
3135
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003136 /*
3137 * Do the initial record conversion from mcount jump
3138 * to the NOP instructions.
3139 */
David Brazdil0f672f62019-12-10 10:32:29 +00003140 if (!__is_defined(CC_USING_NOP_MCOUNT) &&
Olivier Deprez157378f2022-04-04 15:47:50 +02003141 !ftrace_nop_initialize(mod, p))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003142 break;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003143
3144 update_cnt++;
3145 }
3146 }
3147
3148 stop = ftrace_now(raw_smp_processor_id());
3149 ftrace_update_time = stop - start;
3150 ftrace_update_tot_cnt += update_cnt;
3151
3152 return 0;
3153}
3154
3155static int ftrace_allocate_records(struct ftrace_page *pg, int count)
3156{
3157 int order;
Olivier Deprez157378f2022-04-04 15:47:50 +02003158 int pages;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003159 int cnt;
3160
3161 if (WARN_ON(!count))
3162 return -EINVAL;
3163
Olivier Deprez157378f2022-04-04 15:47:50 +02003164 pages = DIV_ROUND_UP(count, ENTRIES_PER_PAGE);
3165 order = get_count_order(pages);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003166
3167 /*
3168 * We want to fill as much as possible. No more than a page
3169 * may be empty.
3170 */
Olivier Deprez157378f2022-04-04 15:47:50 +02003171 if (!is_power_of_2(pages))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003172 order--;
3173
3174 again:
3175 pg->records = (void *)__get_free_pages(GFP_KERNEL | __GFP_ZERO, order);
3176
3177 if (!pg->records) {
3178 /* if we can't allocate this size, try something smaller */
3179 if (!order)
3180 return -ENOMEM;
3181 order >>= 1;
3182 goto again;
3183 }
3184
Olivier Deprez157378f2022-04-04 15:47:50 +02003185 ftrace_number_of_pages += 1 << order;
3186 ftrace_number_of_groups++;
3187
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003188 cnt = (PAGE_SIZE << order) / ENTRY_SIZE;
3189 pg->size = cnt;
3190
3191 if (cnt > count)
3192 cnt = count;
3193
3194 return cnt;
3195}
3196
3197static struct ftrace_page *
3198ftrace_allocate_pages(unsigned long num_to_init)
3199{
3200 struct ftrace_page *start_pg;
3201 struct ftrace_page *pg;
3202 int order;
3203 int cnt;
3204
3205 if (!num_to_init)
David Brazdil0f672f62019-12-10 10:32:29 +00003206 return NULL;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003207
3208 start_pg = pg = kzalloc(sizeof(*pg), GFP_KERNEL);
3209 if (!pg)
3210 return NULL;
3211
3212 /*
3213 * Try to allocate as much as possible in one continues
3214 * location that fills in all of the space. We want to
3215 * waste as little space as possible.
3216 */
3217 for (;;) {
3218 cnt = ftrace_allocate_records(pg, num_to_init);
3219 if (cnt < 0)
3220 goto free_pages;
3221
3222 num_to_init -= cnt;
3223 if (!num_to_init)
3224 break;
3225
3226 pg->next = kzalloc(sizeof(*pg), GFP_KERNEL);
3227 if (!pg->next)
3228 goto free_pages;
3229
3230 pg = pg->next;
3231 }
3232
3233 return start_pg;
3234
3235 free_pages:
3236 pg = start_pg;
3237 while (pg) {
3238 order = get_count_order(pg->size / ENTRIES_PER_PAGE);
Olivier Deprez157378f2022-04-04 15:47:50 +02003239 if (order >= 0)
3240 free_pages((unsigned long)pg->records, order);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003241 start_pg = pg->next;
3242 kfree(pg);
3243 pg = start_pg;
Olivier Deprez157378f2022-04-04 15:47:50 +02003244 ftrace_number_of_pages -= 1 << order;
3245 ftrace_number_of_groups--;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003246 }
3247 pr_info("ftrace: FAILED to allocate memory for functions\n");
3248 return NULL;
3249}
3250
3251#define FTRACE_BUFF_MAX (KSYM_SYMBOL_LEN+4) /* room for wildcards */
3252
3253struct ftrace_iterator {
3254 loff_t pos;
3255 loff_t func_pos;
3256 loff_t mod_pos;
3257 struct ftrace_page *pg;
3258 struct dyn_ftrace *func;
3259 struct ftrace_func_probe *probe;
3260 struct ftrace_func_entry *probe_entry;
3261 struct trace_parser parser;
3262 struct ftrace_hash *hash;
3263 struct ftrace_ops *ops;
3264 struct trace_array *tr;
3265 struct list_head *mod_list;
3266 int pidx;
3267 int idx;
3268 unsigned flags;
3269};
3270
3271static void *
3272t_probe_next(struct seq_file *m, loff_t *pos)
3273{
3274 struct ftrace_iterator *iter = m->private;
3275 struct trace_array *tr = iter->ops->private;
3276 struct list_head *func_probes;
3277 struct ftrace_hash *hash;
3278 struct list_head *next;
3279 struct hlist_node *hnd = NULL;
3280 struct hlist_head *hhd;
3281 int size;
3282
3283 (*pos)++;
3284 iter->pos = *pos;
3285
3286 if (!tr)
3287 return NULL;
3288
3289 func_probes = &tr->func_probes;
3290 if (list_empty(func_probes))
3291 return NULL;
3292
3293 if (!iter->probe) {
3294 next = func_probes->next;
3295 iter->probe = list_entry(next, struct ftrace_func_probe, list);
3296 }
3297
3298 if (iter->probe_entry)
3299 hnd = &iter->probe_entry->hlist;
3300
3301 hash = iter->probe->ops.func_hash->filter_hash;
David Brazdil0f672f62019-12-10 10:32:29 +00003302
3303 /*
3304 * A probe being registered may temporarily have an empty hash
3305 * and it's at the end of the func_probes list.
3306 */
3307 if (!hash || hash == EMPTY_HASH)
3308 return NULL;
3309
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003310 size = 1 << hash->size_bits;
3311
3312 retry:
3313 if (iter->pidx >= size) {
3314 if (iter->probe->list.next == func_probes)
3315 return NULL;
3316 next = iter->probe->list.next;
3317 iter->probe = list_entry(next, struct ftrace_func_probe, list);
3318 hash = iter->probe->ops.func_hash->filter_hash;
3319 size = 1 << hash->size_bits;
3320 iter->pidx = 0;
3321 }
3322
3323 hhd = &hash->buckets[iter->pidx];
3324
3325 if (hlist_empty(hhd)) {
3326 iter->pidx++;
3327 hnd = NULL;
3328 goto retry;
3329 }
3330
3331 if (!hnd)
3332 hnd = hhd->first;
3333 else {
3334 hnd = hnd->next;
3335 if (!hnd) {
3336 iter->pidx++;
3337 goto retry;
3338 }
3339 }
3340
3341 if (WARN_ON_ONCE(!hnd))
3342 return NULL;
3343
3344 iter->probe_entry = hlist_entry(hnd, struct ftrace_func_entry, hlist);
3345
3346 return iter;
3347}
3348
3349static void *t_probe_start(struct seq_file *m, loff_t *pos)
3350{
3351 struct ftrace_iterator *iter = m->private;
3352 void *p = NULL;
3353 loff_t l;
3354
3355 if (!(iter->flags & FTRACE_ITER_DO_PROBES))
3356 return NULL;
3357
3358 if (iter->mod_pos > *pos)
3359 return NULL;
3360
3361 iter->probe = NULL;
3362 iter->probe_entry = NULL;
3363 iter->pidx = 0;
3364 for (l = 0; l <= (*pos - iter->mod_pos); ) {
3365 p = t_probe_next(m, &l);
3366 if (!p)
3367 break;
3368 }
3369 if (!p)
3370 return NULL;
3371
3372 /* Only set this if we have an item */
3373 iter->flags |= FTRACE_ITER_PROBE;
3374
3375 return iter;
3376}
3377
3378static int
3379t_probe_show(struct seq_file *m, struct ftrace_iterator *iter)
3380{
3381 struct ftrace_func_entry *probe_entry;
3382 struct ftrace_probe_ops *probe_ops;
3383 struct ftrace_func_probe *probe;
3384
3385 probe = iter->probe;
3386 probe_entry = iter->probe_entry;
3387
3388 if (WARN_ON_ONCE(!probe || !probe_entry))
3389 return -EIO;
3390
3391 probe_ops = probe->probe_ops;
3392
3393 if (probe_ops->print)
3394 return probe_ops->print(m, probe_entry->ip, probe_ops, probe->data);
3395
3396 seq_printf(m, "%ps:%ps\n", (void *)probe_entry->ip,
3397 (void *)probe_ops->func);
3398
3399 return 0;
3400}
3401
3402static void *
3403t_mod_next(struct seq_file *m, loff_t *pos)
3404{
3405 struct ftrace_iterator *iter = m->private;
3406 struct trace_array *tr = iter->tr;
3407
3408 (*pos)++;
3409 iter->pos = *pos;
3410
3411 iter->mod_list = iter->mod_list->next;
3412
3413 if (iter->mod_list == &tr->mod_trace ||
3414 iter->mod_list == &tr->mod_notrace) {
3415 iter->flags &= ~FTRACE_ITER_MOD;
3416 return NULL;
3417 }
3418
3419 iter->mod_pos = *pos;
3420
3421 return iter;
3422}
3423
3424static void *t_mod_start(struct seq_file *m, loff_t *pos)
3425{
3426 struct ftrace_iterator *iter = m->private;
3427 void *p = NULL;
3428 loff_t l;
3429
3430 if (iter->func_pos > *pos)
3431 return NULL;
3432
3433 iter->mod_pos = iter->func_pos;
3434
3435 /* probes are only available if tr is set */
3436 if (!iter->tr)
3437 return NULL;
3438
3439 for (l = 0; l <= (*pos - iter->func_pos); ) {
3440 p = t_mod_next(m, &l);
3441 if (!p)
3442 break;
3443 }
3444 if (!p) {
3445 iter->flags &= ~FTRACE_ITER_MOD;
3446 return t_probe_start(m, pos);
3447 }
3448
3449 /* Only set this if we have an item */
3450 iter->flags |= FTRACE_ITER_MOD;
3451
3452 return iter;
3453}
3454
3455static int
3456t_mod_show(struct seq_file *m, struct ftrace_iterator *iter)
3457{
3458 struct ftrace_mod_load *ftrace_mod;
3459 struct trace_array *tr = iter->tr;
3460
3461 if (WARN_ON_ONCE(!iter->mod_list) ||
3462 iter->mod_list == &tr->mod_trace ||
3463 iter->mod_list == &tr->mod_notrace)
3464 return -EIO;
3465
3466 ftrace_mod = list_entry(iter->mod_list, struct ftrace_mod_load, list);
3467
3468 if (ftrace_mod->func)
3469 seq_printf(m, "%s", ftrace_mod->func);
3470 else
3471 seq_putc(m, '*');
3472
3473 seq_printf(m, ":mod:%s\n", ftrace_mod->module);
3474
3475 return 0;
3476}
3477
3478static void *
3479t_func_next(struct seq_file *m, loff_t *pos)
3480{
3481 struct ftrace_iterator *iter = m->private;
3482 struct dyn_ftrace *rec = NULL;
3483
3484 (*pos)++;
3485
3486 retry:
3487 if (iter->idx >= iter->pg->index) {
3488 if (iter->pg->next) {
3489 iter->pg = iter->pg->next;
3490 iter->idx = 0;
3491 goto retry;
3492 }
3493 } else {
3494 rec = &iter->pg->records[iter->idx++];
3495 if (((iter->flags & (FTRACE_ITER_FILTER | FTRACE_ITER_NOTRACE)) &&
3496 !ftrace_lookup_ip(iter->hash, rec->ip)) ||
3497
3498 ((iter->flags & FTRACE_ITER_ENABLED) &&
3499 !(rec->flags & FTRACE_FL_ENABLED))) {
3500
3501 rec = NULL;
3502 goto retry;
3503 }
3504 }
3505
3506 if (!rec)
3507 return NULL;
3508
3509 iter->pos = iter->func_pos = *pos;
3510 iter->func = rec;
3511
3512 return iter;
3513}
3514
3515static void *
3516t_next(struct seq_file *m, void *v, loff_t *pos)
3517{
3518 struct ftrace_iterator *iter = m->private;
3519 loff_t l = *pos; /* t_probe_start() must use original pos */
3520 void *ret;
3521
3522 if (unlikely(ftrace_disabled))
3523 return NULL;
3524
3525 if (iter->flags & FTRACE_ITER_PROBE)
3526 return t_probe_next(m, pos);
3527
3528 if (iter->flags & FTRACE_ITER_MOD)
3529 return t_mod_next(m, pos);
3530
3531 if (iter->flags & FTRACE_ITER_PRINTALL) {
3532 /* next must increment pos, and t_probe_start does not */
3533 (*pos)++;
3534 return t_mod_start(m, &l);
3535 }
3536
3537 ret = t_func_next(m, pos);
3538
3539 if (!ret)
3540 return t_mod_start(m, &l);
3541
3542 return ret;
3543}
3544
3545static void reset_iter_read(struct ftrace_iterator *iter)
3546{
3547 iter->pos = 0;
3548 iter->func_pos = 0;
3549 iter->flags &= ~(FTRACE_ITER_PRINTALL | FTRACE_ITER_PROBE | FTRACE_ITER_MOD);
3550}
3551
3552static void *t_start(struct seq_file *m, loff_t *pos)
3553{
3554 struct ftrace_iterator *iter = m->private;
3555 void *p = NULL;
3556 loff_t l;
3557
3558 mutex_lock(&ftrace_lock);
3559
3560 if (unlikely(ftrace_disabled))
3561 return NULL;
3562
3563 /*
3564 * If an lseek was done, then reset and start from beginning.
3565 */
3566 if (*pos < iter->pos)
3567 reset_iter_read(iter);
3568
3569 /*
3570 * For set_ftrace_filter reading, if we have the filter
3571 * off, we can short cut and just print out that all
3572 * functions are enabled.
3573 */
3574 if ((iter->flags & (FTRACE_ITER_FILTER | FTRACE_ITER_NOTRACE)) &&
3575 ftrace_hash_empty(iter->hash)) {
3576 iter->func_pos = 1; /* Account for the message */
3577 if (*pos > 0)
3578 return t_mod_start(m, pos);
3579 iter->flags |= FTRACE_ITER_PRINTALL;
3580 /* reset in case of seek/pread */
3581 iter->flags &= ~FTRACE_ITER_PROBE;
3582 return iter;
3583 }
3584
3585 if (iter->flags & FTRACE_ITER_MOD)
3586 return t_mod_start(m, pos);
3587
3588 /*
3589 * Unfortunately, we need to restart at ftrace_pages_start
3590 * every time we let go of the ftrace_mutex. This is because
3591 * those pointers can change without the lock.
3592 */
3593 iter->pg = ftrace_pages_start;
3594 iter->idx = 0;
3595 for (l = 0; l <= *pos; ) {
3596 p = t_func_next(m, &l);
3597 if (!p)
3598 break;
3599 }
3600
3601 if (!p)
3602 return t_mod_start(m, pos);
3603
3604 return iter;
3605}
3606
3607static void t_stop(struct seq_file *m, void *p)
3608{
3609 mutex_unlock(&ftrace_lock);
3610}
3611
3612void * __weak
3613arch_ftrace_trampoline_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
3614{
3615 return NULL;
3616}
3617
3618static void add_trampoline_func(struct seq_file *m, struct ftrace_ops *ops,
3619 struct dyn_ftrace *rec)
3620{
3621 void *ptr;
3622
3623 ptr = arch_ftrace_trampoline_func(ops, rec);
3624 if (ptr)
3625 seq_printf(m, " ->%pS", ptr);
3626}
3627
3628static int t_show(struct seq_file *m, void *v)
3629{
3630 struct ftrace_iterator *iter = m->private;
3631 struct dyn_ftrace *rec;
3632
3633 if (iter->flags & FTRACE_ITER_PROBE)
3634 return t_probe_show(m, iter);
3635
3636 if (iter->flags & FTRACE_ITER_MOD)
3637 return t_mod_show(m, iter);
3638
3639 if (iter->flags & FTRACE_ITER_PRINTALL) {
3640 if (iter->flags & FTRACE_ITER_NOTRACE)
3641 seq_puts(m, "#### no functions disabled ####\n");
3642 else
3643 seq_puts(m, "#### all functions enabled ####\n");
3644 return 0;
3645 }
3646
3647 rec = iter->func;
3648
3649 if (!rec)
3650 return 0;
3651
3652 seq_printf(m, "%ps", (void *)rec->ip);
3653 if (iter->flags & FTRACE_ITER_ENABLED) {
3654 struct ftrace_ops *ops;
3655
Olivier Deprez157378f2022-04-04 15:47:50 +02003656 seq_printf(m, " (%ld)%s%s%s",
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003657 ftrace_rec_count(rec),
3658 rec->flags & FTRACE_FL_REGS ? " R" : " ",
Olivier Deprez157378f2022-04-04 15:47:50 +02003659 rec->flags & FTRACE_FL_IPMODIFY ? " I" : " ",
3660 rec->flags & FTRACE_FL_DIRECT ? " D" : " ");
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003661 if (rec->flags & FTRACE_FL_TRAMP_EN) {
3662 ops = ftrace_find_tramp_ops_any(rec);
3663 if (ops) {
3664 do {
3665 seq_printf(m, "\ttramp: %pS (%pS)",
3666 (void *)ops->trampoline,
3667 (void *)ops->func);
3668 add_trampoline_func(m, ops, rec);
3669 ops = ftrace_find_tramp_ops_next(rec, ops);
3670 } while (ops);
3671 } else
3672 seq_puts(m, "\ttramp: ERROR!");
3673 } else {
3674 add_trampoline_func(m, NULL, rec);
3675 }
Olivier Deprez157378f2022-04-04 15:47:50 +02003676 if (rec->flags & FTRACE_FL_DIRECT) {
3677 unsigned long direct;
3678
3679 direct = ftrace_find_rec_direct(rec->ip);
3680 if (direct)
3681 seq_printf(m, "\n\tdirect-->%pS", (void *)direct);
3682 }
3683 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003684
3685 seq_putc(m, '\n');
3686
3687 return 0;
3688}
3689
3690static const struct seq_operations show_ftrace_seq_ops = {
3691 .start = t_start,
3692 .next = t_next,
3693 .stop = t_stop,
3694 .show = t_show,
3695};
3696
3697static int
3698ftrace_avail_open(struct inode *inode, struct file *file)
3699{
3700 struct ftrace_iterator *iter;
David Brazdil0f672f62019-12-10 10:32:29 +00003701 int ret;
3702
3703 ret = security_locked_down(LOCKDOWN_TRACEFS);
3704 if (ret)
3705 return ret;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003706
3707 if (unlikely(ftrace_disabled))
3708 return -ENODEV;
3709
3710 iter = __seq_open_private(file, &show_ftrace_seq_ops, sizeof(*iter));
3711 if (!iter)
3712 return -ENOMEM;
3713
3714 iter->pg = ftrace_pages_start;
3715 iter->ops = &global_ops;
3716
3717 return 0;
3718}
3719
3720static int
3721ftrace_enabled_open(struct inode *inode, struct file *file)
3722{
3723 struct ftrace_iterator *iter;
3724
David Brazdil0f672f62019-12-10 10:32:29 +00003725 /*
3726 * This shows us what functions are currently being
3727 * traced and by what. Not sure if we want lockdown
3728 * to hide such critical information for an admin.
3729 * Although, perhaps it can show information we don't
3730 * want people to see, but if something is tracing
3731 * something, we probably want to know about it.
3732 */
3733
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003734 iter = __seq_open_private(file, &show_ftrace_seq_ops, sizeof(*iter));
3735 if (!iter)
3736 return -ENOMEM;
3737
3738 iter->pg = ftrace_pages_start;
3739 iter->flags = FTRACE_ITER_ENABLED;
3740 iter->ops = &global_ops;
3741
3742 return 0;
3743}
3744
3745/**
3746 * ftrace_regex_open - initialize function tracer filter files
3747 * @ops: The ftrace_ops that hold the hash filters
3748 * @flag: The type of filter to process
3749 * @inode: The inode, usually passed in to your open routine
3750 * @file: The file, usually passed in to your open routine
3751 *
3752 * ftrace_regex_open() initializes the filter files for the
3753 * @ops. Depending on @flag it may process the filter hash or
3754 * the notrace hash of @ops. With this called from the open
3755 * routine, you can use ftrace_filter_write() for the write
3756 * routine if @flag has FTRACE_ITER_FILTER set, or
3757 * ftrace_notrace_write() if @flag has FTRACE_ITER_NOTRACE set.
3758 * tracing_lseek() should be used as the lseek routine, and
3759 * release must call ftrace_regex_release().
3760 */
3761int
3762ftrace_regex_open(struct ftrace_ops *ops, int flag,
3763 struct inode *inode, struct file *file)
3764{
3765 struct ftrace_iterator *iter;
3766 struct ftrace_hash *hash;
3767 struct list_head *mod_head;
3768 struct trace_array *tr = ops->private;
David Brazdil0f672f62019-12-10 10:32:29 +00003769 int ret = -ENOMEM;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003770
3771 ftrace_ops_init(ops);
3772
3773 if (unlikely(ftrace_disabled))
3774 return -ENODEV;
3775
David Brazdil0f672f62019-12-10 10:32:29 +00003776 if (tracing_check_open_get_tr(tr))
3777 return -ENODEV;
3778
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003779 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
3780 if (!iter)
David Brazdil0f672f62019-12-10 10:32:29 +00003781 goto out;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003782
David Brazdil0f672f62019-12-10 10:32:29 +00003783 if (trace_parser_get_init(&iter->parser, FTRACE_BUFF_MAX))
3784 goto out;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003785
3786 iter->ops = ops;
3787 iter->flags = flag;
3788 iter->tr = tr;
3789
3790 mutex_lock(&ops->func_hash->regex_lock);
3791
3792 if (flag & FTRACE_ITER_NOTRACE) {
3793 hash = ops->func_hash->notrace_hash;
3794 mod_head = tr ? &tr->mod_notrace : NULL;
3795 } else {
3796 hash = ops->func_hash->filter_hash;
3797 mod_head = tr ? &tr->mod_trace : NULL;
3798 }
3799
3800 iter->mod_list = mod_head;
3801
3802 if (file->f_mode & FMODE_WRITE) {
3803 const int size_bits = FTRACE_HASH_DEFAULT_BITS;
3804
3805 if (file->f_flags & O_TRUNC) {
3806 iter->hash = alloc_ftrace_hash(size_bits);
3807 clear_ftrace_mod_list(mod_head);
3808 } else {
3809 iter->hash = alloc_and_copy_ftrace_hash(size_bits, hash);
3810 }
3811
3812 if (!iter->hash) {
3813 trace_parser_put(&iter->parser);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003814 goto out_unlock;
3815 }
3816 } else
3817 iter->hash = hash;
3818
David Brazdil0f672f62019-12-10 10:32:29 +00003819 ret = 0;
3820
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003821 if (file->f_mode & FMODE_READ) {
3822 iter->pg = ftrace_pages_start;
3823
3824 ret = seq_open(file, &show_ftrace_seq_ops);
3825 if (!ret) {
3826 struct seq_file *m = file->private_data;
3827 m->private = iter;
3828 } else {
3829 /* Failed */
3830 free_ftrace_hash(iter->hash);
3831 trace_parser_put(&iter->parser);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003832 }
3833 } else
3834 file->private_data = iter;
3835
3836 out_unlock:
3837 mutex_unlock(&ops->func_hash->regex_lock);
3838
David Brazdil0f672f62019-12-10 10:32:29 +00003839 out:
3840 if (ret) {
3841 kfree(iter);
3842 if (tr)
3843 trace_array_put(tr);
3844 }
3845
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003846 return ret;
3847}
3848
3849static int
3850ftrace_filter_open(struct inode *inode, struct file *file)
3851{
3852 struct ftrace_ops *ops = inode->i_private;
3853
David Brazdil0f672f62019-12-10 10:32:29 +00003854 /* Checks for tracefs lockdown */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003855 return ftrace_regex_open(ops,
3856 FTRACE_ITER_FILTER | FTRACE_ITER_DO_PROBES,
3857 inode, file);
3858}
3859
3860static int
3861ftrace_notrace_open(struct inode *inode, struct file *file)
3862{
3863 struct ftrace_ops *ops = inode->i_private;
3864
David Brazdil0f672f62019-12-10 10:32:29 +00003865 /* Checks for tracefs lockdown */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003866 return ftrace_regex_open(ops, FTRACE_ITER_NOTRACE,
3867 inode, file);
3868}
3869
3870/* Type for quick search ftrace basic regexes (globs) from filter_parse_regex */
3871struct ftrace_glob {
3872 char *search;
3873 unsigned len;
3874 int type;
3875};
3876
3877/*
3878 * If symbols in an architecture don't correspond exactly to the user-visible
3879 * name of what they represent, it is possible to define this function to
3880 * perform the necessary adjustments.
3881*/
3882char * __weak arch_ftrace_match_adjust(char *str, const char *search)
3883{
3884 return str;
3885}
3886
3887static int ftrace_match(char *str, struct ftrace_glob *g)
3888{
3889 int matched = 0;
3890 int slen;
3891
3892 str = arch_ftrace_match_adjust(str, g->search);
3893
3894 switch (g->type) {
3895 case MATCH_FULL:
3896 if (strcmp(str, g->search) == 0)
3897 matched = 1;
3898 break;
3899 case MATCH_FRONT_ONLY:
3900 if (strncmp(str, g->search, g->len) == 0)
3901 matched = 1;
3902 break;
3903 case MATCH_MIDDLE_ONLY:
3904 if (strstr(str, g->search))
3905 matched = 1;
3906 break;
3907 case MATCH_END_ONLY:
3908 slen = strlen(str);
3909 if (slen >= g->len &&
3910 memcmp(str + slen - g->len, g->search, g->len) == 0)
3911 matched = 1;
3912 break;
3913 case MATCH_GLOB:
3914 if (glob_match(g->search, str))
3915 matched = 1;
3916 break;
3917 }
3918
3919 return matched;
3920}
3921
3922static int
3923enter_record(struct ftrace_hash *hash, struct dyn_ftrace *rec, int clear_filter)
3924{
3925 struct ftrace_func_entry *entry;
3926 int ret = 0;
3927
3928 entry = ftrace_lookup_ip(hash, rec->ip);
3929 if (clear_filter) {
3930 /* Do nothing if it doesn't exist */
3931 if (!entry)
3932 return 0;
3933
3934 free_hash_entry(hash, entry);
3935 } else {
3936 /* Do nothing if it exists */
3937 if (entry)
3938 return 0;
3939
3940 ret = add_hash_entry(hash, rec->ip);
3941 }
3942 return ret;
3943}
3944
3945static int
David Brazdil0f672f62019-12-10 10:32:29 +00003946add_rec_by_index(struct ftrace_hash *hash, struct ftrace_glob *func_g,
3947 int clear_filter)
3948{
3949 long index = simple_strtoul(func_g->search, NULL, 0);
3950 struct ftrace_page *pg;
3951 struct dyn_ftrace *rec;
3952
3953 /* The index starts at 1 */
3954 if (--index < 0)
3955 return 0;
3956
3957 do_for_each_ftrace_rec(pg, rec) {
3958 if (pg->index <= index) {
3959 index -= pg->index;
3960 /* this is a double loop, break goes to the next page */
3961 break;
3962 }
3963 rec = &pg->records[index];
3964 enter_record(hash, rec, clear_filter);
3965 return 1;
3966 } while_for_each_ftrace_rec();
3967 return 0;
3968}
3969
3970static int
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003971ftrace_match_record(struct dyn_ftrace *rec, struct ftrace_glob *func_g,
3972 struct ftrace_glob *mod_g, int exclude_mod)
3973{
3974 char str[KSYM_SYMBOL_LEN];
3975 char *modname;
3976
3977 kallsyms_lookup(rec->ip, NULL, NULL, &modname, str);
3978
3979 if (mod_g) {
3980 int mod_matches = (modname) ? ftrace_match(modname, mod_g) : 0;
3981
3982 /* blank module name to match all modules */
3983 if (!mod_g->len) {
3984 /* blank module globbing: modname xor exclude_mod */
3985 if (!exclude_mod != !modname)
3986 goto func_match;
3987 return 0;
3988 }
3989
3990 /*
3991 * exclude_mod is set to trace everything but the given
3992 * module. If it is set and the module matches, then
3993 * return 0. If it is not set, and the module doesn't match
3994 * also return 0. Otherwise, check the function to see if
3995 * that matches.
3996 */
3997 if (!mod_matches == !exclude_mod)
3998 return 0;
3999func_match:
4000 /* blank search means to match all funcs in the mod */
4001 if (!func_g->len)
4002 return 1;
4003 }
4004
4005 return ftrace_match(str, func_g);
4006}
4007
4008static int
4009match_records(struct ftrace_hash *hash, char *func, int len, char *mod)
4010{
4011 struct ftrace_page *pg;
4012 struct dyn_ftrace *rec;
4013 struct ftrace_glob func_g = { .type = MATCH_FULL };
4014 struct ftrace_glob mod_g = { .type = MATCH_FULL };
4015 struct ftrace_glob *mod_match = (mod) ? &mod_g : NULL;
4016 int exclude_mod = 0;
4017 int found = 0;
4018 int ret;
4019 int clear_filter = 0;
4020
4021 if (func) {
4022 func_g.type = filter_parse_regex(func, len, &func_g.search,
4023 &clear_filter);
4024 func_g.len = strlen(func_g.search);
4025 }
4026
4027 if (mod) {
4028 mod_g.type = filter_parse_regex(mod, strlen(mod),
4029 &mod_g.search, &exclude_mod);
4030 mod_g.len = strlen(mod_g.search);
4031 }
4032
4033 mutex_lock(&ftrace_lock);
4034
4035 if (unlikely(ftrace_disabled))
4036 goto out_unlock;
4037
David Brazdil0f672f62019-12-10 10:32:29 +00004038 if (func_g.type == MATCH_INDEX) {
4039 found = add_rec_by_index(hash, &func_g, clear_filter);
4040 goto out_unlock;
4041 }
4042
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004043 do_for_each_ftrace_rec(pg, rec) {
4044
4045 if (rec->flags & FTRACE_FL_DISABLED)
4046 continue;
4047
4048 if (ftrace_match_record(rec, &func_g, mod_match, exclude_mod)) {
4049 ret = enter_record(hash, rec, clear_filter);
4050 if (ret < 0) {
4051 found = ret;
4052 goto out_unlock;
4053 }
4054 found = 1;
4055 }
4056 } while_for_each_ftrace_rec();
4057 out_unlock:
4058 mutex_unlock(&ftrace_lock);
4059
4060 return found;
4061}
4062
4063static int
4064ftrace_match_records(struct ftrace_hash *hash, char *buff, int len)
4065{
4066 return match_records(hash, buff, len, NULL);
4067}
4068
4069static void ftrace_ops_update_code(struct ftrace_ops *ops,
4070 struct ftrace_ops_hash *old_hash)
4071{
4072 struct ftrace_ops *op;
4073
4074 if (!ftrace_enabled)
4075 return;
4076
4077 if (ops->flags & FTRACE_OPS_FL_ENABLED) {
4078 ftrace_run_modify_code(ops, FTRACE_UPDATE_CALLS, old_hash);
4079 return;
4080 }
4081
4082 /*
4083 * If this is the shared global_ops filter, then we need to
4084 * check if there is another ops that shares it, is enabled.
4085 * If so, we still need to run the modify code.
4086 */
4087 if (ops->func_hash != &global_ops.local_hash)
4088 return;
4089
4090 do_for_each_ftrace_op(op, ftrace_ops_list) {
4091 if (op->func_hash == &global_ops.local_hash &&
4092 op->flags & FTRACE_OPS_FL_ENABLED) {
4093 ftrace_run_modify_code(op, FTRACE_UPDATE_CALLS, old_hash);
4094 /* Only need to do this once */
4095 return;
4096 }
4097 } while_for_each_ftrace_op(op);
4098}
4099
4100static int ftrace_hash_move_and_update_ops(struct ftrace_ops *ops,
4101 struct ftrace_hash **orig_hash,
4102 struct ftrace_hash *hash,
4103 int enable)
4104{
4105 struct ftrace_ops_hash old_hash_ops;
4106 struct ftrace_hash *old_hash;
4107 int ret;
4108
4109 old_hash = *orig_hash;
4110 old_hash_ops.filter_hash = ops->func_hash->filter_hash;
4111 old_hash_ops.notrace_hash = ops->func_hash->notrace_hash;
4112 ret = ftrace_hash_move(ops, enable, orig_hash, hash);
4113 if (!ret) {
4114 ftrace_ops_update_code(ops, &old_hash_ops);
4115 free_ftrace_hash_rcu(old_hash);
4116 }
4117 return ret;
4118}
4119
4120static bool module_exists(const char *module)
4121{
4122 /* All modules have the symbol __this_module */
David Brazdil0f672f62019-12-10 10:32:29 +00004123 static const char this_mod[] = "__this_module";
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004124 char modname[MAX_PARAM_PREFIX_LEN + sizeof(this_mod) + 2];
4125 unsigned long val;
4126 int n;
4127
4128 n = snprintf(modname, sizeof(modname), "%s:%s", module, this_mod);
4129
4130 if (n > sizeof(modname) - 1)
4131 return false;
4132
4133 val = module_kallsyms_lookup_name(modname);
4134 return val != 0;
4135}
4136
4137static int cache_mod(struct trace_array *tr,
4138 const char *func, char *module, int enable)
4139{
4140 struct ftrace_mod_load *ftrace_mod, *n;
4141 struct list_head *head = enable ? &tr->mod_trace : &tr->mod_notrace;
4142 int ret;
4143
4144 mutex_lock(&ftrace_lock);
4145
4146 /* We do not cache inverse filters */
4147 if (func[0] == '!') {
4148 func++;
4149 ret = -EINVAL;
4150
4151 /* Look to remove this hash */
4152 list_for_each_entry_safe(ftrace_mod, n, head, list) {
4153 if (strcmp(ftrace_mod->module, module) != 0)
4154 continue;
4155
4156 /* no func matches all */
4157 if (strcmp(func, "*") == 0 ||
4158 (ftrace_mod->func &&
4159 strcmp(ftrace_mod->func, func) == 0)) {
4160 ret = 0;
4161 free_ftrace_mod(ftrace_mod);
4162 continue;
4163 }
4164 }
4165 goto out;
4166 }
4167
4168 ret = -EINVAL;
4169 /* We only care about modules that have not been loaded yet */
4170 if (module_exists(module))
4171 goto out;
4172
4173 /* Save this string off, and execute it when the module is loaded */
4174 ret = ftrace_add_mod(tr, func, module, enable);
4175 out:
4176 mutex_unlock(&ftrace_lock);
4177
4178 return ret;
4179}
4180
4181static int
4182ftrace_set_regex(struct ftrace_ops *ops, unsigned char *buf, int len,
4183 int reset, int enable);
4184
4185#ifdef CONFIG_MODULES
4186static void process_mod_list(struct list_head *head, struct ftrace_ops *ops,
4187 char *mod, bool enable)
4188{
4189 struct ftrace_mod_load *ftrace_mod, *n;
4190 struct ftrace_hash **orig_hash, *new_hash;
4191 LIST_HEAD(process_mods);
4192 char *func;
4193 int ret;
4194
4195 mutex_lock(&ops->func_hash->regex_lock);
4196
4197 if (enable)
4198 orig_hash = &ops->func_hash->filter_hash;
4199 else
4200 orig_hash = &ops->func_hash->notrace_hash;
4201
4202 new_hash = alloc_and_copy_ftrace_hash(FTRACE_HASH_DEFAULT_BITS,
4203 *orig_hash);
4204 if (!new_hash)
4205 goto out; /* warn? */
4206
4207 mutex_lock(&ftrace_lock);
4208
4209 list_for_each_entry_safe(ftrace_mod, n, head, list) {
4210
4211 if (strcmp(ftrace_mod->module, mod) != 0)
4212 continue;
4213
4214 if (ftrace_mod->func)
4215 func = kstrdup(ftrace_mod->func, GFP_KERNEL);
4216 else
4217 func = kstrdup("*", GFP_KERNEL);
4218
4219 if (!func) /* warn? */
4220 continue;
4221
4222 list_del(&ftrace_mod->list);
4223 list_add(&ftrace_mod->list, &process_mods);
4224
4225 /* Use the newly allocated func, as it may be "*" */
4226 kfree(ftrace_mod->func);
4227 ftrace_mod->func = func;
4228 }
4229
4230 mutex_unlock(&ftrace_lock);
4231
4232 list_for_each_entry_safe(ftrace_mod, n, &process_mods, list) {
4233
4234 func = ftrace_mod->func;
4235
4236 /* Grabs ftrace_lock, which is why we have this extra step */
4237 match_records(new_hash, func, strlen(func), mod);
4238 free_ftrace_mod(ftrace_mod);
4239 }
4240
4241 if (enable && list_empty(head))
4242 new_hash->flags &= ~FTRACE_HASH_FL_MOD;
4243
4244 mutex_lock(&ftrace_lock);
4245
4246 ret = ftrace_hash_move_and_update_ops(ops, orig_hash,
4247 new_hash, enable);
4248 mutex_unlock(&ftrace_lock);
4249
4250 out:
4251 mutex_unlock(&ops->func_hash->regex_lock);
4252
4253 free_ftrace_hash(new_hash);
4254}
4255
4256static void process_cached_mods(const char *mod_name)
4257{
4258 struct trace_array *tr;
4259 char *mod;
4260
4261 mod = kstrdup(mod_name, GFP_KERNEL);
4262 if (!mod)
4263 return;
4264
4265 mutex_lock(&trace_types_lock);
4266 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
4267 if (!list_empty(&tr->mod_trace))
4268 process_mod_list(&tr->mod_trace, tr->ops, mod, true);
4269 if (!list_empty(&tr->mod_notrace))
4270 process_mod_list(&tr->mod_notrace, tr->ops, mod, false);
4271 }
4272 mutex_unlock(&trace_types_lock);
4273
4274 kfree(mod);
4275}
4276#endif
4277
4278/*
4279 * We register the module command as a template to show others how
4280 * to register the a command as well.
4281 */
4282
4283static int
4284ftrace_mod_callback(struct trace_array *tr, struct ftrace_hash *hash,
4285 char *func_orig, char *cmd, char *module, int enable)
4286{
4287 char *func;
4288 int ret;
4289
4290 /* match_records() modifies func, and we need the original */
4291 func = kstrdup(func_orig, GFP_KERNEL);
4292 if (!func)
4293 return -ENOMEM;
4294
4295 /*
4296 * cmd == 'mod' because we only registered this func
4297 * for the 'mod' ftrace_func_command.
4298 * But if you register one func with multiple commands,
4299 * you can tell which command was used by the cmd
4300 * parameter.
4301 */
4302 ret = match_records(hash, func, strlen(func), module);
4303 kfree(func);
4304
4305 if (!ret)
4306 return cache_mod(tr, func_orig, module, enable);
4307 if (ret < 0)
4308 return ret;
4309 return 0;
4310}
4311
4312static struct ftrace_func_command ftrace_mod_cmd = {
4313 .name = "mod",
4314 .func = ftrace_mod_callback,
4315};
4316
4317static int __init ftrace_mod_cmd_init(void)
4318{
4319 return register_ftrace_command(&ftrace_mod_cmd);
4320}
4321core_initcall(ftrace_mod_cmd_init);
4322
4323static void function_trace_probe_call(unsigned long ip, unsigned long parent_ip,
4324 struct ftrace_ops *op, struct pt_regs *pt_regs)
4325{
4326 struct ftrace_probe_ops *probe_ops;
4327 struct ftrace_func_probe *probe;
4328
4329 probe = container_of(op, struct ftrace_func_probe, ops);
4330 probe_ops = probe->probe_ops;
4331
4332 /*
4333 * Disable preemption for these calls to prevent a RCU grace
4334 * period. This syncs the hash iteration and freeing of items
4335 * on the hash. rcu_read_lock is too dangerous here.
4336 */
4337 preempt_disable_notrace();
4338 probe_ops->func(ip, parent_ip, probe->tr, probe_ops, probe->data);
4339 preempt_enable_notrace();
4340}
4341
4342struct ftrace_func_map {
4343 struct ftrace_func_entry entry;
4344 void *data;
4345};
4346
4347struct ftrace_func_mapper {
4348 struct ftrace_hash hash;
4349};
4350
4351/**
4352 * allocate_ftrace_func_mapper - allocate a new ftrace_func_mapper
4353 *
4354 * Returns a ftrace_func_mapper descriptor that can be used to map ips to data.
4355 */
4356struct ftrace_func_mapper *allocate_ftrace_func_mapper(void)
4357{
4358 struct ftrace_hash *hash;
4359
4360 /*
4361 * The mapper is simply a ftrace_hash, but since the entries
4362 * in the hash are not ftrace_func_entry type, we define it
4363 * as a separate structure.
4364 */
4365 hash = alloc_ftrace_hash(FTRACE_HASH_DEFAULT_BITS);
4366 return (struct ftrace_func_mapper *)hash;
4367}
4368
4369/**
4370 * ftrace_func_mapper_find_ip - Find some data mapped to an ip
4371 * @mapper: The mapper that has the ip maps
4372 * @ip: the instruction pointer to find the data for
4373 *
4374 * Returns the data mapped to @ip if found otherwise NULL. The return
4375 * is actually the address of the mapper data pointer. The address is
4376 * returned for use cases where the data is no bigger than a long, and
4377 * the user can use the data pointer as its data instead of having to
4378 * allocate more memory for the reference.
4379 */
4380void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
4381 unsigned long ip)
4382{
4383 struct ftrace_func_entry *entry;
4384 struct ftrace_func_map *map;
4385
4386 entry = ftrace_lookup_ip(&mapper->hash, ip);
4387 if (!entry)
4388 return NULL;
4389
4390 map = (struct ftrace_func_map *)entry;
4391 return &map->data;
4392}
4393
4394/**
4395 * ftrace_func_mapper_add_ip - Map some data to an ip
4396 * @mapper: The mapper that has the ip maps
4397 * @ip: The instruction pointer address to map @data to
4398 * @data: The data to map to @ip
4399 *
Olivier Deprez157378f2022-04-04 15:47:50 +02004400 * Returns 0 on success otherwise an error.
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004401 */
4402int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
4403 unsigned long ip, void *data)
4404{
4405 struct ftrace_func_entry *entry;
4406 struct ftrace_func_map *map;
4407
4408 entry = ftrace_lookup_ip(&mapper->hash, ip);
4409 if (entry)
4410 return -EBUSY;
4411
4412 map = kmalloc(sizeof(*map), GFP_KERNEL);
4413 if (!map)
4414 return -ENOMEM;
4415
4416 map->entry.ip = ip;
4417 map->data = data;
4418
4419 __add_hash_entry(&mapper->hash, &map->entry);
4420
4421 return 0;
4422}
4423
4424/**
4425 * ftrace_func_mapper_remove_ip - Remove an ip from the mapping
4426 * @mapper: The mapper that has the ip maps
4427 * @ip: The instruction pointer address to remove the data from
4428 *
4429 * Returns the data if it is found, otherwise NULL.
4430 * Note, if the data pointer is used as the data itself, (see
4431 * ftrace_func_mapper_find_ip(), then the return value may be meaningless,
4432 * if the data pointer was set to zero.
4433 */
4434void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
4435 unsigned long ip)
4436{
4437 struct ftrace_func_entry *entry;
4438 struct ftrace_func_map *map;
4439 void *data;
4440
4441 entry = ftrace_lookup_ip(&mapper->hash, ip);
4442 if (!entry)
4443 return NULL;
4444
4445 map = (struct ftrace_func_map *)entry;
4446 data = map->data;
4447
4448 remove_hash_entry(&mapper->hash, entry);
4449 kfree(entry);
4450
4451 return data;
4452}
4453
4454/**
4455 * free_ftrace_func_mapper - free a mapping of ips and data
4456 * @mapper: The mapper that has the ip maps
4457 * @free_func: A function to be called on each data item.
4458 *
4459 * This is used to free the function mapper. The @free_func is optional
4460 * and can be used if the data needs to be freed as well.
4461 */
4462void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
4463 ftrace_mapper_func free_func)
4464{
4465 struct ftrace_func_entry *entry;
4466 struct ftrace_func_map *map;
4467 struct hlist_head *hhd;
David Brazdil0f672f62019-12-10 10:32:29 +00004468 int size, i;
4469
4470 if (!mapper)
4471 return;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004472
4473 if (free_func && mapper->hash.count) {
David Brazdil0f672f62019-12-10 10:32:29 +00004474 size = 1 << mapper->hash.size_bits;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004475 for (i = 0; i < size; i++) {
4476 hhd = &mapper->hash.buckets[i];
4477 hlist_for_each_entry(entry, hhd, hlist) {
4478 map = (struct ftrace_func_map *)entry;
4479 free_func(map);
4480 }
4481 }
4482 }
4483 free_ftrace_hash(&mapper->hash);
4484}
4485
4486static void release_probe(struct ftrace_func_probe *probe)
4487{
4488 struct ftrace_probe_ops *probe_ops;
4489
4490 mutex_lock(&ftrace_lock);
4491
4492 WARN_ON(probe->ref <= 0);
4493
4494 /* Subtract the ref that was used to protect this instance */
4495 probe->ref--;
4496
4497 if (!probe->ref) {
4498 probe_ops = probe->probe_ops;
4499 /*
4500 * Sending zero as ip tells probe_ops to free
4501 * the probe->data itself
4502 */
4503 if (probe_ops->free)
4504 probe_ops->free(probe_ops, probe->tr, 0, probe->data);
4505 list_del(&probe->list);
4506 kfree(probe);
4507 }
4508 mutex_unlock(&ftrace_lock);
4509}
4510
4511static void acquire_probe_locked(struct ftrace_func_probe *probe)
4512{
4513 /*
4514 * Add one ref to keep it from being freed when releasing the
4515 * ftrace_lock mutex.
4516 */
4517 probe->ref++;
4518}
4519
4520int
4521register_ftrace_function_probe(char *glob, struct trace_array *tr,
4522 struct ftrace_probe_ops *probe_ops,
4523 void *data)
4524{
4525 struct ftrace_func_entry *entry;
4526 struct ftrace_func_probe *probe;
4527 struct ftrace_hash **orig_hash;
4528 struct ftrace_hash *old_hash;
4529 struct ftrace_hash *hash;
4530 int count = 0;
4531 int size;
4532 int ret;
4533 int i;
4534
4535 if (WARN_ON(!tr))
4536 return -EINVAL;
4537
4538 /* We do not support '!' for function probes */
4539 if (WARN_ON(glob[0] == '!'))
4540 return -EINVAL;
4541
4542
4543 mutex_lock(&ftrace_lock);
4544 /* Check if the probe_ops is already registered */
4545 list_for_each_entry(probe, &tr->func_probes, list) {
4546 if (probe->probe_ops == probe_ops)
4547 break;
4548 }
4549 if (&probe->list == &tr->func_probes) {
4550 probe = kzalloc(sizeof(*probe), GFP_KERNEL);
4551 if (!probe) {
4552 mutex_unlock(&ftrace_lock);
4553 return -ENOMEM;
4554 }
4555 probe->probe_ops = probe_ops;
4556 probe->ops.func = function_trace_probe_call;
4557 probe->tr = tr;
4558 ftrace_ops_init(&probe->ops);
4559 list_add(&probe->list, &tr->func_probes);
4560 }
4561
4562 acquire_probe_locked(probe);
4563
4564 mutex_unlock(&ftrace_lock);
4565
David Brazdil0f672f62019-12-10 10:32:29 +00004566 /*
4567 * Note, there's a small window here that the func_hash->filter_hash
Olivier Deprez157378f2022-04-04 15:47:50 +02004568 * may be NULL or empty. Need to be careful when reading the loop.
David Brazdil0f672f62019-12-10 10:32:29 +00004569 */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004570 mutex_lock(&probe->ops.func_hash->regex_lock);
4571
4572 orig_hash = &probe->ops.func_hash->filter_hash;
4573 old_hash = *orig_hash;
4574 hash = alloc_and_copy_ftrace_hash(FTRACE_HASH_DEFAULT_BITS, old_hash);
4575
David Brazdil0f672f62019-12-10 10:32:29 +00004576 if (!hash) {
4577 ret = -ENOMEM;
4578 goto out;
4579 }
4580
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004581 ret = ftrace_match_records(hash, glob, strlen(glob));
4582
4583 /* Nothing found? */
4584 if (!ret)
4585 ret = -EINVAL;
4586
4587 if (ret < 0)
4588 goto out;
4589
4590 size = 1 << hash->size_bits;
4591 for (i = 0; i < size; i++) {
4592 hlist_for_each_entry(entry, &hash->buckets[i], hlist) {
4593 if (ftrace_lookup_ip(old_hash, entry->ip))
4594 continue;
4595 /*
4596 * The caller might want to do something special
4597 * for each function we find. We call the callback
4598 * to give the caller an opportunity to do so.
4599 */
4600 if (probe_ops->init) {
4601 ret = probe_ops->init(probe_ops, tr,
4602 entry->ip, data,
4603 &probe->data);
4604 if (ret < 0) {
4605 if (probe_ops->free && count)
4606 probe_ops->free(probe_ops, tr,
4607 0, probe->data);
4608 probe->data = NULL;
4609 goto out;
4610 }
4611 }
4612 count++;
4613 }
4614 }
4615
4616 mutex_lock(&ftrace_lock);
4617
4618 if (!count) {
4619 /* Nothing was added? */
4620 ret = -EINVAL;
4621 goto out_unlock;
4622 }
4623
4624 ret = ftrace_hash_move_and_update_ops(&probe->ops, orig_hash,
4625 hash, 1);
4626 if (ret < 0)
4627 goto err_unlock;
4628
4629 /* One ref for each new function traced */
4630 probe->ref += count;
4631
4632 if (!(probe->ops.flags & FTRACE_OPS_FL_ENABLED))
4633 ret = ftrace_startup(&probe->ops, 0);
4634
4635 out_unlock:
4636 mutex_unlock(&ftrace_lock);
4637
4638 if (!ret)
4639 ret = count;
4640 out:
4641 mutex_unlock(&probe->ops.func_hash->regex_lock);
4642 free_ftrace_hash(hash);
4643
4644 release_probe(probe);
4645
4646 return ret;
4647
4648 err_unlock:
4649 if (!probe_ops->free || !count)
4650 goto out_unlock;
4651
4652 /* Failed to do the move, need to call the free functions */
4653 for (i = 0; i < size; i++) {
4654 hlist_for_each_entry(entry, &hash->buckets[i], hlist) {
4655 if (ftrace_lookup_ip(old_hash, entry->ip))
4656 continue;
4657 probe_ops->free(probe_ops, tr, entry->ip, probe->data);
4658 }
4659 }
4660 goto out_unlock;
4661}
4662
4663int
4664unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
4665 struct ftrace_probe_ops *probe_ops)
4666{
4667 struct ftrace_ops_hash old_hash_ops;
4668 struct ftrace_func_entry *entry;
4669 struct ftrace_func_probe *probe;
4670 struct ftrace_glob func_g;
4671 struct ftrace_hash **orig_hash;
4672 struct ftrace_hash *old_hash;
4673 struct ftrace_hash *hash = NULL;
4674 struct hlist_node *tmp;
4675 struct hlist_head hhd;
4676 char str[KSYM_SYMBOL_LEN];
4677 int count = 0;
4678 int i, ret = -ENODEV;
4679 int size;
4680
4681 if (!glob || !strlen(glob) || !strcmp(glob, "*"))
4682 func_g.search = NULL;
4683 else {
4684 int not;
4685
4686 func_g.type = filter_parse_regex(glob, strlen(glob),
4687 &func_g.search, &not);
4688 func_g.len = strlen(func_g.search);
4689
4690 /* we do not support '!' for function probes */
4691 if (WARN_ON(not))
4692 return -EINVAL;
4693 }
4694
4695 mutex_lock(&ftrace_lock);
4696 /* Check if the probe_ops is already registered */
4697 list_for_each_entry(probe, &tr->func_probes, list) {
4698 if (probe->probe_ops == probe_ops)
4699 break;
4700 }
4701 if (&probe->list == &tr->func_probes)
4702 goto err_unlock_ftrace;
4703
4704 ret = -EINVAL;
4705 if (!(probe->ops.flags & FTRACE_OPS_FL_INITIALIZED))
4706 goto err_unlock_ftrace;
4707
4708 acquire_probe_locked(probe);
4709
4710 mutex_unlock(&ftrace_lock);
4711
4712 mutex_lock(&probe->ops.func_hash->regex_lock);
4713
4714 orig_hash = &probe->ops.func_hash->filter_hash;
4715 old_hash = *orig_hash;
4716
4717 if (ftrace_hash_empty(old_hash))
4718 goto out_unlock;
4719
4720 old_hash_ops.filter_hash = old_hash;
4721 /* Probes only have filters */
4722 old_hash_ops.notrace_hash = NULL;
4723
4724 ret = -ENOMEM;
4725 hash = alloc_and_copy_ftrace_hash(FTRACE_HASH_DEFAULT_BITS, old_hash);
4726 if (!hash)
4727 goto out_unlock;
4728
4729 INIT_HLIST_HEAD(&hhd);
4730
4731 size = 1 << hash->size_bits;
4732 for (i = 0; i < size; i++) {
4733 hlist_for_each_entry_safe(entry, tmp, &hash->buckets[i], hlist) {
4734
4735 if (func_g.search) {
4736 kallsyms_lookup(entry->ip, NULL, NULL,
4737 NULL, str);
4738 if (!ftrace_match(str, &func_g))
4739 continue;
4740 }
4741 count++;
4742 remove_hash_entry(hash, entry);
4743 hlist_add_head(&entry->hlist, &hhd);
4744 }
4745 }
4746
4747 /* Nothing found? */
4748 if (!count) {
4749 ret = -EINVAL;
4750 goto out_unlock;
4751 }
4752
4753 mutex_lock(&ftrace_lock);
4754
4755 WARN_ON(probe->ref < count);
4756
4757 probe->ref -= count;
4758
4759 if (ftrace_hash_empty(hash))
4760 ftrace_shutdown(&probe->ops, 0);
4761
4762 ret = ftrace_hash_move_and_update_ops(&probe->ops, orig_hash,
4763 hash, 1);
4764
4765 /* still need to update the function call sites */
4766 if (ftrace_enabled && !ftrace_hash_empty(hash))
4767 ftrace_run_modify_code(&probe->ops, FTRACE_UPDATE_CALLS,
4768 &old_hash_ops);
David Brazdil0f672f62019-12-10 10:32:29 +00004769 synchronize_rcu();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004770
4771 hlist_for_each_entry_safe(entry, tmp, &hhd, hlist) {
4772 hlist_del(&entry->hlist);
4773 if (probe_ops->free)
4774 probe_ops->free(probe_ops, tr, entry->ip, probe->data);
4775 kfree(entry);
4776 }
4777 mutex_unlock(&ftrace_lock);
4778
4779 out_unlock:
4780 mutex_unlock(&probe->ops.func_hash->regex_lock);
4781 free_ftrace_hash(hash);
4782
4783 release_probe(probe);
4784
4785 return ret;
4786
4787 err_unlock_ftrace:
4788 mutex_unlock(&ftrace_lock);
4789 return ret;
4790}
4791
4792void clear_ftrace_function_probes(struct trace_array *tr)
4793{
4794 struct ftrace_func_probe *probe, *n;
4795
4796 list_for_each_entry_safe(probe, n, &tr->func_probes, list)
4797 unregister_ftrace_function_probe_func(NULL, tr, probe->probe_ops);
4798}
4799
4800static LIST_HEAD(ftrace_commands);
4801static DEFINE_MUTEX(ftrace_cmd_mutex);
4802
4803/*
4804 * Currently we only register ftrace commands from __init, so mark this
4805 * __init too.
4806 */
4807__init int register_ftrace_command(struct ftrace_func_command *cmd)
4808{
4809 struct ftrace_func_command *p;
4810 int ret = 0;
4811
4812 mutex_lock(&ftrace_cmd_mutex);
4813 list_for_each_entry(p, &ftrace_commands, list) {
4814 if (strcmp(cmd->name, p->name) == 0) {
4815 ret = -EBUSY;
4816 goto out_unlock;
4817 }
4818 }
4819 list_add(&cmd->list, &ftrace_commands);
4820 out_unlock:
4821 mutex_unlock(&ftrace_cmd_mutex);
4822
4823 return ret;
4824}
4825
4826/*
4827 * Currently we only unregister ftrace commands from __init, so mark
4828 * this __init too.
4829 */
4830__init int unregister_ftrace_command(struct ftrace_func_command *cmd)
4831{
4832 struct ftrace_func_command *p, *n;
4833 int ret = -ENODEV;
4834
4835 mutex_lock(&ftrace_cmd_mutex);
4836 list_for_each_entry_safe(p, n, &ftrace_commands, list) {
4837 if (strcmp(cmd->name, p->name) == 0) {
4838 ret = 0;
4839 list_del_init(&p->list);
4840 goto out_unlock;
4841 }
4842 }
4843 out_unlock:
4844 mutex_unlock(&ftrace_cmd_mutex);
4845
4846 return ret;
4847}
4848
4849static int ftrace_process_regex(struct ftrace_iterator *iter,
4850 char *buff, int len, int enable)
4851{
4852 struct ftrace_hash *hash = iter->hash;
4853 struct trace_array *tr = iter->ops->private;
4854 char *func, *command, *next = buff;
4855 struct ftrace_func_command *p;
4856 int ret = -EINVAL;
4857
4858 func = strsep(&next, ":");
4859
4860 if (!next) {
4861 ret = ftrace_match_records(hash, func, len);
4862 if (!ret)
4863 ret = -EINVAL;
4864 if (ret < 0)
4865 return ret;
4866 return 0;
4867 }
4868
4869 /* command found */
4870
4871 command = strsep(&next, ":");
4872
4873 mutex_lock(&ftrace_cmd_mutex);
4874 list_for_each_entry(p, &ftrace_commands, list) {
4875 if (strcmp(p->name, command) == 0) {
4876 ret = p->func(tr, hash, func, command, next, enable);
4877 goto out_unlock;
4878 }
4879 }
4880 out_unlock:
4881 mutex_unlock(&ftrace_cmd_mutex);
4882
4883 return ret;
4884}
4885
4886static ssize_t
4887ftrace_regex_write(struct file *file, const char __user *ubuf,
4888 size_t cnt, loff_t *ppos, int enable)
4889{
4890 struct ftrace_iterator *iter;
4891 struct trace_parser *parser;
4892 ssize_t ret, read;
4893
4894 if (!cnt)
4895 return 0;
4896
4897 if (file->f_mode & FMODE_READ) {
4898 struct seq_file *m = file->private_data;
4899 iter = m->private;
4900 } else
4901 iter = file->private_data;
4902
4903 if (unlikely(ftrace_disabled))
4904 return -ENODEV;
4905
4906 /* iter->hash is a local copy, so we don't need regex_lock */
4907
4908 parser = &iter->parser;
4909 read = trace_get_user(parser, ubuf, cnt, ppos);
4910
4911 if (read >= 0 && trace_parser_loaded(parser) &&
4912 !trace_parser_cont(parser)) {
4913 ret = ftrace_process_regex(iter, parser->buffer,
4914 parser->idx, enable);
4915 trace_parser_clear(parser);
4916 if (ret < 0)
4917 goto out;
4918 }
4919
4920 ret = read;
4921 out:
4922 return ret;
4923}
4924
4925ssize_t
4926ftrace_filter_write(struct file *file, const char __user *ubuf,
4927 size_t cnt, loff_t *ppos)
4928{
4929 return ftrace_regex_write(file, ubuf, cnt, ppos, 1);
4930}
4931
4932ssize_t
4933ftrace_notrace_write(struct file *file, const char __user *ubuf,
4934 size_t cnt, loff_t *ppos)
4935{
4936 return ftrace_regex_write(file, ubuf, cnt, ppos, 0);
4937}
4938
4939static int
4940ftrace_match_addr(struct ftrace_hash *hash, unsigned long ip, int remove)
4941{
4942 struct ftrace_func_entry *entry;
4943
4944 if (!ftrace_location(ip))
4945 return -EINVAL;
4946
4947 if (remove) {
4948 entry = ftrace_lookup_ip(hash, ip);
4949 if (!entry)
4950 return -ENOENT;
4951 free_hash_entry(hash, entry);
4952 return 0;
4953 }
4954
4955 return add_hash_entry(hash, ip);
4956}
4957
4958static int
4959ftrace_set_hash(struct ftrace_ops *ops, unsigned char *buf, int len,
4960 unsigned long ip, int remove, int reset, int enable)
4961{
4962 struct ftrace_hash **orig_hash;
4963 struct ftrace_hash *hash;
4964 int ret;
4965
4966 if (unlikely(ftrace_disabled))
4967 return -ENODEV;
4968
4969 mutex_lock(&ops->func_hash->regex_lock);
4970
4971 if (enable)
4972 orig_hash = &ops->func_hash->filter_hash;
4973 else
4974 orig_hash = &ops->func_hash->notrace_hash;
4975
4976 if (reset)
4977 hash = alloc_ftrace_hash(FTRACE_HASH_DEFAULT_BITS);
4978 else
4979 hash = alloc_and_copy_ftrace_hash(FTRACE_HASH_DEFAULT_BITS, *orig_hash);
4980
4981 if (!hash) {
4982 ret = -ENOMEM;
4983 goto out_regex_unlock;
4984 }
4985
4986 if (buf && !ftrace_match_records(hash, buf, len)) {
4987 ret = -EINVAL;
4988 goto out_regex_unlock;
4989 }
4990 if (ip) {
4991 ret = ftrace_match_addr(hash, ip, remove);
4992 if (ret < 0)
4993 goto out_regex_unlock;
4994 }
4995
4996 mutex_lock(&ftrace_lock);
4997 ret = ftrace_hash_move_and_update_ops(ops, orig_hash, hash, enable);
4998 mutex_unlock(&ftrace_lock);
4999
5000 out_regex_unlock:
5001 mutex_unlock(&ops->func_hash->regex_lock);
5002
5003 free_ftrace_hash(hash);
5004 return ret;
5005}
5006
5007static int
5008ftrace_set_addr(struct ftrace_ops *ops, unsigned long ip, int remove,
5009 int reset, int enable)
5010{
David Brazdil0f672f62019-12-10 10:32:29 +00005011 return ftrace_set_hash(ops, NULL, 0, ip, remove, reset, enable);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005012}
5013
Olivier Deprez157378f2022-04-04 15:47:50 +02005014#ifdef CONFIG_DYNAMIC_FTRACE_WITH_DIRECT_CALLS
5015
5016struct ftrace_direct_func {
5017 struct list_head next;
5018 unsigned long addr;
5019 int count;
5020};
5021
5022static LIST_HEAD(ftrace_direct_funcs);
5023
5024/**
5025 * ftrace_find_direct_func - test an address if it is a registered direct caller
5026 * @addr: The address of a registered direct caller
5027 *
5028 * This searches to see if a ftrace direct caller has been registered
5029 * at a specific address, and if so, it returns a descriptor for it.
5030 *
5031 * This can be used by architecture code to see if an address is
5032 * a direct caller (trampoline) attached to a fentry/mcount location.
5033 * This is useful for the function_graph tracer, as it may need to
5034 * do adjustments if it traced a location that also has a direct
5035 * trampoline attached to it.
5036 */
5037struct ftrace_direct_func *ftrace_find_direct_func(unsigned long addr)
5038{
5039 struct ftrace_direct_func *entry;
5040 bool found = false;
5041
5042 /* May be called by fgraph trampoline (protected by rcu tasks) */
5043 list_for_each_entry_rcu(entry, &ftrace_direct_funcs, next) {
5044 if (entry->addr == addr) {
5045 found = true;
5046 break;
5047 }
5048 }
5049 if (found)
5050 return entry;
5051
5052 return NULL;
5053}
5054
5055static struct ftrace_direct_func *ftrace_alloc_direct_func(unsigned long addr)
5056{
5057 struct ftrace_direct_func *direct;
5058
5059 direct = kmalloc(sizeof(*direct), GFP_KERNEL);
5060 if (!direct)
5061 return NULL;
5062 direct->addr = addr;
5063 direct->count = 0;
5064 list_add_rcu(&direct->next, &ftrace_direct_funcs);
5065 ftrace_direct_func_count++;
5066 return direct;
5067}
5068
5069/**
5070 * register_ftrace_direct - Call a custom trampoline directly
5071 * @ip: The address of the nop at the beginning of a function
5072 * @addr: The address of the trampoline to call at @ip
5073 *
5074 * This is used to connect a direct call from the nop location (@ip)
5075 * at the start of ftrace traced functions. The location that it calls
5076 * (@addr) must be able to handle a direct call, and save the parameters
5077 * of the function being traced, and restore them (or inject new ones
5078 * if needed), before returning.
5079 *
5080 * Returns:
5081 * 0 on success
5082 * -EBUSY - Another direct function is already attached (there can be only one)
5083 * -ENODEV - @ip does not point to a ftrace nop location (or not supported)
5084 * -ENOMEM - There was an allocation failure.
5085 */
5086int register_ftrace_direct(unsigned long ip, unsigned long addr)
5087{
5088 struct ftrace_direct_func *direct;
5089 struct ftrace_func_entry *entry;
5090 struct ftrace_hash *free_hash = NULL;
5091 struct dyn_ftrace *rec;
5092 int ret = -EBUSY;
5093
5094 mutex_lock(&direct_mutex);
5095
5096 /* See if there's a direct function at @ip already */
5097 if (ftrace_find_rec_direct(ip))
5098 goto out_unlock;
5099
5100 ret = -ENODEV;
5101 rec = lookup_rec(ip, ip);
5102 if (!rec)
5103 goto out_unlock;
5104
5105 /*
5106 * Check if the rec says it has a direct call but we didn't
5107 * find one earlier?
5108 */
5109 if (WARN_ON(rec->flags & FTRACE_FL_DIRECT))
5110 goto out_unlock;
5111
5112 /* Make sure the ip points to the exact record */
5113 if (ip != rec->ip) {
5114 ip = rec->ip;
5115 /* Need to check this ip for a direct. */
5116 if (ftrace_find_rec_direct(ip))
5117 goto out_unlock;
5118 }
5119
5120 ret = -ENOMEM;
5121 if (ftrace_hash_empty(direct_functions) ||
5122 direct_functions->count > 2 * (1 << direct_functions->size_bits)) {
5123 struct ftrace_hash *new_hash;
5124 int size = ftrace_hash_empty(direct_functions) ? 0 :
5125 direct_functions->count + 1;
5126
5127 if (size < 32)
5128 size = 32;
5129
5130 new_hash = dup_hash(direct_functions, size);
5131 if (!new_hash)
5132 goto out_unlock;
5133
5134 free_hash = direct_functions;
5135 direct_functions = new_hash;
5136 }
5137
5138 entry = kmalloc(sizeof(*entry), GFP_KERNEL);
5139 if (!entry)
5140 goto out_unlock;
5141
5142 direct = ftrace_find_direct_func(addr);
5143 if (!direct) {
5144 direct = ftrace_alloc_direct_func(addr);
5145 if (!direct) {
5146 kfree(entry);
5147 goto out_unlock;
5148 }
5149 }
5150
5151 entry->ip = ip;
5152 entry->direct = addr;
5153 __add_hash_entry(direct_functions, entry);
5154
5155 ret = ftrace_set_filter_ip(&direct_ops, ip, 0, 0);
5156 if (ret)
5157 remove_hash_entry(direct_functions, entry);
5158
5159 if (!ret && !(direct_ops.flags & FTRACE_OPS_FL_ENABLED)) {
5160 ret = register_ftrace_function(&direct_ops);
5161 if (ret)
5162 ftrace_set_filter_ip(&direct_ops, ip, 1, 0);
5163 }
5164
5165 if (ret) {
5166 kfree(entry);
5167 if (!direct->count) {
5168 list_del_rcu(&direct->next);
5169 synchronize_rcu_tasks();
5170 kfree(direct);
5171 if (free_hash)
5172 free_ftrace_hash(free_hash);
5173 free_hash = NULL;
5174 ftrace_direct_func_count--;
5175 }
5176 } else {
5177 direct->count++;
5178 }
5179 out_unlock:
5180 mutex_unlock(&direct_mutex);
5181
5182 if (free_hash) {
5183 synchronize_rcu_tasks();
5184 free_ftrace_hash(free_hash);
5185 }
5186
5187 return ret;
5188}
5189EXPORT_SYMBOL_GPL(register_ftrace_direct);
5190
5191static struct ftrace_func_entry *find_direct_entry(unsigned long *ip,
5192 struct dyn_ftrace **recp)
5193{
5194 struct ftrace_func_entry *entry;
5195 struct dyn_ftrace *rec;
5196
5197 rec = lookup_rec(*ip, *ip);
5198 if (!rec)
5199 return NULL;
5200
5201 entry = __ftrace_lookup_ip(direct_functions, rec->ip);
5202 if (!entry) {
5203 WARN_ON(rec->flags & FTRACE_FL_DIRECT);
5204 return NULL;
5205 }
5206
5207 WARN_ON(!(rec->flags & FTRACE_FL_DIRECT));
5208
5209 /* Passed in ip just needs to be on the call site */
5210 *ip = rec->ip;
5211
5212 if (recp)
5213 *recp = rec;
5214
5215 return entry;
5216}
5217
5218int unregister_ftrace_direct(unsigned long ip, unsigned long addr)
5219{
5220 struct ftrace_direct_func *direct;
5221 struct ftrace_func_entry *entry;
5222 int ret = -ENODEV;
5223
5224 mutex_lock(&direct_mutex);
5225
5226 entry = find_direct_entry(&ip, NULL);
5227 if (!entry)
5228 goto out_unlock;
5229
5230 if (direct_functions->count == 1)
5231 unregister_ftrace_function(&direct_ops);
5232
5233 ret = ftrace_set_filter_ip(&direct_ops, ip, 1, 0);
5234
5235 WARN_ON(ret);
5236
5237 remove_hash_entry(direct_functions, entry);
5238
5239 direct = ftrace_find_direct_func(addr);
5240 if (!WARN_ON(!direct)) {
5241 /* This is the good path (see the ! before WARN) */
5242 direct->count--;
5243 WARN_ON(direct->count < 0);
5244 if (!direct->count) {
5245 list_del_rcu(&direct->next);
5246 synchronize_rcu_tasks();
5247 kfree(direct);
5248 kfree(entry);
5249 ftrace_direct_func_count--;
5250 }
5251 }
5252 out_unlock:
5253 mutex_unlock(&direct_mutex);
5254
5255 return ret;
5256}
5257EXPORT_SYMBOL_GPL(unregister_ftrace_direct);
5258
5259static struct ftrace_ops stub_ops = {
5260 .func = ftrace_stub,
5261};
5262
5263/**
5264 * ftrace_modify_direct_caller - modify ftrace nop directly
5265 * @entry: The ftrace hash entry of the direct helper for @rec
5266 * @rec: The record representing the function site to patch
5267 * @old_addr: The location that the site at @rec->ip currently calls
5268 * @new_addr: The location that the site at @rec->ip should call
5269 *
5270 * An architecture may overwrite this function to optimize the
5271 * changing of the direct callback on an ftrace nop location.
5272 * This is called with the ftrace_lock mutex held, and no other
5273 * ftrace callbacks are on the associated record (@rec). Thus,
5274 * it is safe to modify the ftrace record, where it should be
5275 * currently calling @old_addr directly, to call @new_addr.
5276 *
5277 * Safety checks should be made to make sure that the code at
5278 * @rec->ip is currently calling @old_addr. And this must
5279 * also update entry->direct to @new_addr.
5280 */
5281int __weak ftrace_modify_direct_caller(struct ftrace_func_entry *entry,
5282 struct dyn_ftrace *rec,
5283 unsigned long old_addr,
5284 unsigned long new_addr)
5285{
5286 unsigned long ip = rec->ip;
5287 int ret;
5288
5289 /*
5290 * The ftrace_lock was used to determine if the record
5291 * had more than one registered user to it. If it did,
5292 * we needed to prevent that from changing to do the quick
5293 * switch. But if it did not (only a direct caller was attached)
5294 * then this function is called. But this function can deal
5295 * with attached callers to the rec that we care about, and
5296 * since this function uses standard ftrace calls that take
5297 * the ftrace_lock mutex, we need to release it.
5298 */
5299 mutex_unlock(&ftrace_lock);
5300
5301 /*
5302 * By setting a stub function at the same address, we force
5303 * the code to call the iterator and the direct_ops helper.
5304 * This means that @ip does not call the direct call, and
5305 * we can simply modify it.
5306 */
5307 ret = ftrace_set_filter_ip(&stub_ops, ip, 0, 0);
5308 if (ret)
5309 goto out_lock;
5310
5311 ret = register_ftrace_function(&stub_ops);
5312 if (ret) {
5313 ftrace_set_filter_ip(&stub_ops, ip, 1, 0);
5314 goto out_lock;
5315 }
5316
5317 entry->direct = new_addr;
5318
5319 /*
5320 * By removing the stub, we put back the direct call, calling
5321 * the @new_addr.
5322 */
5323 unregister_ftrace_function(&stub_ops);
5324 ftrace_set_filter_ip(&stub_ops, ip, 1, 0);
5325
5326 out_lock:
5327 mutex_lock(&ftrace_lock);
5328
5329 return ret;
5330}
5331
5332/**
5333 * modify_ftrace_direct - Modify an existing direct call to call something else
5334 * @ip: The instruction pointer to modify
5335 * @old_addr: The address that the current @ip calls directly
5336 * @new_addr: The address that the @ip should call
5337 *
5338 * This modifies a ftrace direct caller at an instruction pointer without
5339 * having to disable it first. The direct call will switch over to the
5340 * @new_addr without missing anything.
5341 *
5342 * Returns: zero on success. Non zero on error, which includes:
5343 * -ENODEV : the @ip given has no direct caller attached
5344 * -EINVAL : the @old_addr does not match the current direct caller
5345 */
5346int modify_ftrace_direct(unsigned long ip,
5347 unsigned long old_addr, unsigned long new_addr)
5348{
5349 struct ftrace_direct_func *direct, *new_direct = NULL;
5350 struct ftrace_func_entry *entry;
5351 struct dyn_ftrace *rec;
5352 int ret = -ENODEV;
5353
5354 mutex_lock(&direct_mutex);
5355
5356 mutex_lock(&ftrace_lock);
5357 entry = find_direct_entry(&ip, &rec);
5358 if (!entry)
5359 goto out_unlock;
5360
5361 ret = -EINVAL;
5362 if (entry->direct != old_addr)
5363 goto out_unlock;
5364
5365 direct = ftrace_find_direct_func(old_addr);
5366 if (WARN_ON(!direct))
5367 goto out_unlock;
5368 if (direct->count > 1) {
5369 ret = -ENOMEM;
5370 new_direct = ftrace_alloc_direct_func(new_addr);
5371 if (!new_direct)
5372 goto out_unlock;
5373 direct->count--;
5374 new_direct->count++;
5375 } else {
5376 direct->addr = new_addr;
5377 }
5378
5379 /*
5380 * If there's no other ftrace callback on the rec->ip location,
5381 * then it can be changed directly by the architecture.
5382 * If there is another caller, then we just need to change the
5383 * direct caller helper to point to @new_addr.
5384 */
5385 if (ftrace_rec_count(rec) == 1) {
5386 ret = ftrace_modify_direct_caller(entry, rec, old_addr, new_addr);
5387 } else {
5388 entry->direct = new_addr;
5389 ret = 0;
5390 }
5391
5392 if (unlikely(ret && new_direct)) {
5393 direct->count++;
5394 list_del_rcu(&new_direct->next);
5395 synchronize_rcu_tasks();
5396 kfree(new_direct);
5397 ftrace_direct_func_count--;
5398 }
5399
5400 out_unlock:
5401 mutex_unlock(&ftrace_lock);
5402 mutex_unlock(&direct_mutex);
5403 return ret;
5404}
5405EXPORT_SYMBOL_GPL(modify_ftrace_direct);
5406#endif /* CONFIG_DYNAMIC_FTRACE_WITH_DIRECT_CALLS */
5407
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005408/**
5409 * ftrace_set_filter_ip - set a function to filter on in ftrace by address
5410 * @ops - the ops to set the filter with
5411 * @ip - the address to add to or remove from the filter.
5412 * @remove - non zero to remove the ip from the filter
5413 * @reset - non zero to reset all filters before applying this filter.
5414 *
5415 * Filters denote which functions should be enabled when tracing is enabled
5416 * If @ip is NULL, it failes to update filter.
5417 */
5418int ftrace_set_filter_ip(struct ftrace_ops *ops, unsigned long ip,
5419 int remove, int reset)
5420{
5421 ftrace_ops_init(ops);
5422 return ftrace_set_addr(ops, ip, remove, reset, 1);
5423}
5424EXPORT_SYMBOL_GPL(ftrace_set_filter_ip);
5425
5426/**
5427 * ftrace_ops_set_global_filter - setup ops to use global filters
5428 * @ops - the ops which will use the global filters
5429 *
5430 * ftrace users who need global function trace filtering should call this.
5431 * It can set the global filter only if ops were not initialized before.
5432 */
5433void ftrace_ops_set_global_filter(struct ftrace_ops *ops)
5434{
5435 if (ops->flags & FTRACE_OPS_FL_INITIALIZED)
5436 return;
5437
5438 ftrace_ops_init(ops);
5439 ops->func_hash = &global_ops.local_hash;
5440}
5441EXPORT_SYMBOL_GPL(ftrace_ops_set_global_filter);
5442
5443static int
5444ftrace_set_regex(struct ftrace_ops *ops, unsigned char *buf, int len,
5445 int reset, int enable)
5446{
5447 return ftrace_set_hash(ops, buf, len, 0, 0, reset, enable);
5448}
5449
5450/**
5451 * ftrace_set_filter - set a function to filter on in ftrace
5452 * @ops - the ops to set the filter with
5453 * @buf - the string that holds the function filter text.
5454 * @len - the length of the string.
5455 * @reset - non zero to reset all filters before applying this filter.
5456 *
5457 * Filters denote which functions should be enabled when tracing is enabled.
5458 * If @buf is NULL and reset is set, all functions will be enabled for tracing.
5459 */
5460int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
5461 int len, int reset)
5462{
5463 ftrace_ops_init(ops);
5464 return ftrace_set_regex(ops, buf, len, reset, 1);
5465}
5466EXPORT_SYMBOL_GPL(ftrace_set_filter);
5467
5468/**
5469 * ftrace_set_notrace - set a function to not trace in ftrace
5470 * @ops - the ops to set the notrace filter with
5471 * @buf - the string that holds the function notrace text.
5472 * @len - the length of the string.
5473 * @reset - non zero to reset all filters before applying this filter.
5474 *
5475 * Notrace Filters denote which functions should not be enabled when tracing
5476 * is enabled. If @buf is NULL and reset is set, all functions will be enabled
5477 * for tracing.
5478 */
5479int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
5480 int len, int reset)
5481{
5482 ftrace_ops_init(ops);
5483 return ftrace_set_regex(ops, buf, len, reset, 0);
5484}
5485EXPORT_SYMBOL_GPL(ftrace_set_notrace);
5486/**
5487 * ftrace_set_global_filter - set a function to filter on with global tracers
5488 * @buf - the string that holds the function filter text.
5489 * @len - the length of the string.
5490 * @reset - non zero to reset all filters before applying this filter.
5491 *
5492 * Filters denote which functions should be enabled when tracing is enabled.
5493 * If @buf is NULL and reset is set, all functions will be enabled for tracing.
5494 */
5495void ftrace_set_global_filter(unsigned char *buf, int len, int reset)
5496{
5497 ftrace_set_regex(&global_ops, buf, len, reset, 1);
5498}
5499EXPORT_SYMBOL_GPL(ftrace_set_global_filter);
5500
5501/**
5502 * ftrace_set_global_notrace - set a function to not trace with global tracers
5503 * @buf - the string that holds the function notrace text.
5504 * @len - the length of the string.
5505 * @reset - non zero to reset all filters before applying this filter.
5506 *
5507 * Notrace Filters denote which functions should not be enabled when tracing
5508 * is enabled. If @buf is NULL and reset is set, all functions will be enabled
5509 * for tracing.
5510 */
5511void ftrace_set_global_notrace(unsigned char *buf, int len, int reset)
5512{
5513 ftrace_set_regex(&global_ops, buf, len, reset, 0);
5514}
5515EXPORT_SYMBOL_GPL(ftrace_set_global_notrace);
5516
5517/*
5518 * command line interface to allow users to set filters on boot up.
5519 */
5520#define FTRACE_FILTER_SIZE COMMAND_LINE_SIZE
5521static char ftrace_notrace_buf[FTRACE_FILTER_SIZE] __initdata;
5522static char ftrace_filter_buf[FTRACE_FILTER_SIZE] __initdata;
5523
5524/* Used by function selftest to not test if filter is set */
5525bool ftrace_filter_param __initdata;
5526
5527static int __init set_ftrace_notrace(char *str)
5528{
5529 ftrace_filter_param = true;
5530 strlcpy(ftrace_notrace_buf, str, FTRACE_FILTER_SIZE);
5531 return 1;
5532}
5533__setup("ftrace_notrace=", set_ftrace_notrace);
5534
5535static int __init set_ftrace_filter(char *str)
5536{
5537 ftrace_filter_param = true;
5538 strlcpy(ftrace_filter_buf, str, FTRACE_FILTER_SIZE);
5539 return 1;
5540}
5541__setup("ftrace_filter=", set_ftrace_filter);
5542
5543#ifdef CONFIG_FUNCTION_GRAPH_TRACER
5544static char ftrace_graph_buf[FTRACE_FILTER_SIZE] __initdata;
5545static char ftrace_graph_notrace_buf[FTRACE_FILTER_SIZE] __initdata;
5546static int ftrace_graph_set_hash(struct ftrace_hash *hash, char *buffer);
5547
5548static int __init set_graph_function(char *str)
5549{
5550 strlcpy(ftrace_graph_buf, str, FTRACE_FILTER_SIZE);
5551 return 1;
5552}
5553__setup("ftrace_graph_filter=", set_graph_function);
5554
5555static int __init set_graph_notrace_function(char *str)
5556{
5557 strlcpy(ftrace_graph_notrace_buf, str, FTRACE_FILTER_SIZE);
5558 return 1;
5559}
5560__setup("ftrace_graph_notrace=", set_graph_notrace_function);
5561
5562static int __init set_graph_max_depth_function(char *str)
5563{
5564 if (!str)
5565 return 0;
5566 fgraph_max_depth = simple_strtoul(str, NULL, 0);
5567 return 1;
5568}
5569__setup("ftrace_graph_max_depth=", set_graph_max_depth_function);
5570
5571static void __init set_ftrace_early_graph(char *buf, int enable)
5572{
5573 int ret;
5574 char *func;
5575 struct ftrace_hash *hash;
5576
5577 hash = alloc_ftrace_hash(FTRACE_HASH_DEFAULT_BITS);
Olivier Deprez157378f2022-04-04 15:47:50 +02005578 if (MEM_FAIL(!hash, "Failed to allocate hash\n"))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005579 return;
5580
5581 while (buf) {
5582 func = strsep(&buf, ",");
5583 /* we allow only one expression at a time */
5584 ret = ftrace_graph_set_hash(hash, func);
5585 if (ret)
5586 printk(KERN_DEBUG "ftrace: function %s not "
5587 "traceable\n", func);
5588 }
5589
5590 if (enable)
5591 ftrace_graph_hash = hash;
5592 else
5593 ftrace_graph_notrace_hash = hash;
5594}
5595#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
5596
5597void __init
5598ftrace_set_early_filter(struct ftrace_ops *ops, char *buf, int enable)
5599{
5600 char *func;
5601
5602 ftrace_ops_init(ops);
5603
5604 while (buf) {
5605 func = strsep(&buf, ",");
5606 ftrace_set_regex(ops, func, strlen(func), 0, enable);
5607 }
5608}
5609
5610static void __init set_ftrace_early_filters(void)
5611{
5612 if (ftrace_filter_buf[0])
5613 ftrace_set_early_filter(&global_ops, ftrace_filter_buf, 1);
5614 if (ftrace_notrace_buf[0])
5615 ftrace_set_early_filter(&global_ops, ftrace_notrace_buf, 0);
5616#ifdef CONFIG_FUNCTION_GRAPH_TRACER
5617 if (ftrace_graph_buf[0])
5618 set_ftrace_early_graph(ftrace_graph_buf, 1);
5619 if (ftrace_graph_notrace_buf[0])
5620 set_ftrace_early_graph(ftrace_graph_notrace_buf, 0);
5621#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
5622}
5623
5624int ftrace_regex_release(struct inode *inode, struct file *file)
5625{
5626 struct seq_file *m = (struct seq_file *)file->private_data;
5627 struct ftrace_iterator *iter;
5628 struct ftrace_hash **orig_hash;
5629 struct trace_parser *parser;
5630 int filter_hash;
5631 int ret;
5632
5633 if (file->f_mode & FMODE_READ) {
5634 iter = m->private;
5635 seq_release(inode, file);
5636 } else
5637 iter = file->private_data;
5638
5639 parser = &iter->parser;
5640 if (trace_parser_loaded(parser)) {
Olivier Deprez0e641232021-09-23 10:07:05 +02005641 int enable = !(iter->flags & FTRACE_ITER_NOTRACE);
5642
5643 ftrace_process_regex(iter, parser->buffer,
5644 parser->idx, enable);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005645 }
5646
5647 trace_parser_put(parser);
5648
5649 mutex_lock(&iter->ops->func_hash->regex_lock);
5650
5651 if (file->f_mode & FMODE_WRITE) {
5652 filter_hash = !!(iter->flags & FTRACE_ITER_FILTER);
5653
5654 if (filter_hash) {
5655 orig_hash = &iter->ops->func_hash->filter_hash;
5656 if (iter->tr && !list_empty(&iter->tr->mod_trace))
5657 iter->hash->flags |= FTRACE_HASH_FL_MOD;
5658 } else
5659 orig_hash = &iter->ops->func_hash->notrace_hash;
5660
5661 mutex_lock(&ftrace_lock);
5662 ret = ftrace_hash_move_and_update_ops(iter->ops, orig_hash,
5663 iter->hash, filter_hash);
5664 mutex_unlock(&ftrace_lock);
5665 } else {
5666 /* For read only, the hash is the ops hash */
5667 iter->hash = NULL;
5668 }
5669
5670 mutex_unlock(&iter->ops->func_hash->regex_lock);
5671 free_ftrace_hash(iter->hash);
David Brazdil0f672f62019-12-10 10:32:29 +00005672 if (iter->tr)
5673 trace_array_put(iter->tr);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005674 kfree(iter);
5675
5676 return 0;
5677}
5678
5679static const struct file_operations ftrace_avail_fops = {
5680 .open = ftrace_avail_open,
5681 .read = seq_read,
5682 .llseek = seq_lseek,
5683 .release = seq_release_private,
5684};
5685
5686static const struct file_operations ftrace_enabled_fops = {
5687 .open = ftrace_enabled_open,
5688 .read = seq_read,
5689 .llseek = seq_lseek,
5690 .release = seq_release_private,
5691};
5692
5693static const struct file_operations ftrace_filter_fops = {
5694 .open = ftrace_filter_open,
5695 .read = seq_read,
5696 .write = ftrace_filter_write,
5697 .llseek = tracing_lseek,
5698 .release = ftrace_regex_release,
5699};
5700
5701static const struct file_operations ftrace_notrace_fops = {
5702 .open = ftrace_notrace_open,
5703 .read = seq_read,
5704 .write = ftrace_notrace_write,
5705 .llseek = tracing_lseek,
5706 .release = ftrace_regex_release,
5707};
5708
5709#ifdef CONFIG_FUNCTION_GRAPH_TRACER
5710
5711static DEFINE_MUTEX(graph_lock);
5712
Olivier Deprez0e641232021-09-23 10:07:05 +02005713struct ftrace_hash __rcu *ftrace_graph_hash = EMPTY_HASH;
5714struct ftrace_hash __rcu *ftrace_graph_notrace_hash = EMPTY_HASH;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005715
5716enum graph_filter_type {
5717 GRAPH_FILTER_NOTRACE = 0,
5718 GRAPH_FILTER_FUNCTION,
5719};
5720
5721#define FTRACE_GRAPH_EMPTY ((void *)1)
5722
5723struct ftrace_graph_data {
5724 struct ftrace_hash *hash;
5725 struct ftrace_func_entry *entry;
5726 int idx; /* for hash table iteration */
5727 enum graph_filter_type type;
5728 struct ftrace_hash *new_hash;
5729 const struct seq_operations *seq_ops;
5730 struct trace_parser parser;
5731};
5732
5733static void *
5734__g_next(struct seq_file *m, loff_t *pos)
5735{
5736 struct ftrace_graph_data *fgd = m->private;
5737 struct ftrace_func_entry *entry = fgd->entry;
5738 struct hlist_head *head;
5739 int i, idx = fgd->idx;
5740
5741 if (*pos >= fgd->hash->count)
5742 return NULL;
5743
5744 if (entry) {
5745 hlist_for_each_entry_continue(entry, hlist) {
5746 fgd->entry = entry;
5747 return entry;
5748 }
5749
5750 idx++;
5751 }
5752
5753 for (i = idx; i < 1 << fgd->hash->size_bits; i++) {
5754 head = &fgd->hash->buckets[i];
5755 hlist_for_each_entry(entry, head, hlist) {
5756 fgd->entry = entry;
5757 fgd->idx = i;
5758 return entry;
5759 }
5760 }
5761 return NULL;
5762}
5763
5764static void *
5765g_next(struct seq_file *m, void *v, loff_t *pos)
5766{
5767 (*pos)++;
5768 return __g_next(m, pos);
5769}
5770
5771static void *g_start(struct seq_file *m, loff_t *pos)
5772{
5773 struct ftrace_graph_data *fgd = m->private;
5774
5775 mutex_lock(&graph_lock);
5776
5777 if (fgd->type == GRAPH_FILTER_FUNCTION)
5778 fgd->hash = rcu_dereference_protected(ftrace_graph_hash,
5779 lockdep_is_held(&graph_lock));
5780 else
5781 fgd->hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
5782 lockdep_is_held(&graph_lock));
5783
5784 /* Nothing, tell g_show to print all functions are enabled */
5785 if (ftrace_hash_empty(fgd->hash) && !*pos)
5786 return FTRACE_GRAPH_EMPTY;
5787
5788 fgd->idx = 0;
5789 fgd->entry = NULL;
5790 return __g_next(m, pos);
5791}
5792
5793static void g_stop(struct seq_file *m, void *p)
5794{
5795 mutex_unlock(&graph_lock);
5796}
5797
5798static int g_show(struct seq_file *m, void *v)
5799{
5800 struct ftrace_func_entry *entry = v;
5801
5802 if (!entry)
5803 return 0;
5804
5805 if (entry == FTRACE_GRAPH_EMPTY) {
5806 struct ftrace_graph_data *fgd = m->private;
5807
5808 if (fgd->type == GRAPH_FILTER_FUNCTION)
5809 seq_puts(m, "#### all functions enabled ####\n");
5810 else
5811 seq_puts(m, "#### no functions disabled ####\n");
5812 return 0;
5813 }
5814
5815 seq_printf(m, "%ps\n", (void *)entry->ip);
5816
5817 return 0;
5818}
5819
5820static const struct seq_operations ftrace_graph_seq_ops = {
5821 .start = g_start,
5822 .next = g_next,
5823 .stop = g_stop,
5824 .show = g_show,
5825};
5826
5827static int
5828__ftrace_graph_open(struct inode *inode, struct file *file,
5829 struct ftrace_graph_data *fgd)
5830{
David Brazdil0f672f62019-12-10 10:32:29 +00005831 int ret;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005832 struct ftrace_hash *new_hash = NULL;
5833
David Brazdil0f672f62019-12-10 10:32:29 +00005834 ret = security_locked_down(LOCKDOWN_TRACEFS);
5835 if (ret)
5836 return ret;
5837
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005838 if (file->f_mode & FMODE_WRITE) {
5839 const int size_bits = FTRACE_HASH_DEFAULT_BITS;
5840
5841 if (trace_parser_get_init(&fgd->parser, FTRACE_BUFF_MAX))
5842 return -ENOMEM;
5843
5844 if (file->f_flags & O_TRUNC)
5845 new_hash = alloc_ftrace_hash(size_bits);
5846 else
5847 new_hash = alloc_and_copy_ftrace_hash(size_bits,
5848 fgd->hash);
5849 if (!new_hash) {
5850 ret = -ENOMEM;
5851 goto out;
5852 }
5853 }
5854
5855 if (file->f_mode & FMODE_READ) {
5856 ret = seq_open(file, &ftrace_graph_seq_ops);
5857 if (!ret) {
5858 struct seq_file *m = file->private_data;
5859 m->private = fgd;
5860 } else {
5861 /* Failed */
5862 free_ftrace_hash(new_hash);
5863 new_hash = NULL;
5864 }
5865 } else
5866 file->private_data = fgd;
5867
5868out:
5869 if (ret < 0 && file->f_mode & FMODE_WRITE)
5870 trace_parser_put(&fgd->parser);
5871
5872 fgd->new_hash = new_hash;
5873
5874 /*
5875 * All uses of fgd->hash must be taken with the graph_lock
5876 * held. The graph_lock is going to be released, so force
5877 * fgd->hash to be reinitialized when it is taken again.
5878 */
5879 fgd->hash = NULL;
5880
5881 return ret;
5882}
5883
5884static int
5885ftrace_graph_open(struct inode *inode, struct file *file)
5886{
5887 struct ftrace_graph_data *fgd;
5888 int ret;
5889
5890 if (unlikely(ftrace_disabled))
5891 return -ENODEV;
5892
5893 fgd = kmalloc(sizeof(*fgd), GFP_KERNEL);
5894 if (fgd == NULL)
5895 return -ENOMEM;
5896
5897 mutex_lock(&graph_lock);
5898
5899 fgd->hash = rcu_dereference_protected(ftrace_graph_hash,
5900 lockdep_is_held(&graph_lock));
5901 fgd->type = GRAPH_FILTER_FUNCTION;
5902 fgd->seq_ops = &ftrace_graph_seq_ops;
5903
5904 ret = __ftrace_graph_open(inode, file, fgd);
5905 if (ret < 0)
5906 kfree(fgd);
5907
5908 mutex_unlock(&graph_lock);
5909 return ret;
5910}
5911
5912static int
5913ftrace_graph_notrace_open(struct inode *inode, struct file *file)
5914{
5915 struct ftrace_graph_data *fgd;
5916 int ret;
5917
5918 if (unlikely(ftrace_disabled))
5919 return -ENODEV;
5920
5921 fgd = kmalloc(sizeof(*fgd), GFP_KERNEL);
5922 if (fgd == NULL)
5923 return -ENOMEM;
5924
5925 mutex_lock(&graph_lock);
5926
5927 fgd->hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
5928 lockdep_is_held(&graph_lock));
5929 fgd->type = GRAPH_FILTER_NOTRACE;
5930 fgd->seq_ops = &ftrace_graph_seq_ops;
5931
5932 ret = __ftrace_graph_open(inode, file, fgd);
5933 if (ret < 0)
5934 kfree(fgd);
5935
5936 mutex_unlock(&graph_lock);
5937 return ret;
5938}
5939
5940static int
5941ftrace_graph_release(struct inode *inode, struct file *file)
5942{
5943 struct ftrace_graph_data *fgd;
5944 struct ftrace_hash *old_hash, *new_hash;
5945 struct trace_parser *parser;
5946 int ret = 0;
5947
5948 if (file->f_mode & FMODE_READ) {
5949 struct seq_file *m = file->private_data;
5950
5951 fgd = m->private;
5952 seq_release(inode, file);
5953 } else {
5954 fgd = file->private_data;
5955 }
5956
5957
5958 if (file->f_mode & FMODE_WRITE) {
5959
5960 parser = &fgd->parser;
5961
5962 if (trace_parser_loaded((parser))) {
5963 ret = ftrace_graph_set_hash(fgd->new_hash,
5964 parser->buffer);
5965 }
5966
5967 trace_parser_put(parser);
5968
5969 new_hash = __ftrace_hash_move(fgd->new_hash);
5970 if (!new_hash) {
5971 ret = -ENOMEM;
5972 goto out;
5973 }
5974
5975 mutex_lock(&graph_lock);
5976
5977 if (fgd->type == GRAPH_FILTER_FUNCTION) {
5978 old_hash = rcu_dereference_protected(ftrace_graph_hash,
5979 lockdep_is_held(&graph_lock));
5980 rcu_assign_pointer(ftrace_graph_hash, new_hash);
5981 } else {
5982 old_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
5983 lockdep_is_held(&graph_lock));
5984 rcu_assign_pointer(ftrace_graph_notrace_hash, new_hash);
5985 }
5986
5987 mutex_unlock(&graph_lock);
5988
Olivier Deprez0e641232021-09-23 10:07:05 +02005989 /*
5990 * We need to do a hard force of sched synchronization.
5991 * This is because we use preempt_disable() to do RCU, but
5992 * the function tracers can be called where RCU is not watching
5993 * (like before user_exit()). We can not rely on the RCU
5994 * infrastructure to do the synchronization, thus we must do it
5995 * ourselves.
5996 */
Olivier Deprez157378f2022-04-04 15:47:50 +02005997 synchronize_rcu_tasks_rude();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00005998
5999 free_ftrace_hash(old_hash);
6000 }
6001
6002 out:
6003 free_ftrace_hash(fgd->new_hash);
6004 kfree(fgd);
6005
6006 return ret;
6007}
6008
6009static int
6010ftrace_graph_set_hash(struct ftrace_hash *hash, char *buffer)
6011{
6012 struct ftrace_glob func_g;
6013 struct dyn_ftrace *rec;
6014 struct ftrace_page *pg;
6015 struct ftrace_func_entry *entry;
6016 int fail = 1;
6017 int not;
6018
6019 /* decode regex */
6020 func_g.type = filter_parse_regex(buffer, strlen(buffer),
6021 &func_g.search, &not);
6022
6023 func_g.len = strlen(func_g.search);
6024
6025 mutex_lock(&ftrace_lock);
6026
6027 if (unlikely(ftrace_disabled)) {
6028 mutex_unlock(&ftrace_lock);
6029 return -ENODEV;
6030 }
6031
6032 do_for_each_ftrace_rec(pg, rec) {
6033
6034 if (rec->flags & FTRACE_FL_DISABLED)
6035 continue;
6036
6037 if (ftrace_match_record(rec, &func_g, NULL, 0)) {
6038 entry = ftrace_lookup_ip(hash, rec->ip);
6039
6040 if (!not) {
6041 fail = 0;
6042
6043 if (entry)
6044 continue;
6045 if (add_hash_entry(hash, rec->ip) < 0)
6046 goto out;
6047 } else {
6048 if (entry) {
6049 free_hash_entry(hash, entry);
6050 fail = 0;
6051 }
6052 }
6053 }
6054 } while_for_each_ftrace_rec();
6055out:
6056 mutex_unlock(&ftrace_lock);
6057
6058 if (fail)
6059 return -EINVAL;
6060
6061 return 0;
6062}
6063
6064static ssize_t
6065ftrace_graph_write(struct file *file, const char __user *ubuf,
6066 size_t cnt, loff_t *ppos)
6067{
6068 ssize_t read, ret = 0;
6069 struct ftrace_graph_data *fgd = file->private_data;
6070 struct trace_parser *parser;
6071
6072 if (!cnt)
6073 return 0;
6074
6075 /* Read mode uses seq functions */
6076 if (file->f_mode & FMODE_READ) {
6077 struct seq_file *m = file->private_data;
6078 fgd = m->private;
6079 }
6080
6081 parser = &fgd->parser;
6082
6083 read = trace_get_user(parser, ubuf, cnt, ppos);
6084
6085 if (read >= 0 && trace_parser_loaded(parser) &&
6086 !trace_parser_cont(parser)) {
6087
6088 ret = ftrace_graph_set_hash(fgd->new_hash,
6089 parser->buffer);
6090 trace_parser_clear(parser);
6091 }
6092
6093 if (!ret)
6094 ret = read;
6095
6096 return ret;
6097}
6098
6099static const struct file_operations ftrace_graph_fops = {
6100 .open = ftrace_graph_open,
6101 .read = seq_read,
6102 .write = ftrace_graph_write,
6103 .llseek = tracing_lseek,
6104 .release = ftrace_graph_release,
6105};
6106
6107static const struct file_operations ftrace_graph_notrace_fops = {
6108 .open = ftrace_graph_notrace_open,
6109 .read = seq_read,
6110 .write = ftrace_graph_write,
6111 .llseek = tracing_lseek,
6112 .release = ftrace_graph_release,
6113};
6114#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
6115
6116void ftrace_create_filter_files(struct ftrace_ops *ops,
6117 struct dentry *parent)
6118{
6119
6120 trace_create_file("set_ftrace_filter", 0644, parent,
6121 ops, &ftrace_filter_fops);
6122
6123 trace_create_file("set_ftrace_notrace", 0644, parent,
6124 ops, &ftrace_notrace_fops);
6125}
6126
6127/*
6128 * The name "destroy_filter_files" is really a misnomer. Although
David Brazdil0f672f62019-12-10 10:32:29 +00006129 * in the future, it may actually delete the files, but this is
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006130 * really intended to make sure the ops passed in are disabled
6131 * and that when this function returns, the caller is free to
6132 * free the ops.
6133 *
6134 * The "destroy" name is only to match the "create" name that this
6135 * should be paired with.
6136 */
6137void ftrace_destroy_filter_files(struct ftrace_ops *ops)
6138{
6139 mutex_lock(&ftrace_lock);
6140 if (ops->flags & FTRACE_OPS_FL_ENABLED)
6141 ftrace_shutdown(ops, 0);
6142 ops->flags |= FTRACE_OPS_FL_DELETED;
6143 ftrace_free_filter(ops);
6144 mutex_unlock(&ftrace_lock);
6145}
6146
6147static __init int ftrace_init_dyn_tracefs(struct dentry *d_tracer)
6148{
6149
6150 trace_create_file("available_filter_functions", 0444,
6151 d_tracer, NULL, &ftrace_avail_fops);
6152
6153 trace_create_file("enabled_functions", 0444,
6154 d_tracer, NULL, &ftrace_enabled_fops);
6155
6156 ftrace_create_filter_files(&global_ops, d_tracer);
6157
6158#ifdef CONFIG_FUNCTION_GRAPH_TRACER
6159 trace_create_file("set_graph_function", 0644, d_tracer,
6160 NULL,
6161 &ftrace_graph_fops);
6162 trace_create_file("set_graph_notrace", 0644, d_tracer,
6163 NULL,
6164 &ftrace_graph_notrace_fops);
6165#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
6166
6167 return 0;
6168}
6169
6170static int ftrace_cmp_ips(const void *a, const void *b)
6171{
6172 const unsigned long *ipa = a;
6173 const unsigned long *ipb = b;
6174
6175 if (*ipa > *ipb)
6176 return 1;
6177 if (*ipa < *ipb)
6178 return -1;
6179 return 0;
6180}
6181
6182static int ftrace_process_locs(struct module *mod,
6183 unsigned long *start,
6184 unsigned long *end)
6185{
6186 struct ftrace_page *start_pg;
6187 struct ftrace_page *pg;
6188 struct dyn_ftrace *rec;
6189 unsigned long count;
6190 unsigned long *p;
6191 unsigned long addr;
6192 unsigned long flags = 0; /* Shut up gcc */
6193 int ret = -ENOMEM;
6194
6195 count = end - start;
6196
6197 if (!count)
6198 return 0;
6199
6200 sort(start, count, sizeof(*start),
6201 ftrace_cmp_ips, NULL);
6202
6203 start_pg = ftrace_allocate_pages(count);
6204 if (!start_pg)
6205 return -ENOMEM;
6206
6207 mutex_lock(&ftrace_lock);
6208
6209 /*
6210 * Core and each module needs their own pages, as
6211 * modules will free them when they are removed.
6212 * Force a new page to be allocated for modules.
6213 */
6214 if (!mod) {
6215 WARN_ON(ftrace_pages || ftrace_pages_start);
6216 /* First initialization */
6217 ftrace_pages = ftrace_pages_start = start_pg;
6218 } else {
6219 if (!ftrace_pages)
6220 goto out;
6221
6222 if (WARN_ON(ftrace_pages->next)) {
6223 /* Hmm, we have free pages? */
6224 while (ftrace_pages->next)
6225 ftrace_pages = ftrace_pages->next;
6226 }
6227
6228 ftrace_pages->next = start_pg;
6229 }
6230
6231 p = start;
6232 pg = start_pg;
6233 while (p < end) {
6234 addr = ftrace_call_adjust(*p++);
6235 /*
6236 * Some architecture linkers will pad between
6237 * the different mcount_loc sections of different
6238 * object files to satisfy alignments.
6239 * Skip any NULL pointers.
6240 */
6241 if (!addr)
6242 continue;
6243
6244 if (pg->index == pg->size) {
6245 /* We should have allocated enough */
6246 if (WARN_ON(!pg->next))
6247 break;
6248 pg = pg->next;
6249 }
6250
6251 rec = &pg->records[pg->index++];
6252 rec->ip = addr;
6253 }
6254
6255 /* We should have used all pages */
6256 WARN_ON(pg->next);
6257
6258 /* Assign the last page to ftrace_pages */
6259 ftrace_pages = pg;
6260
6261 /*
6262 * We only need to disable interrupts on start up
6263 * because we are modifying code that an interrupt
6264 * may execute, and the modification is not atomic.
6265 * But for modules, nothing runs the code we modify
6266 * until we are finished with it, and there's no
6267 * reason to cause large interrupt latencies while we do it.
6268 */
6269 if (!mod)
6270 local_irq_save(flags);
6271 ftrace_update_code(mod, start_pg);
6272 if (!mod)
6273 local_irq_restore(flags);
6274 ret = 0;
6275 out:
6276 mutex_unlock(&ftrace_lock);
6277
6278 return ret;
6279}
6280
6281struct ftrace_mod_func {
6282 struct list_head list;
6283 char *name;
6284 unsigned long ip;
6285 unsigned int size;
6286};
6287
6288struct ftrace_mod_map {
6289 struct rcu_head rcu;
6290 struct list_head list;
6291 struct module *mod;
6292 unsigned long start_addr;
6293 unsigned long end_addr;
6294 struct list_head funcs;
6295 unsigned int num_funcs;
6296};
6297
Olivier Deprez157378f2022-04-04 15:47:50 +02006298static int ftrace_get_trampoline_kallsym(unsigned int symnum,
6299 unsigned long *value, char *type,
6300 char *name, char *module_name,
6301 int *exported)
6302{
6303 struct ftrace_ops *op;
6304
6305 list_for_each_entry_rcu(op, &ftrace_ops_trampoline_list, list) {
6306 if (!op->trampoline || symnum--)
6307 continue;
6308 *value = op->trampoline;
6309 *type = 't';
6310 strlcpy(name, FTRACE_TRAMPOLINE_SYM, KSYM_NAME_LEN);
6311 strlcpy(module_name, FTRACE_TRAMPOLINE_MOD, MODULE_NAME_LEN);
6312 *exported = 0;
6313 return 0;
6314 }
6315
6316 return -ERANGE;
6317}
6318
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006319#ifdef CONFIG_MODULES
6320
6321#define next_to_ftrace_page(p) container_of(p, struct ftrace_page, next)
6322
6323static LIST_HEAD(ftrace_mod_maps);
6324
6325static int referenced_filters(struct dyn_ftrace *rec)
6326{
6327 struct ftrace_ops *ops;
6328 int cnt = 0;
6329
6330 for (ops = ftrace_ops_list; ops != &ftrace_list_end; ops = ops->next) {
Olivier Deprez0e641232021-09-23 10:07:05 +02006331 if (ops_references_rec(ops, rec)) {
Olivier Deprez157378f2022-04-04 15:47:50 +02006332 if (WARN_ON_ONCE(ops->flags & FTRACE_OPS_FL_DIRECT))
6333 continue;
6334 if (WARN_ON_ONCE(ops->flags & FTRACE_OPS_FL_IPMODIFY))
6335 continue;
Olivier Deprez0e641232021-09-23 10:07:05 +02006336 cnt++;
6337 if (ops->flags & FTRACE_OPS_FL_SAVE_REGS)
6338 rec->flags |= FTRACE_FL_REGS;
Olivier Deprez157378f2022-04-04 15:47:50 +02006339 if (cnt == 1 && ops->trampoline)
6340 rec->flags |= FTRACE_FL_TRAMP;
6341 else
6342 rec->flags &= ~FTRACE_FL_TRAMP;
Olivier Deprez0e641232021-09-23 10:07:05 +02006343 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006344 }
6345
6346 return cnt;
6347}
6348
6349static void
6350clear_mod_from_hash(struct ftrace_page *pg, struct ftrace_hash *hash)
6351{
6352 struct ftrace_func_entry *entry;
6353 struct dyn_ftrace *rec;
6354 int i;
6355
6356 if (ftrace_hash_empty(hash))
6357 return;
6358
6359 for (i = 0; i < pg->index; i++) {
6360 rec = &pg->records[i];
6361 entry = __ftrace_lookup_ip(hash, rec->ip);
6362 /*
6363 * Do not allow this rec to match again.
6364 * Yeah, it may waste some memory, but will be removed
6365 * if/when the hash is modified again.
6366 */
6367 if (entry)
6368 entry->ip = 0;
6369 }
6370}
6371
6372/* Clear any records from hashs */
6373static void clear_mod_from_hashes(struct ftrace_page *pg)
6374{
6375 struct trace_array *tr;
6376
6377 mutex_lock(&trace_types_lock);
6378 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
6379 if (!tr->ops || !tr->ops->func_hash)
6380 continue;
6381 mutex_lock(&tr->ops->func_hash->regex_lock);
6382 clear_mod_from_hash(pg, tr->ops->func_hash->filter_hash);
6383 clear_mod_from_hash(pg, tr->ops->func_hash->notrace_hash);
6384 mutex_unlock(&tr->ops->func_hash->regex_lock);
6385 }
6386 mutex_unlock(&trace_types_lock);
6387}
6388
6389static void ftrace_free_mod_map(struct rcu_head *rcu)
6390{
6391 struct ftrace_mod_map *mod_map = container_of(rcu, struct ftrace_mod_map, rcu);
6392 struct ftrace_mod_func *mod_func;
6393 struct ftrace_mod_func *n;
6394
6395 /* All the contents of mod_map are now not visible to readers */
6396 list_for_each_entry_safe(mod_func, n, &mod_map->funcs, list) {
6397 kfree(mod_func->name);
6398 list_del(&mod_func->list);
6399 kfree(mod_func);
6400 }
6401
6402 kfree(mod_map);
6403}
6404
6405void ftrace_release_mod(struct module *mod)
6406{
6407 struct ftrace_mod_map *mod_map;
6408 struct ftrace_mod_map *n;
6409 struct dyn_ftrace *rec;
6410 struct ftrace_page **last_pg;
6411 struct ftrace_page *tmp_page = NULL;
6412 struct ftrace_page *pg;
6413 int order;
6414
6415 mutex_lock(&ftrace_lock);
6416
6417 if (ftrace_disabled)
6418 goto out_unlock;
6419
6420 list_for_each_entry_safe(mod_map, n, &ftrace_mod_maps, list) {
6421 if (mod_map->mod == mod) {
6422 list_del_rcu(&mod_map->list);
David Brazdil0f672f62019-12-10 10:32:29 +00006423 call_rcu(&mod_map->rcu, ftrace_free_mod_map);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006424 break;
6425 }
6426 }
6427
6428 /*
6429 * Each module has its own ftrace_pages, remove
6430 * them from the list.
6431 */
6432 last_pg = &ftrace_pages_start;
6433 for (pg = ftrace_pages_start; pg; pg = *last_pg) {
6434 rec = &pg->records[0];
6435 if (within_module_core(rec->ip, mod) ||
6436 within_module_init(rec->ip, mod)) {
6437 /*
6438 * As core pages are first, the first
6439 * page should never be a module page.
6440 */
6441 if (WARN_ON(pg == ftrace_pages_start))
6442 goto out_unlock;
6443
6444 /* Check if we are deleting the last page */
6445 if (pg == ftrace_pages)
6446 ftrace_pages = next_to_ftrace_page(last_pg);
6447
6448 ftrace_update_tot_cnt -= pg->index;
6449 *last_pg = pg->next;
6450
6451 pg->next = tmp_page;
6452 tmp_page = pg;
6453 } else
6454 last_pg = &pg->next;
6455 }
6456 out_unlock:
6457 mutex_unlock(&ftrace_lock);
6458
6459 for (pg = tmp_page; pg; pg = tmp_page) {
6460
6461 /* Needs to be called outside of ftrace_lock */
6462 clear_mod_from_hashes(pg);
6463
6464 order = get_count_order(pg->size / ENTRIES_PER_PAGE);
Olivier Deprez157378f2022-04-04 15:47:50 +02006465 if (order >= 0)
6466 free_pages((unsigned long)pg->records, order);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006467 tmp_page = pg->next;
6468 kfree(pg);
Olivier Deprez157378f2022-04-04 15:47:50 +02006469 ftrace_number_of_pages -= 1 << order;
6470 ftrace_number_of_groups--;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006471 }
6472}
6473
6474void ftrace_module_enable(struct module *mod)
6475{
6476 struct dyn_ftrace *rec;
6477 struct ftrace_page *pg;
6478
6479 mutex_lock(&ftrace_lock);
6480
6481 if (ftrace_disabled)
6482 goto out_unlock;
6483
6484 /*
6485 * If the tracing is enabled, go ahead and enable the record.
6486 *
David Brazdil0f672f62019-12-10 10:32:29 +00006487 * The reason not to enable the record immediately is the
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006488 * inherent check of ftrace_make_nop/ftrace_make_call for
6489 * correct previous instructions. Making first the NOP
6490 * conversion puts the module to the correct state, thus
6491 * passing the ftrace_make_call check.
6492 *
6493 * We also delay this to after the module code already set the
6494 * text to read-only, as we now need to set it back to read-write
6495 * so that we can modify the text.
6496 */
6497 if (ftrace_start_up)
6498 ftrace_arch_code_modify_prepare();
6499
6500 do_for_each_ftrace_rec(pg, rec) {
6501 int cnt;
6502 /*
6503 * do_for_each_ftrace_rec() is a double loop.
6504 * module text shares the pg. If a record is
6505 * not part of this module, then skip this pg,
6506 * which the "break" will do.
6507 */
6508 if (!within_module_core(rec->ip, mod) &&
6509 !within_module_init(rec->ip, mod))
6510 break;
6511
6512 cnt = 0;
6513
6514 /*
6515 * When adding a module, we need to check if tracers are
6516 * currently enabled and if they are, and can trace this record,
6517 * we need to enable the module functions as well as update the
6518 * reference counts for those function records.
6519 */
6520 if (ftrace_start_up)
6521 cnt += referenced_filters(rec);
6522
Olivier Deprez0e641232021-09-23 10:07:05 +02006523 rec->flags &= ~FTRACE_FL_DISABLED;
6524 rec->flags += cnt;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006525
6526 if (ftrace_start_up && cnt) {
6527 int failed = __ftrace_replace_code(rec, 1);
6528 if (failed) {
6529 ftrace_bug(failed, rec);
6530 goto out_loop;
6531 }
6532 }
6533
6534 } while_for_each_ftrace_rec();
6535
6536 out_loop:
6537 if (ftrace_start_up)
6538 ftrace_arch_code_modify_post_process();
6539
6540 out_unlock:
6541 mutex_unlock(&ftrace_lock);
6542
6543 process_cached_mods(mod->name);
6544}
6545
6546void ftrace_module_init(struct module *mod)
6547{
6548 if (ftrace_disabled || !mod->num_ftrace_callsites)
6549 return;
6550
6551 ftrace_process_locs(mod, mod->ftrace_callsites,
6552 mod->ftrace_callsites + mod->num_ftrace_callsites);
6553}
6554
6555static void save_ftrace_mod_rec(struct ftrace_mod_map *mod_map,
6556 struct dyn_ftrace *rec)
6557{
6558 struct ftrace_mod_func *mod_func;
6559 unsigned long symsize;
6560 unsigned long offset;
6561 char str[KSYM_SYMBOL_LEN];
6562 char *modname;
6563 const char *ret;
6564
6565 ret = kallsyms_lookup(rec->ip, &symsize, &offset, &modname, str);
6566 if (!ret)
6567 return;
6568
6569 mod_func = kmalloc(sizeof(*mod_func), GFP_KERNEL);
6570 if (!mod_func)
6571 return;
6572
6573 mod_func->name = kstrdup(str, GFP_KERNEL);
6574 if (!mod_func->name) {
6575 kfree(mod_func);
6576 return;
6577 }
6578
6579 mod_func->ip = rec->ip - offset;
6580 mod_func->size = symsize;
6581
6582 mod_map->num_funcs++;
6583
6584 list_add_rcu(&mod_func->list, &mod_map->funcs);
6585}
6586
6587static struct ftrace_mod_map *
6588allocate_ftrace_mod_map(struct module *mod,
6589 unsigned long start, unsigned long end)
6590{
6591 struct ftrace_mod_map *mod_map;
6592
6593 mod_map = kmalloc(sizeof(*mod_map), GFP_KERNEL);
6594 if (!mod_map)
6595 return NULL;
6596
6597 mod_map->mod = mod;
6598 mod_map->start_addr = start;
6599 mod_map->end_addr = end;
6600 mod_map->num_funcs = 0;
6601
6602 INIT_LIST_HEAD_RCU(&mod_map->funcs);
6603
6604 list_add_rcu(&mod_map->list, &ftrace_mod_maps);
6605
6606 return mod_map;
6607}
6608
6609static const char *
6610ftrace_func_address_lookup(struct ftrace_mod_map *mod_map,
6611 unsigned long addr, unsigned long *size,
6612 unsigned long *off, char *sym)
6613{
6614 struct ftrace_mod_func *found_func = NULL;
6615 struct ftrace_mod_func *mod_func;
6616
6617 list_for_each_entry_rcu(mod_func, &mod_map->funcs, list) {
6618 if (addr >= mod_func->ip &&
6619 addr < mod_func->ip + mod_func->size) {
6620 found_func = mod_func;
6621 break;
6622 }
6623 }
6624
6625 if (found_func) {
6626 if (size)
6627 *size = found_func->size;
6628 if (off)
6629 *off = addr - found_func->ip;
6630 if (sym)
6631 strlcpy(sym, found_func->name, KSYM_NAME_LEN);
6632
6633 return found_func->name;
6634 }
6635
6636 return NULL;
6637}
6638
6639const char *
6640ftrace_mod_address_lookup(unsigned long addr, unsigned long *size,
6641 unsigned long *off, char **modname, char *sym)
6642{
6643 struct ftrace_mod_map *mod_map;
6644 const char *ret = NULL;
6645
David Brazdil0f672f62019-12-10 10:32:29 +00006646 /* mod_map is freed via call_rcu() */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006647 preempt_disable();
6648 list_for_each_entry_rcu(mod_map, &ftrace_mod_maps, list) {
6649 ret = ftrace_func_address_lookup(mod_map, addr, size, off, sym);
6650 if (ret) {
6651 if (modname)
6652 *modname = mod_map->mod->name;
6653 break;
6654 }
6655 }
6656 preempt_enable();
6657
6658 return ret;
6659}
6660
6661int ftrace_mod_get_kallsym(unsigned int symnum, unsigned long *value,
6662 char *type, char *name,
6663 char *module_name, int *exported)
6664{
6665 struct ftrace_mod_map *mod_map;
6666 struct ftrace_mod_func *mod_func;
Olivier Deprez157378f2022-04-04 15:47:50 +02006667 int ret;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006668
6669 preempt_disable();
6670 list_for_each_entry_rcu(mod_map, &ftrace_mod_maps, list) {
6671
6672 if (symnum >= mod_map->num_funcs) {
6673 symnum -= mod_map->num_funcs;
6674 continue;
6675 }
6676
6677 list_for_each_entry_rcu(mod_func, &mod_map->funcs, list) {
6678 if (symnum > 1) {
6679 symnum--;
6680 continue;
6681 }
6682
6683 *value = mod_func->ip;
6684 *type = 'T';
6685 strlcpy(name, mod_func->name, KSYM_NAME_LEN);
6686 strlcpy(module_name, mod_map->mod->name, MODULE_NAME_LEN);
6687 *exported = 1;
6688 preempt_enable();
6689 return 0;
6690 }
6691 WARN_ON(1);
6692 break;
6693 }
Olivier Deprez157378f2022-04-04 15:47:50 +02006694 ret = ftrace_get_trampoline_kallsym(symnum, value, type, name,
6695 module_name, exported);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006696 preempt_enable();
Olivier Deprez157378f2022-04-04 15:47:50 +02006697 return ret;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006698}
6699
6700#else
6701static void save_ftrace_mod_rec(struct ftrace_mod_map *mod_map,
6702 struct dyn_ftrace *rec) { }
6703static inline struct ftrace_mod_map *
6704allocate_ftrace_mod_map(struct module *mod,
6705 unsigned long start, unsigned long end)
6706{
6707 return NULL;
6708}
Olivier Deprez157378f2022-04-04 15:47:50 +02006709int ftrace_mod_get_kallsym(unsigned int symnum, unsigned long *value,
6710 char *type, char *name, char *module_name,
6711 int *exported)
6712{
6713 int ret;
6714
6715 preempt_disable();
6716 ret = ftrace_get_trampoline_kallsym(symnum, value, type, name,
6717 module_name, exported);
6718 preempt_enable();
6719 return ret;
6720}
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006721#endif /* CONFIG_MODULES */
6722
6723struct ftrace_init_func {
6724 struct list_head list;
6725 unsigned long ip;
6726};
6727
6728/* Clear any init ips from hashes */
6729static void
6730clear_func_from_hash(struct ftrace_init_func *func, struct ftrace_hash *hash)
6731{
6732 struct ftrace_func_entry *entry;
6733
David Brazdil0f672f62019-12-10 10:32:29 +00006734 entry = ftrace_lookup_ip(hash, func->ip);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006735 /*
6736 * Do not allow this rec to match again.
6737 * Yeah, it may waste some memory, but will be removed
6738 * if/when the hash is modified again.
6739 */
6740 if (entry)
6741 entry->ip = 0;
6742}
6743
6744static void
6745clear_func_from_hashes(struct ftrace_init_func *func)
6746{
6747 struct trace_array *tr;
6748
6749 mutex_lock(&trace_types_lock);
6750 list_for_each_entry(tr, &ftrace_trace_arrays, list) {
6751 if (!tr->ops || !tr->ops->func_hash)
6752 continue;
6753 mutex_lock(&tr->ops->func_hash->regex_lock);
6754 clear_func_from_hash(func, tr->ops->func_hash->filter_hash);
6755 clear_func_from_hash(func, tr->ops->func_hash->notrace_hash);
6756 mutex_unlock(&tr->ops->func_hash->regex_lock);
6757 }
6758 mutex_unlock(&trace_types_lock);
6759}
6760
6761static void add_to_clear_hash_list(struct list_head *clear_list,
6762 struct dyn_ftrace *rec)
6763{
6764 struct ftrace_init_func *func;
6765
6766 func = kmalloc(sizeof(*func), GFP_KERNEL);
6767 if (!func) {
Olivier Deprez157378f2022-04-04 15:47:50 +02006768 MEM_FAIL(1, "alloc failure, ftrace filter could be stale\n");
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006769 return;
6770 }
6771
6772 func->ip = rec->ip;
6773 list_add(&func->list, clear_list);
6774}
6775
6776void ftrace_free_mem(struct module *mod, void *start_ptr, void *end_ptr)
6777{
6778 unsigned long start = (unsigned long)(start_ptr);
6779 unsigned long end = (unsigned long)(end_ptr);
6780 struct ftrace_page **last_pg = &ftrace_pages_start;
6781 struct ftrace_page *pg;
6782 struct dyn_ftrace *rec;
6783 struct dyn_ftrace key;
6784 struct ftrace_mod_map *mod_map = NULL;
6785 struct ftrace_init_func *func, *func_next;
6786 struct list_head clear_hash;
6787 int order;
6788
6789 INIT_LIST_HEAD(&clear_hash);
6790
6791 key.ip = start;
6792 key.flags = end; /* overload flags, as it is unsigned long */
6793
6794 mutex_lock(&ftrace_lock);
6795
6796 /*
6797 * If we are freeing module init memory, then check if
6798 * any tracer is active. If so, we need to save a mapping of
6799 * the module functions being freed with the address.
6800 */
6801 if (mod && ftrace_ops_list != &ftrace_list_end)
6802 mod_map = allocate_ftrace_mod_map(mod, start, end);
6803
6804 for (pg = ftrace_pages_start; pg; last_pg = &pg->next, pg = *last_pg) {
6805 if (end < pg->records[0].ip ||
6806 start >= (pg->records[pg->index - 1].ip + MCOUNT_INSN_SIZE))
6807 continue;
6808 again:
6809 rec = bsearch(&key, pg->records, pg->index,
6810 sizeof(struct dyn_ftrace),
6811 ftrace_cmp_recs);
6812 if (!rec)
6813 continue;
6814
6815 /* rec will be cleared from hashes after ftrace_lock unlock */
6816 add_to_clear_hash_list(&clear_hash, rec);
6817
6818 if (mod_map)
6819 save_ftrace_mod_rec(mod_map, rec);
6820
6821 pg->index--;
6822 ftrace_update_tot_cnt--;
6823 if (!pg->index) {
6824 *last_pg = pg->next;
6825 order = get_count_order(pg->size / ENTRIES_PER_PAGE);
Olivier Deprez157378f2022-04-04 15:47:50 +02006826 if (order >= 0)
6827 free_pages((unsigned long)pg->records, order);
6828 ftrace_number_of_pages -= 1 << order;
6829 ftrace_number_of_groups--;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006830 kfree(pg);
6831 pg = container_of(last_pg, struct ftrace_page, next);
6832 if (!(*last_pg))
6833 ftrace_pages = pg;
6834 continue;
6835 }
6836 memmove(rec, rec + 1,
6837 (pg->index - (rec - pg->records)) * sizeof(*rec));
6838 /* More than one function may be in this block */
6839 goto again;
6840 }
6841 mutex_unlock(&ftrace_lock);
6842
6843 list_for_each_entry_safe(func, func_next, &clear_hash, list) {
6844 clear_func_from_hashes(func);
6845 kfree(func);
6846 }
6847}
6848
6849void __init ftrace_free_init_mem(void)
6850{
6851 void *start = (void *)(&__init_begin);
6852 void *end = (void *)(&__init_end);
6853
6854 ftrace_free_mem(NULL, start, end);
6855}
6856
6857void __init ftrace_init(void)
6858{
6859 extern unsigned long __start_mcount_loc[];
6860 extern unsigned long __stop_mcount_loc[];
6861 unsigned long count, flags;
6862 int ret;
6863
6864 local_irq_save(flags);
6865 ret = ftrace_dyn_arch_init();
6866 local_irq_restore(flags);
6867 if (ret)
6868 goto failed;
6869
6870 count = __stop_mcount_loc - __start_mcount_loc;
6871 if (!count) {
6872 pr_info("ftrace: No functions to be traced?\n");
6873 goto failed;
6874 }
6875
6876 pr_info("ftrace: allocating %ld entries in %ld pages\n",
6877 count, count / ENTRIES_PER_PAGE + 1);
6878
6879 last_ftrace_enabled = ftrace_enabled = 1;
6880
6881 ret = ftrace_process_locs(NULL,
6882 __start_mcount_loc,
6883 __stop_mcount_loc);
6884
Olivier Deprez157378f2022-04-04 15:47:50 +02006885 pr_info("ftrace: allocated %ld pages with %ld groups\n",
6886 ftrace_number_of_pages, ftrace_number_of_groups);
6887
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006888 set_ftrace_early_filters();
6889
6890 return;
6891 failed:
6892 ftrace_disabled = 1;
6893}
6894
6895/* Do nothing if arch does not support this */
6896void __weak arch_ftrace_update_trampoline(struct ftrace_ops *ops)
6897{
6898}
6899
6900static void ftrace_update_trampoline(struct ftrace_ops *ops)
6901{
Olivier Deprez157378f2022-04-04 15:47:50 +02006902 unsigned long trampoline = ops->trampoline;
6903
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006904 arch_ftrace_update_trampoline(ops);
Olivier Deprez157378f2022-04-04 15:47:50 +02006905 if (ops->trampoline && ops->trampoline != trampoline &&
6906 (ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP)) {
6907 /* Add to kallsyms before the perf events */
6908 ftrace_add_trampoline_to_kallsyms(ops);
6909 perf_event_ksymbol(PERF_RECORD_KSYMBOL_TYPE_OOL,
6910 ops->trampoline, ops->trampoline_size, false,
6911 FTRACE_TRAMPOLINE_SYM);
6912 /*
6913 * Record the perf text poke event after the ksymbol register
6914 * event.
6915 */
6916 perf_event_text_poke((void *)ops->trampoline, NULL, 0,
6917 (void *)ops->trampoline,
6918 ops->trampoline_size);
6919 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006920}
6921
6922void ftrace_init_trace_array(struct trace_array *tr)
6923{
6924 INIT_LIST_HEAD(&tr->func_probes);
6925 INIT_LIST_HEAD(&tr->mod_trace);
6926 INIT_LIST_HEAD(&tr->mod_notrace);
6927}
6928#else
6929
David Brazdil0f672f62019-12-10 10:32:29 +00006930struct ftrace_ops global_ops = {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006931 .func = ftrace_stub,
6932 .flags = FTRACE_OPS_FL_RECURSION_SAFE |
6933 FTRACE_OPS_FL_INITIALIZED |
6934 FTRACE_OPS_FL_PID,
6935};
6936
6937static int __init ftrace_nodyn_init(void)
6938{
6939 ftrace_enabled = 1;
6940 return 0;
6941}
6942core_initcall(ftrace_nodyn_init);
6943
6944static inline int ftrace_init_dyn_tracefs(struct dentry *d_tracer) { return 0; }
6945static inline void ftrace_startup_enable(int command) { }
6946static inline void ftrace_startup_all(int command) { }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006947
6948# define ftrace_startup_sysctl() do { } while (0)
6949# define ftrace_shutdown_sysctl() do { } while (0)
6950
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006951static void ftrace_update_trampoline(struct ftrace_ops *ops)
6952{
6953}
6954
6955#endif /* CONFIG_DYNAMIC_FTRACE */
6956
6957__init void ftrace_init_global_array_ops(struct trace_array *tr)
6958{
6959 tr->ops = &global_ops;
6960 tr->ops->private = tr;
6961 ftrace_init_trace_array(tr);
6962}
6963
6964void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func)
6965{
6966 /* If we filter on pids, update to use the pid function */
6967 if (tr->flags & TRACE_ARRAY_FL_GLOBAL) {
6968 if (WARN_ON(tr->ops->func != ftrace_stub))
6969 printk("ftrace ops had %pS for function\n",
6970 tr->ops->func);
6971 }
6972 tr->ops->func = func;
6973 tr->ops->private = tr;
6974}
6975
6976void ftrace_reset_array_ops(struct trace_array *tr)
6977{
6978 tr->ops->func = ftrace_stub;
6979}
6980
David Brazdil0f672f62019-12-10 10:32:29 +00006981static nokprobe_inline void
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006982__ftrace_ops_list_func(unsigned long ip, unsigned long parent_ip,
6983 struct ftrace_ops *ignored, struct pt_regs *regs)
6984{
6985 struct ftrace_ops *op;
6986 int bit;
6987
Olivier Deprez157378f2022-04-04 15:47:50 +02006988 bit = trace_test_and_set_recursion(TRACE_LIST_START);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006989 if (bit < 0)
6990 return;
6991
6992 /*
6993 * Some of the ops may be dynamically allocated,
David Brazdil0f672f62019-12-10 10:32:29 +00006994 * they must be freed after a synchronize_rcu().
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00006995 */
6996 preempt_disable_notrace();
6997
6998 do_for_each_ftrace_op(op, ftrace_ops_list) {
David Brazdil0f672f62019-12-10 10:32:29 +00006999 /* Stub functions don't need to be called nor tested */
7000 if (op->flags & FTRACE_OPS_FL_STUB)
7001 continue;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007002 /*
7003 * Check the following for each ops before calling their func:
7004 * if RCU flag is set, then rcu_is_watching() must be true
7005 * if PER_CPU is set, then ftrace_function_local_disable()
7006 * must be false
7007 * Otherwise test if the ip matches the ops filter
7008 *
7009 * If any of the above fails then the op->func() is not executed.
7010 */
7011 if ((!(op->flags & FTRACE_OPS_FL_RCU) || rcu_is_watching()) &&
7012 ftrace_ops_test(op, ip, regs)) {
7013 if (FTRACE_WARN_ON(!op->func)) {
7014 pr_warn("op=%p %pS\n", op, op);
7015 goto out;
7016 }
7017 op->func(ip, parent_ip, op, regs);
7018 }
7019 } while_for_each_ftrace_op(op);
7020out:
7021 preempt_enable_notrace();
7022 trace_clear_recursion(bit);
7023}
7024
7025/*
7026 * Some archs only support passing ip and parent_ip. Even though
7027 * the list function ignores the op parameter, we do not want any
7028 * C side effects, where a function is called without the caller
7029 * sending a third parameter.
7030 * Archs are to support both the regs and ftrace_ops at the same time.
7031 * If they support ftrace_ops, it is assumed they support regs.
7032 * If call backs want to use regs, they must either check for regs
7033 * being NULL, or CONFIG_DYNAMIC_FTRACE_WITH_REGS.
7034 * Note, CONFIG_DYNAMIC_FTRACE_WITH_REGS expects a full regs to be saved.
7035 * An architecture can pass partial regs with ftrace_ops and still
7036 * set the ARCH_SUPPORTS_FTRACE_OPS.
7037 */
7038#if ARCH_SUPPORTS_FTRACE_OPS
7039static void ftrace_ops_list_func(unsigned long ip, unsigned long parent_ip,
7040 struct ftrace_ops *op, struct pt_regs *regs)
7041{
7042 __ftrace_ops_list_func(ip, parent_ip, NULL, regs);
7043}
David Brazdil0f672f62019-12-10 10:32:29 +00007044NOKPROBE_SYMBOL(ftrace_ops_list_func);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007045#else
7046static void ftrace_ops_no_ops(unsigned long ip, unsigned long parent_ip)
7047{
7048 __ftrace_ops_list_func(ip, parent_ip, NULL, NULL);
7049}
David Brazdil0f672f62019-12-10 10:32:29 +00007050NOKPROBE_SYMBOL(ftrace_ops_no_ops);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007051#endif
7052
7053/*
7054 * If there's only one function registered but it does not support
7055 * recursion, needs RCU protection and/or requires per cpu handling, then
7056 * this function will be called by the mcount trampoline.
7057 */
7058static void ftrace_ops_assist_func(unsigned long ip, unsigned long parent_ip,
7059 struct ftrace_ops *op, struct pt_regs *regs)
7060{
7061 int bit;
7062
Olivier Deprez157378f2022-04-04 15:47:50 +02007063 bit = trace_test_and_set_recursion(TRACE_LIST_START);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007064 if (bit < 0)
7065 return;
7066
7067 preempt_disable_notrace();
7068
Olivier Deprez0e641232021-09-23 10:07:05 +02007069 if (!(op->flags & FTRACE_OPS_FL_RCU) || rcu_is_watching())
7070 op->func(ip, parent_ip, op, regs);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007071
7072 preempt_enable_notrace();
7073 trace_clear_recursion(bit);
7074}
David Brazdil0f672f62019-12-10 10:32:29 +00007075NOKPROBE_SYMBOL(ftrace_ops_assist_func);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007076
7077/**
7078 * ftrace_ops_get_func - get the function a trampoline should call
7079 * @ops: the ops to get the function for
7080 *
7081 * Normally the mcount trampoline will call the ops->func, but there
7082 * are times that it should not. For example, if the ops does not
7083 * have its own recursion protection, then it should call the
7084 * ftrace_ops_assist_func() instead.
7085 *
7086 * Returns the function that the trampoline should call for @ops.
7087 */
7088ftrace_func_t ftrace_ops_get_func(struct ftrace_ops *ops)
7089{
7090 /*
7091 * If the function does not handle recursion, needs to be RCU safe,
7092 * or does per cpu logic, then we need to call the assist handler.
7093 */
7094 if (!(ops->flags & FTRACE_OPS_FL_RECURSION_SAFE) ||
7095 ops->flags & FTRACE_OPS_FL_RCU)
7096 return ftrace_ops_assist_func;
7097
7098 return ops->func;
7099}
7100
7101static void
7102ftrace_filter_pid_sched_switch_probe(void *data, bool preempt,
7103 struct task_struct *prev, struct task_struct *next)
7104{
7105 struct trace_array *tr = data;
7106 struct trace_pid_list *pid_list;
Olivier Deprez157378f2022-04-04 15:47:50 +02007107 struct trace_pid_list *no_pid_list;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007108
7109 pid_list = rcu_dereference_sched(tr->function_pids);
Olivier Deprez157378f2022-04-04 15:47:50 +02007110 no_pid_list = rcu_dereference_sched(tr->function_no_pids);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007111
Olivier Deprez157378f2022-04-04 15:47:50 +02007112 if (trace_ignore_this_task(pid_list, no_pid_list, next))
7113 this_cpu_write(tr->array_buffer.data->ftrace_ignore_pid,
7114 FTRACE_PID_IGNORE);
7115 else
7116 this_cpu_write(tr->array_buffer.data->ftrace_ignore_pid,
7117 next->pid);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007118}
7119
7120static void
7121ftrace_pid_follow_sched_process_fork(void *data,
7122 struct task_struct *self,
7123 struct task_struct *task)
7124{
7125 struct trace_pid_list *pid_list;
7126 struct trace_array *tr = data;
7127
7128 pid_list = rcu_dereference_sched(tr->function_pids);
7129 trace_filter_add_remove_task(pid_list, self, task);
Olivier Deprez157378f2022-04-04 15:47:50 +02007130
7131 pid_list = rcu_dereference_sched(tr->function_no_pids);
7132 trace_filter_add_remove_task(pid_list, self, task);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007133}
7134
7135static void
7136ftrace_pid_follow_sched_process_exit(void *data, struct task_struct *task)
7137{
7138 struct trace_pid_list *pid_list;
7139 struct trace_array *tr = data;
7140
7141 pid_list = rcu_dereference_sched(tr->function_pids);
7142 trace_filter_add_remove_task(pid_list, NULL, task);
Olivier Deprez157378f2022-04-04 15:47:50 +02007143
7144 pid_list = rcu_dereference_sched(tr->function_no_pids);
7145 trace_filter_add_remove_task(pid_list, NULL, task);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007146}
7147
7148void ftrace_pid_follow_fork(struct trace_array *tr, bool enable)
7149{
7150 if (enable) {
7151 register_trace_sched_process_fork(ftrace_pid_follow_sched_process_fork,
7152 tr);
Olivier Deprez0e641232021-09-23 10:07:05 +02007153 register_trace_sched_process_free(ftrace_pid_follow_sched_process_exit,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007154 tr);
7155 } else {
7156 unregister_trace_sched_process_fork(ftrace_pid_follow_sched_process_fork,
7157 tr);
Olivier Deprez0e641232021-09-23 10:07:05 +02007158 unregister_trace_sched_process_free(ftrace_pid_follow_sched_process_exit,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007159 tr);
7160 }
7161}
7162
Olivier Deprez157378f2022-04-04 15:47:50 +02007163static void clear_ftrace_pids(struct trace_array *tr, int type)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007164{
7165 struct trace_pid_list *pid_list;
Olivier Deprez157378f2022-04-04 15:47:50 +02007166 struct trace_pid_list *no_pid_list;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007167 int cpu;
7168
7169 pid_list = rcu_dereference_protected(tr->function_pids,
7170 lockdep_is_held(&ftrace_lock));
Olivier Deprez157378f2022-04-04 15:47:50 +02007171 no_pid_list = rcu_dereference_protected(tr->function_no_pids,
7172 lockdep_is_held(&ftrace_lock));
7173
7174 /* Make sure there's something to do */
7175 if (!pid_type_enabled(type, pid_list, no_pid_list))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007176 return;
7177
Olivier Deprez157378f2022-04-04 15:47:50 +02007178 /* See if the pids still need to be checked after this */
7179 if (!still_need_pid_events(type, pid_list, no_pid_list)) {
7180 unregister_trace_sched_switch(ftrace_filter_pid_sched_switch_probe, tr);
7181 for_each_possible_cpu(cpu)
7182 per_cpu_ptr(tr->array_buffer.data, cpu)->ftrace_ignore_pid = FTRACE_PID_TRACE;
7183 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007184
Olivier Deprez157378f2022-04-04 15:47:50 +02007185 if (type & TRACE_PIDS)
7186 rcu_assign_pointer(tr->function_pids, NULL);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007187
Olivier Deprez157378f2022-04-04 15:47:50 +02007188 if (type & TRACE_NO_PIDS)
7189 rcu_assign_pointer(tr->function_no_pids, NULL);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007190
7191 /* Wait till all users are no longer using pid filtering */
David Brazdil0f672f62019-12-10 10:32:29 +00007192 synchronize_rcu();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007193
Olivier Deprez157378f2022-04-04 15:47:50 +02007194 if ((type & TRACE_PIDS) && pid_list)
7195 trace_free_pid_list(pid_list);
7196
7197 if ((type & TRACE_NO_PIDS) && no_pid_list)
7198 trace_free_pid_list(no_pid_list);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007199}
7200
7201void ftrace_clear_pids(struct trace_array *tr)
7202{
7203 mutex_lock(&ftrace_lock);
7204
Olivier Deprez157378f2022-04-04 15:47:50 +02007205 clear_ftrace_pids(tr, TRACE_PIDS | TRACE_NO_PIDS);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007206
7207 mutex_unlock(&ftrace_lock);
7208}
7209
Olivier Deprez157378f2022-04-04 15:47:50 +02007210static void ftrace_pid_reset(struct trace_array *tr, int type)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007211{
7212 mutex_lock(&ftrace_lock);
Olivier Deprez157378f2022-04-04 15:47:50 +02007213 clear_ftrace_pids(tr, type);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007214
7215 ftrace_update_pid_func();
7216 ftrace_startup_all(0);
7217
7218 mutex_unlock(&ftrace_lock);
7219}
7220
7221/* Greater than any max PID */
7222#define FTRACE_NO_PIDS (void *)(PID_MAX_LIMIT + 1)
7223
7224static void *fpid_start(struct seq_file *m, loff_t *pos)
7225 __acquires(RCU)
7226{
7227 struct trace_pid_list *pid_list;
7228 struct trace_array *tr = m->private;
7229
7230 mutex_lock(&ftrace_lock);
7231 rcu_read_lock_sched();
7232
7233 pid_list = rcu_dereference_sched(tr->function_pids);
7234
7235 if (!pid_list)
7236 return !(*pos) ? FTRACE_NO_PIDS : NULL;
7237
7238 return trace_pid_start(pid_list, pos);
7239}
7240
7241static void *fpid_next(struct seq_file *m, void *v, loff_t *pos)
7242{
7243 struct trace_array *tr = m->private;
7244 struct trace_pid_list *pid_list = rcu_dereference_sched(tr->function_pids);
7245
Olivier Deprez0e641232021-09-23 10:07:05 +02007246 if (v == FTRACE_NO_PIDS) {
7247 (*pos)++;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007248 return NULL;
Olivier Deprez0e641232021-09-23 10:07:05 +02007249 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007250 return trace_pid_next(pid_list, v, pos);
7251}
7252
7253static void fpid_stop(struct seq_file *m, void *p)
7254 __releases(RCU)
7255{
7256 rcu_read_unlock_sched();
7257 mutex_unlock(&ftrace_lock);
7258}
7259
7260static int fpid_show(struct seq_file *m, void *v)
7261{
7262 if (v == FTRACE_NO_PIDS) {
7263 seq_puts(m, "no pid\n");
7264 return 0;
7265 }
7266
7267 return trace_pid_show(m, v);
7268}
7269
7270static const struct seq_operations ftrace_pid_sops = {
7271 .start = fpid_start,
7272 .next = fpid_next,
7273 .stop = fpid_stop,
7274 .show = fpid_show,
7275};
7276
Olivier Deprez157378f2022-04-04 15:47:50 +02007277static void *fnpid_start(struct seq_file *m, loff_t *pos)
7278 __acquires(RCU)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007279{
Olivier Deprez157378f2022-04-04 15:47:50 +02007280 struct trace_pid_list *pid_list;
7281 struct trace_array *tr = m->private;
7282
7283 mutex_lock(&ftrace_lock);
7284 rcu_read_lock_sched();
7285
7286 pid_list = rcu_dereference_sched(tr->function_no_pids);
7287
7288 if (!pid_list)
7289 return !(*pos) ? FTRACE_NO_PIDS : NULL;
7290
7291 return trace_pid_start(pid_list, pos);
7292}
7293
7294static void *fnpid_next(struct seq_file *m, void *v, loff_t *pos)
7295{
7296 struct trace_array *tr = m->private;
7297 struct trace_pid_list *pid_list = rcu_dereference_sched(tr->function_no_pids);
7298
7299 if (v == FTRACE_NO_PIDS) {
7300 (*pos)++;
7301 return NULL;
7302 }
7303 return trace_pid_next(pid_list, v, pos);
7304}
7305
7306static const struct seq_operations ftrace_no_pid_sops = {
7307 .start = fnpid_start,
7308 .next = fnpid_next,
7309 .stop = fpid_stop,
7310 .show = fpid_show,
7311};
7312
7313static int pid_open(struct inode *inode, struct file *file, int type)
7314{
7315 const struct seq_operations *seq_ops;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007316 struct trace_array *tr = inode->i_private;
7317 struct seq_file *m;
7318 int ret = 0;
7319
David Brazdil0f672f62019-12-10 10:32:29 +00007320 ret = tracing_check_open_get_tr(tr);
7321 if (ret)
7322 return ret;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007323
7324 if ((file->f_mode & FMODE_WRITE) &&
7325 (file->f_flags & O_TRUNC))
Olivier Deprez157378f2022-04-04 15:47:50 +02007326 ftrace_pid_reset(tr, type);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007327
Olivier Deprez157378f2022-04-04 15:47:50 +02007328 switch (type) {
7329 case TRACE_PIDS:
7330 seq_ops = &ftrace_pid_sops;
7331 break;
7332 case TRACE_NO_PIDS:
7333 seq_ops = &ftrace_no_pid_sops;
7334 break;
7335 default:
7336 trace_array_put(tr);
7337 WARN_ON_ONCE(1);
7338 return -EINVAL;
7339 }
7340
7341 ret = seq_open(file, seq_ops);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007342 if (ret < 0) {
7343 trace_array_put(tr);
7344 } else {
7345 m = file->private_data;
7346 /* copy tr over to seq ops */
7347 m->private = tr;
7348 }
7349
7350 return ret;
7351}
7352
Olivier Deprez157378f2022-04-04 15:47:50 +02007353static int
7354ftrace_pid_open(struct inode *inode, struct file *file)
7355{
7356 return pid_open(inode, file, TRACE_PIDS);
7357}
7358
7359static int
7360ftrace_no_pid_open(struct inode *inode, struct file *file)
7361{
7362 return pid_open(inode, file, TRACE_NO_PIDS);
7363}
7364
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007365static void ignore_task_cpu(void *data)
7366{
7367 struct trace_array *tr = data;
7368 struct trace_pid_list *pid_list;
Olivier Deprez157378f2022-04-04 15:47:50 +02007369 struct trace_pid_list *no_pid_list;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007370
7371 /*
7372 * This function is called by on_each_cpu() while the
7373 * event_mutex is held.
7374 */
7375 pid_list = rcu_dereference_protected(tr->function_pids,
7376 mutex_is_locked(&ftrace_lock));
Olivier Deprez157378f2022-04-04 15:47:50 +02007377 no_pid_list = rcu_dereference_protected(tr->function_no_pids,
7378 mutex_is_locked(&ftrace_lock));
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007379
Olivier Deprez157378f2022-04-04 15:47:50 +02007380 if (trace_ignore_this_task(pid_list, no_pid_list, current))
7381 this_cpu_write(tr->array_buffer.data->ftrace_ignore_pid,
7382 FTRACE_PID_IGNORE);
7383 else
7384 this_cpu_write(tr->array_buffer.data->ftrace_ignore_pid,
7385 current->pid);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007386}
7387
7388static ssize_t
Olivier Deprez157378f2022-04-04 15:47:50 +02007389pid_write(struct file *filp, const char __user *ubuf,
7390 size_t cnt, loff_t *ppos, int type)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007391{
7392 struct seq_file *m = filp->private_data;
7393 struct trace_array *tr = m->private;
Olivier Deprez157378f2022-04-04 15:47:50 +02007394 struct trace_pid_list *filtered_pids;
7395 struct trace_pid_list *other_pids;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007396 struct trace_pid_list *pid_list;
7397 ssize_t ret;
7398
7399 if (!cnt)
7400 return 0;
7401
7402 mutex_lock(&ftrace_lock);
7403
Olivier Deprez157378f2022-04-04 15:47:50 +02007404 switch (type) {
7405 case TRACE_PIDS:
7406 filtered_pids = rcu_dereference_protected(tr->function_pids,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007407 lockdep_is_held(&ftrace_lock));
Olivier Deprez157378f2022-04-04 15:47:50 +02007408 other_pids = rcu_dereference_protected(tr->function_no_pids,
7409 lockdep_is_held(&ftrace_lock));
7410 break;
7411 case TRACE_NO_PIDS:
7412 filtered_pids = rcu_dereference_protected(tr->function_no_pids,
7413 lockdep_is_held(&ftrace_lock));
7414 other_pids = rcu_dereference_protected(tr->function_pids,
7415 lockdep_is_held(&ftrace_lock));
7416 break;
7417 default:
7418 ret = -EINVAL;
7419 WARN_ON_ONCE(1);
7420 goto out;
7421 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007422
7423 ret = trace_pid_write(filtered_pids, &pid_list, ubuf, cnt);
7424 if (ret < 0)
7425 goto out;
7426
Olivier Deprez157378f2022-04-04 15:47:50 +02007427 switch (type) {
7428 case TRACE_PIDS:
7429 rcu_assign_pointer(tr->function_pids, pid_list);
7430 break;
7431 case TRACE_NO_PIDS:
7432 rcu_assign_pointer(tr->function_no_pids, pid_list);
7433 break;
7434 }
7435
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007436
7437 if (filtered_pids) {
David Brazdil0f672f62019-12-10 10:32:29 +00007438 synchronize_rcu();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007439 trace_free_pid_list(filtered_pids);
Olivier Deprez157378f2022-04-04 15:47:50 +02007440 } else if (pid_list && !other_pids) {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007441 /* Register a probe to set whether to ignore the tracing of a task */
7442 register_trace_sched_switch(ftrace_filter_pid_sched_switch_probe, tr);
7443 }
7444
7445 /*
7446 * Ignoring of pids is done at task switch. But we have to
7447 * check for those tasks that are currently running.
7448 * Always do this in case a pid was appended or removed.
7449 */
7450 on_each_cpu(ignore_task_cpu, tr, 1);
7451
7452 ftrace_update_pid_func();
7453 ftrace_startup_all(0);
7454 out:
7455 mutex_unlock(&ftrace_lock);
7456
7457 if (ret > 0)
7458 *ppos += ret;
7459
7460 return ret;
7461}
7462
Olivier Deprez157378f2022-04-04 15:47:50 +02007463static ssize_t
7464ftrace_pid_write(struct file *filp, const char __user *ubuf,
7465 size_t cnt, loff_t *ppos)
7466{
7467 return pid_write(filp, ubuf, cnt, ppos, TRACE_PIDS);
7468}
7469
7470static ssize_t
7471ftrace_no_pid_write(struct file *filp, const char __user *ubuf,
7472 size_t cnt, loff_t *ppos)
7473{
7474 return pid_write(filp, ubuf, cnt, ppos, TRACE_NO_PIDS);
7475}
7476
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007477static int
7478ftrace_pid_release(struct inode *inode, struct file *file)
7479{
7480 struct trace_array *tr = inode->i_private;
7481
7482 trace_array_put(tr);
7483
7484 return seq_release(inode, file);
7485}
7486
7487static const struct file_operations ftrace_pid_fops = {
7488 .open = ftrace_pid_open,
7489 .write = ftrace_pid_write,
7490 .read = seq_read,
7491 .llseek = tracing_lseek,
7492 .release = ftrace_pid_release,
7493};
7494
Olivier Deprez157378f2022-04-04 15:47:50 +02007495static const struct file_operations ftrace_no_pid_fops = {
7496 .open = ftrace_no_pid_open,
7497 .write = ftrace_no_pid_write,
7498 .read = seq_read,
7499 .llseek = tracing_lseek,
7500 .release = ftrace_pid_release,
7501};
7502
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007503void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer)
7504{
7505 trace_create_file("set_ftrace_pid", 0644, d_tracer,
7506 tr, &ftrace_pid_fops);
Olivier Deprez157378f2022-04-04 15:47:50 +02007507 trace_create_file("set_ftrace_notrace_pid", 0644, d_tracer,
7508 tr, &ftrace_no_pid_fops);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007509}
7510
7511void __init ftrace_init_tracefs_toplevel(struct trace_array *tr,
7512 struct dentry *d_tracer)
7513{
7514 /* Only the top level directory has the dyn_tracefs and profile */
7515 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
7516
7517 ftrace_init_dyn_tracefs(d_tracer);
7518 ftrace_profile_tracefs(d_tracer);
7519}
7520
7521/**
7522 * ftrace_kill - kill ftrace
7523 *
7524 * This function should be used by panic code. It stops ftrace
7525 * but in a not so nice way. If you need to simply kill ftrace
7526 * from a non-atomic section, use ftrace_kill.
7527 */
7528void ftrace_kill(void)
7529{
7530 ftrace_disabled = 1;
7531 ftrace_enabled = 0;
7532 ftrace_trace_function = ftrace_stub;
7533}
7534
7535/**
7536 * Test if ftrace is dead or not.
7537 */
7538int ftrace_is_dead(void)
7539{
7540 return ftrace_disabled;
7541}
7542
7543/**
7544 * register_ftrace_function - register a function for profiling
7545 * @ops - ops structure that holds the function for profiling.
7546 *
7547 * Register a function to be called by all functions in the
7548 * kernel.
7549 *
7550 * Note: @ops->func and all the functions it calls must be labeled
7551 * with "notrace", otherwise it will go into a
7552 * recursive loop.
7553 */
7554int register_ftrace_function(struct ftrace_ops *ops)
7555{
7556 int ret = -1;
7557
7558 ftrace_ops_init(ops);
7559
7560 mutex_lock(&ftrace_lock);
7561
7562 ret = ftrace_startup(ops, 0);
7563
7564 mutex_unlock(&ftrace_lock);
7565
7566 return ret;
7567}
7568EXPORT_SYMBOL_GPL(register_ftrace_function);
7569
7570/**
7571 * unregister_ftrace_function - unregister a function for profiling.
7572 * @ops - ops structure that holds the function to unregister
7573 *
7574 * Unregister a function that was added to be called by ftrace profiling.
7575 */
7576int unregister_ftrace_function(struct ftrace_ops *ops)
7577{
7578 int ret;
7579
7580 mutex_lock(&ftrace_lock);
7581 ret = ftrace_shutdown(ops, 0);
7582 mutex_unlock(&ftrace_lock);
7583
7584 return ret;
7585}
7586EXPORT_SYMBOL_GPL(unregister_ftrace_function);
7587
Olivier Deprez157378f2022-04-04 15:47:50 +02007588static bool is_permanent_ops_registered(void)
7589{
7590 struct ftrace_ops *op;
7591
7592 do_for_each_ftrace_op(op, ftrace_ops_list) {
7593 if (op->flags & FTRACE_OPS_FL_PERMANENT)
7594 return true;
7595 } while_for_each_ftrace_op(op);
7596
7597 return false;
7598}
7599
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007600int
7601ftrace_enable_sysctl(struct ctl_table *table, int write,
Olivier Deprez157378f2022-04-04 15:47:50 +02007602 void *buffer, size_t *lenp, loff_t *ppos)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007603{
7604 int ret = -ENODEV;
7605
7606 mutex_lock(&ftrace_lock);
7607
7608 if (unlikely(ftrace_disabled))
7609 goto out;
7610
7611 ret = proc_dointvec(table, write, buffer, lenp, ppos);
7612
7613 if (ret || !write || (last_ftrace_enabled == !!ftrace_enabled))
7614 goto out;
7615
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007616 if (ftrace_enabled) {
7617
7618 /* we are starting ftrace again */
7619 if (rcu_dereference_protected(ftrace_ops_list,
7620 lockdep_is_held(&ftrace_lock)) != &ftrace_list_end)
7621 update_ftrace_function();
7622
7623 ftrace_startup_sysctl();
7624
7625 } else {
Olivier Deprez157378f2022-04-04 15:47:50 +02007626 if (is_permanent_ops_registered()) {
7627 ftrace_enabled = true;
7628 ret = -EBUSY;
7629 goto out;
7630 }
7631
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007632 /* stopping ftrace calls (just send to ftrace_stub) */
7633 ftrace_trace_function = ftrace_stub;
7634
7635 ftrace_shutdown_sysctl();
7636 }
7637
Olivier Deprez157378f2022-04-04 15:47:50 +02007638 last_ftrace_enabled = !!ftrace_enabled;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007639 out:
7640 mutex_unlock(&ftrace_lock);
7641 return ret;
7642}