blob: 9d369f6803216cd365358d1660c6aab999287d51 [file] [log] [blame]
H. Peter Anvin1965aae2008-10-22 22:26:29 -07001#ifndef _ASM_X86_PTRACE_H
2#define _ASM_X86_PTRACE_H
Thomas Gleixner8fc37f22007-10-23 22:37:24 +02003
4#include <linux/compiler.h> /* For __user */
5#include <asm/ptrace-abi.h>
Vegard Nossum6330a302008-05-28 09:46:19 +02006#include <asm/processor-flags.h>
Thomas Gleixner8fc37f22007-10-23 22:37:24 +02007
Vegard Nossum6330a302008-05-28 09:46:19 +02008#ifdef __KERNEL__
Vegard Nossum6330a302008-05-28 09:46:19 +02009#include <asm/segment.h>
Masami Hiramatsub1cf5402009-08-13 16:34:44 -040010#include <asm/page_types.h>
Vegard Nossum6330a302008-05-28 09:46:19 +020011#endif
Markus Metzgereee3af42008-01-30 13:31:09 +010012
Thomas Gleixner8fc37f22007-10-23 22:37:24 +020013#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
H. Peter Anvin65ea5b02008-01-30 13:30:56 +010019#ifndef __KERNEL__
20
Thomas Gleixner8fc37f22007-10-23 22:37:24 +020021struct 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;
Tejun Heoccbeed32009-02-09 22:17:40 +090032 int xgs;
Thomas Gleixner8fc37f22007-10-23 22:37:24 +020033 long orig_eax;
34 long eip;
35 int xcs;
36 long eflags;
37 long esp;
38 int xss;
39};
40
H. Peter Anvin65ea5b02008-01-30 13:30:56 +010041#else /* __KERNEL__ */
42
43struct pt_regs {
Harvey Harrison92bc2052008-02-08 12:09:56 -080044 unsigned long bx;
45 unsigned long cx;
46 unsigned long dx;
47 unsigned long si;
48 unsigned long di;
49 unsigned long bp;
Harvey Harrison9902a702008-02-08 12:09:57 -080050 unsigned long ax;
Harvey Harrison92bc2052008-02-08 12:09:56 -080051 unsigned long ds;
52 unsigned long es;
53 unsigned long fs;
Tejun Heoccbeed32009-02-09 22:17:40 +090054 unsigned long gs;
Harvey Harrison9902a702008-02-08 12:09:57 -080055 unsigned long orig_ax;
Harvey Harrison92bc2052008-02-08 12:09:56 -080056 unsigned long ip;
57 unsigned long cs;
58 unsigned long flags;
59 unsigned long sp;
60 unsigned long ss;
H. Peter Anvin65ea5b02008-01-30 13:30:56 +010061};
Thomas Gleixner8fc37f22007-10-23 22:37:24 +020062
Thomas Gleixner8fc37f22007-10-23 22:37:24 +020063#endif /* __KERNEL__ */
64
65#else /* __i386__ */
66
H. Peter Anvin65ea5b02008-01-30 13:30:56 +010067#ifndef __KERNEL__
68
Thomas Gleixner8fc37f22007-10-23 22:37:24 +020069struct 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 upto 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
H. Peter Anvin65ea5b02008-01-30 13:30:56 +010097#else /* __KERNEL__ */
98
99struct 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 upto 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};
Thomas Gleixner8fc37f22007-10-23 22:37:24 +0200126
Thomas Gleixner8fc37f22007-10-23 22:37:24 +0200127#endif /* __KERNEL__ */
128#endif /* !__i386__ */
Roland McGrathefd1ca52008-01-30 13:30:46 +0100129
Markus Metzger93fa7632008-04-08 11:01:58 +0200130
Roland McGrathefd1ca52008-01-30 13:30:46 +0100131#ifdef __KERNEL__
132
Markus Metzger93fa7632008-04-08 11:01:58 +0200133#include <linux/init.h>
Harvey Harrisondbe35332008-01-30 13:33:16 +0100134
Markus Metzger93fa7632008-04-08 11:01:58 +0200135struct cpuinfo_x86;
Harvey Harrisondbe35332008-01-30 13:33:16 +0100136struct task_struct;
137
Harvey Harrisondbe35332008-01-30 13:33:16 +0100138extern unsigned long profile_pc(struct pt_regs *regs);
139
140extern unsigned long
141convert_ip_to_linear(struct task_struct *child, struct pt_regs *regs);
Joe Perches72f74fa22008-03-23 01:03:17 -0700142extern void send_sigtrap(struct task_struct *tsk, struct pt_regs *regs,
Srinivasa Dsda654b72008-09-23 15:23:52 +0530143 int error_code, int si_code);
Hiroshi Shimamoto72fa50f2008-09-05 16:27:11 -0700144void signal_fault(struct pt_regs *regs, void __user *frame, char *where);
145
Jaswinder Singhc1686ae2008-07-21 22:35:38 +0530146extern long syscall_trace_enter(struct pt_regs *);
147extern void syscall_trace_leave(struct pt_regs *);
148
Harvey Harrison9902a702008-02-08 12:09:57 -0800149static inline unsigned long regs_return_value(struct pt_regs *regs)
150{
151 return regs->ax;
152}
Harvey Harrisondbe35332008-01-30 13:33:16 +0100153
Roland McGrath7f232342008-01-30 13:30:48 +0100154/*
Harvey Harrison90d43d72008-01-30 13:33:16 +0100155 * user_mode_vm(regs) determines whether a register set came from user mode.
156 * This is true if V8086 mode was enabled OR if the register set was from
157 * protected mode with RPL-3 CS value. This tricky test checks that with
158 * one comparison. Many places in the kernel can bypass this full check
159 * if they have already ruled out V8086 mode, so user_mode(regs) can be used.
160 */
161static inline int user_mode(struct pt_regs *regs)
162{
163#ifdef CONFIG_X86_32
164 return (regs->cs & SEGMENT_RPL_MASK) == USER_RPL;
165#else
166 return !!(regs->cs & 3);
167#endif
168}
169
170static inline int user_mode_vm(struct pt_regs *regs)
171{
172#ifdef CONFIG_X86_32
gorcunov@gmail.com6b6891f2008-03-28 17:56:57 +0300173 return ((regs->cs & SEGMENT_RPL_MASK) | (regs->flags & X86_VM_MASK)) >=
Joe Perches72f74fa22008-03-23 01:03:17 -0700174 USER_RPL;
Harvey Harrison90d43d72008-01-30 13:33:16 +0100175#else
176 return user_mode(regs);
177#endif
178}
179
180static inline int v8086_mode(struct pt_regs *regs)
181{
182#ifdef CONFIG_X86_32
gorcunov@gmail.com6b6891f2008-03-28 17:56:57 +0300183 return (regs->flags & X86_VM_MASK);
Harvey Harrison90d43d72008-01-30 13:33:16 +0100184#else
185 return 0; /* No V86 mode support in long mode */
186#endif
187}
188
Harvey Harrisonf6e8e282008-01-30 13:33:16 +0100189/*
190 * X86_32 CPUs don't save ss and esp if the CPU is already in kernel mode
Masami Hiramatsu7b6c6c72009-05-11 17:03:00 -0400191 * when it traps. The previous stack will be directly underneath the saved
192 * registers, and 'sp/ss' won't even have been saved. Thus the '&regs->sp'.
Harvey Harrisonf6e8e282008-01-30 13:33:16 +0100193 *
194 * This is valid only for kernel mode traps.
195 */
Masami Hiramatsu7b6c6c72009-05-11 17:03:00 -0400196static inline unsigned long kernel_stack_pointer(struct pt_regs *regs)
Harvey Harrison90d43d72008-01-30 13:33:16 +0100197{
198#ifdef CONFIG_X86_32
Masami Hiramatsu7b6c6c72009-05-11 17:03:00 -0400199 return (unsigned long)(&regs->sp);
Harvey Harrison90d43d72008-01-30 13:33:16 +0100200#else
201 return regs->sp;
202#endif
203}
204
205static inline unsigned long instruction_pointer(struct pt_regs *regs)
206{
207 return regs->ip;
208}
209
210static inline unsigned long frame_pointer(struct pt_regs *regs)
211{
212 return regs->bp;
213}
214
Roland McGrath68bd0f42008-04-18 17:08:44 -0700215static inline unsigned long user_stack_pointer(struct pt_regs *regs)
216{
217 return regs->sp;
218}
219
Masami Hiramatsub1cf5402009-08-13 16:34:44 -0400220/* Query offset/name of register from its name/offset */
221extern int regs_query_register_offset(const char *name);
222extern const char *regs_query_register_name(unsigned int offset);
223#define MAX_REG_OFFSET (offsetof(struct pt_regs, ss))
224
225/**
226 * regs_get_register() - get register value from its offset
227 * @regs: pt_regs from which register value is gotten.
228 * @offset: offset number of the register.
229 *
Masami Hiramatsue859cf82009-11-30 19:02:22 -0500230 * regs_get_register returns the value of a register. The @offset is the
231 * offset of the register in struct pt_regs address which specified by @regs.
Masami Hiramatsub1cf5402009-08-13 16:34:44 -0400232 * If @offset is bigger than MAX_REG_OFFSET, this returns 0.
233 */
234static inline unsigned long regs_get_register(struct pt_regs *regs,
235 unsigned int offset)
236{
237 if (unlikely(offset > MAX_REG_OFFSET))
238 return 0;
239 return *(unsigned long *)((unsigned long)regs + offset);
240}
241
242/**
243 * regs_within_kernel_stack() - check the address in the stack
244 * @regs: pt_regs which contains kernel stack pointer.
245 * @addr: address which is checked.
246 *
Masami Hiramatsue859cf82009-11-30 19:02:22 -0500247 * regs_within_kernel_stack() checks @addr is within the kernel stack page(s).
Masami Hiramatsub1cf5402009-08-13 16:34:44 -0400248 * If @addr is within the kernel stack, it returns true. If not, returns false.
249 */
250static inline int regs_within_kernel_stack(struct pt_regs *regs,
251 unsigned long addr)
252{
253 return ((addr & ~(THREAD_SIZE - 1)) ==
254 (kernel_stack_pointer(regs) & ~(THREAD_SIZE - 1)));
255}
256
257/**
258 * regs_get_kernel_stack_nth() - get Nth entry of the stack
259 * @regs: pt_regs which contains kernel stack pointer.
260 * @n: stack entry number.
261 *
262 * regs_get_kernel_stack_nth() returns @n th entry of the kernel stack which
Masami Hiramatsue859cf82009-11-30 19:02:22 -0500263 * is specified by @regs. If the @n th entry is NOT in the kernel stack,
Masami Hiramatsub1cf5402009-08-13 16:34:44 -0400264 * this returns 0.
265 */
266static inline unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs,
267 unsigned int n)
268{
269 unsigned long *addr = (unsigned long *)kernel_stack_pointer(regs);
270 addr += n;
271 if (regs_within_kernel_stack(regs, (unsigned long)addr))
272 return *addr;
273 else
274 return 0;
275}
276
277/* Get Nth argument at function call */
278extern unsigned long regs_get_argument_nth(struct pt_regs *regs,
279 unsigned int n);
280
Harvey Harrison90d43d72008-01-30 13:33:16 +0100281/*
Roland McGrath7f232342008-01-30 13:30:48 +0100282 * These are defined as per linux/ptrace.h, which see.
283 */
284#define arch_has_single_step() (1)
285extern void user_enable_single_step(struct task_struct *);
286extern void user_disable_single_step(struct task_struct *);
287
Roland McGrath10faa812008-01-30 13:30:54 +0100288extern void user_enable_block_step(struct task_struct *);
289#ifdef CONFIG_X86_DEBUGCTLMSR
290#define arch_has_block_step() (1)
291#else
292#define arch_has_block_step() (boot_cpu_data.x86 >= 6)
293#endif
294
Oleg Nesterov7f385512009-12-15 16:47:20 -0800295#define ARCH_HAS_USER_SINGLE_STEP_INFO
296
Roland McGrathefd1ca52008-01-30 13:30:46 +0100297struct user_desc;
298extern int do_get_thread_area(struct task_struct *p, int idx,
299 struct user_desc __user *info);
300extern int do_set_thread_area(struct task_struct *p, int idx,
301 struct user_desc __user *info, int can_allocate);
302
Markus Metzger0f481402009-04-03 16:43:48 +0200303#ifdef CONFIG_X86_PTRACE_BTS
304extern void ptrace_bts_untrace(struct task_struct *tsk);
Markus Metzgerbf53de92008-12-19 15:10:24 +0100305
Markus Metzger0f481402009-04-03 16:43:48 +0200306#define arch_ptrace_untrace(tsk) ptrace_bts_untrace(tsk)
307#endif /* CONFIG_X86_PTRACE_BTS */
Markus Metzgerbf53de92008-12-19 15:10:24 +0100308
Roland McGrathefd1ca52008-01-30 13:30:46 +0100309#endif /* __KERNEL__ */
310
Thomas Gleixner8fc37f22007-10-23 22:37:24 +0200311#endif /* !__ASSEMBLY__ */
312
H. Peter Anvin1965aae2008-10-22 22:26:29 -0700313#endif /* _ASM_X86_PTRACE_H */