2 * This file is subject to the terms and conditions of the GNU General Public
3 * License. See the file "COPYING" in the main directory of this archive
6 * Copyright (C) 1996, 1997, 1998, 1999, 2000, 03, 04 by Ralf Baechle
7 * Copyright (C) 1999, 2000 Silicon Graphics, Inc.
10 #define _ASM_UACCESS_H
12 #include <linux/kernel.h>
13 #include <linux/errno.h>
14 #include <linux/thread_info.h>
15 #include <asm-generic/uaccess.h>
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.
26 #define __UA_LIMIT 0x80000000UL
28 #define __UA_ADDR ".word"
30 #define __UA_ADDU "addu"
34 #endif /* CONFIG_32BIT */
38 #define __UA_LIMIT (- TASK_SIZE)
40 #define __UA_ADDR ".dword"
42 #define __UA_ADDU "daddu"
46 #endif /* CONFIG_64BIT */
49 * USER_DS is a bitmask that has the bits set that may not be set in a valid
50 * userspace address. Note that we limit 32-bit userspace to 0x7fff8000 but
51 * the arithmetic we're doing only works if the limit is a power of two, so
52 * we use 0x80000000 here on 32-bit kernels. If a process passes an invalid
53 * address in this range it's the process's problem, not ours :-)
56 #define KERNEL_DS ((mm_segment_t) { 0UL })
57 #define USER_DS ((mm_segment_t) { __UA_LIMIT })
60 #define VERIFY_WRITE 1
62 #define get_ds() (KERNEL_DS)
63 #define get_fs() (current_thread_info()->addr_limit)
64 #define set_fs(x) (current_thread_info()->addr_limit = (x))
66 #define segment_eq(a,b) ((a).seg == (b).seg)
70 * Is a address valid? This does a straighforward calculation rather
74 * - "addr" doesn't have any high-bits set
75 * - AND "size" doesn't have any high-bits set
76 * - AND "addr+size" doesn't have any high-bits set
77 * - OR we are in kernel mode.
79 * __ua_size() is a trick to avoid runtime checking of positive constant
80 * sizes; for those we already know at compile time that the size is ok.
82 #define __ua_size(size) \
83 ((__builtin_constant_p(size) && (signed long) (size) > 0) ? 0 : (size))
86 * access_ok: - Checks if a user space pointer is valid
87 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
88 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
89 * to write to a block, it is always safe to read from it.
90 * @addr: User space pointer to start of block to check
91 * @size: Size of block to check
93 * Context: User context only. This function may sleep.
95 * Checks if a pointer to a block of memory in user space is valid.
97 * Returns true (nonzero) if the memory block may be valid, false (zero)
98 * if it is definitely invalid.
100 * Note that, depending on architecture, this function probably just
101 * checks that the pointer is in the user space range - after calling
102 * this function, memory access functions may still return -EFAULT.
105 #define __access_mask get_fs().seg
107 #define __access_ok(addr, size, mask) \
108 (((signed long)((mask) & ((addr) | ((addr) + (size)) | __ua_size(size)))) == 0)
110 #define access_ok(type, addr, size) \
111 likely(__access_ok((unsigned long)(addr), (size),__access_mask))
114 * put_user: - Write a simple value into user space.
115 * @x: Value to copy to user space.
116 * @ptr: Destination address, in user space.
118 * Context: User context only. This function may sleep.
120 * This macro copies a single simple value from kernel space to user
121 * space. It supports simple types like char and int, but not larger
122 * data types like structures or arrays.
124 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
125 * to the result of dereferencing @ptr.
127 * Returns zero on success, or -EFAULT on error.
129 #define put_user(x,ptr) \
130 __put_user_check((x),(ptr),sizeof(*(ptr)))
133 * get_user: - Get a simple variable from user space.
134 * @x: Variable to store result.
135 * @ptr: Source address, in user space.
137 * Context: User context only. This function may sleep.
139 * This macro copies a single simple variable from user space to kernel
140 * space. It supports simple types like char and int, but not larger
141 * data types like structures or arrays.
143 * @ptr must have pointer-to-simple-variable type, and the result of
144 * dereferencing @ptr must be assignable to @x without a cast.
146 * Returns zero on success, or -EFAULT on error.
147 * On error, the variable @x is set to zero.
149 #define get_user(x,ptr) \
150 __get_user_check((x),(ptr),sizeof(*(ptr)))
153 * __put_user: - Write a simple value into user space, with less checking.
154 * @x: Value to copy to user space.
155 * @ptr: Destination address, in user space.
157 * Context: User context only. This function may sleep.
159 * This macro copies a single simple value from kernel space to user
160 * space. It supports simple types like char and int, but not larger
161 * data types like structures or arrays.
163 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
164 * to the result of dereferencing @ptr.
166 * Caller must check the pointer with access_ok() before calling this
169 * Returns zero on success, or -EFAULT on error.
171 #define __put_user(x,ptr) \
172 __put_user_nocheck((x),(ptr),sizeof(*(ptr)))
175 * __get_user: - Get a simple variable from user space, with less checking.
176 * @x: Variable to store result.
177 * @ptr: Source address, in user space.
179 * Context: User context only. This function may sleep.
181 * This macro copies a single simple variable from user space to kernel
182 * space. It supports simple types like char and int, but not larger
183 * data types like structures or arrays.
185 * @ptr must have pointer-to-simple-variable type, and the result of
186 * dereferencing @ptr must be assignable to @x without a cast.
188 * Caller must check the pointer with access_ok() before calling this
191 * Returns zero on success, or -EFAULT on error.
192 * On error, the variable @x is set to zero.
194 #define __get_user(x,ptr) \
195 __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
197 struct __large_struct
{ unsigned long buf
[100]; };
198 #define __m(x) (*(struct __large_struct __user *)(x))
201 * Yuck. We need two variants, one for 64bit operation and one
202 * for 32 bit mode and old iron.
205 #define __GET_USER_DW(val, ptr) __get_user_asm_ll32(val, ptr)
208 #define __GET_USER_DW(val, ptr) __get_user_asm(val, "ld", ptr)
211 extern void __get_user_unknown(void);
213 #define __get_user_common(val, size, ptr) \
216 case 1: __get_user_asm(val, "lb", ptr); break; \
217 case 2: __get_user_asm(val, "lh", ptr); break; \
218 case 4: __get_user_asm(val, "lw", ptr); break; \
219 case 8: __GET_USER_DW(val, ptr); break; \
220 default: __get_user_unknown(); break; \
224 #define __get_user_nocheck(x,ptr,size) \
228 __get_user_common((x), size, ptr); \
232 #define __get_user_check(x,ptr,size) \
234 long __gu_err = -EFAULT; \
235 const __typeof__(*(ptr)) __user * __gu_ptr = (ptr); \
237 if (likely(access_ok(VERIFY_READ, __gu_ptr, size))) \
238 __get_user_common((x), size, __gu_ptr); \
243 #define __get_user_asm(val, insn, addr) \
247 __asm__ __volatile__( \
248 "1: " insn " %1, %3 \n" \
250 " .section .fixup,\"ax\" \n" \
254 " .section __ex_table,\"a\" \n" \
255 " "__UA_ADDR "\t1b, 3b \n" \
257 : "=r" (__gu_err), "=r" (__gu_tmp) \
258 : "0" (0), "o" (__m(addr)), "i" (-EFAULT)); \
260 (val) = (__typeof__(*(addr))) __gu_tmp; \
264 * Get a long long 64 using 32 bit registers.
266 #define __get_user_asm_ll32(val, addr) \
268 unsigned long long __gu_tmp; \
270 __asm__ __volatile__( \
271 "1: lw %1, (%3) \n" \
272 "2: lw %D1, 4(%3) \n" \
274 "3: .section .fixup,\"ax\" \n" \
280 " .section __ex_table,\"a\" \n" \
281 " " __UA_ADDR " 1b, 4b \n" \
282 " " __UA_ADDR " 2b, 4b \n" \
284 : "=r" (__gu_err), "=&r" (__gu_tmp) \
285 : "0" (0), "r" (addr), "i" (-EFAULT)); \
286 (val) = (__typeof__(*(addr))) __gu_tmp; \
290 * Yuck. We need two variants, one for 64bit operation and one
291 * for 32 bit mode and old iron.
294 #define __PUT_USER_DW(ptr) __put_user_asm_ll32(ptr)
297 #define __PUT_USER_DW(ptr) __put_user_asm("sd", ptr)
300 #define __put_user_nocheck(x,ptr,size) \
302 __typeof__(*(ptr)) __pu_val; \
307 case 1: __put_user_asm("sb", ptr); break; \
308 case 2: __put_user_asm("sh", ptr); break; \
309 case 4: __put_user_asm("sw", ptr); break; \
310 case 8: __PUT_USER_DW(ptr); break; \
311 default: __put_user_unknown(); break; \
316 #define __put_user_check(x,ptr,size) \
318 __typeof__(*(ptr)) __user *__pu_addr = (ptr); \
319 __typeof__(*(ptr)) __pu_val = (x); \
320 long __pu_err = -EFAULT; \
322 if (likely(access_ok(VERIFY_WRITE, __pu_addr, size))) { \
324 case 1: __put_user_asm("sb", __pu_addr); break; \
325 case 2: __put_user_asm("sh", __pu_addr); break; \
326 case 4: __put_user_asm("sw", __pu_addr); break; \
327 case 8: __PUT_USER_DW(__pu_addr); break; \
328 default: __put_user_unknown(); break; \
334 #define __put_user_asm(insn, ptr) \
336 __asm__ __volatile__( \
337 "1: " insn " %z2, %3 # __put_user_asm\n" \
339 " .section .fixup,\"ax\" \n" \
343 " .section __ex_table,\"a\" \n" \
344 " " __UA_ADDR " 1b, 3b \n" \
347 : "0" (0), "Jr" (__pu_val), "o" (__m(ptr)), \
351 #define __put_user_asm_ll32(ptr) \
353 __asm__ __volatile__( \
354 "1: sw %2, (%3) # __put_user_asm_ll32 \n" \
355 "2: sw %D2, 4(%3) \n" \
357 " .section .fixup,\"ax\" \n" \
361 " .section __ex_table,\"a\" \n" \
362 " " __UA_ADDR " 1b, 4b \n" \
363 " " __UA_ADDR " 2b, 4b \n" \
366 : "0" (0), "r" (__pu_val), "r" (ptr), \
370 extern void __put_user_unknown(void);
373 * We're generating jump to subroutines which will be outside the range of
377 #define __MODULE_JAL(destination) \
379 __UA_LA "\t$1, " #destination "\n\t" \
383 #define __MODULE_JAL(destination) \
384 "jal\t" #destination "\n\t"
387 extern size_t __copy_user(void *__to
, const void *__from
, size_t __n
);
389 #define __invoke_copy_to_user(to,from,n) \
391 register void __user *__cu_to_r __asm__ ("$4"); \
392 register const void *__cu_from_r __asm__ ("$5"); \
393 register long __cu_len_r __asm__ ("$6"); \
396 __cu_from_r = (from); \
398 __asm__ __volatile__( \
399 __MODULE_JAL(__copy_user) \
400 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
402 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
408 * __copy_to_user: - Copy a block of data into user space, with less checking.
409 * @to: Destination address, in user space.
410 * @from: Source address, in kernel space.
411 * @n: Number of bytes to copy.
413 * Context: User context only. This function may sleep.
415 * Copy data from kernel space to user space. Caller must check
416 * the specified block with access_ok() before calling this function.
418 * Returns number of bytes that could not be copied.
419 * On success, this will be zero.
421 #define __copy_to_user(to,from,n) \
423 void __user *__cu_to; \
424 const void *__cu_from; \
429 __cu_from = (from); \
431 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, __cu_len); \
435 #define __copy_to_user_inatomic __copy_to_user
436 #define __copy_from_user_inatomic __copy_from_user
439 * copy_to_user: - Copy a block of data into user space.
440 * @to: Destination address, in user space.
441 * @from: Source address, in kernel space.
442 * @n: Number of bytes to copy.
444 * Context: User context only. This function may sleep.
446 * Copy data from kernel space to user space.
448 * Returns number of bytes that could not be copied.
449 * On success, this will be zero.
451 #define copy_to_user(to,from,n) \
453 void __user *__cu_to; \
454 const void *__cu_from; \
459 __cu_from = (from); \
461 if (access_ok(VERIFY_WRITE, __cu_to, __cu_len)) \
462 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, \
467 #define __invoke_copy_from_user(to,from,n) \
469 register void *__cu_to_r __asm__ ("$4"); \
470 register const void __user *__cu_from_r __asm__ ("$5"); \
471 register long __cu_len_r __asm__ ("$6"); \
474 __cu_from_r = (from); \
476 __asm__ __volatile__( \
477 ".set\tnoreorder\n\t" \
478 __MODULE_JAL(__copy_user) \
480 __UA_ADDU "\t$1, %1, %2\n\t" \
483 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
485 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
491 * __copy_from_user: - Copy a block of data from user space, with less checking. * @to: Destination address, in kernel space.
492 * @from: Source address, in user space.
493 * @n: Number of bytes to copy.
495 * Context: User context only. This function may sleep.
497 * Copy data from user space to kernel space. Caller must check
498 * the specified block with access_ok() before calling this function.
500 * Returns number of bytes that could not be copied.
501 * On success, this will be zero.
503 * If some data could not be copied, this function will pad the copied
504 * data to the requested size using zero bytes.
506 #define __copy_from_user(to,from,n) \
509 const void __user *__cu_from; \
514 __cu_from = (from); \
516 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
522 * copy_from_user: - Copy a block of data from user space.
523 * @to: Destination address, in kernel space.
524 * @from: Source address, in user space.
525 * @n: Number of bytes to copy.
527 * Context: User context only. This function may sleep.
529 * Copy data from user space to kernel space.
531 * Returns number of bytes that could not be copied.
532 * On success, this will be zero.
534 * If some data could not be copied, this function will pad the copied
535 * data to the requested size using zero bytes.
537 #define copy_from_user(to,from,n) \
540 const void __user *__cu_from; \
545 __cu_from = (from); \
547 if (access_ok(VERIFY_READ, __cu_from, __cu_len)) \
548 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
553 #define __copy_in_user(to, from, n) __copy_from_user(to, from, n)
555 #define copy_in_user(to,from,n) \
557 void __user *__cu_to; \
558 const void __user *__cu_from; \
563 __cu_from = (from); \
565 if (likely(access_ok(VERIFY_READ, __cu_from, __cu_len) && \
566 access_ok(VERIFY_WRITE, __cu_to, __cu_len))) \
567 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
573 * __clear_user: - Zero a block of memory in user space, with less checking.
574 * @to: Destination address, in user space.
575 * @n: Number of bytes to zero.
577 * Zero a block of memory in user space. Caller must check
578 * the specified block with access_ok() before calling this function.
580 * Returns number of bytes that could not be cleared.
581 * On success, this will be zero.
583 static inline __kernel_size_t
584 __clear_user(void __user
*addr
, __kernel_size_t size
)
589 __asm__
__volatile__(
593 __MODULE_JAL(__bzero
)
596 : "r" (addr
), "r" (size
)
597 : "$4", "$5", "$6", __UA_t0
, __UA_t1
, "$31");
602 #define clear_user(addr,n) \
604 void __user * __cl_addr = (addr); \
605 unsigned long __cl_size = (n); \
606 if (__cl_size && access_ok(VERIFY_WRITE, \
607 ((unsigned long)(__cl_addr)), __cl_size)) \
608 __cl_size = __clear_user(__cl_addr, __cl_size); \
613 * __strncpy_from_user: - Copy a NUL terminated string from userspace, with less checking.
614 * @dst: Destination address, in kernel space. This buffer must be at
615 * least @count bytes long.
616 * @src: Source address, in user space.
617 * @count: Maximum number of bytes to copy, including the trailing NUL.
619 * Copies a NUL-terminated string from userspace to kernel space.
620 * Caller must check the specified block with access_ok() before calling
623 * On success, returns the length of the string (not including the trailing
626 * If access to userspace fails, returns -EFAULT (some data may have been
629 * If @count is smaller than the length of the string, copies @count bytes
630 * and returns @count.
633 __strncpy_from_user(char *__to
, const char __user
*__from
, long __len
)
638 __asm__
__volatile__(
642 __MODULE_JAL(__strncpy_from_user_nocheck_asm
)
645 : "r" (__to
), "r" (__from
), "r" (__len
)
646 : "$2", "$3", "$4", "$5", "$6", __UA_t0
, "$31", "memory");
652 * strncpy_from_user: - Copy a NUL terminated string from userspace.
653 * @dst: Destination address, in kernel space. This buffer must be at
654 * least @count bytes long.
655 * @src: Source address, in user space.
656 * @count: Maximum number of bytes to copy, including the trailing NUL.
658 * Copies a NUL-terminated string from userspace to kernel space.
660 * On success, returns the length of the string (not including the trailing
663 * If access to userspace fails, returns -EFAULT (some data may have been
666 * If @count is smaller than the length of the string, copies @count bytes
667 * and returns @count.
670 strncpy_from_user(char *__to
, const char __user
*__from
, long __len
)
675 __asm__
__volatile__(
679 __MODULE_JAL(__strncpy_from_user_asm
)
682 : "r" (__to
), "r" (__from
), "r" (__len
)
683 : "$2", "$3", "$4", "$5", "$6", __UA_t0
, "$31", "memory");
688 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
689 static inline long __strlen_user(const char __user
*s
)
694 __asm__
__volatile__(
696 __MODULE_JAL(__strlen_user_nocheck_asm
)
700 : "$2", "$4", __UA_t0
, "$31");
706 * strlen_user: - Get the size of a string in user space.
707 * @str: The string to measure.
709 * Context: User context only. This function may sleep.
711 * Get the size of a NUL-terminated string in user space.
713 * Returns the size of the string INCLUDING the terminating NUL.
714 * On exception, returns 0.
716 * If there is a limit on the length of a valid string, you may wish to
717 * consider using strnlen_user() instead.
719 static inline long strlen_user(const char __user
*s
)
724 __asm__
__volatile__(
726 __MODULE_JAL(__strlen_user_asm
)
730 : "$2", "$4", __UA_t0
, "$31");
735 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
736 static inline long __strnlen_user(const char __user
*s
, long n
)
741 __asm__
__volatile__(
744 __MODULE_JAL(__strnlen_user_nocheck_asm
)
748 : "$2", "$4", "$5", __UA_t0
, "$31");
754 * strlen_user: - Get the size of a string in user space.
755 * @str: The string to measure.
757 * Context: User context only. This function may sleep.
759 * Get the size of a NUL-terminated string in user space.
761 * Returns the size of the string INCLUDING the terminating NUL.
762 * On exception, returns 0.
764 * If there is a limit on the length of a valid string, you may wish to
765 * consider using strnlen_user() instead.
767 static inline long strnlen_user(const char __user
*s
, long n
)
772 __asm__
__volatile__(
775 __MODULE_JAL(__strnlen_user_asm
)
779 : "$2", "$4", "$5", __UA_t0
, "$31");
784 struct exception_table_entry
787 unsigned long nextinsn
;
790 extern int fixup_exception(struct pt_regs
*regs
);
792 #endif /* _ASM_UACCESS_H */