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_MIPS32 */
39 #define __UA_LIMIT (- TASK_SIZE)
41 #define __UA_ADDR ".dword"
43 #define __UA_ADDU "daddu"
47 #endif /* CONFIG_MIPS64 */
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 * verify_area: - Obsolete, use access_ok()
116 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE
117 * @addr: User space pointer to start of block to check
118 * @size: Size of block to check
120 * Context: User context only. This function may sleep.
122 * This function has been replaced by access_ok().
124 * Checks if a pointer to a block of memory in user space is valid.
126 * Returns zero if the memory block may be valid, -EFAULT
127 * if it is definitely invalid.
129 * See access_ok() for more details.
131 static inline int verify_area(int type, const void * addr, unsigned long size)
133 return access_ok(type, addr, size) ? 0 : -EFAULT;
137 * put_user: - Write a simple value into user space.
138 * @x: Value to copy to user space.
139 * @ptr: Destination address, in user space.
141 * Context: User context only. This function may sleep.
143 * This macro copies a single simple value from kernel space to user
144 * space. It supports simple types like char and int, but not larger
145 * data types like structures or arrays.
147 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
148 * to the result of dereferencing @ptr.
150 * Returns zero on success, or -EFAULT on error.
152 #define put_user(x,ptr) \
153 __put_user_check((x),(ptr),sizeof(*(ptr)))
156 * get_user: - Get a simple variable from user space.
157 * @x: Variable to store result.
158 * @ptr: Source address, in user space.
160 * Context: User context only. This function may sleep.
162 * This macro copies a single simple variable from user space to kernel
163 * space. It supports simple types like char and int, but not larger
164 * data types like structures or arrays.
166 * @ptr must have pointer-to-simple-variable type, and the result of
167 * dereferencing @ptr must be assignable to @x without a cast.
169 * Returns zero on success, or -EFAULT on error.
170 * On error, the variable @x is set to zero.
172 #define get_user(x,ptr) \
173 __get_user_check((x),(ptr),sizeof(*(ptr)))
176 * __put_user: - Write a simple value into user space, with less checking.
177 * @x: Value to copy to user space.
178 * @ptr: Destination address, in user space.
180 * Context: User context only. This function may sleep.
182 * This macro copies a single simple value from kernel space to user
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 @x must be assignable
187 * to the result of dereferencing @ptr.
189 * Caller must check the pointer with access_ok() before calling this
192 * Returns zero on success, or -EFAULT on error.
194 #define __put_user(x,ptr) \
195 __put_user_nocheck((x),(ptr),sizeof(*(ptr)))
198 * __get_user: - Get a simple variable from user space, with less checking.
199 * @x: Variable to store result.
200 * @ptr: Source address, in user space.
202 * Context: User context only. This function may sleep.
204 * This macro copies a single simple variable from user space to kernel
205 * space. It supports simple types like char and int, but not larger
206 * data types like structures or arrays.
208 * @ptr must have pointer-to-simple-variable type, and the result of
209 * dereferencing @ptr must be assignable to @x without a cast.
211 * Caller must check the pointer with access_ok() before calling this
214 * Returns zero on success, or -EFAULT on error.
215 * On error, the variable @x is set to zero.
217 #define __get_user(x,ptr) \
218 __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
220 struct __large_struct { unsigned long buf[100]; };
221 #define __m(x) (*(struct __large_struct *)(x))
224 * Yuck. We need two variants, one for 64bit operation and one
225 * for 32 bit mode and old iron.
228 #define __GET_USER_DW(__gu_err) __get_user_asm("ld", __gu_err)
230 #define __GET_USER_DW(__gu_err) __get_user_asm_ll32(__gu_err)
233 #define __get_user_nocheck(x,ptr,size) \
235 __typeof(*(ptr)) __gu_val = 0; \
240 __gu_addr = (long) (ptr); \
242 case 1: __get_user_asm("lb", __gu_err); break; \
243 case 2: __get_user_asm("lh", __gu_err); break; \
244 case 4: __get_user_asm("lw", __gu_err); break; \
245 case 8: __GET_USER_DW(__gu_err); break; \
246 default: __get_user_unknown(); break; \
248 x = (__typeof__(*(ptr))) __gu_val; \
252 #define __get_user_check(x,ptr,size) \
254 __typeof__(*(ptr)) __gu_val = 0; \
259 __gu_addr = (long) (ptr); \
260 __gu_err = verify_area(VERIFY_READ, (void *) __gu_addr, size); \
262 if (likely(!__gu_err)) { \
264 case 1: __get_user_asm("lb", __gu_err); break; \
265 case 2: __get_user_asm("lh", __gu_err); break; \
266 case 4: __get_user_asm("lw", __gu_err); break; \
267 case 8: __GET_USER_DW(__gu_err); break; \
268 default: __get_user_unknown(); break; \
271 x = (__typeof__(*(ptr))) __gu_val; \
275 #define __get_user_asm(insn,__gu_err) \
277 __asm__ __volatile__( \
278 "1: " insn " %1, %3 \n" \
280 " .section .fixup,\"ax\" \n" \
284 " .section __ex_table,\"a\" \n" \
285 " "__UA_ADDR "\t1b, 3b \n" \
287 : "=r" (__gu_err), "=r" (__gu_val) \
288 : "0" (__gu_err), "o" (__m(__gu_addr)), "i" (-EFAULT)); \
292 * Get a long long 64 using 32 bit registers.
294 #define __get_user_asm_ll32(__gu_err) \
296 __asm__ __volatile__( \
300 "3: .section .fixup,\"ax\" \n" \
306 " .section __ex_table,\"a\" \n" \
307 " " __UA_ADDR " 1b, 4b \n" \
308 " " __UA_ADDR " 2b, 4b \n" \
310 : "=r" (__gu_err), "=&r" (__gu_val) \
311 : "0" (__gu_err), "o" (__m(__gu_addr)), \
312 "o" (__m(__gu_addr + 4)), "i" (-EFAULT)); \
315 extern void __get_user_unknown(void);
318 * Yuck. We need two variants, one for 64bit operation and one
319 * for 32 bit mode and old iron.
322 #define __PUT_USER_DW(__pu_val) __put_user_asm("sd", __pu_val)
324 #define __PUT_USER_DW(__pu_val) __put_user_asm_ll32(__pu_val)
327 #define __put_user_nocheck(x,ptr,size) \
329 __typeof__(*(ptr)) __pu_val; \
335 __pu_addr = (long) (ptr); \
337 case 1: __put_user_asm("sb", __pu_val); break; \
338 case 2: __put_user_asm("sh", __pu_val); break; \
339 case 4: __put_user_asm("sw", __pu_val); break; \
340 case 8: __PUT_USER_DW(__pu_val); break; \
341 default: __put_user_unknown(); break; \
346 #define __put_user_check(x,ptr,size) \
348 __typeof__(*(ptr)) __pu_val; \
354 __pu_addr = (long) (ptr); \
355 __pu_err = verify_area(VERIFY_WRITE, (void *) __pu_addr, size); \
357 if (likely(!__pu_err)) { \
359 case 1: __put_user_asm("sb", __pu_val); break; \
360 case 2: __put_user_asm("sh", __pu_val); break; \
361 case 4: __put_user_asm("sw", __pu_val); break; \
362 case 8: __PUT_USER_DW(__pu_val); break; \
363 default: __put_user_unknown(); break; \
369 #define __put_user_asm(insn, __pu_val) \
371 __asm__ __volatile__( \
372 "1: " insn " %z2, %3 # __put_user_asm\n" \
374 " .section .fixup,\"ax\" \n" \
378 " .section __ex_table,\"a\" \n" \
379 " " __UA_ADDR " 1b, 3b \n" \
382 : "0" (__pu_err), "Jr" (__pu_val), "o" (__m(__pu_addr)), \
386 #define __put_user_asm_ll32(__pu_val) \
388 __asm__ __volatile__( \
389 "1: sw %2, %3 # __put_user_asm_ll32 \n" \
392 " .section .fixup,\"ax\" \n" \
396 " .section __ex_table,\"a\" \n" \
397 " " __UA_ADDR " 1b, 4b \n" \
398 " " __UA_ADDR " 2b, 4b \n" \
401 : "0" (__pu_err), "r" (__pu_val), "o" (__m(__pu_addr)), \
402 "o" (__m(__pu_addr + 4)), "i" (-EFAULT)); \
405 extern void __put_user_unknown(void);
408 * We're generating jump to subroutines which will be outside the range of
412 #define __MODULE_JAL(destination) \
414 __UA_LA "\t$1, " #destination "\n\t" \
418 #define __MODULE_JAL(destination) \
419 "jal\t" #destination "\n\t"
422 extern size_t __copy_user(void *__to, const void *__from, size_t __n);
424 #define __invoke_copy_to_user(to,from,n) \
426 register void *__cu_to_r __asm__ ("$4"); \
427 register const void *__cu_from_r __asm__ ("$5"); \
428 register long __cu_len_r __asm__ ("$6"); \
431 __cu_from_r = (from); \
433 __asm__ __volatile__( \
434 __MODULE_JAL(__copy_user) \
435 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
437 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
443 * __copy_to_user: - Copy a block of data into user space, with less checking.
444 * @to: Destination address, in user space.
445 * @from: Source address, in kernel space.
446 * @n: Number of bytes to copy.
448 * Context: User context only. This function may sleep.
450 * Copy data from kernel space to user space. Caller must check
451 * the specified block with access_ok() before calling this function.
453 * Returns number of bytes that could not be copied.
454 * On success, this will be zero.
456 #define __copy_to_user(to,from,n) \
459 const void *__cu_from; \
464 __cu_from = (from); \
466 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, __cu_len); \
470 #define __copy_to_user_inatomic __copy_to_user
471 #define __copy_from_user_inatomic __copy_from_user
474 * copy_to_user: - Copy a block of data into user space.
475 * @to: Destination address, in user space.
476 * @from: Source address, in kernel space.
477 * @n: Number of bytes to copy.
479 * Context: User context only. This function may sleep.
481 * Copy data from kernel space to user space.
483 * Returns number of bytes that could not be copied.
484 * On success, this will be zero.
486 #define copy_to_user(to,from,n) \
489 const void *__cu_from; \
494 __cu_from = (from); \
496 if (access_ok(VERIFY_WRITE, __cu_to, __cu_len)) \
497 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, \
502 #define __invoke_copy_from_user(to,from,n) \
504 register void *__cu_to_r __asm__ ("$4"); \
505 register const void *__cu_from_r __asm__ ("$5"); \
506 register long __cu_len_r __asm__ ("$6"); \
509 __cu_from_r = (from); \
511 __asm__ __volatile__( \
512 ".set\tnoreorder\n\t" \
513 __MODULE_JAL(__copy_user) \
515 __UA_ADDU "\t$1, %1, %2\n\t" \
518 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
520 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
526 * __copy_from_user: - Copy a block of data from user space, with less checking. * @to: Destination address, in kernel space.
527 * @from: Source address, in user space.
528 * @n: Number of bytes to copy.
530 * Context: User context only. This function may sleep.
532 * Copy data from user space to kernel space. Caller must check
533 * the specified block with access_ok() before calling this function.
535 * Returns number of bytes that could not be copied.
536 * On success, this will be zero.
538 * If some data could not be copied, this function will pad the copied
539 * data to the requested size using zero bytes.
541 #define __copy_from_user(to,from,n) \
544 const void *__cu_from; \
549 __cu_from = (from); \
551 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
557 * copy_from_user: - Copy a block of data from user space.
558 * @to: Destination address, in kernel space.
559 * @from: Source address, in user space.
560 * @n: Number of bytes to copy.
562 * Context: User context only. This function may sleep.
564 * Copy data from user space to kernel space.
566 * Returns number of bytes that could not be copied.
567 * On success, this will be zero.
569 * If some data could not be copied, this function will pad the copied
570 * data to the requested size using zero bytes.
572 #define copy_from_user(to,from,n) \
575 const void *__cu_from; \
580 __cu_from = (from); \
582 if (access_ok(VERIFY_READ, __cu_from, __cu_len)) \
583 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
588 #define __copy_in_user(to, from, n) __copy_from_user(to, from, n)
590 #define copy_in_user(to,from,n) \
593 const void *__cu_from; \
598 __cu_from = (from); \
600 if (likely(access_ok(VERIFY_READ, __cu_from, __cu_len) && \
601 access_ok(VERIFY_WRITE, __cu_to, __cu_len))) \
602 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
608 * __clear_user: - Zero a block of memory in user space, with less checking.
609 * @to: Destination address, in user space.
610 * @n: Number of bytes to zero.
612 * Zero a block of memory in user space. Caller must check
613 * the specified block with access_ok() before calling this function.
615 * Returns number of bytes that could not be cleared.
616 * On success, this will be zero.
618 static inline __kernel_size_t
619 __clear_user(void *addr, __kernel_size_t size)
624 __asm__ __volatile__(
628 __MODULE_JAL(__bzero)
631 : "r" (addr), "r" (size)
632 : "$4", "$5", "$6", __UA_t0, __UA_t1, "$31");
637 #define clear_user(addr,n) \
639 void * __cl_addr = (addr); \
640 unsigned long __cl_size = (n); \
641 if (__cl_size && access_ok(VERIFY_WRITE, \
642 ((unsigned long)(__cl_addr)), __cl_size)) \
643 __cl_size = __clear_user(__cl_addr, __cl_size); \
648 * __strncpy_from_user: - Copy a NUL terminated string from userspace, with less checking.
649 * @dst: Destination address, in kernel space. This buffer must be at
650 * least @count bytes long.
651 * @src: Source address, in user space.
652 * @count: Maximum number of bytes to copy, including the trailing NUL.
654 * Copies a NUL-terminated string from userspace to kernel space.
655 * Caller must check the specified block with access_ok() before calling
658 * On success, returns the length of the string (not including the trailing
661 * If access to userspace fails, returns -EFAULT (some data may have been
664 * If @count is smaller than the length of the string, copies @count bytes
665 * and returns @count.
668 __strncpy_from_user(char *__to, const char *__from, long __len)
673 __asm__ __volatile__(
677 __MODULE_JAL(__strncpy_from_user_nocheck_asm)
680 : "r" (__to), "r" (__from), "r" (__len)
681 : "$2", "$3", "$4", "$5", "$6", __UA_t0, "$31", "memory");
687 * strncpy_from_user: - Copy a NUL terminated string from userspace.
688 * @dst: Destination address, in kernel space. This buffer must be at
689 * least @count bytes long.
690 * @src: Source address, in user space.
691 * @count: Maximum number of bytes to copy, including the trailing NUL.
693 * Copies a NUL-terminated string from userspace to kernel space.
695 * On success, returns the length of the string (not including the trailing
698 * If access to userspace fails, returns -EFAULT (some data may have been
701 * If @count is smaller than the length of the string, copies @count bytes
702 * and returns @count.
705 strncpy_from_user(char *__to, const char *__from, long __len)
710 __asm__ __volatile__(
714 __MODULE_JAL(__strncpy_from_user_asm)
717 : "r" (__to), "r" (__from), "r" (__len)
718 : "$2", "$3", "$4", "$5", "$6", __UA_t0, "$31", "memory");
723 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
724 static inline long __strlen_user(const char *s)
729 __asm__ __volatile__(
731 __MODULE_JAL(__strlen_user_nocheck_asm)
735 : "$2", "$4", __UA_t0, "$31");
741 * strlen_user: - Get the size of a string in user space.
742 * @str: The string to measure.
744 * Context: User context only. This function may sleep.
746 * Get the size of a NUL-terminated string in user space.
748 * Returns the size of the string INCLUDING the terminating NUL.
749 * On exception, returns 0.
751 * If there is a limit on the length of a valid string, you may wish to
752 * consider using strnlen_user() instead.
754 static inline long strlen_user(const char *s)
759 __asm__ __volatile__(
761 __MODULE_JAL(__strlen_user_asm)
765 : "$2", "$4", __UA_t0, "$31");
770 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
771 static inline long __strnlen_user(const char *s, long n)
776 __asm__ __volatile__(
779 __MODULE_JAL(__strnlen_user_nocheck_asm)
783 : "$2", "$4", "$5", __UA_t0, "$31");
789 * strlen_user: - Get the size of a string in user space.
790 * @str: The string to measure.
792 * Context: User context only. This function may sleep.
794 * Get the size of a NUL-terminated string in user space.
796 * Returns the size of the string INCLUDING the terminating NUL.
797 * On exception, returns 0.
799 * If there is a limit on the length of a valid string, you may wish to
800 * consider using strnlen_user() instead.
802 static inline long strnlen_user(const char *s, long n)
807 __asm__ __volatile__(
810 __MODULE_JAL(__strnlen_user_asm)
814 : "$2", "$4", "$5", __UA_t0, "$31");
819 struct exception_table_entry
822 unsigned long nextinsn;
825 extern int fixup_exception(struct pt_regs *regs);
827 #endif /* _ASM_UACCESS_H */