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(ptr) __get_user_asm("ld", ptr)
208 #define __GET_USER_DW(ptr) __get_user_asm_ll32(ptr)
211 #define __get_user_nocheck(x,ptr,size) \
213 __typeof(*(ptr)) __gu_val = (__typeof(*(ptr))) 0; \
217 case 1: __get_user_asm("lb", ptr); break; \
218 case 2: __get_user_asm("lh", ptr); break; \
219 case 4: __get_user_asm("lw", ptr); break; \
220 case 8: __GET_USER_DW(ptr); break; \
221 default: __get_user_unknown(); break; \
223 (x) = (__typeof__(*(ptr))) __gu_val; \
227 #define __get_user_check(x,ptr,size) \
229 const __typeof__(*(ptr)) __user * __gu_addr = (ptr); \
230 __typeof__(*(ptr)) __gu_val = 0; \
231 long __gu_err = -EFAULT; \
233 if (likely(access_ok(VERIFY_READ, __gu_addr, size))) { \
235 case 1: __get_user_asm("lb", __gu_addr); break; \
236 case 2: __get_user_asm("lh", __gu_addr); break; \
237 case 4: __get_user_asm("lw", __gu_addr); break; \
238 case 8: __GET_USER_DW(__gu_addr); break; \
239 default: __get_user_unknown(); break; \
242 (x) = (__typeof__(*(ptr))) __gu_val; \
246 #define __get_user_asm(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_val) \
259 : "0" (0), "o" (__m(addr)), "i" (-EFAULT)); \
263 * Get a long long 64 using 32 bit registers.
265 #define __get_user_asm_ll32(addr) \
267 __asm__ __volatile__( \
268 "1: lw %1, (%3) \n" \
269 "2: lw %D1, 4(%3) \n" \
271 "3: .section .fixup,\"ax\" \n" \
277 " .section __ex_table,\"a\" \n" \
278 " " __UA_ADDR " 1b, 4b \n" \
279 " " __UA_ADDR " 2b, 4b \n" \
281 : "=r" (__gu_err), "=&r" (__gu_val) \
282 : "0" (0), "r" (addr), "i" (-EFAULT)); \
285 extern void __get_user_unknown(void);
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("sd", ptr)
294 #define __PUT_USER_DW(ptr) __put_user_asm_ll32(ptr)
297 #define __put_user_nocheck(x,ptr,size) \
299 __typeof__(*(ptr)) __pu_val; \
304 case 1: __put_user_asm("sb", ptr); break; \
305 case 2: __put_user_asm("sh", ptr); break; \
306 case 4: __put_user_asm("sw", ptr); break; \
307 case 8: __PUT_USER_DW(ptr); break; \
308 default: __put_user_unknown(); break; \
313 #define __put_user_check(x,ptr,size) \
315 __typeof__(*(ptr)) __user *__pu_addr = (ptr); \
316 __typeof__(*(ptr)) __pu_val = (x); \
317 long __pu_err = -EFAULT; \
319 if (likely(access_ok(VERIFY_WRITE, __pu_addr, size))) { \
321 case 1: __put_user_asm("sb", __pu_addr); break; \
322 case 2: __put_user_asm("sh", __pu_addr); break; \
323 case 4: __put_user_asm("sw", __pu_addr); break; \
324 case 8: __PUT_USER_DW(__pu_addr); break; \
325 default: __put_user_unknown(); break; \
331 #define __put_user_asm(insn, ptr) \
333 __asm__ __volatile__( \
334 "1: " insn " %z2, %3 # __put_user_asm\n" \
336 " .section .fixup,\"ax\" \n" \
340 " .section __ex_table,\"a\" \n" \
341 " " __UA_ADDR " 1b, 3b \n" \
344 : "0" (0), "Jr" (__pu_val), "o" (__m(ptr)), \
348 #define __put_user_asm_ll32(ptr) \
350 __asm__ __volatile__( \
351 "1: sw %2, (%3) # __put_user_asm_ll32 \n" \
352 "2: sw %D2, 4(%3) \n" \
354 " .section .fixup,\"ax\" \n" \
358 " .section __ex_table,\"a\" \n" \
359 " " __UA_ADDR " 1b, 4b \n" \
360 " " __UA_ADDR " 2b, 4b \n" \
363 : "0" (0), "r" (__pu_val), "r" (ptr), \
367 extern void __put_user_unknown(void);
370 * We're generating jump to subroutines which will be outside the range of
374 #define __MODULE_JAL(destination) \
376 __UA_LA "\t$1, " #destination "\n\t" \
380 #define __MODULE_JAL(destination) \
381 "jal\t" #destination "\n\t"
384 extern size_t __copy_user(void *__to
, const void *__from
, size_t __n
);
386 #define __invoke_copy_to_user(to,from,n) \
388 register void __user *__cu_to_r __asm__ ("$4"); \
389 register const void *__cu_from_r __asm__ ("$5"); \
390 register long __cu_len_r __asm__ ("$6"); \
393 __cu_from_r = (from); \
395 __asm__ __volatile__( \
396 __MODULE_JAL(__copy_user) \
397 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
399 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
405 * __copy_to_user: - Copy a block of data into user space, with less checking.
406 * @to: Destination address, in user space.
407 * @from: Source address, in kernel space.
408 * @n: Number of bytes to copy.
410 * Context: User context only. This function may sleep.
412 * Copy data from kernel space to user space. Caller must check
413 * the specified block with access_ok() before calling this function.
415 * Returns number of bytes that could not be copied.
416 * On success, this will be zero.
418 #define __copy_to_user(to,from,n) \
420 void __user *__cu_to; \
421 const void *__cu_from; \
426 __cu_from = (from); \
428 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, __cu_len); \
432 #define __copy_to_user_inatomic __copy_to_user
433 #define __copy_from_user_inatomic __copy_from_user
436 * copy_to_user: - Copy a block of data into user space.
437 * @to: Destination address, in user space.
438 * @from: Source address, in kernel space.
439 * @n: Number of bytes to copy.
441 * Context: User context only. This function may sleep.
443 * Copy data from kernel space to user space.
445 * Returns number of bytes that could not be copied.
446 * On success, this will be zero.
448 #define copy_to_user(to,from,n) \
450 void __user *__cu_to; \
451 const void *__cu_from; \
456 __cu_from = (from); \
458 if (access_ok(VERIFY_WRITE, __cu_to, __cu_len)) \
459 __cu_len = __invoke_copy_to_user(__cu_to, __cu_from, \
464 #define __invoke_copy_from_user(to,from,n) \
466 register void *__cu_to_r __asm__ ("$4"); \
467 register const void __user *__cu_from_r __asm__ ("$5"); \
468 register long __cu_len_r __asm__ ("$6"); \
471 __cu_from_r = (from); \
473 __asm__ __volatile__( \
474 ".set\tnoreorder\n\t" \
475 __MODULE_JAL(__copy_user) \
477 __UA_ADDU "\t$1, %1, %2\n\t" \
480 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
482 : "$8", "$9", "$10", "$11", "$12", "$15", "$24", "$31", \
488 * __copy_from_user: - Copy a block of data from user space, with less checking. * @to: Destination address, in kernel space.
489 * @from: Source address, in user space.
490 * @n: Number of bytes to copy.
492 * Context: User context only. This function may sleep.
494 * Copy data from user space to kernel space. Caller must check
495 * the specified block with access_ok() before calling this function.
497 * Returns number of bytes that could not be copied.
498 * On success, this will be zero.
500 * If some data could not be copied, this function will pad the copied
501 * data to the requested size using zero bytes.
503 #define __copy_from_user(to,from,n) \
506 const void __user *__cu_from; \
511 __cu_from = (from); \
513 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
519 * copy_from_user: - Copy a block of data from user space.
520 * @to: Destination address, in kernel space.
521 * @from: Source address, in user space.
522 * @n: Number of bytes to copy.
524 * Context: User context only. This function may sleep.
526 * Copy data from user space to kernel space.
528 * Returns number of bytes that could not be copied.
529 * On success, this will be zero.
531 * If some data could not be copied, this function will pad the copied
532 * data to the requested size using zero bytes.
534 #define copy_from_user(to,from,n) \
537 const void __user *__cu_from; \
542 __cu_from = (from); \
544 if (access_ok(VERIFY_READ, __cu_from, __cu_len)) \
545 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
550 #define __copy_in_user(to, from, n) __copy_from_user(to, from, n)
552 #define copy_in_user(to,from,n) \
554 void __user *__cu_to; \
555 const void __user *__cu_from; \
560 __cu_from = (from); \
562 if (likely(access_ok(VERIFY_READ, __cu_from, __cu_len) && \
563 access_ok(VERIFY_WRITE, __cu_to, __cu_len))) \
564 __cu_len = __invoke_copy_from_user(__cu_to, __cu_from, \
570 * __clear_user: - Zero a block of memory in user space, with less checking.
571 * @to: Destination address, in user space.
572 * @n: Number of bytes to zero.
574 * Zero a block of memory in user space. Caller must check
575 * the specified block with access_ok() before calling this function.
577 * Returns number of bytes that could not be cleared.
578 * On success, this will be zero.
580 static inline __kernel_size_t
581 __clear_user(void __user
*addr
, __kernel_size_t size
)
586 __asm__
__volatile__(
590 __MODULE_JAL(__bzero
)
593 : "r" (addr
), "r" (size
)
594 : "$4", "$5", "$6", __UA_t0
, __UA_t1
, "$31");
599 #define clear_user(addr,n) \
601 void __user * __cl_addr = (addr); \
602 unsigned long __cl_size = (n); \
603 if (__cl_size && access_ok(VERIFY_WRITE, \
604 ((unsigned long)(__cl_addr)), __cl_size)) \
605 __cl_size = __clear_user(__cl_addr, __cl_size); \
610 * __strncpy_from_user: - Copy a NUL terminated string from userspace, with less checking.
611 * @dst: Destination address, in kernel space. This buffer must be at
612 * least @count bytes long.
613 * @src: Source address, in user space.
614 * @count: Maximum number of bytes to copy, including the trailing NUL.
616 * Copies a NUL-terminated string from userspace to kernel space.
617 * Caller must check the specified block with access_ok() before calling
620 * On success, returns the length of the string (not including the trailing
623 * If access to userspace fails, returns -EFAULT (some data may have been
626 * If @count is smaller than the length of the string, copies @count bytes
627 * and returns @count.
630 __strncpy_from_user(char *__to
, const char __user
*__from
, long __len
)
635 __asm__
__volatile__(
639 __MODULE_JAL(__strncpy_from_user_nocheck_asm
)
642 : "r" (__to
), "r" (__from
), "r" (__len
)
643 : "$2", "$3", "$4", "$5", "$6", __UA_t0
, "$31", "memory");
649 * strncpy_from_user: - Copy a NUL terminated string from userspace.
650 * @dst: Destination address, in kernel space. This buffer must be at
651 * least @count bytes long.
652 * @src: Source address, in user space.
653 * @count: Maximum number of bytes to copy, including the trailing NUL.
655 * Copies a NUL-terminated string from userspace to kernel space.
657 * On success, returns the length of the string (not including the trailing
660 * If access to userspace fails, returns -EFAULT (some data may have been
663 * If @count is smaller than the length of the string, copies @count bytes
664 * and returns @count.
667 strncpy_from_user(char *__to
, const char __user
*__from
, long __len
)
672 __asm__
__volatile__(
676 __MODULE_JAL(__strncpy_from_user_asm
)
679 : "r" (__to
), "r" (__from
), "r" (__len
)
680 : "$2", "$3", "$4", "$5", "$6", __UA_t0
, "$31", "memory");
685 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
686 static inline long __strlen_user(const char __user
*s
)
691 __asm__
__volatile__(
693 __MODULE_JAL(__strlen_user_nocheck_asm
)
697 : "$2", "$4", __UA_t0
, "$31");
703 * strlen_user: - Get the size of a string in user space.
704 * @str: The string to measure.
706 * Context: User context only. This function may sleep.
708 * Get the size of a NUL-terminated string in user space.
710 * Returns the size of the string INCLUDING the terminating NUL.
711 * On exception, returns 0.
713 * If there is a limit on the length of a valid string, you may wish to
714 * consider using strnlen_user() instead.
716 static inline long strlen_user(const char __user
*s
)
721 __asm__
__volatile__(
723 __MODULE_JAL(__strlen_user_asm
)
727 : "$2", "$4", __UA_t0
, "$31");
732 /* Returns: 0 if bad, string length+1 (memory size) of string if ok */
733 static inline long __strnlen_user(const char __user
*s
, long n
)
738 __asm__
__volatile__(
741 __MODULE_JAL(__strnlen_user_nocheck_asm
)
745 : "$2", "$4", "$5", __UA_t0
, "$31");
751 * strlen_user: - Get the size of a string in user space.
752 * @str: The string to measure.
754 * Context: User context only. This function may sleep.
756 * Get the size of a NUL-terminated string in user space.
758 * Returns the size of the string INCLUDING the terminating NUL.
759 * On exception, returns 0.
761 * If there is a limit on the length of a valid string, you may wish to
762 * consider using strnlen_user() instead.
764 static inline long strnlen_user(const char __user
*s
, long n
)
769 __asm__
__volatile__(
772 __MODULE_JAL(__strnlen_user_asm
)
776 : "$2", "$4", "$5", __UA_t0
, "$31");
781 struct exception_table_entry
784 unsigned long nextinsn
;
787 extern int fixup_exception(struct pt_regs
*regs
);
789 #endif /* _ASM_UACCESS_H */