[deliverable/linux.git] / include / linux / uprobes.h

#ifndef _LINUX_UPROBES_H
#define _LINUX_UPROBES_H
/*
 * User-space Probes (UProbes)
 *
 * 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, 2008-2011
 * Authors:
 *	Srikar Dronamraju
 *	Jim Keniston
 */

#include <linux/errno.h>
#include <linux/rbtree.h>

struct vm_area_struct;
#ifdef CONFIG_ARCH_SUPPORTS_UPROBES
#include <asm/uprobes.h>
#else

typedef u8 uprobe_opcode_t;
struct uprobe_arch_info {};

#define MAX_UINSN_BYTES 4
#endif

/* flags that denote/change uprobes behaviour */

/* Have a copy of original instruction */
#define UPROBES_COPY_INSN	0x1

/* Dont run handlers when first register/ last unregister in progress*/
#define UPROBES_RUN_HANDLER	0x2

struct uprobe_consumer {
	int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
	/*
	 * filter is optional; If a filter exists, handler is run
	 * if and only if filter returns true.
	 */
	bool (*filter)(struct uprobe_consumer *self, struct task_struct *task);

	struct uprobe_consumer *next;
};

struct uprobe {
	struct rb_node		rb_node;	/* node in the rb tree */
	atomic_t		ref;
	struct rw_semaphore	consumer_rwsem;
	struct list_head	pending_list;
	struct uprobe_arch_info arch_info;
	struct uprobe_consumer	*consumers;
	struct inode		*inode;		/* Also hold a ref to inode */
	loff_t			offset;
	int			flags;
	u8			insn[MAX_UINSN_BYTES];
};

#ifdef CONFIG_UPROBES
extern int __weak set_bkpt(struct mm_struct *mm, struct uprobe *uprobe, unsigned long vaddr);
extern int __weak set_orig_insn(struct mm_struct *mm, struct uprobe *uprobe, unsigned long vaddr, bool verify);
extern bool __weak is_bkpt_insn(uprobe_opcode_t *insn);
extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *consumer);
extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *consumer);
extern int uprobe_mmap(struct vm_area_struct *vma);
#else /* CONFIG_UPROBES is not defined */
static inline int
uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *consumer)
{
	return -ENOSYS;
}
static inline void
uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *consumer)
{
}
static inline int uprobe_mmap(struct vm_area_struct *vma)
{
	return 0;
}
#endif /* CONFIG_UPROBES */
#endif	/* _LINUX_UPROBES_H */
Commit	Line	Data
2b144498 SD	1	#ifndef _LINUX_UPROBES_H
	2	#define _LINUX_UPROBES_H
	3	/*
7b2d81d4	4	* User-space Probes (UProbes)
2b144498 SD	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	19	*
	20	* Copyright (C) IBM Corporation, 2008-2011
	21	* Authors:
	22	* Srikar Dronamraju
	23	* Jim Keniston
	24	*/
	25
	26	#include <linux/errno.h>
	27	#include <linux/rbtree.h>
	28
	29	struct vm_area_struct;
	30	#ifdef CONFIG_ARCH_SUPPORTS_UPROBES
	31	#include <asm/uprobes.h>
	32	#else
	33
	34	typedef u8 uprobe_opcode_t;
	35	struct uprobe_arch_info {};
	36
	37	#define MAX_UINSN_BYTES 4
	38	#endif
	39
2b144498	40	/* flags that denote/change uprobes behaviour */
7b2d81d4	41
2b144498 SD	42	/* Have a copy of original instruction */
2b144498 SD	43	#define UPROBES_COPY_INSN 0x1
7b2d81d4	44
2b144498 SD	45	/* Dont run handlers when first register/ last unregister in progress*/
	46	#define UPROBES_RUN_HANDLER 0x2
	47
	48	struct uprobe_consumer {
	49	int (handler)(struct uprobe_consumer self, struct pt_regs *regs);
	50	/*
	51	* filter is optional; If a filter exists, handler is run
	52	* if and only if filter returns true.
	53	*/
	54	bool (filter)(struct uprobe_consumer self, struct task_struct *task);
	55
	56	struct uprobe_consumer *next;
	57	};
	58
	59	struct uprobe {
	60	struct rb_node rb_node; /* node in the rb tree */
	61	atomic_t ref;
	62	struct rw_semaphore consumer_rwsem;
	63	struct list_head pending_list;
	64	struct uprobe_arch_info arch_info;
	65	struct uprobe_consumer *consumers;
	66	struct inode inode; / Also hold a ref to inode */
	67	loff_t offset;
	68	int flags;
	69	u8 insn[MAX_UINSN_BYTES];
	70	};
	71
	72	#ifdef CONFIG_UPROBES
7b2d81d4 IM	73	extern int __weak set_bkpt(struct mm_struct mm, struct uprobe uprobe, unsigned long vaddr);
7b2d81d4 IM	74	extern int __weak set_orig_insn(struct mm_struct mm, struct uprobe uprobe, unsigned long vaddr, bool verify);
2b144498	75	extern bool __weak is_bkpt_insn(uprobe_opcode_t *insn);
7b2d81d4 IM	76	extern int uprobe_register(struct inode inode, loff_t offset, struct uprobe_consumer consumer);
	77	extern void uprobe_unregister(struct inode inode, loff_t offset, struct uprobe_consumer consumer);
	78	extern int uprobe_mmap(struct vm_area_struct *vma);
2b144498	79	#else /* CONFIG_UPROBES is not defined */
7b2d81d4 IM	80	static inline int
7b2d81d4 IM	81	uprobe_register(struct inode inode, loff_t offset, struct uprobe_consumer consumer)
2b144498 SD	82	{
	83	return -ENOSYS;
	84	}
7b2d81d4 IM	85	static inline void
7b2d81d4 IM	86	uprobe_unregister(struct inode inode, loff_t offset, struct uprobe_consumer consumer)
2b144498 SD	87	{
2b144498 SD	88	}
7b2d81d4	89	static inline int uprobe_mmap(struct vm_area_struct *vma)
2b144498 SD	90	{
	91	return 0;
	92	}
	93	#endif /* CONFIG_UPROBES */
	94	#endif /* _LINUX_UPROBES_H */