1 #ifndef _ASM_X86_UACCESS_H
2 #define _ASM_X86_UACCESS_H
4 * User space memory access functions
6 #include <linux/errno.h>
7 #include <linux/compiler.h>
8 #include <linux/thread_info.h>
9 #include <linux/prefetch.h>
10 #include <linux/string.h>
15 #define VERIFY_WRITE 1
18 * The fs value determines whether argument validity checking should be
19 * performed or not. If get_fs() == USER_DS, checking is performed, with
20 * get_fs() == KERNEL_DS, checking is bypassed.
22 * For historical reasons, these macros are grossly misnamed.
25 #define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
27 #define KERNEL_DS MAKE_MM_SEG(-1UL)
28 #define USER_DS MAKE_MM_SEG(TASK_SIZE_MAX)
30 #define get_ds() (KERNEL_DS)
31 #define get_fs() (current_thread_info()->addr_limit)
32 #define set_fs(x) (current_thread_info()->addr_limit = (x))
34 #define segment_eq(a, b) ((a).seg == (b).seg)
36 #define __addr_ok(addr) \
37 ((unsigned long __force)(addr) < \
38 (current_thread_info()->addr_limit.seg))
41 * Test whether a block of memory is a valid user space address.
42 * Returns 0 if the range is valid, nonzero otherwise.
44 * This is equivalent to the following test:
45 * (u33)addr + (u33)size >= (u33)current->addr_limit.seg (u65 for x86_64)
47 * This needs 33-bit (65-bit for x86_64) arithmetic. We have a carry...
50 #define __range_not_ok(addr, size) \
52 unsigned long flag, roksum; \
53 __chk_user_ptr(addr); \
54 asm("add %3,%1 ; sbb %0,%0 ; cmp %1,%4 ; sbb $0,%0" \
55 : "=&r" (flag), "=r" (roksum) \
56 : "1" (addr), "g" ((long)(size)), \
57 "rm" (current_thread_info()->addr_limit.seg)); \
62 * access_ok: - Checks if a user space pointer is valid
63 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
64 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
65 * to write to a block, it is always safe to read from it.
66 * @addr: User space pointer to start of block to check
67 * @size: Size of block to check
69 * Context: User context only. This function may sleep.
71 * Checks if a pointer to a block of memory in user space is valid.
73 * Returns true (nonzero) if the memory block may be valid, false (zero)
74 * if it is definitely invalid.
76 * Note that, depending on architecture, this function probably just
77 * checks that the pointer is in the user space range - after calling
78 * this function, memory access functions may still return -EFAULT.
80 #define access_ok(type, addr, size) (likely(__range_not_ok(addr, size) == 0))
83 * The exception table consists of pairs of addresses: the first is the
84 * address of an instruction that is allowed to fault, and the second is
85 * the address at which the program should continue. No registers are
86 * modified, so it is entirely up to the continuation code to figure out
89 * All the routines below use bits of fixup code that are out of line
90 * with the main instruction path. This means when everything is well,
91 * we don't even have to jump over them. Further, they do not intrude
92 * on our cache or tlb entries.
95 struct exception_table_entry
{
96 unsigned long insn
, fixup
;
99 extern int fixup_exception(struct pt_regs
*regs
);
102 * These are the main single-value transfer routines. They automatically
103 * use the right size if we just have the right pointer type.
105 * This gets kind of ugly. We want to return _two_ values in "get_user()"
106 * and yet we don't want to do any pointers, because that is too much
107 * of a performance impact. Thus we have a few rather ugly macros here,
108 * and hide all the ugliness from the user.
110 * The "__xxx" versions of the user access functions are versions that
111 * do not verify the address space, that must have been done previously
112 * with a separate "access_ok()" call (this is used when we do multiple
113 * accesses to the same area of user memory).
116 extern int __get_user_1(void);
117 extern int __get_user_2(void);
118 extern int __get_user_4(void);
119 extern int __get_user_8(void);
120 extern int __get_user_bad(void);
122 #define __get_user_x(size, ret, x, ptr) \
123 asm volatile("call __get_user_" #size \
124 : "=a" (ret), "=d" (x) \
127 /* Careful: we have to cast the result to the type of the pointer
128 * for sign reasons */
131 * get_user: - Get a simple variable from user space.
132 * @x: Variable to store result.
133 * @ptr: Source address, in user space.
135 * Context: User context only. This function may sleep.
137 * This macro copies a single simple variable from user space to kernel
138 * space. It supports simple types like char and int, but not larger
139 * data types like structures or arrays.
141 * @ptr must have pointer-to-simple-variable type, and the result of
142 * dereferencing @ptr must be assignable to @x without a cast.
144 * Returns zero on success, or -EFAULT on error.
145 * On error, the variable @x is set to zero.
148 #define __get_user_8(__ret_gu, __val_gu, ptr) \
149 __get_user_x(X, __ret_gu, __val_gu, ptr)
151 #define __get_user_8(__ret_gu, __val_gu, ptr) \
152 __get_user_x(8, __ret_gu, __val_gu, ptr)
155 #define get_user(x, ptr) \
158 unsigned long __val_gu; \
159 __chk_user_ptr(ptr); \
161 switch (sizeof(*(ptr))) { \
163 __get_user_x(1, __ret_gu, __val_gu, ptr); \
166 __get_user_x(2, __ret_gu, __val_gu, ptr); \
169 __get_user_x(4, __ret_gu, __val_gu, ptr); \
172 __get_user_8(__ret_gu, __val_gu, ptr); \
175 __get_user_x(X, __ret_gu, __val_gu, ptr); \
178 (x) = (__typeof__(*(ptr)))__val_gu; \
182 #define __put_user_x(size, x, ptr, __ret_pu) \
183 asm volatile("call __put_user_" #size : "=a" (__ret_pu) \
184 : "0" ((typeof(*(ptr)))(x)), "c" (ptr) : "ebx")
189 #define __put_user_asm_u64(x, addr, err, errret) \
190 asm volatile("1: movl %%eax,0(%2)\n" \
191 "2: movl %%edx,4(%2)\n" \
193 ".section .fixup,\"ax\"\n" \
197 _ASM_EXTABLE(1b, 4b) \
198 _ASM_EXTABLE(2b, 4b) \
200 : "A" (x), "r" (addr), "i" (errret), "0" (err))
202 #define __put_user_asm_ex_u64(x, addr) \
203 asm volatile("1: movl %%eax,0(%1)\n" \
204 "2: movl %%edx,4(%1)\n" \
206 _ASM_EXTABLE(1b, 2b - 1b) \
207 _ASM_EXTABLE(2b, 3b - 2b) \
208 : : "A" (x), "r" (addr))
210 #define __put_user_x8(x, ptr, __ret_pu) \
211 asm volatile("call __put_user_8" : "=a" (__ret_pu) \
212 : "A" ((typeof(*(ptr)))(x)), "c" (ptr) : "ebx")
214 #define __put_user_asm_u64(x, ptr, retval, errret) \
215 __put_user_asm(x, ptr, retval, "q", "", "er", errret)
216 #define __put_user_asm_ex_u64(x, addr) \
217 __put_user_asm_ex(x, addr, "q", "", "er")
218 #define __put_user_x8(x, ptr, __ret_pu) __put_user_x(8, x, ptr, __ret_pu)
221 extern void __put_user_bad(void);
224 * Strange magic calling convention: pointer in %ecx,
225 * value in %eax(:%edx), return value in %eax. clobbers %rbx
227 extern void __put_user_1(void);
228 extern void __put_user_2(void);
229 extern void __put_user_4(void);
230 extern void __put_user_8(void);
232 #ifdef CONFIG_X86_WP_WORKS_OK
235 * put_user: - Write a simple value into user space.
236 * @x: Value to copy to user space.
237 * @ptr: Destination address, in user space.
239 * Context: User context only. This function may sleep.
241 * This macro copies a single simple value from kernel space to user
242 * space. It supports simple types like char and int, but not larger
243 * data types like structures or arrays.
245 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
246 * to the result of dereferencing @ptr.
248 * Returns zero on success, or -EFAULT on error.
250 #define put_user(x, ptr) \
253 __typeof__(*(ptr)) __pu_val; \
254 __chk_user_ptr(ptr); \
257 switch (sizeof(*(ptr))) { \
259 __put_user_x(1, __pu_val, ptr, __ret_pu); \
262 __put_user_x(2, __pu_val, ptr, __ret_pu); \
265 __put_user_x(4, __pu_val, ptr, __ret_pu); \
268 __put_user_x8(__pu_val, ptr, __ret_pu); \
271 __put_user_x(X, __pu_val, ptr, __ret_pu); \
277 #define __put_user_size(x, ptr, size, retval, errret) \
280 __chk_user_ptr(ptr); \
283 __put_user_asm(x, ptr, retval, "b", "b", "iq", errret); \
286 __put_user_asm(x, ptr, retval, "w", "w", "ir", errret); \
289 __put_user_asm(x, ptr, retval, "l", "k", "ir", errret); \
292 __put_user_asm_u64((__typeof__(*ptr))(x), ptr, retval, \
300 #define __put_user_size_ex(x, ptr, size) \
302 __chk_user_ptr(ptr); \
305 __put_user_asm_ex(x, ptr, "b", "b", "iq"); \
308 __put_user_asm_ex(x, ptr, "w", "w", "ir"); \
311 __put_user_asm_ex(x, ptr, "l", "k", "ir"); \
314 __put_user_asm_ex_u64((__typeof__(*ptr))(x), ptr); \
323 #define __put_user_size(x, ptr, size, retval, errret) \
325 __typeof__(*(ptr))__pus_tmp = x; \
328 if (unlikely(__copy_to_user_ll(ptr, &__pus_tmp, size) != 0)) \
332 #define put_user(x, ptr) \
335 __typeof__(*(ptr))__pus_tmp = x; \
337 if (unlikely(__copy_to_user_ll(ptr, &__pus_tmp, \
338 sizeof(*(ptr))) != 0)) \
339 __ret_pu = -EFAULT; \
345 #define __get_user_asm_u64(x, ptr, retval, errret) (x) = __get_user_bad()
346 #define __get_user_asm_ex_u64(x, ptr) (x) = __get_user_bad()
348 #define __get_user_asm_u64(x, ptr, retval, errret) \
349 __get_user_asm(x, ptr, retval, "q", "", "=r", errret)
350 #define __get_user_asm_ex_u64(x, ptr) \
351 __get_user_asm_ex(x, ptr, "q", "", "=r")
354 #define __get_user_size(x, ptr, size, retval, errret) \
357 __chk_user_ptr(ptr); \
360 __get_user_asm(x, ptr, retval, "b", "b", "=q", errret); \
363 __get_user_asm(x, ptr, retval, "w", "w", "=r", errret); \
366 __get_user_asm(x, ptr, retval, "l", "k", "=r", errret); \
369 __get_user_asm_u64(x, ptr, retval, errret); \
372 (x) = __get_user_bad(); \
376 #define __get_user_asm(x, addr, err, itype, rtype, ltype, errret) \
377 asm volatile("1: mov"itype" %2,%"rtype"1\n" \
379 ".section .fixup,\"ax\"\n" \
381 " xor"itype" %"rtype"1,%"rtype"1\n" \
384 _ASM_EXTABLE(1b, 3b) \
385 : "=r" (err), ltype(x) \
386 : "m" (__m(addr)), "i" (errret), "0" (err))
388 #define __get_user_size_ex(x, ptr, size) \
390 __chk_user_ptr(ptr); \
393 __get_user_asm_ex(x, ptr, "b", "b", "=q"); \
396 __get_user_asm_ex(x, ptr, "w", "w", "=r"); \
399 __get_user_asm_ex(x, ptr, "l", "k", "=r"); \
402 __get_user_asm_ex_u64(x, ptr); \
405 (x) = __get_user_bad(); \
409 #define __get_user_asm_ex(x, addr, itype, rtype, ltype) \
410 asm volatile("1: mov"itype" %1,%"rtype"0\n" \
412 _ASM_EXTABLE(1b, 2b - 1b) \
413 : ltype(x) : "m" (__m(addr)))
415 #define __put_user_nocheck(x, ptr, size) \
418 __put_user_size((x), (ptr), (size), __pu_err, -EFAULT); \
422 #define __get_user_nocheck(x, ptr, size) \
425 unsigned long __gu_val; \
426 __get_user_size(__gu_val, (ptr), (size), __gu_err, -EFAULT); \
427 (x) = (__force __typeof__(*(ptr)))__gu_val; \
431 /* FIXME: this hack is definitely wrong -AK */
432 struct __large_struct
{ unsigned long buf
[100]; };
433 #define __m(x) (*(struct __large_struct __user *)(x))
436 * Tell gcc we read from memory instead of writing: this is because
437 * we do not write to any memory gcc knows about, so there are no
440 #define __put_user_asm(x, addr, err, itype, rtype, ltype, errret) \
441 asm volatile("1: mov"itype" %"rtype"1,%2\n" \
443 ".section .fixup,\"ax\"\n" \
447 _ASM_EXTABLE(1b, 3b) \
449 : ltype(x), "m" (__m(addr)), "i" (errret), "0" (err))
451 #define __put_user_asm_ex(x, addr, itype, rtype, ltype) \
452 asm volatile("1: mov"itype" %"rtype"0,%1\n" \
454 _ASM_EXTABLE(1b, 2b - 1b) \
455 : : ltype(x), "m" (__m(addr)))
458 * uaccess_try and catch
460 #define uaccess_try do { \
461 int prev_err = current_thread_info()->uaccess_err; \
462 current_thread_info()->uaccess_err = 0; \
465 #define uaccess_catch(err) \
466 (err) |= current_thread_info()->uaccess_err; \
467 current_thread_info()->uaccess_err = prev_err; \
471 * __get_user: - Get a simple variable from user space, with less checking.
472 * @x: Variable to store result.
473 * @ptr: Source address, in user space.
475 * Context: User context only. This function may sleep.
477 * This macro copies a single simple variable from user space to kernel
478 * space. It supports simple types like char and int, but not larger
479 * data types like structures or arrays.
481 * @ptr must have pointer-to-simple-variable type, and the result of
482 * dereferencing @ptr must be assignable to @x without a cast.
484 * Caller must check the pointer with access_ok() before calling this
487 * Returns zero on success, or -EFAULT on error.
488 * On error, the variable @x is set to zero.
491 #define __get_user(x, ptr) \
492 __get_user_nocheck((x), (ptr), sizeof(*(ptr)))
495 * __put_user: - Write a simple value into user space, with less checking.
496 * @x: Value to copy to user space.
497 * @ptr: Destination address, in user space.
499 * Context: User context only. This function may sleep.
501 * This macro copies a single simple value from kernel space to user
502 * space. It supports simple types like char and int, but not larger
503 * data types like structures or arrays.
505 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
506 * to the result of dereferencing @ptr.
508 * Caller must check the pointer with access_ok() before calling this
511 * Returns zero on success, or -EFAULT on error.
514 #define __put_user(x, ptr) \
515 __put_user_nocheck((__typeof__(*(ptr)))(x), (ptr), sizeof(*(ptr)))
517 #define __get_user_unaligned __get_user
518 #define __put_user_unaligned __put_user
521 * {get|put}_user_try and catch
525 * } get_user_catch(err)
527 #define get_user_try uaccess_try
528 #define get_user_catch(err) uaccess_catch(err)
530 #define get_user_ex(x, ptr) do { \
531 unsigned long __gue_val; \
532 __get_user_size_ex((__gue_val), (ptr), (sizeof(*(ptr)))); \
533 (x) = (__force __typeof__(*(ptr)))__gue_val; \
536 #ifdef CONFIG_X86_WP_WORKS_OK
538 #define put_user_try uaccess_try
539 #define put_user_catch(err) uaccess_catch(err)
541 #define put_user_ex(x, ptr) \
542 __put_user_size_ex((__typeof__(*(ptr)))(x), (ptr), sizeof(*(ptr)))
544 #else /* !CONFIG_X86_WP_WORKS_OK */
546 #define put_user_try do { \
547 int __uaccess_err = 0;
549 #define put_user_catch(err) \
550 (err) |= __uaccess_err; \
553 #define put_user_ex(x, ptr) do { \
554 __uaccess_err |= __put_user(x, ptr); \
557 #endif /* CONFIG_X86_WP_WORKS_OK */
560 * movsl can be slow when source and dest are not both 8-byte aligned
562 #ifdef CONFIG_X86_INTEL_USERCOPY
563 extern struct movsl_mask
{
565 } ____cacheline_aligned_in_smp movsl_mask
;
568 #define ARCH_HAS_NOCACHE_UACCESS 1
571 # include "uaccess_32.h"
573 # define ARCH_HAS_SEARCH_EXTABLE
574 # include "uaccess_64.h"
577 #endif /* _ASM_X86_UACCESS_H */