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/config.h>
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/thread_info.h>
16 #include <asm-generic/uaccess.h>
19 * The fs value determines whether argument validity checking should be
20 * performed or not. If get_fs() == USER_DS, checking is performed, with
21 * get_fs() == KERNEL_DS, checking is bypassed.
23 * For historical reasons, these macros are grossly misnamed.
27 #define __UA_LIMIT 0x80000000UL
29 #define __UA_ADDR ".word"
31 #define __UA_ADDU "addu"
35 #endif /* CONFIG_32BIT */
39 #define __UA_LIMIT (- TASK_SIZE)
41 #define __UA_ADDR ".dword"
43 #define __UA_ADDU "daddu"
47 #endif /* CONFIG_64BIT */
50 * USER_DS is a bitmask that has the bits set that may not be set in a valid
51 * userspace address. Note that we limit 32-bit userspace to 0x7fff8000 but
52 * the arithmetic we're doing only works if the limit is a power of two, so
53 * we use 0x80000000 here on 32-bit kernels. If a process passes an invalid
54 * address in this range it's the process's problem, not ours :-)
57 #define KERNEL_DS ((mm_segment_t) { 0UL })
58 #define USER_DS ((mm_segment_t) { __UA_LIMIT })
61 #define VERIFY_WRITE 1
63 #define get_ds() (KERNEL_DS)
64 #define get_fs() (current_thread_info()->addr_limit)
65 #define set_fs(x) (current_thread_info()->addr_limit = (x))
67 #define segment_eq(a,b) ((a).seg == (b).seg)
71 * Is a address valid? This does a straighforward calculation rather
75 * - "addr" doesn't have any high-bits set
76 * - AND "size" doesn't have any high-bits set
77 * - AND "addr+size" doesn't have any high-bits set
78 * - OR we are in kernel mode.
80 * __ua_size() is a trick to avoid runtime checking of positive constant
81 * sizes; for those we already know at compile time that the size is ok.
83 #define __ua_size(size) \
84 ((__builtin_constant_p(size) && (signed long) (size) > 0) ? 0 : (size))
87 * access_ok: - Checks if a user space pointer is valid
88 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
89 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
90 * to write to a block, it is always safe to read from it.
91 * @addr: User space pointer to start of block to check
92 * @size: Size of block to check
94 * Context: User context only. This function may sleep.
96 * Checks if a pointer to a block of memory in user space is valid.
98 * Returns true (nonzero) if the memory block may be valid, false (zero)
99 * if it is definitely invalid.
101 * Note that, depending on architecture, this function probably just
102 * checks that the pointer is in the user space range - after calling
103 * this function, memory access functions may still return -EFAULT.
106 #define __access_mask get_fs().seg
108 #define __access_ok(addr, size, mask) \
109 (((signed long)((mask) & ((addr) | ((addr) + (size)) | __ua_size(size)))) == 0)
111 #define access_ok(type, addr, size) \
112 likely(__access_ok((unsigned long)(addr), (size),__access_mask))
115 * put_user: - Write a simple value into user space.
116 * @x: Value to copy to user space.
117 * @ptr: Destination address, in user space.
119 * Context: User context only. This function may sleep.
121 * This macro copies a single simple value from kernel space to user
122 * space. It supports simple types like char and int, but not larger
123 * data types like structures or arrays.
125 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
126 * to the result of dereferencing @ptr.
128 * Returns zero on success, or -EFAULT on error.
130 #define put_user(x,ptr) \
131 __put_user_check((x),(ptr),sizeof(*(ptr)))
134 * get_user: - Get a simple variable from user space.
135 * @x: Variable to store result.
136 * @ptr: Source address, in user space.
138 * Context: User context only. This function may sleep.
140 * This macro copies a single simple variable from user space to kernel
141 * space. It supports simple types like char and int, but not larger
142 * data types like structures or arrays.
144 * @ptr must have pointer-to-simple-variable type, and the result of
145 * dereferencing @ptr must be assignable to @x without a cast.
147 * Returns zero on success, or -EFAULT on error.
148 * On error, the variable @x is set to zero.
150 #define get_user(x,ptr) \
151 __get_user_check((x),(ptr),sizeof(*(ptr)))
154 * __put_user: - Write a simple value into user space, with less checking.
155 * @x: Value to copy to user space.
156 * @ptr: Destination address, in user space.
158 * Context: User context only. This function may sleep.
160 * This macro copies a single simple value from kernel space to user
161 * space. It supports simple types like char and int, but not larger
162 * data types like structures or arrays.
164 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
165 * to the result of dereferencing @ptr.
167 * Caller must check the pointer with access_ok() before calling this
170 * Returns zero on success, or -EFAULT on error.
172 #define __put_user(x,ptr) \
173 __put_user_nocheck((x),(ptr),sizeof(*(ptr)))
176 * __get_user: - Get a simple variable from user space, with less checking.
177 * @x: Variable to store result.
178 * @ptr: Source address, in user space.
180 * Context: User context only. This function may sleep.
182 * This macro copies a single simple variable from user space to kernel
183 * space. It supports simple types like char and int, but not larger
184 * data types like structures or arrays.
186 * @ptr must have pointer-to-simple-variable type, and the result of
187 * dereferencing @ptr must be assignable to @x without a cast.
189 * Caller must check the pointer with access_ok() before calling this
192 * Returns zero on success, or -EFAULT on error.
193 * On error, the variable @x is set to zero.
195 #define __get_user(x,ptr) \
196 __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
198 struct __large_struct
{ unsigned long buf
[100]; };
199 #define __m(x) (*(struct __large_struct *)(x))
202 * Yuck. We need two variants, one for 64bit operation and one
203 * for 32 bit mode and old iron.
206 #define __GET_USER_DW(__gu_err) __get_user_asm("ld", __gu_err)
208 #define __GET_USER_DW(__gu_err) __get_user_asm_ll32(__gu_err)
211 #define __get_user_nocheck(x,ptr,size) \
213 __typeof(*(ptr)) __gu_val = 0; \
218 __gu_addr = (long) (ptr); \
220 case 1: __get_user_asm("lb", __gu_err); break; \
221 case 2: __get_user_asm("lh", __gu_err); break; \
222 case 4: __get_user_asm("lw", __gu_err); break; \
223 case 8: __GET_USER_DW(__gu_err); break; \
224 default: __get_user_unknown(); break; \
226 x = (__typeof__(*(ptr))) __gu_val; \
230 #define __get_user_check(x,ptr,size) \
232 __typeof__(*(ptr)) __gu_val = 0; \
237 __gu_addr = (long) (ptr); \
238 __gu_err = access_ok(VERIFY_READ, (void *) __gu_addr, size) \
241 if (likely(!__gu_err)) { \
243 case 1: __get_user_asm("lb", __gu_err); break; \
244 case 2: __get_user_asm("lh", __gu_err); break; \
245 case 4: __get_user_asm("lw", __gu_err); break; \
246 case 8: __GET_USER_DW(__gu_err); break; \
247 default: __get_user_unknown(); break; \
250 x = (__typeof__(*(ptr))) __gu_val; \
254 #define __get_user_asm(insn,__gu_err) \
256 __asm__ __volatile__( \
257 "1: " insn " %1, %3 \n" \
259 " .section .fixup,\"ax\" \n" \
263 " .section __ex_table,\"a\" \n" \
264 " "__UA_ADDR "\t1b, 3b \n" \
266 : "=r" (__gu_err), "=r" (__gu_val) \
267 : "0" (__gu_err), "o" (__m(__gu_addr)), "i" (-EFAULT)); \
271 * Get a long long 64 using 32 bit registers.
273 #define __get_user_asm_ll32(__gu_err) \
275 __asm__ __volatile__( \
279 "3: .section .fixup,\"ax\" \n" \
285 " .section __ex_table,\"a\" \n" \
286 " " __UA_ADDR " 1b, 4b \n" \
287 " " __UA_ADDR " 2b, 4b \n" \
289 : "=r" (__gu_err), "=&r" (__gu_val) \
290 : "0" (__gu_err), "o" (__m(__gu_addr)), \
291 "o" (__m(__gu_addr + 4)), "i" (-EFAULT)); \
294 extern void __get_user_unknown(void);
297 * Yuck. We need two variants, one for 64bit operation and one
298 * for 32 bit mode and old iron.
301 #define __PUT_USER_DW(__pu_val) __put_user_asm("sd", __pu_val)
303 #define __PUT_USER_DW(__pu_val) __put_user_asm_ll32(__pu_val)
306 #define __put_user_nocheck(x,ptr,size) \
308 __typeof__(*(ptr)) __pu_val; \
314 __pu_addr = (long) (ptr); \
316 case 1: __put_user_asm("sb", __pu_val); break; \
317 case 2: __put_user_asm("sh", __pu_val); break; \
318 case 4: __put_user_asm("sw", __pu_val); break; \
319 case 8: __PUT_USER_DW(__pu_val); break; \
320 default: __put_user_unknown(); break; \
325 #define __put_user_check(x,ptr,size) \
327 __typeof__(*(ptr)) __pu_val; \
333 __pu_addr = (long) (ptr); \
334 __pu_err = access_ok(VERIFY_WRITE, (void *) __pu_addr, size) \
337 if (likely(!__pu_err)) { \
339 case 1: __put_user_asm("sb", __pu_val); break; \
340 case 2: __put_user_asm("sh", __pu_val); break; \
341 case 4: __put_user_asm("sw", __pu_val); break; \
342 case 8: __PUT_USER_DW(__pu_val); break; \
343 default: __put_user_unknown(); break; \
349 #define __put_user_asm(insn, __pu_val) \
351 __asm__ __volatile__( \
352 "1: " insn " %z2, %3 # __put_user_asm\n" \
354 " .section .fixup,\"ax\" \n" \
358 " .section __ex_table,\"a\" \n" \
359 " " __UA_ADDR " 1b, 3b \n" \
362 : "0" (__pu_err), "Jr" (__pu_val), "o" (__m(__pu_addr)), \
366 #define __put_user_asm_ll32(__pu_val) \
368 __asm__ __volatile__( \
369 "1: sw %2, %3 # __put_user_asm_ll32 \n" \
372 " .section .fixup,\"ax\" \n" \
376 " .section __ex_table,\"a\" \n" \
377 " " __UA_ADDR " 1b, 4b \n" \
378 " " __UA_ADDR " 2b, 4b \n" \
381 : "0" (__pu_err), "r" (__pu_val), "o" (__m(__pu_addr)), \
382 "o" (__m(__pu_addr + 4)), "i" (-EFAULT)); \
385 extern void __put_user_unknown(void);
388 * We're generating jump to subroutines which will be outside the range of
392 #define __MODULE_JAL(destination) \
394 __UA_LA "\t$1, " #destination "\n\t" \
398 #define __MODULE_JAL(destination) \
399 "jal\t" #destination "\n\t"
402 extern size_t __copy_user(void *__to
, const void *__from
, size_t __n
);
404 #define __invoke_copy_to_user(to,from,n) \
406 register void *__cu_to_r __asm__ ("$4"); \
407 register const void *__cu_from_r __asm__ ("$5"); \
408 register long __cu_len_r __asm__ ("$6"); \
411 __cu_from_r = (from); \
413 __asm__ __volatile__( \
414 __MODULE_JAL(__copy_user) \
415 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
417 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
423 * __copy_to_user: - Copy a block of data into user space, with less checking.
424 * @to: Destination address, in user space.
425 * @from: Source address, in kernel space.
426 * @n: Number of bytes to copy.
428 * Context: User context only. This function may sleep.
430 * Copy data from kernel space to user space. Caller must check
431 * the specified block with access_ok() before calling this function.
433 * Returns number of bytes that could not be copied.
434 * On success, this will be zero.
436 #define __copy_to_user(to,from,n) \
439 const void *__cu_from; \
444 __cu_from = (from); \
446 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, __cu_len); \
450 #define __copy_to_user_inatomic __copy_to_user
451 #define __copy_from_user_inatomic __copy_from_user
454 * copy_to_user: - Copy a block of data into user space.
455 * @to: Destination address, in user space.
456 * @from: Source address, in kernel space.
457 * @n: Number of bytes to copy.
459 * Context: User context only. This function may sleep.
461 * Copy data from kernel space to user space.
463 * Returns number of bytes that could not be copied.
464 * On success, this will be zero.
466 #define copy_to_user(to,from,n) \
469 const void *__cu_from; \
474 __cu_from = (from); \
476 if (access_ok(VERIFY_WRITE, __cu_to, __cu_len)) \
477 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, \
482 #define __invoke_copy_from_user(to,from,n) \
484 register void *__cu_to_r __asm__ ("$4"); \
485 register const void *__cu_from_r __asm__ ("$5"); \
486 register long __cu_len_r __asm__ ("$6"); \
489 __cu_from_r = (from); \
491 __asm__ __volatile__( \
492 ".set\tnoreorder\n\t" \
493 __MODULE_JAL(__copy_user) \
495 __UA_ADDU "\t$1, %1, %2\n\t" \
498 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
500 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
506 * __copy_from_user: - Copy a block of data from user space, with less checking. * @to: Destination address, in kernel space.
507 * @from: Source address, in user space.
508 * @n: Number of bytes to copy.
510 * Context: User context only. This function may sleep.
512 * Copy data from user space to kernel space. Caller must check
513 * the specified block with access_ok() before calling this function.
515 * Returns number of bytes that could not be copied.
516 * On success, this will be zero.
518 * If some data could not be copied, this function will pad the copied
519 * data to the requested size using zero bytes.
521 #define __copy_from_user(to,from,n) \
524 const void *__cu_from; \
529 __cu_from = (from); \
531 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
537 * copy_from_user: - Copy a block of data from user space.
538 * @to: Destination address, in kernel space.
539 * @from: Source address, in user space.
540 * @n: Number of bytes to copy.
542 * Context: User context only. This function may sleep.
544 * Copy data from user space to kernel space.
546 * Returns number of bytes that could not be copied.
547 * On success, this will be zero.
549 * If some data could not be copied, this function will pad the copied
550 * data to the requested size using zero bytes.
552 #define copy_from_user(to,from,n) \
555 const void *__cu_from; \
560 __cu_from = (from); \
562 if (access_ok(VERIFY_READ, __cu_from, __cu_len)) \
563 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
568 #define __copy_in_user(to, from, n) __copy_from_user(to, from, n)
570 #define copy_in_user(to,from,n) \
573 const void *__cu_from; \
578 __cu_from = (from); \
580 if (likely(access_ok(VERIFY_READ, __cu_from, __cu_len) && \
581 access_ok(VERIFY_WRITE, __cu_to, __cu_len))) \
582 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
588 * __clear_user: - Zero a block of memory in user space, with less checking.
589 * @to: Destination address, in user space.
590 * @n: Number of bytes to zero.
592 * Zero a block of memory in user space. Caller must check
593 * the specified block with access_ok() before calling this function.
595 * Returns number of bytes that could not be cleared.
596 * On success, this will be zero.
598 static inline __kernel_size_t
599 __clear_user(void *addr
, __kernel_size_t size
)
604 __asm__
__volatile__(
608 __MODULE_JAL(__bzero
)
611 : "r" (addr
), "r" (size
)
612 : "$4", "$5", "$6", __UA_t0
, __UA_t1
, "$31");
617 #define clear_user(addr,n) \
619 void * __cl_addr = (addr); \
620 unsigned long __cl_size = (n); \
621 if (__cl_size && access_ok(VERIFY_WRITE, \
622 ((unsigned long)(__cl_addr)), __cl_size)) \
623 __cl_size = __clear_user(__cl_addr, __cl_size); \
628 * __strncpy_from_user: - Copy a NUL terminated string from userspace, with less checking.
629 * @dst: Destination address, in kernel space. This buffer must be at
630 * least @count bytes long.
631 * @src: Source address, in user space.
632 * @count: Maximum number of bytes to copy, including the trailing NUL.
634 * Copies a NUL-terminated string from userspace to kernel space.
635 * Caller must check the specified block with access_ok() before calling
638 * On success, returns the length of the string (not including the trailing
641 * If access to userspace fails, returns -EFAULT (some data may have been
644 * If @count is smaller than the length of the string, copies @count bytes
645 * and returns @count.
648 __strncpy_from_user(char *__to
, const char *__from
, long __len
)
653 __asm__
__volatile__(
657 __MODULE_JAL(__strncpy_from_user_nocheck_asm
)
660 : "r" (__to
), "r" (__from
), "r" (__len
)
661 : "$2", "$3", "$4", "$5", "$6", __UA_t0
, "$31", "memory");
667 * strncpy_from_user: - Copy a NUL terminated string from userspace.
668 * @dst: Destination address, in kernel space. This buffer must be at
669 * least @count bytes long.
670 * @src: Source address, in user space.
671 * @count: Maximum number of bytes to copy, including the trailing NUL.
673 * Copies a NUL-terminated string from userspace to kernel space.
675 * On success, returns the length of the string (not including the trailing
678 * If access to userspace fails, returns -EFAULT (some data may have been
681 * If @count is smaller than the length of the string, copies @count bytes
682 * and returns @count.
685 strncpy_from_user(char *__to
, const char *__from
, long __len
)
690 __asm__
__volatile__(
694 __MODULE_JAL(__strncpy_from_user_asm
)
697 : "r" (__to
), "r" (__from
), "r" (__len
)
698 : "$2", "$3", "$4", "$5", "$6", __UA_t0
, "$31", "memory");
703 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
704 static inline long __strlen_user(const char *s
)
709 __asm__
__volatile__(
711 __MODULE_JAL(__strlen_user_nocheck_asm
)
715 : "$2", "$4", __UA_t0
, "$31");
721 * strlen_user: - Get the size of a string in user space.
722 * @str: The string to measure.
724 * Context: User context only. This function may sleep.
726 * Get the size of a NUL-terminated string in user space.
728 * Returns the size of the string INCLUDING the terminating NUL.
729 * On exception, returns 0.
731 * If there is a limit on the length of a valid string, you may wish to
732 * consider using strnlen_user() instead.
734 static inline long strlen_user(const char *s
)
739 __asm__
__volatile__(
741 __MODULE_JAL(__strlen_user_asm
)
745 : "$2", "$4", __UA_t0
, "$31");
750 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
751 static inline long __strnlen_user(const char *s
, long n
)
756 __asm__
__volatile__(
759 __MODULE_JAL(__strnlen_user_nocheck_asm
)
763 : "$2", "$4", "$5", __UA_t0
, "$31");
769 * strlen_user: - Get the size of a string in user space.
770 * @str: The string to measure.
772 * Context: User context only. This function may sleep.
774 * Get the size of a NUL-terminated string in user space.
776 * Returns the size of the string INCLUDING the terminating NUL.
777 * On exception, returns 0.
779 * If there is a limit on the length of a valid string, you may wish to
780 * consider using strnlen_user() instead.
782 static inline long strnlen_user(const char *s
, long n
)
787 __asm__
__volatile__(
790 __MODULE_JAL(__strnlen_user_asm
)
794 : "$2", "$4", "$5", __UA_t0
, "$31");
799 struct exception_table_entry
802 unsigned long nextinsn
;
805 extern int fixup_exception(struct pt_regs
*regs
);
807 #endif /* _ASM_UACCESS_H */