1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Simple ftrace probe wrapper */
3 #ifndef _LINUX_FPROBE_H
4 #define _LINUX_FPROBE_H
6 #include <linux/compiler.h>
7 #include <linux/ftrace.h>
8 #include <linux/rethook.h>
11 * struct fprobe - ftrace based probe.
12 * @ops: The ftrace_ops.
13 * @nmissed: The counter for missing events.
14 * @flags: The status flag.
15 * @rethook: The rethook data structure. (internal data)
16 * @entry_data_size: The private data storage size.
17 * @nr_maxactive: The max number of active functions.
18 * @entry_handler: The callback function for function entry.
19 * @exit_handler: The callback function for function exit.
22 #ifdef CONFIG_FUNCTION_TRACER
24 * If CONFIG_FUNCTION_TRACER is not set, CONFIG_FPROBE is disabled too.
25 * But user of fprobe may keep embedding the struct fprobe on their own
26 * code. To avoid build error, this will keep the fprobe data structure
27 * defined here, but remove ftrace_ops data structure.
29 struct ftrace_ops ops;
31 unsigned long nmissed;
33 struct rethook *rethook;
34 size_t entry_data_size;
37 int (*entry_handler)(struct fprobe *fp, unsigned long entry_ip,
38 struct pt_regs *regs, void *entry_data);
39 void (*exit_handler)(struct fprobe *fp, unsigned long entry_ip,
40 struct pt_regs *regs, void *entry_data);
43 /* This fprobe is soft-disabled. */
44 #define FPROBE_FL_DISABLED 1
47 * This fprobe handler will be shared with kprobes.
48 * This flag must be set before registering.
50 #define FPROBE_FL_KPROBE_SHARED 2
52 static inline bool fprobe_disabled(struct fprobe *fp)
54 return (fp) ? fp->flags & FPROBE_FL_DISABLED : false;
57 static inline bool fprobe_shared_with_kprobes(struct fprobe *fp)
59 return (fp) ? fp->flags & FPROBE_FL_KPROBE_SHARED : false;
63 int register_fprobe(struct fprobe *fp, const char *filter, const char *notfilter);
64 int register_fprobe_ips(struct fprobe *fp, unsigned long *addrs, int num);
65 int register_fprobe_syms(struct fprobe *fp, const char **syms, int num);
66 int unregister_fprobe(struct fprobe *fp);
68 static inline int register_fprobe(struct fprobe *fp, const char *filter, const char *notfilter)
72 static inline int register_fprobe_ips(struct fprobe *fp, unsigned long *addrs, int num)
76 static inline int register_fprobe_syms(struct fprobe *fp, const char **syms, int num)
80 static inline int unregister_fprobe(struct fprobe *fp)
87 * disable_fprobe() - Disable fprobe
88 * @fp: The fprobe to be disabled.
90 * This will soft-disable @fp. Note that this doesn't remove the ftrace
91 * hooks from the function entry.
93 static inline void disable_fprobe(struct fprobe *fp)
96 fp->flags |= FPROBE_FL_DISABLED;
100 * enable_fprobe() - Enable fprobe
101 * @fp: The fprobe to be enabled.
103 * This will soft-enable @fp.
105 static inline void enable_fprobe(struct fprobe *fp)
108 fp->flags &= ~FPROBE_FL_DISABLED;