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 __user *)(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(val, ptr) __get_user_asm_ll32(val, ptr)
209 #define __GET_USER_DW(val, ptr) __get_user_asm(val, "ld", ptr)
212 extern void __get_user_unknown(void);
214 #define __get_user_common(val, size, ptr) \
217 case 1: __get_user_asm(val, "lb", ptr); break; \
218 case 2: __get_user_asm(val, "lh", ptr); break; \
219 case 4: __get_user_asm(val, "lw", ptr); break; \
220 case 8: __GET_USER_DW(val, ptr); break; \
221 default: __get_user_unknown(); break; \
225 #define __get_user_nocheck(x,ptr,size) \
229 __get_user_common((x), size, ptr); \
233 #define __get_user_check(x,ptr,size) \
235 long __gu_err = -EFAULT; \
236 const void __user * __gu_ptr = (ptr); \
238 if (likely(access_ok(VERIFY_READ, __gu_ptr, size))) \
239 __get_user_common((x), size, __gu_ptr); \
244 #define __get_user_asm(val, insn, addr) \
248 __asm__ __volatile__( \
249 "1: " insn " %1, %3 \n" \
251 " .section .fixup,\"ax\" \n" \
255 " .section __ex_table,\"a\" \n" \
256 " "__UA_ADDR "\t1b, 3b \n" \
258 : "=r" (__gu_err), "=r" (__gu_tmp) \
259 : "0" (0), "o" (__m(addr)), "i" (-EFAULT)); \
261 (val) = (__typeof__(val)) __gu_tmp; \
265 * Get a long long 64 using 32 bit registers.
267 #define __get_user_asm_ll32(val, addr) \
269 __asm__ __volatile__( \
270 "1: lw %1, (%3) \n" \
271 "2: lw %D1, 4(%3) \n" \
273 "3: .section .fixup,\"ax\" \n" \
279 " .section __ex_table,\"a\" \n" \
280 " " __UA_ADDR " 1b, 4b \n" \
281 " " __UA_ADDR " 2b, 4b \n" \
283 : "=r" (__gu_err), "=&r" (val) \
284 : "0" (0), "r" (addr), "i" (-EFAULT)); \
288 * Yuck. We need two variants, one for 64bit operation and one
289 * for 32 bit mode and old iron.
292 #define __PUT_USER_DW(ptr) __put_user_asm_ll32(ptr)
295 #define __PUT_USER_DW(ptr) __put_user_asm("sd", ptr)
298 #define __put_user_nocheck(x,ptr,size) \
300 __typeof__(*(ptr)) __pu_val; \
305 case 1: __put_user_asm("sb", ptr); break; \
306 case 2: __put_user_asm("sh", ptr); break; \
307 case 4: __put_user_asm("sw", ptr); break; \
308 case 8: __PUT_USER_DW(ptr); break; \
309 default: __put_user_unknown(); break; \
314 #define __put_user_check(x,ptr,size) \
316 __typeof__(*(ptr)) __user *__pu_addr = (ptr); \
317 __typeof__(*(ptr)) __pu_val = (x); \
318 long __pu_err = -EFAULT; \
320 if (likely(access_ok(VERIFY_WRITE, __pu_addr, size))) { \
322 case 1: __put_user_asm("sb", __pu_addr); break; \
323 case 2: __put_user_asm("sh", __pu_addr); break; \
324 case 4: __put_user_asm("sw", __pu_addr); break; \
325 case 8: __PUT_USER_DW(__pu_addr); break; \
326 default: __put_user_unknown(); break; \
332 #define __put_user_asm(insn, ptr) \
334 __asm__ __volatile__( \
335 "1: " insn " %z2, %3 # __put_user_asm\n" \
337 " .section .fixup,\"ax\" \n" \
341 " .section __ex_table,\"a\" \n" \
342 " " __UA_ADDR " 1b, 3b \n" \
345 : "0" (0), "Jr" (__pu_val), "o" (__m(ptr)), \
349 #define __put_user_asm_ll32(ptr) \
351 __asm__ __volatile__( \
352 "1: sw %2, (%3) # __put_user_asm_ll32 \n" \
353 "2: sw %D2, 4(%3) \n" \
355 " .section .fixup,\"ax\" \n" \
359 " .section __ex_table,\"a\" \n" \
360 " " __UA_ADDR " 1b, 4b \n" \
361 " " __UA_ADDR " 2b, 4b \n" \
364 : "0" (0), "r" (__pu_val), "r" (ptr), \
368 extern void __put_user_unknown(void);
371 * We're generating jump to subroutines which will be outside the range of
375 #define __MODULE_JAL(destination) \
377 __UA_LA "\t$1, " #destination "\n\t" \
381 #define __MODULE_JAL(destination) \
382 "jal\t" #destination "\n\t"
385 extern size_t __copy_user(void *__to, const void *__from, size_t __n);
387 #define __invoke_copy_to_user(to,from,n) \
389 register void __user *__cu_to_r __asm__ ("$4"); \
390 register const void *__cu_from_r __asm__ ("$5"); \
391 register long __cu_len_r __asm__ ("$6"); \
394 __cu_from_r = (from); \
396 __asm__ __volatile__( \
397 __MODULE_JAL(__copy_user) \
398 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
400 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
406 * __copy_to_user: - Copy a block of data into user space, with less checking.
407 * @to: Destination address, in user space.
408 * @from: Source address, in kernel space.
409 * @n: Number of bytes to copy.
411 * Context: User context only. This function may sleep.
413 * Copy data from kernel space to user space. Caller must check
414 * the specified block with access_ok() before calling this function.
416 * Returns number of bytes that could not be copied.
417 * On success, this will be zero.
419 #define __copy_to_user(to,from,n) \
421 void __user *__cu_to; \
422 const void *__cu_from; \
427 __cu_from = (from); \
429 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, __cu_len); \
433 #define __copy_to_user_inatomic __copy_to_user
434 #define __copy_from_user_inatomic __copy_from_user
437 * copy_to_user: - Copy a block of data into user space.
438 * @to: Destination address, in user space.
439 * @from: Source address, in kernel space.
440 * @n: Number of bytes to copy.
442 * Context: User context only. This function may sleep.
444 * Copy data from kernel space to user space.
446 * Returns number of bytes that could not be copied.
447 * On success, this will be zero.
449 #define copy_to_user(to,from,n) \
451 void __user *__cu_to; \
452 const void *__cu_from; \
457 __cu_from = (from); \
459 if (access_ok(VERIFY_WRITE, __cu_to, __cu_len)) \
460 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, \
465 #define __invoke_copy_from_user(to,from,n) \
467 register void *__cu_to_r __asm__ ("$4"); \
468 register const void __user *__cu_from_r __asm__ ("$5"); \
469 register long __cu_len_r __asm__ ("$6"); \
472 __cu_from_r = (from); \
474 __asm__ __volatile__( \
475 ".set\tnoreorder\n\t" \
476 __MODULE_JAL(__copy_user) \
478 __UA_ADDU "\t$1, %1, %2\n\t" \
481 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
483 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
489 * __copy_from_user: - Copy a block of data from user space, with less checking. * @to: Destination address, in kernel space.
490 * @from: Source address, in user space.
491 * @n: Number of bytes to copy.
493 * Context: User context only. This function may sleep.
495 * Copy data from user space to kernel space. Caller must check
496 * the specified block with access_ok() before calling this function.
498 * Returns number of bytes that could not be copied.
499 * On success, this will be zero.
501 * If some data could not be copied, this function will pad the copied
502 * data to the requested size using zero bytes.
504 #define __copy_from_user(to,from,n) \
507 const void __user *__cu_from; \
512 __cu_from = (from); \
514 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
520 * copy_from_user: - Copy a block of data from user space.
521 * @to: Destination address, in kernel space.
522 * @from: Source address, in user space.
523 * @n: Number of bytes to copy.
525 * Context: User context only. This function may sleep.
527 * Copy data from user space to kernel space.
529 * Returns number of bytes that could not be copied.
530 * On success, this will be zero.
532 * If some data could not be copied, this function will pad the copied
533 * data to the requested size using zero bytes.
535 #define copy_from_user(to,from,n) \
538 const void __user *__cu_from; \
543 __cu_from = (from); \
545 if (access_ok(VERIFY_READ, __cu_from, __cu_len)) \
546 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
551 #define __copy_in_user(to, from, n) __copy_from_user(to, from, n)
553 #define copy_in_user(to,from,n) \
555 void __user *__cu_to; \
556 const void __user *__cu_from; \
561 __cu_from = (from); \
563 if (likely(access_ok(VERIFY_READ, __cu_from, __cu_len) && \
564 access_ok(VERIFY_WRITE, __cu_to, __cu_len))) \
565 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
571 * __clear_user: - Zero a block of memory in user space, with less checking.
572 * @to: Destination address, in user space.
573 * @n: Number of bytes to zero.
575 * Zero a block of memory in user space. Caller must check
576 * the specified block with access_ok() before calling this function.
578 * Returns number of bytes that could not be cleared.
579 * On success, this will be zero.
581 static inline __kernel_size_t
582 __clear_user(void __user *addr, __kernel_size_t size)
587 __asm__ __volatile__(
591 __MODULE_JAL(__bzero)
594 : "r" (addr), "r" (size)
595 : "$4", "$5", "$6", __UA_t0, __UA_t1, "$31");
600 #define clear_user(addr,n) \
602 void __user * __cl_addr = (addr); \
603 unsigned long __cl_size = (n); \
604 if (__cl_size && access_ok(VERIFY_WRITE, \
605 ((unsigned long)(__cl_addr)), __cl_size)) \
606 __cl_size = __clear_user(__cl_addr, __cl_size); \
611 * __strncpy_from_user: - Copy a NUL terminated string from userspace, with less checking.
612 * @dst: Destination address, in kernel space. This buffer must be at
613 * least @count bytes long.
614 * @src: Source address, in user space.
615 * @count: Maximum number of bytes to copy, including the trailing NUL.
617 * Copies a NUL-terminated string from userspace to kernel space.
618 * Caller must check the specified block with access_ok() before calling
621 * On success, returns the length of the string (not including the trailing
624 * If access to userspace fails, returns -EFAULT (some data may have been
627 * If @count is smaller than the length of the string, copies @count bytes
628 * and returns @count.
631 __strncpy_from_user(char *__to, const char __user *__from, long __len)
636 __asm__ __volatile__(
640 __MODULE_JAL(__strncpy_from_user_nocheck_asm)
643 : "r" (__to), "r" (__from), "r" (__len)
644 : "$2", "$3", "$4", "$5", "$6", __UA_t0, "$31", "memory");
650 * strncpy_from_user: - Copy a NUL terminated string from userspace.
651 * @dst: Destination address, in kernel space. This buffer must be at
652 * least @count bytes long.
653 * @src: Source address, in user space.
654 * @count: Maximum number of bytes to copy, including the trailing NUL.
656 * Copies a NUL-terminated string from userspace to kernel space.
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 __user *__from, long __len)
673 __asm__ __volatile__(
677 __MODULE_JAL(__strncpy_from_user_asm)
680 : "r" (__to), "r" (__from), "r" (__len)
681 : "$2", "$3", "$4", "$5", "$6", __UA_t0, "$31", "memory");
686 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
687 static inline long __strlen_user(const char __user *s)
692 __asm__ __volatile__(
694 __MODULE_JAL(__strlen_user_nocheck_asm)
698 : "$2", "$4", __UA_t0, "$31");
704 * strlen_user: - Get the size of a string in user space.
705 * @str: The string to measure.
707 * Context: User context only. This function may sleep.
709 * Get the size of a NUL-terminated string in user space.
711 * Returns the size of the string INCLUDING the terminating NUL.
712 * On exception, returns 0.
714 * If there is a limit on the length of a valid string, you may wish to
715 * consider using strnlen_user() instead.
717 static inline long strlen_user(const char __user *s)
722 __asm__ __volatile__(
724 __MODULE_JAL(__strlen_user_asm)
728 : "$2", "$4", __UA_t0, "$31");
733 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
734 static inline long __strnlen_user(const char __user *s, long n)
739 __asm__ __volatile__(
742 __MODULE_JAL(__strnlen_user_nocheck_asm)
746 : "$2", "$4", "$5", __UA_t0, "$31");
752 * strlen_user: - Get the size of a string in user space.
753 * @str: The string to measure.
755 * Context: User context only. This function may sleep.
757 * Get the size of a NUL-terminated string in user space.
759 * Returns the size of the string INCLUDING the terminating NUL.
760 * On exception, returns 0.
762 * If there is a limit on the length of a valid string, you may wish to
763 * consider using strnlen_user() instead.
765 static inline long strnlen_user(const char __user *s, long n)
770 __asm__ __volatile__(
773 __MODULE_JAL(__strnlen_user_asm)
777 : "$2", "$4", "$5", __UA_t0, "$31");
782 struct exception_table_entry
785 unsigned long nextinsn;
788 extern int fixup_exception(struct pt_regs *regs);
790 #endif /* _ASM_UACCESS_H */