cregit-Linux how code gets into the kernel

Release 4.14 include/linux/kprobes.h

Directory: include/linux
#ifndef _LINUX_KPROBES_H

#define _LINUX_KPROBES_H
/*
 *  Kernel Probes (KProbes)
 *  include/linux/kprobes.h
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * Copyright (C) IBM Corporation, 2002, 2004
 *
 * 2002-Oct     Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
 *              Probes initial implementation ( includes suggestions from
 *              Rusty Russell).
 * 2004-July    Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
 *              interface to access function arguments.
 * 2005-May     Hien Nguyen <hien@us.ibm.com> and Jim Keniston
 *              <jkenisto@us.ibm.com>  and Prasanna S Panchamukhi
 *              <prasanna@in.ibm.com> added function-return probes.
 */
#include <linux/compiler.h>
#include <linux/linkage.h>
#include <linux/list.h>
#include <linux/notifier.h>
#include <linux/smp.h>
#include <linux/bug.h>
#include <linux/percpu.h>
#include <linux/spinlock.h>
#include <linux/rcupdate.h>
#include <linux/mutex.h>
#include <linux/ftrace.h>
#include <asm/kprobes.h>

#ifdef CONFIG_KPROBES

/* kprobe_status settings */

#define KPROBE_HIT_ACTIVE	0x00000001

#define KPROBE_HIT_SS		0x00000002

#define KPROBE_REENTER		0x00000004

#define KPROBE_HIT_SSDONE	0x00000008

#else /* CONFIG_KPROBES */
#include <asm-generic/kprobes.h>

typedef int kprobe_opcode_t;

struct arch_specific_insn {
	
int dummy;
};
#endif /* CONFIG_KPROBES */

struct kprobe;
struct pt_regs;
struct kretprobe;
struct kretprobe_instance;

typedef int (*kprobe_pre_handler_t) (struct kprobe *, struct pt_regs *);

typedef int (*kprobe_break_handler_t) (struct kprobe *, struct pt_regs *);

typedef void (*kprobe_post_handler_t) (struct kprobe *, struct pt_regs *,
				       unsigned long flags);

typedef int (*kprobe_fault_handler_t) (struct kprobe *, struct pt_regs *,
				       int trapnr);

typedef int (*kretprobe_handler_t) (struct kretprobe_instance *,
				    struct pt_regs *);


struct kprobe {
	
struct hlist_node hlist;

	/* list of kprobes for multi-handler support */
	
struct list_head list;

	/*count the number of times this probe was temporarily disarmed */
	
unsigned long nmissed;

	/* location of the probe point */
	
kprobe_opcode_t *addr;

	/* Allow user to indicate symbol name of the probe point */
	
const char *symbol_name;

	/* Offset into the symbol */
	
unsigned int offset;

	/* Called before addr is executed. */
	
kprobe_pre_handler_t pre_handler;

	/* Called after addr is executed, unless... */
	
kprobe_post_handler_t post_handler;

	/*
         * ... called if executing addr causes a fault (eg. page fault).
         * Return 1 if it handled fault, otherwise kernel will see it.
         */
	
kprobe_fault_handler_t fault_handler;

	/*
         * ... called if breakpoint trap occurs in probe handler.
         * Return 1 if it handled break, otherwise kernel will see it.
         */
	
kprobe_break_handler_t break_handler;

	/* Saved opcode (which has been replaced with breakpoint) */
	
kprobe_opcode_t opcode;

	/* copy of the original instruction */
	
struct arch_specific_insn ainsn;

	/*
         * Indicates various status flags.
         * Protected by kprobe_mutex after this kprobe is registered.
         */
	
u32 flags;
};

/* Kprobe status flags */

#define KPROBE_FLAG_GONE	1 
/* breakpoint has already gone */

#define KPROBE_FLAG_DISABLED	2 
/* probe is temporarily disabled */

#define KPROBE_FLAG_OPTIMIZED	4 
/*
                                   * probe is really optimized.
                                   * NOTE:
                                   * this flag is only for optimized_kprobe.
                                   */

#define KPROBE_FLAG_FTRACE	8 
/* probe is using ftrace */

/* Has this kprobe gone ? */

static inline int kprobe_gone(struct kprobe *p) { return p->flags & KPROBE_FLAG_GONE; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu19100.00%1100.00%
Total19100.00%1100.00%

/* Is this kprobe disabled ? */
static inline int kprobe_disabled(struct kprobe *p) { return p->flags & (KPROBE_FLAG_DISABLED | KPROBE_FLAG_GONE); }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu23100.00%1100.00%
Total23100.00%1100.00%

/* Is this kprobe really running optimized path ? */
static inline int kprobe_optimized(struct kprobe *p) { return p->flags & KPROBE_FLAG_OPTIMIZED; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu19100.00%1100.00%
Total19100.00%1100.00%

/* Is this kprobe uses ftrace ? */
static inline int kprobe_ftrace(struct kprobe *p) { return p->flags & KPROBE_FLAG_FTRACE; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu19100.00%1100.00%
Total19100.00%1100.00%

/* * Special probe type that uses setjmp-longjmp type tricks to resume * execution at a specified entry with a matching prototype corresponding * to the probed function - a trick to enable arguments to become * accessible seamlessly by probe handling logic. * Note: * Because of the way compilers allocate stack space for local variables * etc upfront, regardless of sub-scopes within a function, this mirroring * principle currently works only for probes placed on function entry points. */ struct jprobe { struct kprobe kp; void *entry; /* probe handling code to jump to */ }; /* For backward compatibility with old code using JPROBE_ENTRY() */ #define JPROBE_ENTRY(handler) (handler) /* * Function-return probe - * Note: * User needs to provide a handler function, and initialize maxactive. * maxactive - The maximum number of instances of the probed function that * can be active concurrently. * nmissed - tracks the number of times the probed function's return was * ignored, due to maxactive being too low. * */ struct kretprobe { struct kprobe kp; kretprobe_handler_t handler; kretprobe_handler_t entry_handler; int maxactive; int nmissed; size_t data_size; struct hlist_head free_instances; raw_spinlock_t lock; }; struct kretprobe_instance { struct hlist_node hlist; struct kretprobe *rp; kprobe_opcode_t *ret_addr; struct task_struct *task; char data[0]; }; struct kretprobe_blackpoint { const char *name; void *addr; }; struct kprobe_blacklist_entry { struct list_head list; unsigned long start_addr; unsigned long end_addr; }; #ifdef CONFIG_KPROBES DECLARE_PER_CPU(struct kprobe *, current_kprobe); DECLARE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk); /* * For #ifdef avoidance: */
static inline int kprobes_built_in(void) { return 1; }

Contributors

PersonTokensPropCommitsCommitProp
Ingo Molnar12100.00%1100.00%
Total12100.00%1100.00%

#ifdef CONFIG_KRETPROBES extern void arch_prepare_kretprobe(struct kretprobe_instance *ri, struct pt_regs *regs); extern int arch_trampoline_kprobe(struct kprobe *p); #else /* CONFIG_KRETPROBES */
static inline void arch_prepare_kretprobe(struct kretprobe *rp, struct pt_regs *regs) { }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu16100.00%1100.00%
Total16100.00%1100.00%


static inline int arch_trampoline_kprobe(struct kprobe *p) { return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu15100.00%1100.00%
Total15100.00%1100.00%

#endif /* CONFIG_KRETPROBES */ extern struct kretprobe_blackpoint kretprobe_blacklist[];
static inline void kretprobe_assert(struct kretprobe_instance *ri, unsigned long orig_ret_address, unsigned long trampoline_address) { if (!orig_ret_address || (orig_ret_address == trampoline_address)) { printk("kretprobe BUG!: Processing kretprobe %p @ %p\n", ri->rp, ri->rp->kp.addr); BUG(); } }

Contributors

PersonTokensPropCommitsCommitProp
Ananth N. Mavinakayanahalli53100.00%1100.00%
Total53100.00%1100.00%

#ifdef CONFIG_KPROBES_SANITY_TEST extern int init_test_probes(void); #else
static inline int init_test_probes(void) { return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Ananth N. Mavinakayanahalli12100.00%1100.00%
Total12100.00%1100.00%

#endif /* CONFIG_KPROBES_SANITY_TEST */ extern int arch_prepare_kprobe(struct kprobe *p); extern void arch_arm_kprobe(struct kprobe *p); extern void arch_disarm_kprobe(struct kprobe *p); extern int arch_init_kprobes(void); extern void show_registers(struct pt_regs *regs); extern void kprobes_inc_nmissed_count(struct kprobe *p); extern bool arch_within_kprobe_blacklist(unsigned long addr); extern bool arch_kprobe_on_func_entry(unsigned long offset); extern bool kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset); extern bool within_kprobe_blacklist(unsigned long addr); struct kprobe_insn_cache { struct mutex mutex; void *(*alloc)(void); /* allocate insn page */ void (*free)(void *); /* free insn page */ struct list_head pages; /* list of kprobe_insn_page */ size_t insn_size; /* size of instruction slot */ int nr_garbage; }; #ifdef __ARCH_WANT_KPROBES_INSN_SLOT extern kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c); extern void __free_insn_slot(struct kprobe_insn_cache *c, kprobe_opcode_t *slot, int dirty); /* sleep-less address checking routine */ extern bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr); #define DEFINE_INSN_CACHE_OPS(__name) \ extern struct kprobe_insn_cache kprobe_##__name##_slots; \ \ static inline kprobe_opcode_t *get_##__name##_slot(void) \ { \ return __get_insn_slot(&kprobe_##__name##_slots); \ } \ \ static inline void free_##__name##_slot(kprobe_opcode_t *slot, int dirty)\ { \ __free_insn_slot(&kprobe_##__name##_slots, slot, dirty); \ } \ \ static inline bool is_kprobe_##__name##_slot(unsigned long addr) \ { \ return __is_insn_slot_addr(&kprobe_##__name##_slots, addr); \ } #else /* __ARCH_WANT_KPROBES_INSN_SLOT */ #define DEFINE_INSN_CACHE_OPS(__name) \ static inline bool is_kprobe_##__name##_slot(unsigned long addr) \ { \ return 0; \ } #endif DEFINE_INSN_CACHE_OPS(insn); #ifdef CONFIG_OPTPROBES /* * Internal structure for direct jump optimized probe */ struct optimized_kprobe { struct kprobe kp; struct list_head list; /* list for optimizing queue */ struct arch_optimized_insn optinsn; }; /* Architecture dependent functions for direct jump optimization */ extern int arch_prepared_optinsn(struct arch_optimized_insn *optinsn); extern int arch_check_optimized_kprobe(struct optimized_kprobe *op); extern int arch_prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *orig); extern void arch_remove_optimized_kprobe(struct optimized_kprobe *op); extern void arch_optimize_kprobes(struct list_head *oplist); extern void arch_unoptimize_kprobes(struct list_head *oplist, struct list_head *done_list); extern void arch_unoptimize_kprobe(struct optimized_kprobe *op); extern int arch_within_optimized_kprobe(struct optimized_kprobe *op, unsigned long addr); extern void opt_pre_handler(struct kprobe *p, struct pt_regs *regs); DEFINE_INSN_CACHE_OPS(optinsn); #ifdef CONFIG_SYSCTL extern int sysctl_kprobes_optimization; extern int proc_kprobes_optimization_handler(struct ctl_table *table, int write, void __user *buffer, size_t *length, loff_t *ppos); #endif extern void wait_for_kprobe_optimizer(void); #else
static inline void wait_for_kprobe_optimizer(void) { }

Contributors

PersonTokensPropCommitsCommitProp
Thomas Gleixner8100.00%1100.00%
Total8100.00%1100.00%

#endif /* CONFIG_OPTPROBES */ #ifdef CONFIG_KPROBES_ON_FTRACE extern void kprobe_ftrace_handler(unsigned long ip, unsigned long parent_ip, struct ftrace_ops *ops, struct pt_regs *regs); extern int arch_prepare_kprobe_ftrace(struct kprobe *p); #endif int arch_check_ftrace_location(struct kprobe *p); /* Get the kprobe at this addr (if any) - called with preemption disabled */ struct kprobe *get_kprobe(void *addr); void kretprobe_hash_lock(struct task_struct *tsk, struct hlist_head **head, unsigned long *flags); void kretprobe_hash_unlock(struct task_struct *tsk, unsigned long *flags); struct hlist_head * kretprobe_inst_table_head(struct task_struct *tsk); /* kprobe_running() will just return the current_kprobe on this CPU */
static inline struct kprobe *kprobe_running(void) { return (__this_cpu_read(current_kprobe)); }

Contributors

PersonTokensPropCommitsCommitProp
Ananth N. Mavinakayanahalli1894.74%150.00%
Christoph Lameter15.26%150.00%
Total19100.00%2100.00%


static inline void reset_current_kprobe(void) { __this_cpu_write(current_kprobe, NULL); }

Contributors

PersonTokensPropCommitsCommitProp
Ananth N. Mavinakayanahalli1381.25%150.00%
Christoph Lameter318.75%150.00%
Total16100.00%2100.00%


static inline struct kprobe_ctlblk *get_kprobe_ctlblk(void) { return this_cpu_ptr(&kprobe_ctlblk); }

Contributors

PersonTokensPropCommitsCommitProp
Ananth N. Mavinakayanahalli1688.89%150.00%
Christoph Lameter211.11%150.00%
Total18100.00%2100.00%

kprobe_opcode_t *kprobe_lookup_name(const char *name, unsigned int offset); int register_kprobe(struct kprobe *p); void unregister_kprobe(struct kprobe *p); int register_kprobes(struct kprobe **kps, int num); void unregister_kprobes(struct kprobe **kps, int num); int setjmp_pre_handler(struct kprobe *, struct pt_regs *); int longjmp_break_handler(struct kprobe *, struct pt_regs *); int register_jprobe(struct jprobe *p); void unregister_jprobe(struct jprobe *p); int register_jprobes(struct jprobe **jps, int num); void unregister_jprobes(struct jprobe **jps, int num); void jprobe_return(void); unsigned long arch_deref_entry_point(void *); int register_kretprobe(struct kretprobe *rp); void unregister_kretprobe(struct kretprobe *rp); int register_kretprobes(struct kretprobe **rps, int num); void unregister_kretprobes(struct kretprobe **rps, int num); void kprobe_flush_task(struct task_struct *tk); void recycle_rp_inst(struct kretprobe_instance *ri, struct hlist_head *head); int disable_kprobe(struct kprobe *kp); int enable_kprobe(struct kprobe *kp); void dump_kprobe(struct kprobe *kp); #else /* !CONFIG_KPROBES: */
static inline int kprobes_built_in(void) { return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Ingo Molnar12100.00%1100.00%
Total12100.00%1100.00%


static inline int kprobe_fault_handler(struct pt_regs *regs, int trapnr) { return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Ingo Molnar18100.00%1100.00%
Total18100.00%1100.00%


static inline struct kprobe *get_kprobe(void *addr) { return NULL; }

Contributors

PersonTokensPropCommitsCommitProp
Abhishek Sagar16100.00%1100.00%
Total16100.00%1100.00%


static inline struct kprobe *kprobe_running(void) { return NULL; }

Contributors

PersonTokensPropCommitsCommitProp
Prasanna S. Panchamukhi1071.43%150.00%
Ananth N. Mavinakayanahalli428.57%150.00%
Total14100.00%2100.00%


static inline int register_kprobe(struct kprobe *p) { return -ENOSYS; }

Contributors

PersonTokensPropCommitsCommitProp
Prasanna S. Panchamukhi16100.00%1100.00%
Total16100.00%1100.00%


static inline int register_kprobes(struct kprobe **kps, int num) { return -ENOSYS; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu20100.00%1100.00%
Total20100.00%1100.00%


static inline void unregister_kprobe(struct kprobe *p) { }

Contributors

PersonTokensPropCommitsCommitProp
Prasanna S. Panchamukhi11100.00%1100.00%
Total11100.00%1100.00%


static inline void unregister_kprobes(struct kprobe **kps, int num) { }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu15100.00%1100.00%
Total15100.00%1100.00%


static inline int register_jprobe(struct jprobe *p) { return -ENOSYS; }

Contributors

PersonTokensPropCommitsCommitProp
Prasanna S. Panchamukhi16100.00%1100.00%
Total16100.00%1100.00%


static inline int register_jprobes(struct jprobe **jps, int num) { return -ENOSYS; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu20100.00%1100.00%
Total20100.00%1100.00%


static inline void unregister_jprobe(struct jprobe *p) { }

Contributors

PersonTokensPropCommitsCommitProp
Prasanna S. Panchamukhi11100.00%1100.00%
Total11100.00%1100.00%


static inline void unregister_jprobes(struct jprobe **jps, int num) { }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu15100.00%1100.00%
Total15100.00%1100.00%


static inline void jprobe_return(void) { }

Contributors

PersonTokensPropCommitsCommitProp
Prasanna S. Panchamukhi8100.00%1100.00%
Total8100.00%1100.00%


static inline int register_kretprobe(struct kretprobe *rp) { return -ENOSYS; }

Contributors

PersonTokensPropCommitsCommitProp
Hien Nguyen16100.00%1100.00%
Total16100.00%1100.00%


static inline int register_kretprobes(struct kretprobe **rps, int num) { return -ENOSYS; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu20100.00%1100.00%
Total20100.00%1100.00%


static inline void unregister_kretprobe(struct kretprobe *rp) { }

Contributors

PersonTokensPropCommitsCommitProp
Hien Nguyen11100.00%1100.00%
Total11100.00%1100.00%


static inline void unregister_kretprobes(struct kretprobe **rps, int num) { }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu15100.00%1100.00%
Total15100.00%1100.00%


static inline void kprobe_flush_task(struct task_struct *tk) { }

Contributors

PersonTokensPropCommitsCommitProp
Hien Nguyen11100.00%1100.00%
Total11100.00%1100.00%


static inline int disable_kprobe(struct kprobe *kp) { return -ENOSYS; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu16100.00%1100.00%
Total16100.00%1100.00%


static inline int enable_kprobe(struct kprobe *kp) { return -ENOSYS; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu16100.00%1100.00%
Total16100.00%1100.00%

#endif /* CONFIG_KPROBES */
static inline int disable_kretprobe(struct kretprobe *rp) { return disable_kprobe(&rp->kp); }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu21100.00%1100.00%
Total21100.00%1100.00%


static inline int enable_kretprobe(struct kretprobe *rp) { return enable_kprobe(&rp->kp); }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu21100.00%1100.00%
Total21100.00%1100.00%


static inline int disable_jprobe(struct jprobe *jp) { return disable_kprobe(&jp->kp); }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu21100.00%1100.00%
Total21100.00%1100.00%


static inline int enable_jprobe(struct jprobe *jp) { return enable_kprobe(&jp->kp); }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu21100.00%1100.00%
Total21100.00%1100.00%

#ifndef CONFIG_KPROBES
static inline bool is_kprobe_insn_slot(unsigned long addr) { return false; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu14100.00%1100.00%
Total14100.00%1100.00%

#endif #ifndef CONFIG_OPTPROBES
static inline bool is_kprobe_optinsn_slot(unsigned long addr) { return false; }

Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu14100.00%1100.00%
Total14100.00%1100.00%

#endif #endif /* _LINUX_KPROBES_H */

Overall Contributors

PersonTokensPropCommitsCommitProp
Masami Hiramatsu85745.61%2232.84%
Prasanna S. Panchamukhi34418.31%45.97%
Ananth N. Mavinakayanahalli1729.15%913.43%
Hien Nguyen1528.09%11.49%
Heiko Carstens834.42%34.48%
Ingo Molnar502.66%34.48%
Srinivasa D S472.50%22.99%
Naveen N. Rao412.18%57.46%
Rusty Lynch301.60%34.48%
Abhishek Sagar281.49%22.99%
Thomas Gleixner180.96%22.99%
Michael Ellerman170.90%34.48%
Frédéric Weisbecker90.48%11.49%
Andrew Lutomirski90.48%11.49%
Christoph Lameter60.32%22.99%
Luis R. Rodriguez60.32%11.49%
Bibo Mao50.27%11.49%
Paul Gortmaker30.16%11.49%
Anil S Keshavamurthy20.11%11.49%
Total1879100.00%67100.00%
Directory: include/linux
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.