2 * x86 single-step support code, common to 32-bit and 64-bit.
4 #include <linux/sched.h>
6 #include <linux/ptrace.h>
8 unsigned long convert_ip_to_linear(struct task_struct *child, struct pt_regs *regs)
10 unsigned long addr, seg;
13 seg = regs->cs & 0xffff;
14 if (v8086_mode(regs)) {
15 addr = (addr & 0xffff) + (seg << 4);
20 * We'll assume that the code segments in the GDT
21 * are all zero-based. That is largely true: the
22 * TLS segments are used for data, and the PNPBIOS
23 * and APM bios ones we just ignore here.
25 if ((seg & SEGMENT_TI_MASK) == SEGMENT_LDT) {
31 mutex_lock(&child->mm->context.lock);
32 if (unlikely((seg >> 3) >= child->mm->context.size))
33 addr = -1L; /* bogus selector, access would fault */
35 desc = child->mm->context.ldt + seg;
36 base = ((desc[0] >> 16) |
37 ((desc[1] & 0xff) << 16) |
38 (desc[1] & 0xff000000));
40 /* 16-bit code segment? */
41 if (!((desc[1] >> 22) & 1))
45 mutex_unlock(&child->mm->context.lock);
51 static int is_setting_trap_flag(struct task_struct *child, struct pt_regs *regs)
54 unsigned char opcode[15];
55 unsigned long addr = convert_ip_to_linear(child, regs);
57 copied = access_process_vm(child, addr, opcode, sizeof(opcode), 0);
58 for (i = 0; i < copied; i++) {
66 /* opcode and address size prefixes */
69 /* irrelevant prefixes (segment overrides and repeats) */
73 case 0xf0: case 0xf2: case 0xf3:
78 if (regs->cs != __USER_CS)
79 /* 32-bit mode: register increment */
81 /* 64-bit mode: REX prefix */
88 * pushf: NOTE! We should probably not let
89 * the user see the TF bit being set. But
90 * it's more pain than it's worth to avoid
91 * it, and a debugger could emulate this
92 * all in user space if it _really_ cares.
103 * Enable single-stepping. Return nonzero if user mode is not using TF itself.
105 static int enable_single_step(struct task_struct *child)
107 struct pt_regs *regs = task_pt_regs(child);
108 unsigned long oflags;
111 * If we stepped into a sysenter/syscall insn, it trapped in
112 * kernel mode; do_debug() cleared TF and set TIF_SINGLESTEP.
113 * If user-mode had set TF itself, then it's still clear from
114 * do_debug() and we need to set it again to restore the user
115 * state so we don't wrongly set TIF_FORCED_TF below.
116 * If enable_single_step() was used last and that is what
117 * set TIF_SINGLESTEP, then both TF and TIF_FORCED_TF are
118 * already set and our bookkeeping is fine.
120 if (unlikely(test_tsk_thread_flag(child, TIF_SINGLESTEP)))
121 regs->flags |= X86_EFLAGS_TF;
124 * Always set TIF_SINGLESTEP - this guarantees that
125 * we single-step system calls etc.. This will also
126 * cause us to set TF when returning to user mode.
128 set_tsk_thread_flag(child, TIF_SINGLESTEP);
130 oflags = regs->flags;
132 /* Set TF on the kernel stack.. */
133 regs->flags |= X86_EFLAGS_TF;
136 * ..but if TF is changed by the instruction we will trace,
137 * don't mark it as being "us" that set it, so that we
138 * won't clear it by hand later.
140 * Note that if we don't actually execute the popf because
141 * of a signal arriving right now or suchlike, we will lose
142 * track of the fact that it really was "us" that set it.
144 if (is_setting_trap_flag(child, regs)) {
145 clear_tsk_thread_flag(child, TIF_FORCED_TF);
150 * If TF was already set, check whether it was us who set it.
151 * If not, we should never attempt a block step.
153 if (oflags & X86_EFLAGS_TF)
154 return test_tsk_thread_flag(child, TIF_FORCED_TF);
156 set_tsk_thread_flag(child, TIF_FORCED_TF);
162 * Install this value in MSR_IA32_DEBUGCTLMSR whenever child is running.
164 static void write_debugctlmsr(struct task_struct *child, unsigned long val)
166 if (child->thread.debugctlmsr == val)
169 child->thread.debugctlmsr = val;
171 if (child != current)
174 update_debugctlmsr(val);
178 * Enable single or block step.
180 static void enable_step(struct task_struct *child, bool block)
183 * Make sure block stepping (BTF) is not enabled unless it should be.
184 * Note that we don't try to worry about any is_setting_trap_flag()
185 * instructions after the first when using block stepping.
186 * So noone should try to use debugger block stepping in a program
187 * that uses user-mode single stepping itself.
189 if (enable_single_step(child) && block) {
190 set_tsk_thread_flag(child, TIF_DEBUGCTLMSR);
191 write_debugctlmsr(child,
192 child->thread.debugctlmsr | DEBUGCTLMSR_BTF);
194 write_debugctlmsr(child,
195 child->thread.debugctlmsr & ~DEBUGCTLMSR_BTF);
197 if (!child->thread.debugctlmsr)
198 clear_tsk_thread_flag(child, TIF_DEBUGCTLMSR);
202 void user_enable_single_step(struct task_struct *child)
204 enable_step(child, 0);
207 void user_enable_block_step(struct task_struct *child)
209 enable_step(child, 1);
212 void user_disable_single_step(struct task_struct *child)
215 * Make sure block stepping (BTF) is disabled.
217 write_debugctlmsr(child,
218 child->thread.debugctlmsr & ~DEBUGCTLMSR_BTF);
220 if (!child->thread.debugctlmsr)
221 clear_tsk_thread_flag(child, TIF_DEBUGCTLMSR);
223 /* Always clear TIF_SINGLESTEP... */
224 clear_tsk_thread_flag(child, TIF_SINGLESTEP);
226 /* But touch TF only if it was set by us.. */
227 if (test_and_clear_tsk_thread_flag(child, TIF_FORCED_TF))
228 task_pt_regs(child)->flags &= ~X86_EFLAGS_TF;