Merge branch 'irq' into release
[linux-2.6.git] / include / linux / ptrace.h
1 #ifndef _LINUX_PTRACE_H
2 #define _LINUX_PTRACE_H
3 /* ptrace.h */
4 /* structs and defines to help the user use the ptrace system call. */
5
6 /* has the defines to get at the registers. */
7
8 #define PTRACE_TRACEME             0
9 #define PTRACE_PEEKTEXT            1
10 #define PTRACE_PEEKDATA            2
11 #define PTRACE_PEEKUSR             3
12 #define PTRACE_POKETEXT            4
13 #define PTRACE_POKEDATA            5
14 #define PTRACE_POKEUSR             6
15 #define PTRACE_CONT                7
16 #define PTRACE_KILL                8
17 #define PTRACE_SINGLESTEP          9
18
19 #define PTRACE_ATTACH             16
20 #define PTRACE_DETACH             17
21
22 #define PTRACE_SYSCALL            24
23
24 /* 0x4200-0x4300 are reserved for architecture-independent additions.  */
25 #define PTRACE_SETOPTIONS       0x4200
26 #define PTRACE_GETEVENTMSG      0x4201
27 #define PTRACE_GETSIGINFO       0x4202
28 #define PTRACE_SETSIGINFO       0x4203
29
30 /* options set using PTRACE_SETOPTIONS */
31 #define PTRACE_O_TRACESYSGOOD   0x00000001
32 #define PTRACE_O_TRACEFORK      0x00000002
33 #define PTRACE_O_TRACEVFORK     0x00000004
34 #define PTRACE_O_TRACECLONE     0x00000008
35 #define PTRACE_O_TRACEEXEC      0x00000010
36 #define PTRACE_O_TRACEVFORKDONE 0x00000020
37 #define PTRACE_O_TRACEEXIT      0x00000040
38
39 #define PTRACE_O_MASK           0x0000007f
40
41 /* Wait extended result codes for the above trace options.  */
42 #define PTRACE_EVENT_FORK       1
43 #define PTRACE_EVENT_VFORK      2
44 #define PTRACE_EVENT_CLONE      3
45 #define PTRACE_EVENT_EXEC       4
46 #define PTRACE_EVENT_VFORK_DONE 5
47 #define PTRACE_EVENT_EXIT       6
48
49 #include <asm/ptrace.h>
50
51 #ifdef __KERNEL__
52 /*
53  * Ptrace flags
54  *
55  * The owner ship rules for task->ptrace which holds the ptrace
56  * flags is simple.  When a task is running it owns it's task->ptrace
57  * flags.  When the a task is stopped the ptracer owns task->ptrace.
58  */
59
60 #define PT_PTRACED      0x00000001
61 #define PT_DTRACE       0x00000002      /* delayed trace (used on m68k, i386) */
62 #define PT_TRACESYSGOOD 0x00000004
63 #define PT_PTRACE_CAP   0x00000008      /* ptracer can follow suid-exec */
64 #define PT_TRACE_FORK   0x00000010
65 #define PT_TRACE_VFORK  0x00000020
66 #define PT_TRACE_CLONE  0x00000040
67 #define PT_TRACE_EXEC   0x00000080
68 #define PT_TRACE_VFORK_DONE     0x00000100
69 #define PT_TRACE_EXIT   0x00000200
70
71 #define PT_TRACE_MASK   0x000003f4
72
73 /* single stepping state bits (used on ARM and PA-RISC) */
74 #define PT_SINGLESTEP_BIT       31
75 #define PT_SINGLESTEP           (1<<PT_SINGLESTEP_BIT)
76 #define PT_BLOCKSTEP_BIT        30
77 #define PT_BLOCKSTEP            (1<<PT_BLOCKSTEP_BIT)
78
79 #include <linux/compiler.h>             /* For unlikely.  */
80 #include <linux/sched.h>                /* For struct task_struct.  */
81
82
83 extern long arch_ptrace(struct task_struct *child, long request, long addr, long data);
84 extern struct task_struct *ptrace_get_task_struct(pid_t pid);
85 extern int ptrace_traceme(void);
86 extern int ptrace_readdata(struct task_struct *tsk, unsigned long src, char __user *dst, int len);
87 extern int ptrace_writedata(struct task_struct *tsk, char __user *src, unsigned long dst, int len);
88 extern int ptrace_attach(struct task_struct *tsk);
89 extern int ptrace_detach(struct task_struct *, unsigned int);
90 extern void ptrace_disable(struct task_struct *);
91 extern int ptrace_check_attach(struct task_struct *task, int kill);
92 extern int ptrace_request(struct task_struct *child, long request, long addr, long data);
93 extern void ptrace_notify(int exit_code);
94 extern void __ptrace_link(struct task_struct *child,
95                           struct task_struct *new_parent);
96 extern void __ptrace_unlink(struct task_struct *child);
97 extern void exit_ptrace(struct task_struct *tracer);
98 extern void ptrace_fork(struct task_struct *task, unsigned long clone_flags);
99 #define PTRACE_MODE_READ   1
100 #define PTRACE_MODE_ATTACH 2
101 /* Returns 0 on success, -errno on denial. */
102 extern int __ptrace_may_access(struct task_struct *task, unsigned int mode);
103 /* Returns true on success, false on denial. */
104 extern bool ptrace_may_access(struct task_struct *task, unsigned int mode);
105
106 static inline int ptrace_reparented(struct task_struct *child)
107 {
108         return child->real_parent != child->parent;
109 }
110 static inline void ptrace_link(struct task_struct *child,
111                                struct task_struct *new_parent)
112 {
113         if (unlikely(child->ptrace))
114                 __ptrace_link(child, new_parent);
115 }
116 static inline void ptrace_unlink(struct task_struct *child)
117 {
118         if (unlikely(child->ptrace))
119                 __ptrace_unlink(child);
120 }
121
122 int generic_ptrace_peekdata(struct task_struct *tsk, long addr, long data);
123 int generic_ptrace_pokedata(struct task_struct *tsk, long addr, long data);
124
125 /**
126  * task_ptrace - return %PT_* flags that apply to a task
127  * @task:       pointer to &task_struct in question
128  *
129  * Returns the %PT_* flags that apply to @task.
130  */
131 static inline int task_ptrace(struct task_struct *task)
132 {
133         return task->ptrace;
134 }
135
136 /**
137  * ptrace_event - possibly stop for a ptrace event notification
138  * @mask:       %PT_* bit to check in @current->ptrace
139  * @event:      %PTRACE_EVENT_* value to report if @mask is set
140  * @message:    value for %PTRACE_GETEVENTMSG to return
141  *
142  * This checks the @mask bit to see if ptrace wants stops for this event.
143  * If so we stop, reporting @event and @message to the ptrace parent.
144  *
145  * Returns nonzero if we did a ptrace notification, zero if not.
146  *
147  * Called without locks.
148  */
149 static inline int ptrace_event(int mask, int event, unsigned long message)
150 {
151         if (mask && likely(!(current->ptrace & mask)))
152                 return 0;
153         current->ptrace_message = message;
154         ptrace_notify((event << 8) | SIGTRAP);
155         return 1;
156 }
157
158 /**
159  * ptrace_init_task - initialize ptrace state for a new child
160  * @child:              new child task
161  * @ptrace:             true if child should be ptrace'd by parent's tracer
162  *
163  * This is called immediately after adding @child to its parent's children
164  * list.  @ptrace is false in the normal case, and true to ptrace @child.
165  *
166  * Called with current's siglock and write_lock_irq(&tasklist_lock) held.
167  */
168 static inline void ptrace_init_task(struct task_struct *child, bool ptrace)
169 {
170         INIT_LIST_HEAD(&child->ptrace_entry);
171         INIT_LIST_HEAD(&child->ptraced);
172         child->parent = child->real_parent;
173         child->ptrace = 0;
174         if (unlikely(ptrace)) {
175                 child->ptrace = current->ptrace;
176                 ptrace_link(child, current->parent);
177         }
178 }
179
180 /**
181  * ptrace_release_task - final ptrace-related cleanup of a zombie being reaped
182  * @task:       task in %EXIT_DEAD state
183  *
184  * Called with write_lock(&tasklist_lock) held.
185  */
186 static inline void ptrace_release_task(struct task_struct *task)
187 {
188         BUG_ON(!list_empty(&task->ptraced));
189         ptrace_unlink(task);
190         BUG_ON(!list_empty(&task->ptrace_entry));
191 }
192
193 #ifndef force_successful_syscall_return
194 /*
195  * System call handlers that, upon successful completion, need to return a
196  * negative value should call force_successful_syscall_return() right before
197  * returning.  On architectures where the syscall convention provides for a
198  * separate error flag (e.g., alpha, ia64, ppc{,64}, sparc{,64}, possibly
199  * others), this macro can be used to ensure that the error flag will not get
200  * set.  On architectures which do not support a separate error flag, the macro
201  * is a no-op and the spurious error condition needs to be filtered out by some
202  * other means (e.g., in user-level, by passing an extra argument to the
203  * syscall handler, or something along those lines).
204  */
205 #define force_successful_syscall_return() do { } while (0)
206 #endif
207
208 /*
209  * <asm/ptrace.h> should define the following things inside #ifdef __KERNEL__.
210  *
211  * These do-nothing inlines are used when the arch does not
212  * implement single-step.  The kerneldoc comments are here
213  * to document the interface for all arch definitions.
214  */
215
216 #ifndef arch_has_single_step
217 /**
218  * arch_has_single_step - does this CPU support user-mode single-step?
219  *
220  * If this is defined, then there must be function declarations or
221  * inlines for user_enable_single_step() and user_disable_single_step().
222  * arch_has_single_step() should evaluate to nonzero iff the machine
223  * supports instruction single-step for user mode.
224  * It can be a constant or it can test a CPU feature bit.
225  */
226 #define arch_has_single_step()          (0)
227
228 /**
229  * user_enable_single_step - single-step in user-mode task
230  * @task: either current or a task stopped in %TASK_TRACED
231  *
232  * This can only be called when arch_has_single_step() has returned nonzero.
233  * Set @task so that when it returns to user mode, it will trap after the
234  * next single instruction executes.  If arch_has_block_step() is defined,
235  * this must clear the effects of user_enable_block_step() too.
236  */
237 static inline void user_enable_single_step(struct task_struct *task)
238 {
239         BUG();                  /* This can never be called.  */
240 }
241
242 /**
243  * user_disable_single_step - cancel user-mode single-step
244  * @task: either current or a task stopped in %TASK_TRACED
245  *
246  * Clear @task of the effects of user_enable_single_step() and
247  * user_enable_block_step().  This can be called whether or not either
248  * of those was ever called on @task, and even if arch_has_single_step()
249  * returned zero.
250  */
251 static inline void user_disable_single_step(struct task_struct *task)
252 {
253 }
254 #endif  /* arch_has_single_step */
255
256 #ifndef arch_has_block_step
257 /**
258  * arch_has_block_step - does this CPU support user-mode block-step?
259  *
260  * If this is defined, then there must be a function declaration or inline
261  * for user_enable_block_step(), and arch_has_single_step() must be defined
262  * too.  arch_has_block_step() should evaluate to nonzero iff the machine
263  * supports step-until-branch for user mode.  It can be a constant or it
264  * can test a CPU feature bit.
265  */
266 #define arch_has_block_step()           (0)
267
268 /**
269  * user_enable_block_step - step until branch in user-mode task
270  * @task: either current or a task stopped in %TASK_TRACED
271  *
272  * This can only be called when arch_has_block_step() has returned nonzero,
273  * and will never be called when single-instruction stepping is being used.
274  * Set @task so that when it returns to user mode, it will trap after the
275  * next branch or trap taken.
276  */
277 static inline void user_enable_block_step(struct task_struct *task)
278 {
279         BUG();                  /* This can never be called.  */
280 }
281 #endif  /* arch_has_block_step */
282
283 #ifndef arch_ptrace_stop_needed
284 /**
285  * arch_ptrace_stop_needed - Decide whether arch_ptrace_stop() should be called
286  * @code:       current->exit_code value ptrace will stop with
287  * @info:       siginfo_t pointer (or %NULL) for signal ptrace will stop with
288  *
289  * This is called with the siglock held, to decide whether or not it's
290  * necessary to release the siglock and call arch_ptrace_stop() with the
291  * same @code and @info arguments.  It can be defined to a constant if
292  * arch_ptrace_stop() is never required, or always is.  On machines where
293  * this makes sense, it should be defined to a quick test to optimize out
294  * calling arch_ptrace_stop() when it would be superfluous.  For example,
295  * if the thread has not been back to user mode since the last stop, the
296  * thread state might indicate that nothing needs to be done.
297  */
298 #define arch_ptrace_stop_needed(code, info)     (0)
299 #endif
300
301 #ifndef arch_ptrace_stop
302 /**
303  * arch_ptrace_stop - Do machine-specific work before stopping for ptrace
304  * @code:       current->exit_code value ptrace will stop with
305  * @info:       siginfo_t pointer (or %NULL) for signal ptrace will stop with
306  *
307  * This is called with no locks held when arch_ptrace_stop_needed() has
308  * just returned nonzero.  It is allowed to block, e.g. for user memory
309  * access.  The arch can have machine-specific work to be done before
310  * ptrace stops.  On ia64, register backing store gets written back to user
311  * memory here.  Since this can be costly (requires dropping the siglock),
312  * we only do it when the arch requires it for this particular stop, as
313  * indicated by arch_ptrace_stop_needed().
314  */
315 #define arch_ptrace_stop(code, info)            do { } while (0)
316 #endif
317
318 #ifndef arch_ptrace_untrace
319 /*
320  * Do machine-specific work before untracing child.
321  *
322  * This is called for a normal detach as well as from ptrace_exit()
323  * when the tracing task dies.
324  *
325  * Called with write_lock(&tasklist_lock) held.
326  */
327 #define arch_ptrace_untrace(task)               do { } while (0)
328 #endif
329
330 #ifndef arch_ptrace_fork
331 /*
332  * Do machine-specific work to initialize a new task.
333  *
334  * This is called from copy_process().
335  */
336 #define arch_ptrace_fork(child, clone_flags)    do { } while (0)
337 #endif
338
339 extern int task_current_syscall(struct task_struct *target, long *callno,
340                                 unsigned long args[6], unsigned int maxargs,
341                                 unsigned long *sp, unsigned long *pc);
342
343 #endif
344
345 #endif