Initial commit
[kernel/linux-3.0.git] / arch / x86 / include / asm / ptrace.h
1 #ifndef _ASM_X86_PTRACE_H
2 #define _ASM_X86_PTRACE_H
3
4 #include <linux/compiler.h>     /* For __user */
5 #include <asm/ptrace-abi.h>
6 #include <asm/processor-flags.h>
7
8 #ifdef __KERNEL__
9 #include <asm/segment.h>
10 #include <asm/page_types.h>
11 #endif
12
13 #ifndef __ASSEMBLY__
14
15 #ifdef __i386__
16 /* this struct defines the way the registers are stored on the
17    stack during a system call. */
18
19 #ifndef __KERNEL__
20
21 struct pt_regs {
22         long ebx;
23         long ecx;
24         long edx;
25         long esi;
26         long edi;
27         long ebp;
28         long eax;
29         int  xds;
30         int  xes;
31         int  xfs;
32         int  xgs;
33         long orig_eax;
34         long eip;
35         int  xcs;
36         long eflags;
37         long esp;
38         int  xss;
39 };
40
41 #else /* __KERNEL__ */
42
43 struct pt_regs {
44         unsigned long bx;
45         unsigned long cx;
46         unsigned long dx;
47         unsigned long si;
48         unsigned long di;
49         unsigned long bp;
50         unsigned long ax;
51         unsigned long ds;
52         unsigned long es;
53         unsigned long fs;
54         unsigned long gs;
55         unsigned long orig_ax;
56         unsigned long ip;
57         unsigned long cs;
58         unsigned long flags;
59         unsigned long sp;
60         unsigned long ss;
61 };
62
63 #endif /* __KERNEL__ */
64
65 #else /* __i386__ */
66
67 #ifndef __KERNEL__
68
69 struct pt_regs {
70         unsigned long r15;
71         unsigned long r14;
72         unsigned long r13;
73         unsigned long r12;
74         unsigned long rbp;
75         unsigned long rbx;
76 /* arguments: non interrupts/non tracing syscalls only save up to here*/
77         unsigned long r11;
78         unsigned long r10;
79         unsigned long r9;
80         unsigned long r8;
81         unsigned long rax;
82         unsigned long rcx;
83         unsigned long rdx;
84         unsigned long rsi;
85         unsigned long rdi;
86         unsigned long orig_rax;
87 /* end of arguments */
88 /* cpu exception frame or undefined */
89         unsigned long rip;
90         unsigned long cs;
91         unsigned long eflags;
92         unsigned long rsp;
93         unsigned long ss;
94 /* top of stack page */
95 };
96
97 #else /* __KERNEL__ */
98
99 struct pt_regs {
100         unsigned long r15;
101         unsigned long r14;
102         unsigned long r13;
103         unsigned long r12;
104         unsigned long bp;
105         unsigned long bx;
106 /* arguments: non interrupts/non tracing syscalls only save up to here*/
107         unsigned long r11;
108         unsigned long r10;
109         unsigned long r9;
110         unsigned long r8;
111         unsigned long ax;
112         unsigned long cx;
113         unsigned long dx;
114         unsigned long si;
115         unsigned long di;
116         unsigned long orig_ax;
117 /* end of arguments */
118 /* cpu exception frame or undefined */
119         unsigned long ip;
120         unsigned long cs;
121         unsigned long flags;
122         unsigned long sp;
123         unsigned long ss;
124 /* top of stack page */
125 };
126
127 #endif /* __KERNEL__ */
128 #endif /* !__i386__ */
129
130
131 #ifdef __KERNEL__
132
133 #include <linux/init.h>
134
135 struct cpuinfo_x86;
136 struct task_struct;
137
138 extern unsigned long profile_pc(struct pt_regs *regs);
139 #define profile_pc profile_pc
140
141 extern unsigned long
142 convert_ip_to_linear(struct task_struct *child, struct pt_regs *regs);
143 extern void send_sigtrap(struct task_struct *tsk, struct pt_regs *regs,
144                          int error_code, int si_code);
145 void signal_fault(struct pt_regs *regs, void __user *frame, char *where);
146
147 extern long syscall_trace_enter(struct pt_regs *);
148 extern void syscall_trace_leave(struct pt_regs *);
149
150 static inline unsigned long regs_return_value(struct pt_regs *regs)
151 {
152         return regs->ax;
153 }
154
155 /*
156  * user_mode_vm(regs) determines whether a register set came from user mode.
157  * This is true if V8086 mode was enabled OR if the register set was from
158  * protected mode with RPL-3 CS value.  This tricky test checks that with
159  * one comparison.  Many places in the kernel can bypass this full check
160  * if they have already ruled out V8086 mode, so user_mode(regs) can be used.
161  */
162 static inline int user_mode(struct pt_regs *regs)
163 {
164 #ifdef CONFIG_X86_32
165         return (regs->cs & SEGMENT_RPL_MASK) == USER_RPL;
166 #else
167         return !!(regs->cs & 3);
168 #endif
169 }
170
171 static inline int user_mode_vm(struct pt_regs *regs)
172 {
173 #ifdef CONFIG_X86_32
174         return ((regs->cs & SEGMENT_RPL_MASK) | (regs->flags & X86_VM_MASK)) >=
175                 USER_RPL;
176 #else
177         return user_mode(regs);
178 #endif
179 }
180
181 static inline int v8086_mode(struct pt_regs *regs)
182 {
183 #ifdef CONFIG_X86_32
184         return (regs->flags & X86_VM_MASK);
185 #else
186         return 0;       /* No V86 mode support in long mode */
187 #endif
188 }
189
190 /*
191  * X86_32 CPUs don't save ss and esp if the CPU is already in kernel mode
192  * when it traps.  The previous stack will be directly underneath the saved
193  * registers, and 'sp/ss' won't even have been saved. Thus the '&regs->sp'.
194  *
195  * This is valid only for kernel mode traps.
196  */
197 static inline unsigned long kernel_stack_pointer(struct pt_regs *regs)
198 {
199 #ifdef CONFIG_X86_32
200         return (unsigned long)(&regs->sp);
201 #else
202         return regs->sp;
203 #endif
204 }
205
206 #define GET_IP(regs) ((regs)->ip)
207 #define GET_FP(regs) ((regs)->bp)
208 #define GET_USP(regs) ((regs)->sp)
209
210 #include <asm-generic/ptrace.h>
211
212 /* Query offset/name of register from its name/offset */
213 extern int regs_query_register_offset(const char *name);
214 extern const char *regs_query_register_name(unsigned int offset);
215 #define MAX_REG_OFFSET (offsetof(struct pt_regs, ss))
216
217 /**
218  * regs_get_register() - get register value from its offset
219  * @regs:       pt_regs from which register value is gotten.
220  * @offset:     offset number of the register.
221  *
222  * regs_get_register returns the value of a register. The @offset is the
223  * offset of the register in struct pt_regs address which specified by @regs.
224  * If @offset is bigger than MAX_REG_OFFSET, this returns 0.
225  */
226 static inline unsigned long regs_get_register(struct pt_regs *regs,
227                                               unsigned int offset)
228 {
229         if (unlikely(offset > MAX_REG_OFFSET))
230                 return 0;
231         return *(unsigned long *)((unsigned long)regs + offset);
232 }
233
234 /**
235  * regs_within_kernel_stack() - check the address in the stack
236  * @regs:       pt_regs which contains kernel stack pointer.
237  * @addr:       address which is checked.
238  *
239  * regs_within_kernel_stack() checks @addr is within the kernel stack page(s).
240  * If @addr is within the kernel stack, it returns true. If not, returns false.
241  */
242 static inline int regs_within_kernel_stack(struct pt_regs *regs,
243                                            unsigned long addr)
244 {
245         return ((addr & ~(THREAD_SIZE - 1))  ==
246                 (kernel_stack_pointer(regs) & ~(THREAD_SIZE - 1)));
247 }
248
249 /**
250  * regs_get_kernel_stack_nth() - get Nth entry of the stack
251  * @regs:       pt_regs which contains kernel stack pointer.
252  * @n:          stack entry number.
253  *
254  * regs_get_kernel_stack_nth() returns @n th entry of the kernel stack which
255  * is specified by @regs. If the @n th entry is NOT in the kernel stack,
256  * this returns 0.
257  */
258 static inline unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs,
259                                                       unsigned int n)
260 {
261         unsigned long *addr = (unsigned long *)kernel_stack_pointer(regs);
262         addr += n;
263         if (regs_within_kernel_stack(regs, (unsigned long)addr))
264                 return *addr;
265         else
266                 return 0;
267 }
268
269 #define arch_has_single_step()  (1)
270 #ifdef CONFIG_X86_DEBUGCTLMSR
271 #define arch_has_block_step()   (1)
272 #else
273 #define arch_has_block_step()   (boot_cpu_data.x86 >= 6)
274 #endif
275
276 #define ARCH_HAS_USER_SINGLE_STEP_INFO
277
278 struct user_desc;
279 extern int do_get_thread_area(struct task_struct *p, int idx,
280                               struct user_desc __user *info);
281 extern int do_set_thread_area(struct task_struct *p, int idx,
282                               struct user_desc __user *info, int can_allocate);
283
284 #endif /* __KERNEL__ */
285
286 #endif /* !__ASSEMBLY__ */
287
288 #endif /* _ASM_X86_PTRACE_H */