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