1 #ifndef _ASM_X86_UACCESS_H
2 #define _ASM_X86_UACCESS_H
4 * User space memory access functions
6 #include <linux/compiler.h>
7 #include <linux/kasan-checks.h>
8 #include <linux/string.h>
12 #include <asm/extable.h>
15 * The fs value determines whether argument validity checking should be
16 * performed or not. If get_fs() == USER_DS, checking is performed, with
17 * get_fs() == KERNEL_DS, checking is bypassed.
19 * For historical reasons, these macros are grossly misnamed.
22 #define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
24 #define KERNEL_DS MAKE_MM_SEG(-1UL)
25 #define USER_DS MAKE_MM_SEG(TASK_SIZE_MAX)
27 #define get_ds() (KERNEL_DS)
28 #define get_fs() (current->thread.addr_limit)
29 static inline void set_fs(mm_segment_t fs)
31 current->thread.addr_limit = fs;
32 /* On user-mode return, check fs is correct */
33 set_thread_flag(TIF_FSCHECK);
36 #define segment_eq(a, b) ((a).seg == (b).seg)
38 #define user_addr_max() (current->thread.addr_limit.seg)
39 #define __addr_ok(addr) \
40 ((unsigned long __force)(addr) < user_addr_max())
43 * Test whether a block of memory is a valid user space address.
44 * Returns 0 if the range is valid, nonzero otherwise.
46 static inline bool __chk_range_not_ok(unsigned long addr, unsigned long size, unsigned long limit)
49 * If we have used "sizeof()" for the size,
50 * we know it won't overflow the limit (but
51 * it might overflow the 'addr', so it's
52 * important to subtract the size from the
53 * limit, not add it to the address).
55 if (__builtin_constant_p(size))
56 return unlikely(addr > limit - size);
58 /* Arbitrary sizes? Be careful about overflow */
60 if (unlikely(addr < size))
62 return unlikely(addr > limit);
65 #define __range_not_ok(addr, size, limit) \
67 __chk_user_ptr(addr); \
68 __chk_range_not_ok((unsigned long __force)(addr), size, limit); \
71 #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
72 # define WARN_ON_IN_IRQ() WARN_ON_ONCE(!in_task())
74 # define WARN_ON_IN_IRQ()
78 * access_ok: - Checks if a user space pointer is valid
79 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
80 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
81 * to write to a block, it is always safe to read from it.
82 * @addr: User space pointer to start of block to check
83 * @size: Size of block to check
85 * Context: User context only. This function may sleep if pagefaults are
88 * Checks if a pointer to a block of memory in user space is valid.
90 * Returns true (nonzero) if the memory block may be valid, false (zero)
91 * if it is definitely invalid.
93 * Note that, depending on architecture, this function probably just
94 * checks that the pointer is in the user space range - after calling
95 * this function, memory access functions may still return -EFAULT.
97 #define access_ok(type, addr, size) \
100 likely(!__range_not_ok(addr, size, user_addr_max())); \
104 * These are the main single-value transfer routines. They automatically
105 * use the right size if we just have the right pointer type.
107 * This gets kind of ugly. We want to return _two_ values in "get_user()"
108 * and yet we don't want to do any pointers, because that is too much
109 * of a performance impact. Thus we have a few rather ugly macros here,
110 * and hide all the ugliness from the user.
112 * The "__xxx" versions of the user access functions are versions that
113 * do not verify the address space, that must have been done previously
114 * with a separate "access_ok()" call (this is used when we do multiple
115 * accesses to the same area of user memory).
118 extern int __get_user_1(void);
119 extern int __get_user_2(void);
120 extern int __get_user_4(void);
121 extern int __get_user_8(void);
122 extern int __get_user_bad(void);
124 #define __uaccess_begin() stac()
125 #define __uaccess_end() clac()
128 * This is a type: either unsigned long, if the argument fits into
129 * that type, or otherwise unsigned long long.
131 #define __inttype(x) \
132 __typeof__(__builtin_choose_expr(sizeof(x) > sizeof(0UL), 0ULL, 0UL))
135 * get_user: - Get a simple variable from user space.
136 * @x: Variable to store result.
137 * @ptr: Source address, in user space.
139 * Context: User context only. This function may sleep if pagefaults are
142 * This macro copies a single simple variable from user space to kernel
143 * space. It supports simple types like char and int, but not larger
144 * data types like structures or arrays.
146 * @ptr must have pointer-to-simple-variable type, and the result of
147 * dereferencing @ptr must be assignable to @x without a cast.
149 * Returns zero on success, or -EFAULT on error.
150 * On error, the variable @x is set to zero.
153 * Careful: we have to cast the result to the type of the pointer
156 * The use of _ASM_DX as the register specifier is a bit of a
157 * simplification, as gcc only cares about it as the starting point
158 * and not size: for a 64-bit value it will use %ecx:%edx on 32 bits
159 * (%ecx being the next register in gcc's x86 register sequence), and
162 * Clang/LLVM cares about the size of the register, but still wants
163 * the base register for something that ends up being a pair.
165 #define get_user(x, ptr) \
168 register __inttype(*(ptr)) __val_gu asm("%"_ASM_DX); \
169 __chk_user_ptr(ptr); \
171 asm volatile("call __get_user_%P4" \
172 : "=a" (__ret_gu), "=r" (__val_gu), \
173 ASM_CALL_CONSTRAINT \
174 : "0" (ptr), "i" (sizeof(*(ptr)))); \
175 (x) = (__force __typeof__(*(ptr))) __val_gu; \
176 __builtin_expect(__ret_gu, 0); \
179 #define __put_user_x(size, x, ptr, __ret_pu) \
180 asm volatile("call __put_user_" #size : "=a" (__ret_pu) \
181 : "0" ((typeof(*(ptr)))(x)), "c" (ptr) : "ebx")
186 #define __put_user_asm_u64(x, addr, err, errret) \
188 "1: movl %%eax,0(%2)\n" \
189 "2: movl %%edx,4(%2)\n" \
191 ".section .fixup,\"ax\"\n" \
195 _ASM_EXTABLE(1b, 4b) \
196 _ASM_EXTABLE(2b, 4b) \
198 : "A" (x), "r" (addr), "i" (errret), "0" (err))
200 #define __put_user_asm_ex_u64(x, addr) \
202 "1: movl %%eax,0(%1)\n" \
203 "2: movl %%edx,4(%1)\n" \
205 _ASM_EXTABLE_EX(1b, 2b) \
206 _ASM_EXTABLE_EX(2b, 3b) \
207 : : "A" (x), "r" (addr))
209 #define __put_user_x8(x, ptr, __ret_pu) \
210 asm volatile("call __put_user_8" : "=a" (__ret_pu) \
211 : "A" ((typeof(*(ptr)))(x)), "c" (ptr) : "ebx")
213 #define __put_user_asm_u64(x, ptr, retval, errret) \
214 __put_user_asm(x, ptr, retval, "q", "", "er", errret)
215 #define __put_user_asm_ex_u64(x, addr) \
216 __put_user_asm_ex(x, addr, "q", "", "er")
217 #define __put_user_x8(x, ptr, __ret_pu) __put_user_x(8, x, ptr, __ret_pu)
220 extern void __put_user_bad(void);
223 * Strange magic calling convention: pointer in %ecx,
224 * value in %eax(:%edx), return value in %eax. clobbers %rbx
226 extern void __put_user_1(void);
227 extern void __put_user_2(void);
228 extern void __put_user_4(void);
229 extern void __put_user_8(void);
232 * put_user: - Write a simple value into user space.
233 * @x: Value to copy to user space.
234 * @ptr: Destination address, in user space.
236 * Context: User context only. This function may sleep if pagefaults are
239 * This macro copies a single simple value from kernel space to user
240 * space. It supports simple types like char and int, but not larger
241 * data types like structures or arrays.
243 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
244 * to the result of dereferencing @ptr.
246 * Returns zero on success, or -EFAULT on error.
248 #define put_user(x, ptr) \
251 __typeof__(*(ptr)) __pu_val; \
252 __chk_user_ptr(ptr); \
255 switch (sizeof(*(ptr))) { \
257 __put_user_x(1, __pu_val, ptr, __ret_pu); \
260 __put_user_x(2, __pu_val, ptr, __ret_pu); \
263 __put_user_x(4, __pu_val, ptr, __ret_pu); \
266 __put_user_x8(__pu_val, ptr, __ret_pu); \
269 __put_user_x(X, __pu_val, ptr, __ret_pu); \
272 __builtin_expect(__ret_pu, 0); \
275 #define __put_user_size(x, ptr, size, retval, errret) \
278 __chk_user_ptr(ptr); \
281 __put_user_asm(x, ptr, retval, "b", "b", "iq", errret); \
284 __put_user_asm(x, ptr, retval, "w", "w", "ir", errret); \
287 __put_user_asm(x, ptr, retval, "l", "k", "ir", errret); \
290 __put_user_asm_u64((__typeof__(*ptr))(x), ptr, retval, \
299 * This doesn't do __uaccess_begin/end - the exception handling
300 * around it must do that.
302 #define __put_user_size_ex(x, ptr, size) \
304 __chk_user_ptr(ptr); \
307 __put_user_asm_ex(x, ptr, "b", "b", "iq"); \
310 __put_user_asm_ex(x, ptr, "w", "w", "ir"); \
313 __put_user_asm_ex(x, ptr, "l", "k", "ir"); \
316 __put_user_asm_ex_u64((__typeof__(*ptr))(x), ptr); \
324 #define __get_user_asm_u64(x, ptr, retval, errret) \
326 __typeof__(ptr) __ptr = (ptr); \
328 "1: movl %2,%%eax\n" \
329 "2: movl %3,%%edx\n" \
331 ".section .fixup,\"ax\"\n" \
333 " xorl %%eax,%%eax\n" \
334 " xorl %%edx,%%edx\n" \
337 _ASM_EXTABLE(1b, 4b) \
338 _ASM_EXTABLE(2b, 4b) \
339 : "=r" (retval), "=&A"(x) \
340 : "m" (__m(__ptr)), "m" __m(((u32 __user *)(__ptr)) + 1), \
341 "i" (errret), "0" (retval)); \
344 #define __get_user_asm_ex_u64(x, ptr) (x) = __get_user_bad()
346 #define __get_user_asm_u64(x, ptr, retval, errret) \
347 __get_user_asm(x, ptr, retval, "q", "", "=r", errret)
348 #define __get_user_asm_ex_u64(x, ptr) \
349 __get_user_asm_ex(x, ptr, "q", "", "=r")
352 #define __get_user_size(x, ptr, size, retval, errret) \
355 __chk_user_ptr(ptr); \
358 __get_user_asm(x, ptr, retval, "b", "b", "=q", errret); \
361 __get_user_asm(x, ptr, retval, "w", "w", "=r", errret); \
364 __get_user_asm(x, ptr, retval, "l", "k", "=r", errret); \
367 __get_user_asm_u64(x, ptr, retval, errret); \
370 (x) = __get_user_bad(); \
374 #define __get_user_asm(x, addr, err, itype, rtype, ltype, errret) \
376 "1: mov"itype" %2,%"rtype"1\n" \
378 ".section .fixup,\"ax\"\n" \
380 " xor"itype" %"rtype"1,%"rtype"1\n" \
383 _ASM_EXTABLE(1b, 3b) \
384 : "=r" (err), ltype(x) \
385 : "m" (__m(addr)), "i" (errret), "0" (err))
387 #define __get_user_asm_nozero(x, addr, err, itype, rtype, ltype, errret) \
389 "1: mov"itype" %2,%"rtype"1\n" \
391 ".section .fixup,\"ax\"\n" \
395 _ASM_EXTABLE(1b, 3b) \
396 : "=r" (err), ltype(x) \
397 : "m" (__m(addr)), "i" (errret), "0" (err))
400 * This doesn't do __uaccess_begin/end - the exception handling
401 * around it must do that.
403 #define __get_user_size_ex(x, ptr, size) \
405 __chk_user_ptr(ptr); \
408 __get_user_asm_ex(x, ptr, "b", "b", "=q"); \
411 __get_user_asm_ex(x, ptr, "w", "w", "=r"); \
414 __get_user_asm_ex(x, ptr, "l", "k", "=r"); \
417 __get_user_asm_ex_u64(x, ptr); \
420 (x) = __get_user_bad(); \
424 #define __get_user_asm_ex(x, addr, itype, rtype, ltype) \
425 asm volatile("1: mov"itype" %1,%"rtype"0\n" \
427 ".section .fixup,\"ax\"\n" \
428 "3:xor"itype" %"rtype"0,%"rtype"0\n" \
431 _ASM_EXTABLE_EX(1b, 3b) \
432 : ltype(x) : "m" (__m(addr)))
434 #define __put_user_nocheck(x, ptr, size) \
438 __put_user_size((x), (ptr), (size), __pu_err, -EFAULT); \
440 __builtin_expect(__pu_err, 0); \
443 #define __get_user_nocheck(x, ptr, size) \
446 __inttype(*(ptr)) __gu_val; \
448 __get_user_size(__gu_val, (ptr), (size), __gu_err, -EFAULT); \
450 (x) = (__force __typeof__(*(ptr)))__gu_val; \
451 __builtin_expect(__gu_err, 0); \
454 /* FIXME: this hack is definitely wrong -AK */
455 struct __large_struct { unsigned long buf[100]; };
456 #define __m(x) (*(struct __large_struct __user *)(x))
459 * Tell gcc we read from memory instead of writing: this is because
460 * we do not write to any memory gcc knows about, so there are no
463 #define __put_user_asm(x, addr, err, itype, rtype, ltype, errret) \
465 "1: mov"itype" %"rtype"1,%2\n" \
467 ".section .fixup,\"ax\"\n" \
471 _ASM_EXTABLE(1b, 3b) \
473 : ltype(x), "m" (__m(addr)), "i" (errret), "0" (err))
475 #define __put_user_asm_ex(x, addr, itype, rtype, ltype) \
476 asm volatile("1: mov"itype" %"rtype"0,%1\n" \
478 _ASM_EXTABLE_EX(1b, 2b) \
479 : : ltype(x), "m" (__m(addr)))
482 * uaccess_try and catch
484 #define uaccess_try do { \
485 current->thread.uaccess_err = 0; \
489 #define uaccess_catch(err) \
491 (err) |= (current->thread.uaccess_err ? -EFAULT : 0); \
495 * __get_user: - Get a simple variable from user space, with less checking.
496 * @x: Variable to store result.
497 * @ptr: Source address, in user space.
499 * Context: User context only. This function may sleep if pagefaults are
502 * This macro copies a single simple variable from user space to kernel
503 * space. It supports simple types like char and int, but not larger
504 * data types like structures or arrays.
506 * @ptr must have pointer-to-simple-variable type, and the result of
507 * dereferencing @ptr must be assignable to @x without a cast.
509 * Caller must check the pointer with access_ok() before calling this
512 * Returns zero on success, or -EFAULT on error.
513 * On error, the variable @x is set to zero.
516 #define __get_user(x, ptr) \
517 __get_user_nocheck((x), (ptr), sizeof(*(ptr)))
520 * __put_user: - Write a simple value into user space, with less checking.
521 * @x: Value to copy to user space.
522 * @ptr: Destination address, in user space.
524 * Context: User context only. This function may sleep if pagefaults are
527 * This macro copies a single simple value from kernel space to user
528 * space. It supports simple types like char and int, but not larger
529 * data types like structures or arrays.
531 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
532 * to the result of dereferencing @ptr.
534 * Caller must check the pointer with access_ok() before calling this
537 * Returns zero on success, or -EFAULT on error.
540 #define __put_user(x, ptr) \
541 __put_user_nocheck((__typeof__(*(ptr)))(x), (ptr), sizeof(*(ptr)))
544 * {get|put}_user_try and catch
548 * } get_user_catch(err)
550 #define get_user_try uaccess_try
551 #define get_user_catch(err) uaccess_catch(err)
553 #define get_user_ex(x, ptr) do { \
554 unsigned long __gue_val; \
555 __get_user_size_ex((__gue_val), (ptr), (sizeof(*(ptr)))); \
556 (x) = (__force __typeof__(*(ptr)))__gue_val; \
559 #define put_user_try uaccess_try
560 #define put_user_catch(err) uaccess_catch(err)
562 #define put_user_ex(x, ptr) \
563 __put_user_size_ex((__typeof__(*(ptr)))(x), (ptr), sizeof(*(ptr)))
566 copy_from_user_nmi(void *to, const void __user *from, unsigned long n);
567 extern __must_check long
568 strncpy_from_user(char *dst, const char __user *src, long count);
570 extern __must_check long strnlen_user(const char __user *str, long n);
572 unsigned long __must_check clear_user(void __user *mem, unsigned long len);
573 unsigned long __must_check __clear_user(void __user *mem, unsigned long len);
575 extern void __cmpxchg_wrong_size(void)
576 __compiletime_error("Bad argument size for cmpxchg");
578 #define __user_atomic_cmpxchg_inatomic(uval, ptr, old, new, size) \
581 __typeof__(ptr) __uval = (uval); \
582 __typeof__(*(ptr)) __old = (old); \
583 __typeof__(*(ptr)) __new = (new); \
589 "1:\t" LOCK_PREFIX "cmpxchgb %4, %2\n" \
591 "\t.section .fixup, \"ax\"\n" \
595 _ASM_EXTABLE(1b, 3b) \
596 : "+r" (__ret), "=a" (__old), "+m" (*(ptr)) \
597 : "i" (-EFAULT), "q" (__new), "1" (__old) \
605 "1:\t" LOCK_PREFIX "cmpxchgw %4, %2\n" \
607 "\t.section .fixup, \"ax\"\n" \
611 _ASM_EXTABLE(1b, 3b) \
612 : "+r" (__ret), "=a" (__old), "+m" (*(ptr)) \
613 : "i" (-EFAULT), "r" (__new), "1" (__old) \
621 "1:\t" LOCK_PREFIX "cmpxchgl %4, %2\n" \
623 "\t.section .fixup, \"ax\"\n" \
627 _ASM_EXTABLE(1b, 3b) \
628 : "+r" (__ret), "=a" (__old), "+m" (*(ptr)) \
629 : "i" (-EFAULT), "r" (__new), "1" (__old) \
636 if (!IS_ENABLED(CONFIG_X86_64)) \
637 __cmpxchg_wrong_size(); \
640 "1:\t" LOCK_PREFIX "cmpxchgq %4, %2\n" \
642 "\t.section .fixup, \"ax\"\n" \
646 _ASM_EXTABLE(1b, 3b) \
647 : "+r" (__ret), "=a" (__old), "+m" (*(ptr)) \
648 : "i" (-EFAULT), "r" (__new), "1" (__old) \
654 __cmpxchg_wrong_size(); \
661 #define user_atomic_cmpxchg_inatomic(uval, ptr, old, new) \
663 access_ok(VERIFY_WRITE, (ptr), sizeof(*(ptr))) ? \
664 __user_atomic_cmpxchg_inatomic((uval), (ptr), \
665 (old), (new), sizeof(*(ptr))) : \
670 * movsl can be slow when source and dest are not both 8-byte aligned
672 #ifdef CONFIG_X86_INTEL_USERCOPY
673 extern struct movsl_mask {
675 } ____cacheline_aligned_in_smp movsl_mask;
678 #define ARCH_HAS_NOCACHE_UACCESS 1
681 # include <asm/uaccess_32.h>
683 # include <asm/uaccess_64.h>
687 * We rely on the nested NMI work to allow atomic faults from the NMI path; the
688 * nested NMI paths are careful to preserve CR2.
690 * Caller must use pagefault_enable/disable, or run in interrupt context,
691 * and also do a uaccess_ok() check
693 #define __copy_from_user_nmi __copy_from_user_inatomic
696 * The "unsafe" user accesses aren't really "unsafe", but the naming
697 * is a big fat warning: you have to not only do the access_ok()
698 * checking before using them, but you have to surround them with the
699 * user_access_begin/end() pair.
701 #define user_access_begin() __uaccess_begin()
702 #define user_access_end() __uaccess_end()
704 #define unsafe_put_user(x, ptr, err_label) \
707 __typeof__(*(ptr)) __pu_val = (x); \
708 __put_user_size(__pu_val, (ptr), sizeof(*(ptr)), __pu_err, -EFAULT); \
709 if (unlikely(__pu_err)) goto err_label; \
712 #define unsafe_get_user(x, ptr, err_label) \
715 __inttype(*(ptr)) __gu_val; \
716 __get_user_size(__gu_val, (ptr), sizeof(*(ptr)), __gu_err, -EFAULT); \
717 (x) = (__force __typeof__(*(ptr)))__gu_val; \
718 if (unlikely(__gu_err)) goto err_label; \
721 #endif /* _ASM_X86_UACCESS_H */