1 // SPDX-License-Identifier: GPL-2.0-only
3 * common.c - C code for kernel entry and exit
4 * Copyright (c) 2015 Andrew Lutomirski
6 * Based on asm and ptrace code by many authors. The code here originated
7 * in ptrace.c and signal.c.
10 #include <linux/kernel.h>
11 #include <linux/sched.h>
12 #include <linux/sched/task_stack.h>
13 #include <linux/entry-common.h>
15 #include <linux/smp.h>
16 #include <linux/errno.h>
17 #include <linux/ptrace.h>
18 #include <linux/export.h>
19 #include <linux/nospec.h>
20 #include <linux/syscalls.h>
21 #include <linux/uaccess.h>
22 #include <linux/init.h>
25 #include <xen/xen-ops.h>
26 #include <xen/events.h>
31 #include <asm/traps.h>
33 #include <asm/cpufeature.h>
34 #include <asm/fpu/api.h>
35 #include <asm/nospec-branch.h>
36 #include <asm/io_bitmap.h>
37 #include <asm/syscall.h>
38 #include <asm/irq_stack.h>
42 static __always_inline
bool do_syscall_x64(struct pt_regs
*regs
, int nr
)
45 * Convert negative numbers to very high and thus out of range
46 * numbers for comparisons.
48 unsigned int unr
= nr
;
50 if (likely(unr
< NR_syscalls
)) {
51 unr
= array_index_nospec(unr
, NR_syscalls
);
52 regs
->ax
= x64_sys_call(regs
, unr
);
58 static __always_inline
bool do_syscall_x32(struct pt_regs
*regs
, int nr
)
61 * Adjust the starting offset of the table, and convert numbers
62 * < __X32_SYSCALL_BIT to very high and thus out of range
63 * numbers for comparisons.
65 unsigned int xnr
= nr
- __X32_SYSCALL_BIT
;
67 if (IS_ENABLED(CONFIG_X86_X32_ABI
) && likely(xnr
< X32_NR_syscalls
)) {
68 xnr
= array_index_nospec(xnr
, X32_NR_syscalls
);
69 regs
->ax
= x32_sys_call(regs
, xnr
);
75 /* Returns true to return using SYSRET, or false to use IRET */
76 __visible noinstr
bool do_syscall_64(struct pt_regs
*regs
, int nr
)
78 add_random_kstack_offset();
79 nr
= syscall_enter_from_user_mode(regs
, nr
);
81 instrumentation_begin();
83 if (!do_syscall_x64(regs
, nr
) && !do_syscall_x32(regs
, nr
) && nr
!= -1) {
84 /* Invalid system call, but still a system call. */
85 regs
->ax
= __x64_sys_ni_syscall(regs
);
88 instrumentation_end();
89 syscall_exit_to_user_mode(regs
);
92 * Check that the register state is valid for using SYSRET to exit
93 * to userspace. Otherwise use the slower but fully capable IRET
97 /* XEN PV guests always use the IRET path */
98 if (cpu_feature_enabled(X86_FEATURE_XENPV
))
101 /* SYSRET requires RCX == RIP and R11 == EFLAGS */
102 if (unlikely(regs
->cx
!= regs
->ip
|| regs
->r11
!= regs
->flags
))
105 /* CS and SS must match the values set in MSR_STAR */
106 if (unlikely(regs
->cs
!= __USER_CS
|| regs
->ss
!= __USER_DS
))
110 * On Intel CPUs, SYSRET with non-canonical RCX/RIP will #GP
111 * in kernel space. This essentially lets the user take over
112 * the kernel, since userspace controls RSP.
114 * TASK_SIZE_MAX covers all user-accessible addresses other than
115 * the deprecated vsyscall page.
117 if (unlikely(regs
->ip
>= TASK_SIZE_MAX
))
121 * SYSRET cannot restore RF. It can restore TF, but unlike IRET,
122 * restoring TF results in a trap from userspace immediately after
125 if (unlikely(regs
->flags
& (X86_EFLAGS_RF
| X86_EFLAGS_TF
)))
128 /* Use SYSRET to exit to userspace */
133 #if defined(CONFIG_X86_32) || defined(CONFIG_IA32_EMULATION)
134 static __always_inline
int syscall_32_enter(struct pt_regs
*regs
)
136 if (IS_ENABLED(CONFIG_IA32_EMULATION
))
137 current_thread_info()->status
|= TS_COMPAT
;
139 return (int)regs
->orig_ax
;
142 #ifdef CONFIG_IA32_EMULATION
143 bool __ia32_enabled __ro_after_init
= !IS_ENABLED(CONFIG_IA32_EMULATION_DEFAULT_DISABLED
);
145 static int ia32_emulation_override_cmdline(char *arg
)
147 return kstrtobool(arg
, &__ia32_enabled
);
149 early_param("ia32_emulation", ia32_emulation_override_cmdline
);
153 * Invoke a 32-bit syscall. Called with IRQs on in CT_STATE_KERNEL.
155 static __always_inline
void do_syscall_32_irqs_on(struct pt_regs
*regs
, int nr
)
158 * Convert negative numbers to very high and thus out of range
159 * numbers for comparisons.
161 unsigned int unr
= nr
;
163 if (likely(unr
< IA32_NR_syscalls
)) {
164 unr
= array_index_nospec(unr
, IA32_NR_syscalls
);
165 regs
->ax
= ia32_sys_call(regs
, unr
);
166 } else if (nr
!= -1) {
167 regs
->ax
= __ia32_sys_ni_syscall(regs
);
171 #ifdef CONFIG_IA32_EMULATION
172 static __always_inline
bool int80_is_external(void)
174 const unsigned int offs
= (0x80 / 32) * 0x10;
175 const u32 bit
= BIT(0x80 % 32);
177 /* The local APIC on XENPV guests is fake */
178 if (cpu_feature_enabled(X86_FEATURE_XENPV
))
182 * If vector 0x80 is set in the APIC ISR then this is an external
183 * interrupt. Either from broken hardware or injected by a VMM.
185 * Note: In guest mode this is only valid for secure guests where
186 * the secure module fully controls the vAPIC exposed to the guest.
188 return apic_read(APIC_ISR
+ offs
) & bit
;
192 * do_int80_emulation - 32-bit legacy syscall C entry from asm
194 * This entry point can be used by 32-bit and 64-bit programs to perform
195 * 32-bit system calls. Instances of INT $0x80 can be found inline in
196 * various programs and libraries. It is also used by the vDSO's
197 * __kernel_vsyscall fallback for hardware that doesn't support a faster
198 * entry method. Restarted 32-bit system calls also fall back to INT
199 * $0x80 regardless of what instruction was originally used to do the
202 * This is considered a slow path. It is not used by most libc
203 * implementations on modern hardware except during process startup.
205 * The arguments for the INT $0x80 based syscall are on stack in the
207 * eax: system call number
208 * ebx, ecx, edx, esi, edi, ebp: arg1 - arg 6
210 __visible noinstr
void do_int80_emulation(struct pt_regs
*regs
)
214 /* Kernel does not use INT $0x80! */
215 if (unlikely(!user_mode(regs
))) {
216 irqentry_enter(regs
);
217 instrumentation_begin();
218 panic("Unexpected external interrupt 0x80\n");
222 * Establish kernel context for instrumentation, including for
223 * int80_is_external() below which calls into the APIC driver.
224 * Identical for soft and external interrupts.
226 enter_from_user_mode(regs
);
228 instrumentation_begin();
229 add_random_kstack_offset();
231 /* Validate that this is a soft interrupt to the extent possible */
232 if (unlikely(int80_is_external()))
233 panic("Unexpected external interrupt 0x80\n");
236 * The low level idtentry code pushed -1 into regs::orig_ax
237 * and regs::ax contains the syscall number.
239 * User tracing code (ptrace or signal handlers) might assume
240 * that the regs::orig_ax contains a 32-bit number on invoking
243 * Establish the syscall convention by saving the 32bit truncated
244 * syscall number in regs::orig_ax and by invalidating regs::ax.
246 regs
->orig_ax
= regs
->ax
& GENMASK(31, 0);
249 nr
= syscall_32_enter(regs
);
252 nr
= syscall_enter_from_user_mode_work(regs
, nr
);
253 do_syscall_32_irqs_on(regs
, nr
);
255 instrumentation_end();
256 syscall_exit_to_user_mode(regs
);
259 #ifdef CONFIG_X86_FRED
261 * A FRED-specific INT80 handler is warranted for the follwing reasons:
263 * 1) As INT instructions and hardware interrupts are separate event
264 * types, FRED does not preclude the use of vector 0x80 for external
265 * interrupts. As a result, the FRED setup code does not reserve
266 * vector 0x80 and calling int80_is_external() is not merely
267 * suboptimal but actively incorrect: it could cause a system call
268 * to be incorrectly ignored.
270 * 2) It is called only for handling vector 0x80 of event type
271 * EVENT_TYPE_SWINT and will never be called to handle any external
272 * interrupt (event type EVENT_TYPE_EXTINT).
274 * 3) FRED has separate entry flows depending on if the event came from
275 * user space or kernel space, and because the kernel does not use
276 * INT insns, the FRED kernel entry handler fred_entry_from_kernel()
277 * falls through to fred_bad_type() if the event type is
278 * EVENT_TYPE_SWINT, i.e., INT insns. So if the kernel is handling
279 * an INT insn, it can only be from a user level.
281 * 4) int80_emulation() does a CLEAR_BRANCH_HISTORY. While FRED will
282 * likely take a different approach if it is ever needed: it
283 * probably belongs in either fred_intx()/ fred_other() or
284 * asm_fred_entrypoint_user(), depending on if this ought to be done
285 * for all entries from userspace or only system
288 * 5) INT $0x80 is the fast path for 32-bit system calls under FRED.
290 DEFINE_FREDENTRY_RAW(int80_emulation
)
294 enter_from_user_mode(regs
);
296 instrumentation_begin();
297 add_random_kstack_offset();
300 * FRED pushed 0 into regs::orig_ax and regs::ax contains the
303 * User tracing code (ptrace or signal handlers) might assume
304 * that the regs::orig_ax contains a 32-bit number on invoking
307 * Establish the syscall convention by saving the 32bit truncated
308 * syscall number in regs::orig_ax and by invalidating regs::ax.
310 regs
->orig_ax
= regs
->ax
& GENMASK(31, 0);
313 nr
= syscall_32_enter(regs
);
316 nr
= syscall_enter_from_user_mode_work(regs
, nr
);
317 do_syscall_32_irqs_on(regs
, nr
);
319 instrumentation_end();
320 syscall_exit_to_user_mode(regs
);
323 #else /* CONFIG_IA32_EMULATION */
325 /* Handles int $0x80 on a 32bit kernel */
326 __visible noinstr
void do_int80_syscall_32(struct pt_regs
*regs
)
328 int nr
= syscall_32_enter(regs
);
330 add_random_kstack_offset();
332 * Subtlety here: if ptrace pokes something larger than 2^31-1 into
333 * orig_ax, the int return value truncates it. This matches
334 * the semantics of syscall_get_nr().
336 nr
= syscall_enter_from_user_mode(regs
, nr
);
337 instrumentation_begin();
339 do_syscall_32_irqs_on(regs
, nr
);
341 instrumentation_end();
342 syscall_exit_to_user_mode(regs
);
344 #endif /* !CONFIG_IA32_EMULATION */
346 static noinstr
bool __do_fast_syscall_32(struct pt_regs
*regs
)
348 int nr
= syscall_32_enter(regs
);
351 add_random_kstack_offset();
353 * This cannot use syscall_enter_from_user_mode() as it has to
354 * fetch EBP before invoking any of the syscall entry work
357 syscall_enter_from_user_mode_prepare(regs
);
359 instrumentation_begin();
360 /* Fetch EBP from where the vDSO stashed it. */
361 if (IS_ENABLED(CONFIG_X86_64
)) {
363 * Micro-optimization: the pointer we're following is
364 * explicitly 32 bits, so it can't be out of range.
366 res
= __get_user(*(u32
*)®s
->bp
,
367 (u32 __user __force
*)(unsigned long)(u32
)regs
->sp
);
369 res
= get_user(*(u32
*)®s
->bp
,
370 (u32 __user __force
*)(unsigned long)(u32
)regs
->sp
);
374 /* User code screwed up. */
378 instrumentation_end();
379 irqentry_exit_to_user_mode(regs
);
383 nr
= syscall_enter_from_user_mode_work(regs
, nr
);
385 /* Now this is just like a normal syscall. */
386 do_syscall_32_irqs_on(regs
, nr
);
388 instrumentation_end();
389 syscall_exit_to_user_mode(regs
);
393 /* Returns true to return using SYSEXIT/SYSRETL, or false to use IRET */
394 __visible noinstr
bool do_fast_syscall_32(struct pt_regs
*regs
)
397 * Called using the internal vDSO SYSENTER/SYSCALL32 calling
398 * convention. Adjust regs so it looks like we entered using int80.
400 unsigned long landing_pad
= (unsigned long)current
->mm
->context
.vdso
+
401 vdso_image_32
.sym_int80_landing_pad
;
404 * SYSENTER loses EIP, and even SYSCALL32 needs us to skip forward
405 * so that 'regs->ip -= 2' lands back on an int $0x80 instruction.
408 regs
->ip
= landing_pad
;
410 /* Invoke the syscall. If it failed, keep it simple: use IRET. */
411 if (!__do_fast_syscall_32(regs
))
415 * Check that the register state is valid for using SYSRETL/SYSEXIT
416 * to exit to userspace. Otherwise use the slower but fully capable
420 /* XEN PV guests always use the IRET path */
421 if (cpu_feature_enabled(X86_FEATURE_XENPV
))
424 /* EIP must point to the VDSO landing pad */
425 if (unlikely(regs
->ip
!= landing_pad
))
428 /* CS and SS must match the values set in MSR_STAR */
429 if (unlikely(regs
->cs
!= __USER32_CS
|| regs
->ss
!= __USER_DS
))
432 /* If the TF, RF, or VM flags are set, use IRET */
433 if (unlikely(regs
->flags
& (X86_EFLAGS_RF
| X86_EFLAGS_TF
| X86_EFLAGS_VM
)))
436 /* Use SYSRETL/SYSEXIT to exit to userspace */
440 /* Returns true to return using SYSEXIT/SYSRETL, or false to use IRET */
441 __visible noinstr
bool do_SYSENTER_32(struct pt_regs
*regs
)
443 /* SYSENTER loses RSP, but the vDSO saved it in RBP. */
446 /* SYSENTER clobbers EFLAGS.IF. Assume it was set in usermode. */
447 regs
->flags
|= X86_EFLAGS_IF
;
449 return do_fast_syscall_32(regs
);
453 SYSCALL_DEFINE0(ni_syscall
)
459 #ifndef CONFIG_PREEMPTION
461 * Some hypercalls issued by the toolstack can take many 10s of
462 * seconds. Allow tasks running hypercalls via the privcmd driver to
463 * be voluntarily preempted even if full kernel preemption is
466 * Such preemptible hypercalls are bracketed by
467 * xen_preemptible_hcall_begin() and xen_preemptible_hcall_end()
470 DEFINE_PER_CPU(bool, xen_in_preemptible_hcall
);
471 EXPORT_SYMBOL_GPL(xen_in_preemptible_hcall
);
474 * In case of scheduling the flag must be cleared and restored after
475 * returning from schedule as the task might move to a different CPU.
477 static __always_inline
bool get_and_clear_inhcall(void)
479 bool inhcall
= __this_cpu_read(xen_in_preemptible_hcall
);
481 __this_cpu_write(xen_in_preemptible_hcall
, false);
485 static __always_inline
void restore_inhcall(bool inhcall
)
487 __this_cpu_write(xen_in_preemptible_hcall
, inhcall
);
490 static __always_inline
bool get_and_clear_inhcall(void) { return false; }
491 static __always_inline
void restore_inhcall(bool inhcall
) { }
494 static void __xen_pv_evtchn_do_upcall(struct pt_regs
*regs
)
496 struct pt_regs
*old_regs
= set_irq_regs(regs
);
498 inc_irq_stat(irq_hv_callback_count
);
500 xen_evtchn_do_upcall();
502 set_irq_regs(old_regs
);
505 __visible noinstr
void xen_pv_evtchn_do_upcall(struct pt_regs
*regs
)
507 irqentry_state_t state
= irqentry_enter(regs
);
510 instrumentation_begin();
511 run_sysvec_on_irqstack_cond(__xen_pv_evtchn_do_upcall
, regs
);
513 inhcall
= get_and_clear_inhcall();
514 if (inhcall
&& !WARN_ON_ONCE(state
.exit_rcu
)) {
515 irqentry_exit_cond_resched();
516 instrumentation_end();
517 restore_inhcall(inhcall
);
519 instrumentation_end();
520 irqentry_exit(regs
, state
);
523 #endif /* CONFIG_XEN_PV */