xref: /linux-6.15/include/linux/ptrace.h (revision 643d1f7f)
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 #define PT_ATTACHED	0x00000400	/* parent != real_parent */
71 
72 #define PT_TRACE_MASK	0x000003f4
73 
74 /* single stepping state bits (used on ARM and PA-RISC) */
75 #define PT_SINGLESTEP_BIT	31
76 #define PT_SINGLESTEP		(1<<PT_SINGLESTEP_BIT)
77 #define PT_BLOCKSTEP_BIT	30
78 #define PT_BLOCKSTEP		(1<<PT_BLOCKSTEP_BIT)
79 
80 #include <linux/compiler.h>		/* For unlikely.  */
81 #include <linux/sched.h>		/* For struct task_struct.  */
82 
83 
84 extern long arch_ptrace(struct task_struct *child, long request, long addr, long data);
85 extern struct task_struct *ptrace_get_task_struct(pid_t pid);
86 extern int ptrace_traceme(void);
87 extern int ptrace_readdata(struct task_struct *tsk, unsigned long src, char __user *dst, int len);
88 extern int ptrace_writedata(struct task_struct *tsk, char __user *src, unsigned long dst, int len);
89 extern int ptrace_attach(struct task_struct *tsk);
90 extern int ptrace_detach(struct task_struct *, unsigned int);
91 extern void ptrace_disable(struct task_struct *);
92 extern int ptrace_check_attach(struct task_struct *task, int kill);
93 extern int ptrace_request(struct task_struct *child, long request, long addr, long data);
94 extern void ptrace_notify(int exit_code);
95 extern void __ptrace_link(struct task_struct *child,
96 			  struct task_struct *new_parent);
97 extern void __ptrace_unlink(struct task_struct *child);
98 extern void ptrace_untrace(struct task_struct *child);
99 extern int ptrace_may_attach(struct task_struct *task);
100 extern int __ptrace_may_attach(struct task_struct *task);
101 
102 static inline void ptrace_link(struct task_struct *child,
103 			       struct task_struct *new_parent)
104 {
105 	if (unlikely(child->ptrace))
106 		__ptrace_link(child, new_parent);
107 }
108 static inline void ptrace_unlink(struct task_struct *child)
109 {
110 	if (unlikely(child->ptrace))
111 		__ptrace_unlink(child);
112 }
113 
114 int generic_ptrace_peekdata(struct task_struct *tsk, long addr, long data);
115 int generic_ptrace_pokedata(struct task_struct *tsk, long addr, long data);
116 
117 #ifndef force_successful_syscall_return
118 /*
119  * System call handlers that, upon successful completion, need to return a
120  * negative value should call force_successful_syscall_return() right before
121  * returning.  On architectures where the syscall convention provides for a
122  * separate error flag (e.g., alpha, ia64, ppc{,64}, sparc{,64}, possibly
123  * others), this macro can be used to ensure that the error flag will not get
124  * set.  On architectures which do not support a separate error flag, the macro
125  * is a no-op and the spurious error condition needs to be filtered out by some
126  * other means (e.g., in user-level, by passing an extra argument to the
127  * syscall handler, or something along those lines).
128  */
129 #define force_successful_syscall_return() do { } while (0)
130 #endif
131 
132 /*
133  * <asm/ptrace.h> should define the following things inside #ifdef __KERNEL__.
134  *
135  * These do-nothing inlines are used when the arch does not
136  * implement single-step.  The kerneldoc comments are here
137  * to document the interface for all arch definitions.
138  */
139 
140 #ifndef arch_has_single_step
141 /**
142  * arch_has_single_step - does this CPU support user-mode single-step?
143  *
144  * If this is defined, then there must be function declarations or
145  * inlines for user_enable_single_step() and user_disable_single_step().
146  * arch_has_single_step() should evaluate to nonzero iff the machine
147  * supports instruction single-step for user mode.
148  * It can be a constant or it can test a CPU feature bit.
149  */
150 #define arch_has_single_step()		(0)
151 
152 /**
153  * user_enable_single_step - single-step in user-mode task
154  * @task: either current or a task stopped in %TASK_TRACED
155  *
156  * This can only be called when arch_has_single_step() has returned nonzero.
157  * Set @task so that when it returns to user mode, it will trap after the
158  * next single instruction executes.  If arch_has_block_step() is defined,
159  * this must clear the effects of user_enable_block_step() too.
160  */
161 static inline void user_enable_single_step(struct task_struct *task)
162 {
163 	BUG();			/* This can never be called.  */
164 }
165 
166 /**
167  * user_disable_single_step - cancel user-mode single-step
168  * @task: either current or a task stopped in %TASK_TRACED
169  *
170  * Clear @task of the effects of user_enable_single_step() and
171  * user_enable_block_step().  This can be called whether or not either
172  * of those was ever called on @task, and even if arch_has_single_step()
173  * returned zero.
174  */
175 static inline void user_disable_single_step(struct task_struct *task)
176 {
177 }
178 #endif	/* arch_has_single_step */
179 
180 #ifndef arch_has_block_step
181 /**
182  * arch_has_block_step - does this CPU support user-mode block-step?
183  *
184  * If this is defined, then there must be a function declaration or inline
185  * for user_enable_block_step(), and arch_has_single_step() must be defined
186  * too.  arch_has_block_step() should evaluate to nonzero iff the machine
187  * supports step-until-branch for user mode.  It can be a constant or it
188  * can test a CPU feature bit.
189  */
190 #define arch_has_block_step()		(0)
191 
192 /**
193  * user_enable_block_step - step until branch in user-mode task
194  * @task: either current or a task stopped in %TASK_TRACED
195  *
196  * This can only be called when arch_has_block_step() has returned nonzero,
197  * and will never be called when single-instruction stepping is being used.
198  * Set @task so that when it returns to user mode, it will trap after the
199  * next branch or trap taken.
200  */
201 static inline void user_enable_block_step(struct task_struct *task)
202 {
203 	BUG();			/* This can never be called.  */
204 }
205 #endif	/* arch_has_block_step */
206 
207 #endif
208 
209 #endif
210