[S390] cio: Add docbook comments.
[linux-2.6] / include / asm-s390 / kprobes.h
1 #ifndef _ASM_S390_KPROBES_H
2 #define _ASM_S390_KPROBES_H
3 /*
4  *  Kernel Probes (KProbes)
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, 2002, 2006
21  *
22  * 2002-Oct     Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
23  *              Probes initial implementation ( includes suggestions from
24  *              Rusty Russell).
25  * 2004-Nov     Modified for PPC64 by Ananth N Mavinakayanahalli
26  *              <ananth@in.ibm.com>
27  * 2005-Dec     Used as a template for s390 by Mike Grundy
28  *              <grundym@us.ibm.com>
29  */
30 #include <linux/types.h>
31 #include <linux/ptrace.h>
32 #include <linux/percpu.h>
33
34 #define  __ARCH_WANT_KPROBES_INSN_SLOT
35 struct pt_regs;
36 struct kprobe;
37
38 typedef u16 kprobe_opcode_t;
39 #define BREAKPOINT_INSTRUCTION  0x0002
40
41 /* Maximum instruction size is 3 (16bit) halfwords: */
42 #define MAX_INSN_SIZE           0x0003
43 #define MAX_STACK_SIZE          64
44 #define MIN_STACK_SIZE(ADDR) (((MAX_STACK_SIZE) < \
45         (((unsigned long)current_thread_info()) + THREAD_SIZE - (ADDR))) \
46         ? (MAX_STACK_SIZE) \
47         : (((unsigned long)current_thread_info()) + THREAD_SIZE - (ADDR)))
48
49 #define ARCH_SUPPORTS_KRETPROBES
50 #define ARCH_INACTIVE_KPROBE_COUNT 0
51
52 #define KPROBE_SWAP_INST        0x10
53
54 #define FIXUP_PSW_NORMAL        0x08
55 #define FIXUP_BRANCH_NOT_TAKEN  0x04
56 #define FIXUP_RETURN_REGISTER   0x02
57 #define FIXUP_NOT_REQUIRED      0x01
58
59 /* Architecture specific copy of original instruction */
60 struct arch_specific_insn {
61         /* copy of original instruction */
62         kprobe_opcode_t *insn;
63         int fixup;
64         int ilen;
65         int reg;
66 };
67
68 struct ins_replace_args {
69         kprobe_opcode_t *ptr;
70         kprobe_opcode_t old;
71         kprobe_opcode_t new;
72 };
73 struct prev_kprobe {
74         struct kprobe *kp;
75         unsigned long status;
76         unsigned long saved_psw;
77         unsigned long kprobe_saved_imask;
78         unsigned long kprobe_saved_ctl[3];
79 };
80
81 /* per-cpu kprobe control block */
82 struct kprobe_ctlblk {
83         unsigned long kprobe_status;
84         unsigned long kprobe_saved_imask;
85         unsigned long kprobe_saved_ctl[3];
86         struct pt_regs jprobe_saved_regs;
87         unsigned long jprobe_saved_r14;
88         unsigned long jprobe_saved_r15;
89         struct prev_kprobe prev_kprobe;
90         kprobe_opcode_t jprobes_stack[MAX_STACK_SIZE];
91 };
92
93 void arch_remove_kprobe(struct kprobe *p);
94 void kretprobe_trampoline(void);
95 int  is_prohibited_opcode(kprobe_opcode_t *instruction);
96 void get_instruction_type(struct arch_specific_insn *ainsn);
97
98 int kprobe_fault_handler(struct pt_regs *regs, int trapnr);
99 int kprobe_exceptions_notify(struct notifier_block *self,
100         unsigned long val, void *data);
101
102 #define flush_insn_slot(p)      do { } while (0)
103
104 #endif  /* _ASM_S390_KPROBES_H */