include/linux/kprobes.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 #ifndef _LINUX_KPROBES_H
   3 #define _LINUX_KPROBES_H
   4 /*
   5  *  Kernel Probes (KProbes)
   6  *
   7  * Copyright (C) IBM Corporation, 2002, 2004
   8  *
   9  * 2002-Oct     Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
  10  *              Probes initial implementation ( includes suggestions from
  11  *              Rusty Russell).
  12  * 2004-July    Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
  13  *              interface to access function arguments.
  14  * 2005-May     Hien Nguyen <hien@us.ibm.com> and Jim Keniston
  15  *              <jkenisto@us.ibm.com>  and Prasanna S Panchamukhi
  16  *              <prasanna@in.ibm.com> added function-return probes.
  17  */
  18 #include <linux/compiler.h>
  19 #include <linux/linkage.h>
  20 #include <linux/list.h>
  21 #include <linux/notifier.h>
  22 #include <linux/smp.h>
  23 #include <linux/bug.h>
  24 #include <linux/percpu.h>
  25 #include <linux/spinlock.h>
  26 #include <linux/rcupdate.h>
  27 #include <linux/mutex.h>
  28 #include <linux/ftrace.h>
  29 #include <linux/refcount.h>
  30 #include <linux/freelist.h>
  31 #include <asm/kprobes.h>
  32
  33 #ifdef CONFIG_KPROBES
  34
  35 /* kprobe_status settings */
  36 #define KPROBE_HIT_ACTIVE       0x00000001
  37 #define KPROBE_HIT_SS           0x00000002
  38 #define KPROBE_REENTER          0x00000004
  39 #define KPROBE_HIT_SSDONE       0x00000008
  40
  41 #else /* !CONFIG_KPROBES */
  42 #include <asm-generic/kprobes.h>
  43 typedef int kprobe_opcode_t;
  44 struct arch_specific_insn {
  45         int dummy;
  46 };
  47 #endif /* CONFIG_KPROBES */
  48
  49 struct kprobe;
  50 struct pt_regs;
  51 struct kretprobe;
  52 struct kretprobe_instance;
  53 typedef int (*kprobe_pre_handler_t) (struct kprobe *, struct pt_regs *);
  54 typedef void (*kprobe_post_handler_t) (struct kprobe *, struct pt_regs *,
  55                                        unsigned long flags);
  56 typedef int (*kretprobe_handler_t) (struct kretprobe_instance *,
  57                                     struct pt_regs *);
  58
  59 struct kprobe {
  60         struct hlist_node hlist;
  61
  62         /* list of kprobes for multi-handler support */
  63         struct list_head list;
  64
  65         /*count the number of times this probe was temporarily disarmed */
  66         unsigned long nmissed;
  67
  68         /* location of the probe point */
  69         kprobe_opcode_t *addr;
  70
  71         /* Allow user to indicate symbol name of the probe point */
  72         const char *symbol_name;
  73
  74         /* Offset into the symbol */
  75         unsigned int offset;
  76
  77         /* Called before addr is executed. */
  78         kprobe_pre_handler_t pre_handler;
  79
  80         /* Called after addr is executed, unless... */
  81         kprobe_post_handler_t post_handler;
  82
  83         /* Saved opcode (which has been replaced with breakpoint) */
  84         kprobe_opcode_t opcode;
  85
  86         /* copy of the original instruction */
  87         struct arch_specific_insn ainsn;
  88
  89         /*
  90          * Indicates various status flags.
  91          * Protected by kprobe_mutex after this kprobe is registered.
  92          */
  93         u32 flags;
  94 };
  95
  96 /* Kprobe status flags */
  97 #define KPROBE_FLAG_GONE        1 /* breakpoint has already gone */
  98 #define KPROBE_FLAG_DISABLED    2 /* probe is temporarily disabled */
  99 #define KPROBE_FLAG_OPTIMIZED   4 /*
 100                                    * probe is really optimized.
 101                                    * NOTE:
 102                                    * this flag is only for optimized_kprobe.
 103                                    */
 104 #define KPROBE_FLAG_FTRACE      8 /* probe is using ftrace */
 105
 106 /* Has this kprobe gone ? */
 107 static inline int kprobe_gone(struct kprobe *p)
 108 {
 109         return p->flags & KPROBE_FLAG_GONE;
 110 }
 111
 112 /* Is this kprobe disabled ? */
 113 static inline int kprobe_disabled(struct kprobe *p)
 114 {
 115         return p->flags & (KPROBE_FLAG_DISABLED | KPROBE_FLAG_GONE);
 116 }
 117
 118 /* Is this kprobe really running optimized path ? */
 119 static inline int kprobe_optimized(struct kprobe *p)
 120 {
 121         return p->flags & KPROBE_FLAG_OPTIMIZED;
 122 }
 123
 124 /* Is this kprobe uses ftrace ? */
 125 static inline int kprobe_ftrace(struct kprobe *p)
 126 {
 127         return p->flags & KPROBE_FLAG_FTRACE;
 128 }
 129
 130 /*
 131  * Function-return probe -
 132  * Note:
 133  * User needs to provide a handler function, and initialize maxactive.
 134  * maxactive - The maximum number of instances of the probed function that
 135  * can be active concurrently.
 136  * nmissed - tracks the number of times the probed function's return was
 137  * ignored, due to maxactive being too low.
 138  *
 139  */
 140 struct kretprobe_holder {
 141         struct kretprobe        *rp;
 142         refcount_t              ref;
 143 };
 144
 145 struct kretprobe {
 146         struct kprobe kp;
 147         kretprobe_handler_t handler;
 148         kretprobe_handler_t entry_handler;
 149         int maxactive;
 150         int nmissed;
 151         size_t data_size;
 152         struct freelist_head freelist;
 153         struct kretprobe_holder *rph;
 154 };
 155
 156 struct kretprobe_instance {
 157         union {
 158                 struct freelist_node freelist;
 159                 struct rcu_head rcu;
 160         };
 161         struct llist_node llist;
 162         struct kretprobe_holder *rph;
 163         kprobe_opcode_t *ret_addr;
 164         void *fp;
 165         char data[];
 166 };
 167
 168 struct kretprobe_blackpoint {
 169         const char *name;
 170         void *addr;
 171 };
 172
 173 struct kprobe_blacklist_entry {
 174         struct list_head list;
 175         unsigned long start_addr;
 176         unsigned long end_addr;
 177 };
 178
 179 #ifdef CONFIG_KPROBES
 180 DECLARE_PER_CPU(struct kprobe *, current_kprobe);
 181 DECLARE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
 182
 183 extern void kprobe_busy_begin(void);
 184 extern void kprobe_busy_end(void);
 185
 186 #ifdef CONFIG_KRETPROBES
 187 extern void arch_prepare_kretprobe(struct kretprobe_instance *ri,
 188                                    struct pt_regs *regs);
 189 extern int arch_trampoline_kprobe(struct kprobe *p);
 190
 191 /* If the trampoline handler called from a kprobe, use this version */
 192 unsigned long __kretprobe_trampoline_handler(struct pt_regs *regs,
 193                                 void *trampoline_address,
 194                                 void *frame_pointer);
 195
 196 static nokprobe_inline
 197 unsigned long kretprobe_trampoline_handler(struct pt_regs *regs,
 198                                 void *trampoline_address,
 199                                 void *frame_pointer)
 200 {
 201         unsigned long ret;
 202         /*
 203          * Set a dummy kprobe for avoiding kretprobe recursion.
 204          * Since kretprobe never runs in kprobe handler, no kprobe must
 205          * be running at this point.
 206          */
 207         kprobe_busy_begin();
 208         ret = __kretprobe_trampoline_handler(regs, trampoline_address, frame_pointer);
 209         kprobe_busy_end();
 210
 211         return ret;
 212 }
 213
 214 static nokprobe_inline struct kretprobe *get_kretprobe(struct kretprobe_instance *ri)
 215 {
 216         RCU_LOCKDEP_WARN(!rcu_read_lock_any_held(),
 217                 "Kretprobe is accessed from instance under preemptive context");
 218
 219         return READ_ONCE(ri->rph->rp);
 220 }
 221
 222 #else /* !CONFIG_KRETPROBES */
 223 static inline void arch_prepare_kretprobe(struct kretprobe *rp,
 224                                         struct pt_regs *regs)
 225 {
 226 }
 227 static inline int arch_trampoline_kprobe(struct kprobe *p)
 228 {
 229         return 0;
 230 }
 231 #endif /* CONFIG_KRETPROBES */
 232
 233 /* Markers of '_kprobe_blacklist' section */
 234 extern unsigned long __start_kprobe_blacklist[];
 235 extern unsigned long __stop_kprobe_blacklist[];
 236
 237 extern struct kretprobe_blackpoint kretprobe_blacklist[];
 238
 239 #ifdef CONFIG_KPROBES_SANITY_TEST
 240 extern int init_test_probes(void);
 241 #else /* !CONFIG_KPROBES_SANITY_TEST */
 242 static inline int init_test_probes(void)
 243 {
 244         return 0;
 245 }
 246 #endif /* CONFIG_KPROBES_SANITY_TEST */
 247
 248 extern int arch_prepare_kprobe(struct kprobe *p);
 249 extern void arch_arm_kprobe(struct kprobe *p);
 250 extern void arch_disarm_kprobe(struct kprobe *p);
 251 extern int arch_init_kprobes(void);
 252 extern void kprobes_inc_nmissed_count(struct kprobe *p);
 253 extern bool arch_within_kprobe_blacklist(unsigned long addr);
 254 extern int arch_populate_kprobe_blacklist(void);
 255 extern bool arch_kprobe_on_func_entry(unsigned long offset);
 256 extern int kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset);
 257
 258 extern bool within_kprobe_blacklist(unsigned long addr);
 259 extern int kprobe_add_ksym_blacklist(unsigned long entry);
 260 extern int kprobe_add_area_blacklist(unsigned long start, unsigned long end);
 261
 262 struct kprobe_insn_cache {
 263         struct mutex mutex;
 264         void *(*alloc)(void);   /* allocate insn page */
 265         void (*free)(void *);   /* free insn page */
 266         const char *sym;        /* symbol for insn pages */
 267         struct list_head pages; /* list of kprobe_insn_page */
 268         size_t insn_size;       /* size of instruction slot */
 269         int nr_garbage;
 270 };
 271
 272 #ifdef __ARCH_WANT_KPROBES_INSN_SLOT
 273 extern kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c);
 274 extern void __free_insn_slot(struct kprobe_insn_cache *c,
 275                              kprobe_opcode_t *slot, int dirty);
 276 /* sleep-less address checking routine  */
 277 extern bool __is_insn_slot_addr(struct kprobe_insn_cache *c,
 278                                 unsigned long addr);
 279
 280 #define DEFINE_INSN_CACHE_OPS(__name)                                   \
 281 extern struct kprobe_insn_cache kprobe_##__name##_slots;                \
 282                                                                         \
 283 static inline kprobe_opcode_t *get_##__name##_slot(void)                \
 284 {                                                                       \
 285         return __get_insn_slot(&kprobe_##__name##_slots);               \
 286 }                                                                       \
 287                                                                         \
 288 static inline void free_##__name##_slot(kprobe_opcode_t *slot, int dirty)\
 289 {                                                                       \
 290         __free_insn_slot(&kprobe_##__name##_slots, slot, dirty);        \
 291 }                                                                       \
 292                                                                         \
 293 static inline bool is_kprobe_##__name##_slot(unsigned long addr)        \
 294 {                                                                       \
 295         return __is_insn_slot_addr(&kprobe_##__name##_slots, addr);     \
 296 }
 297 #define KPROBE_INSN_PAGE_SYM            "kprobe_insn_page"
 298 #define KPROBE_OPTINSN_PAGE_SYM         "kprobe_optinsn_page"
 299 int kprobe_cache_get_kallsym(struct kprobe_insn_cache *c, unsigned int *symnum,
 300                              unsigned long *value, char *type, char *sym);
 301 #else /* !__ARCH_WANT_KPROBES_INSN_SLOT */
 302 #define DEFINE_INSN_CACHE_OPS(__name)                                   \
 303 static inline bool is_kprobe_##__name##_slot(unsigned long addr)        \
 304 {                                                                       \
 305         return 0;                                                       \
 306 }
 307 #endif
 308
 309 DEFINE_INSN_CACHE_OPS(insn);
 310
 311 #ifdef CONFIG_OPTPROBES
 312 /*
 313  * Internal structure for direct jump optimized probe
 314  */
 315 struct optimized_kprobe {
 316         struct kprobe kp;
 317         struct list_head list;  /* list for optimizing queue */
 318         struct arch_optimized_insn optinsn;
 319 };
 320
 321 /* Architecture dependent functions for direct jump optimization */
 322 extern int arch_prepared_optinsn(struct arch_optimized_insn *optinsn);
 323 extern int arch_check_optimized_kprobe(struct optimized_kprobe *op);
 324 extern int arch_prepare_optimized_kprobe(struct optimized_kprobe *op,
 325                                          struct kprobe *orig);
 326 extern void arch_remove_optimized_kprobe(struct optimized_kprobe *op);
 327 extern void arch_optimize_kprobes(struct list_head *oplist);
 328 extern void arch_unoptimize_kprobes(struct list_head *oplist,
 329                                     struct list_head *done_list);
 330 extern void arch_unoptimize_kprobe(struct optimized_kprobe *op);
 331 extern int arch_within_optimized_kprobe(struct optimized_kprobe *op,
 332                                         unsigned long addr);
 333
 334 extern void opt_pre_handler(struct kprobe *p, struct pt_regs *regs);
 335
 336 DEFINE_INSN_CACHE_OPS(optinsn);
 337
 338 #ifdef CONFIG_SYSCTL
 339 extern int sysctl_kprobes_optimization;
 340 extern int proc_kprobes_optimization_handler(struct ctl_table *table,
 341                                              int write, void *buffer,
 342                                              size_t *length, loff_t *ppos);
 343 #endif /* CONFIG_SYSCTL */
 344 extern void wait_for_kprobe_optimizer(void);
 345 #else /* !CONFIG_OPTPROBES */
 346 static inline void wait_for_kprobe_optimizer(void) { }
 347 #endif /* CONFIG_OPTPROBES */
 348
 349 #ifdef CONFIG_KPROBES_ON_FTRACE
 350 extern void kprobe_ftrace_handler(unsigned long ip, unsigned long parent_ip,
 351                                   struct ftrace_ops *ops, struct ftrace_regs *fregs);
 352 extern int arch_prepare_kprobe_ftrace(struct kprobe *p);
 353 #else
 354 static inline int arch_prepare_kprobe_ftrace(struct kprobe *p)
 355 {
 356         return -EINVAL;
 357 }
 358 #endif /* CONFIG_KPROBES_ON_FTRACE */
 359
 360 /* Get the kprobe at this addr (if any) - called with preemption disabled */
 361 struct kprobe *get_kprobe(void *addr);
 362
 363 /* kprobe_running() will just return the current_kprobe on this CPU */
 364 static inline struct kprobe *kprobe_running(void)
 365 {
 366         return __this_cpu_read(current_kprobe);
 367 }
 368
 369 static inline void reset_current_kprobe(void)
 370 {
 371         __this_cpu_write(current_kprobe, NULL);
 372 }
 373
 374 static inline struct kprobe_ctlblk *get_kprobe_ctlblk(void)
 375 {
 376         return this_cpu_ptr(&kprobe_ctlblk);
 377 }
 378
 379 kprobe_opcode_t *kprobe_lookup_name(const char *name, unsigned int offset);
 380 int register_kprobe(struct kprobe *p);
 381 void unregister_kprobe(struct kprobe *p);
 382 int register_kprobes(struct kprobe **kps, int num);
 383 void unregister_kprobes(struct kprobe **kps, int num);
 384 unsigned long arch_deref_entry_point(void *);
 385
 386 int register_kretprobe(struct kretprobe *rp);
 387 void unregister_kretprobe(struct kretprobe *rp);
 388 int register_kretprobes(struct kretprobe **rps, int num);
 389 void unregister_kretprobes(struct kretprobe **rps, int num);
 390
 391 void kprobe_flush_task(struct task_struct *tk);
 392
 393 void kprobe_free_init_mem(void);
 394
 395 int disable_kprobe(struct kprobe *kp);
 396 int enable_kprobe(struct kprobe *kp);
 397
 398 void dump_kprobe(struct kprobe *kp);
 399
 400 void *alloc_insn_page(void);
 401
 402 void *alloc_optinsn_page(void);
 403 void free_optinsn_page(void *page);
 404
 405 int kprobe_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
 406                        char *sym);
 407
 408 int arch_kprobe_get_kallsym(unsigned int *symnum, unsigned long *value,
 409                             char *type, char *sym);
 410 #else /* !CONFIG_KPROBES: */
 411
 412 static inline int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
 413 {
 414         return 0;
 415 }
 416 static inline struct kprobe *get_kprobe(void *addr)
 417 {
 418         return NULL;
 419 }
 420 static inline struct kprobe *kprobe_running(void)
 421 {
 422         return NULL;
 423 }
 424 static inline int register_kprobe(struct kprobe *p)
 425 {
 426         return -EOPNOTSUPP;
 427 }
 428 static inline int register_kprobes(struct kprobe **kps, int num)
 429 {
 430         return -EOPNOTSUPP;
 431 }
 432 static inline void unregister_kprobe(struct kprobe *p)
 433 {
 434 }
 435 static inline void unregister_kprobes(struct kprobe **kps, int num)
 436 {
 437 }
 438 static inline int register_kretprobe(struct kretprobe *rp)
 439 {
 440         return -EOPNOTSUPP;
 441 }
 442 static inline int register_kretprobes(struct kretprobe **rps, int num)
 443 {
 444         return -EOPNOTSUPP;
 445 }
 446 static inline void unregister_kretprobe(struct kretprobe *rp)
 447 {
 448 }
 449 static inline void unregister_kretprobes(struct kretprobe **rps, int num)
 450 {
 451 }
 452 static inline void kprobe_flush_task(struct task_struct *tk)
 453 {
 454 }
 455 static inline void kprobe_free_init_mem(void)
 456 {
 457 }
 458 static inline int disable_kprobe(struct kprobe *kp)
 459 {
 460         return -EOPNOTSUPP;
 461 }
 462 static inline int enable_kprobe(struct kprobe *kp)
 463 {
 464         return -EOPNOTSUPP;
 465 }
 466
 467 static inline bool within_kprobe_blacklist(unsigned long addr)
 468 {
 469         return true;
 470 }
 471 static inline int kprobe_get_kallsym(unsigned int symnum, unsigned long *value,
 472                                      char *type, char *sym)
 473 {
 474         return -ERANGE;
 475 }
 476 #endif /* CONFIG_KPROBES */
 477
 478 static inline int disable_kretprobe(struct kretprobe *rp)
 479 {
 480         return disable_kprobe(&rp->kp);
 481 }
 482 static inline int enable_kretprobe(struct kretprobe *rp)
 483 {
 484         return enable_kprobe(&rp->kp);
 485 }
 486
 487 #ifndef CONFIG_KPROBES
 488 static inline bool is_kprobe_insn_slot(unsigned long addr)
 489 {
 490         return false;
 491 }
 492 #endif /* !CONFIG_KPROBES */
 493
 494 #ifndef CONFIG_OPTPROBES
 495 static inline bool is_kprobe_optinsn_slot(unsigned long addr)
 496 {
 497         return false;
 498 }
 499 #endif /* !CONFIG_OPTPROBES */
 500
 501 /* Returns true if kprobes handled the fault */
 502 static nokprobe_inline bool kprobe_page_fault(struct pt_regs *regs,
 503                                               unsigned int trap)
 504 {
 505         if (!IS_ENABLED(CONFIG_KPROBES))
 506                 return false;
 507         if (user_mode(regs))
 508                 return false;
 509         /*
 510          * To be potentially processing a kprobe fault and to be allowed
 511          * to call kprobe_running(), we have to be non-preemptible.
 512          */
 513         if (preemptible())
 514                 return false;
 515         if (!kprobe_running())
 516                 return false;
 517         return kprobe_fault_handler(regs, trap);
 518 }
 519
 520 #endif /* _LINUX_KPROBES_H */