1 #ifndef _ASM_M32R_UACCESS_H
2 #define _ASM_M32R_UACCESS_H
5 * linux/include/asm-m32r/uaccess.h
8 * Copyright (C) 2004 Hirokazu Takata <takata at linux-m32r.org>
14 #define UAPRINTK(args...) printk(args)
16 #define UAPRINTK(args...)
17 #endif /* UACCESS_DEBUG */
20 * User space memory access functions
22 #include <linux/config.h>
23 #include <linux/errno.h>
24 #include <linux/thread_info.h>
28 #define VERIFY_WRITE 1
31 * The fs value determines whether argument validity checking should be
32 * performed or not. If get_fs() == USER_DS, checking is performed, with
33 * get_fs() == KERNEL_DS, checking is bypassed.
35 * For historical reasons, these macros are grossly misnamed.
38 #define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
41 #define KERNEL_DS MAKE_MM_SEG(0xFFFFFFFF)
42 #define USER_DS MAKE_MM_SEG(PAGE_OFFSET)
44 #define KERNEL_DS MAKE_MM_SEG(0xFFFFFFFF)
45 #define USER_DS MAKE_MM_SEG(0xFFFFFFFF)
46 #endif /* CONFIG_MMU */
48 #define get_ds() (KERNEL_DS)
50 #define get_fs() (current_thread_info()->addr_limit)
51 #define set_fs(x) (current_thread_info()->addr_limit = (x))
53 static inline mm_segment_t get_fs(void)
58 static inline void set_fs(mm_segment_t s)
61 #endif /* CONFIG_MMU */
63 #define segment_eq(a,b) ((a).seg == (b).seg)
65 #define __addr_ok(addr) \
66 ((unsigned long)(addr) < (current_thread_info()->addr_limit.seg))
69 * Test whether a block of memory is a valid user space address.
70 * Returns 0 if the range is valid, nonzero otherwise.
72 * This is equivalent to the following test:
73 * (u33)addr + (u33)size >= (u33)current->addr_limit.seg
75 * This needs 33-bit arithmetic. We have a carry...
77 #define __range_ok(addr,size) ({ \
78 unsigned long flag, sum; \
79 __chk_user_ptr(addr); \
81 " cmpu %1, %1 ; clear cbit\n" \
82 " addx %1, %3 ; set cbit if overflow\n" \
86 : "=&r"(flag), "=r"(sum) \
87 : "1"(addr), "r"((int)(size)), \
88 "r"(current_thread_info()->addr_limit.seg), "r"(0) \
93 * access_ok: - Checks if a user space pointer is valid
94 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
95 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
96 * to write to a block, it is always safe to read from it.
97 * @addr: User space pointer to start of block to check
98 * @size: Size of block to check
100 * Context: User context only. This function may sleep.
102 * Checks if a pointer to a block of memory in user space is valid.
104 * Returns true (nonzero) if the memory block may be valid, false (zero)
105 * if it is definitely invalid.
107 * Note that, depending on architecture, this function probably just
108 * checks that the pointer is in the user space range - after calling
109 * this function, memory access functions may still return -EFAULT.
112 #define access_ok(type,addr,size) (likely(__range_ok(addr,size) == 0))
114 static inline int access_ok(int type, const void *addr, unsigned long size)
116 extern unsigned long memory_start, memory_end;
117 unsigned long val = (unsigned long)addr;
119 return ((val >= memory_start) && ((val + size) < memory_end));
121 #endif /* CONFIG_MMU */
124 * verify_area: - Obsolete/deprecated and will go away soon,
125 * use access_ok() instead.
126 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE
127 * @addr: User space pointer to start of block to check
128 * @size: Size of block to check
130 * Context: User context only. This function may sleep.
132 * This function has been replaced by access_ok().
134 * Checks if a pointer to a block of memory in user space is valid.
136 * Returns zero if the memory block may be valid, -EFAULT
137 * if it is definitely invalid.
139 * See access_ok() for more details.
141 static inline int __deprecated verify_area(int type, const void __user *addr,
144 return access_ok(type, addr, size) ? 0 : -EFAULT;
149 * The exception table consists of pairs of addresses: the first is the
150 * address of an instruction that is allowed to fault, and the second is
151 * the address at which the program should continue. No registers are
152 * modified, so it is entirely up to the continuation code to figure out
155 * All the routines below use bits of fixup code that are out of line
156 * with the main instruction path. This means when everything is well,
157 * we don't even have to jump over them. Further, they do not intrude
158 * on our cache or tlb entries.
161 struct exception_table_entry
163 unsigned long insn, fixup;
166 extern int fixup_exception(struct pt_regs *regs);
169 * These are the main single-value transfer routines. They automatically
170 * use the right size if we just have the right pointer type.
172 * This gets kind of ugly. We want to return _two_ values in "get_user()"
173 * and yet we don't want to do any pointers, because that is too much
174 * of a performance impact. Thus we have a few rather ugly macros here,
175 * and hide all the uglyness from the user.
177 * The "__xxx" versions of the user access functions are versions that
178 * do not verify the address space, that must have been done previously
179 * with a separate "access_ok()" call (this is used when we do multiple
180 * accesses to the same area of user memory).
183 extern void __get_user_1(void);
184 extern void __get_user_2(void);
185 extern void __get_user_4(void);
188 #define __get_user_x(size,ret,x,ptr) \
189 __asm__ __volatile__( \
192 " bl __get_user_" #size "\n" \
195 : "=r"(ret), "=r"(x) \
197 : "r0", "r1", "r14" )
200 * Use "jl" instead of "bl" for MODULE
202 #define __get_user_x(size,ret,x,ptr) \
203 __asm__ __volatile__( \
206 " seth lr, #high(__get_user_" #size ")\n" \
207 " or3 lr, lr, #low(__get_user_" #size ")\n" \
211 : "=r"(ret), "=r"(x) \
213 : "r0", "r1", "r14" )
216 /* Careful: we have to cast the result to the type of the pointer for sign
219 * get_user: - Get a simple variable from user space.
220 * @x: Variable to store result.
221 * @ptr: Source address, in user space.
223 * Context: User context only. This function may sleep.
225 * This macro copies a single simple variable from user space to kernel
226 * space. It supports simple types like char and int, but not larger
227 * data types like structures or arrays.
229 * @ptr must have pointer-to-simple-variable type, and the result of
230 * dereferencing @ptr must be assignable to @x without a cast.
232 * Returns zero on success, or -EFAULT on error.
233 * On error, the variable @x is set to zero.
235 #define get_user(x,ptr) \
236 ({ int __ret_gu,__val_gu; \
237 __chk_user_ptr(ptr); \
238 switch(sizeof (*(ptr))) { \
239 case 1: __get_user_x(1,__ret_gu,__val_gu,ptr); break; \
240 case 2: __get_user_x(2,__ret_gu,__val_gu,ptr); break; \
241 case 4: __get_user_x(4,__ret_gu,__val_gu,ptr); break; \
242 default: __get_user_x(X,__ret_gu,__val_gu,ptr); break; \
244 (x) = (__typeof__(*(ptr)))__val_gu; \
248 extern void __put_user_bad(void);
251 * put_user: - Write a simple value into user space.
252 * @x: Value to copy to user space.
253 * @ptr: Destination address, in user space.
255 * Context: User context only. This function may sleep.
257 * This macro copies a single simple value from kernel space to user
258 * space. It supports simple types like char and int, but not larger
259 * data types like structures or arrays.
261 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
262 * to the result of dereferencing @ptr.
264 * Returns zero on success, or -EFAULT on error.
266 #define put_user(x,ptr) \
267 __put_user_check((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
271 * __get_user: - Get a simple variable from user space, with less checking.
272 * @x: Variable to store result.
273 * @ptr: Source address, in user space.
275 * Context: User context only. This function may sleep.
277 * This macro copies a single simple variable from user space to kernel
278 * space. It supports simple types like char and int, but not larger
279 * data types like structures or arrays.
281 * @ptr must have pointer-to-simple-variable type, and the result of
282 * dereferencing @ptr must be assignable to @x without a cast.
284 * Caller must check the pointer with access_ok() before calling this
287 * Returns zero on success, or -EFAULT on error.
288 * On error, the variable @x is set to zero.
290 #define __get_user(x,ptr) \
291 __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
295 * __put_user: - Write a simple value into user space, with less checking.
296 * @x: Value to copy to user space.
297 * @ptr: Destination address, in user space.
299 * Context: User context only. This function may sleep.
301 * This macro copies a single simple value from kernel space to user
302 * space. It supports simple types like char and int, but not larger
303 * data types like structures or arrays.
305 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
306 * to the result of dereferencing @ptr.
308 * Caller must check the pointer with access_ok() before calling this
311 * Returns zero on success, or -EFAULT on error.
313 #define __put_user(x,ptr) \
314 __put_user_nocheck((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
316 #define __put_user_nocheck(x,ptr,size) \
319 __put_user_size((x),(ptr),(size),__pu_err); \
324 #define __put_user_check(x,ptr,size) \
326 long __pu_err = -EFAULT; \
327 __typeof__(*(ptr)) __user *__pu_addr = (ptr); \
329 if (access_ok(VERIFY_WRITE,__pu_addr,size)) \
330 __put_user_size((x),__pu_addr,(size),__pu_err); \
334 #if defined(__LITTLE_ENDIAN__)
335 #define __put_user_u64(x, addr, err) \
336 __asm__ __volatile__( \
340 "2: st %H1,@(4,%2)\n" \
343 ".section .fixup,\"ax\"\n" \
346 " seth r14,#high(3b)\n" \
347 " or3 r14,r14,#low(3b)\n" \
350 ".section __ex_table,\"a\"\n" \
356 : "r"(x), "r"(addr), "i"(-EFAULT), "0"(err) \
359 #elif defined(__BIG_ENDIAN__)
360 #define __put_user_u64(x, addr, err) \
361 __asm__ __volatile__( \
365 "2: st %L1,@(4,%2)\n" \
368 ".section .fixup,\"ax\"\n" \
371 " seth r14,#high(3b)\n" \
372 " or3 r14,r14,#low(3b)\n" \
375 ".section __ex_table,\"a\"\n" \
381 : "r"(x), "r"(addr), "i"(-EFAULT), "0"(err) \
384 #error no endian defined
387 #define __put_user_size(x,ptr,size,retval) \
390 __chk_user_ptr(ptr); \
392 case 1: __put_user_asm(x,ptr,retval,"b"); break; \
393 case 2: __put_user_asm(x,ptr,retval,"h"); break; \
394 case 4: __put_user_asm(x,ptr,retval,""); break; \
395 case 8: __put_user_u64((__typeof__(*ptr))(x),ptr,retval); break;\
396 default: __put_user_bad(); \
400 struct __large_struct { unsigned long buf[100]; };
401 #define __m(x) (*(struct __large_struct *)(x))
404 * Tell gcc we read from memory instead of writing: this is because
405 * we do not write to any memory gcc knows about, so there are no
408 #define __put_user_asm(x, addr, err, itype) \
409 __asm__ __volatile__( \
411 "1: st"itype" %1,@%2\n" \
414 ".section .fixup,\"ax\"\n" \
417 " seth r14,#high(2b)\n" \
418 " or3 r14,r14,#low(2b)\n" \
421 ".section __ex_table,\"a\"\n" \
426 : "r"(x), "r"(addr), "i"(-EFAULT), "0"(err) \
429 #define __get_user_nocheck(x,ptr,size) \
431 long __gu_err, __gu_val; \
432 __get_user_size(__gu_val,(ptr),(size),__gu_err); \
433 (x) = (__typeof__(*(ptr)))__gu_val; \
437 extern long __get_user_bad(void);
439 #define __get_user_size(x,ptr,size,retval) \
442 __chk_user_ptr(ptr); \
444 case 1: __get_user_asm(x,ptr,retval,"ub"); break; \
445 case 2: __get_user_asm(x,ptr,retval,"uh"); break; \
446 case 4: __get_user_asm(x,ptr,retval,""); break; \
447 default: (x) = __get_user_bad(); \
451 #define __get_user_asm(x, addr, err, itype) \
452 __asm__ __volatile__( \
454 "1: ld"itype" %1,@%2\n" \
457 ".section .fixup,\"ax\"\n" \
460 " seth r14,#high(2b)\n" \
461 " or3 r14,r14,#low(2b)\n" \
464 ".section __ex_table,\"a\"\n" \
468 : "=r"(err), "=&r"(x) \
469 : "r"(addr), "i"(-EFAULT), "0"(err) \
473 * Here we special-case 1, 2 and 4-byte copy_*_user invocations. On a fault
474 * we return the initial request size (1, 2 or 4), as copy_*_user should do.
475 * If a store crosses a page boundary and gets a fault, the m32r will not write
476 * anything, so this is accurate.
481 * Copy To/From Userspace
484 /* Generic arbitrary sized copy. */
485 /* Return the number of bytes NOT copied. */
486 #define __copy_user(to,from,size) \
488 unsigned long __dst, __src, __c; \
489 __asm__ __volatile__ ( \
492 " beq %0, %1, 9f\n" \
494 " and3 r14, r14, #3\n" \
496 " and3 %2, %2, #3\n" \
498 " addi %0, #-4 ; word_copy \n" \
500 "0: ld r14, @%1+\n" \
503 "1: st r14, @+%0\n" \
508 "2: ldb r14, @%1 ; byte_copy \n" \
510 "3: stb r14, @%0\n" \
517 ".section .fixup,\"ax\"\n" \
526 "7: seth r14, #high(9b)\n" \
527 " or3 r14, r14, #low(9b)\n" \
530 ".section __ex_table,\"a\"\n" \
537 : "=&r"(__dst), "=&r"(__src), "=&r"(size), "=&r"(__c) \
538 : "0"(to), "1"(from), "2"(size), "3"(size / 4) \
539 : "r14", "memory"); \
542 #define __copy_user_zeroing(to,from,size) \
544 unsigned long __dst, __src, __c; \
545 __asm__ __volatile__ ( \
548 " beq %0, %1, 9f\n" \
550 " and3 r14, r14, #3\n" \
552 " and3 %2, %2, #3\n" \
554 " addi %0, #-4 ; word_copy \n" \
556 "0: ld r14, @%1+\n" \
559 "1: st r14, @+%0\n" \
564 "2: ldb r14, @%1 ; byte_copy \n" \
566 "3: stb r14, @%0\n" \
573 ".section .fixup,\"ax\"\n" \
582 "7: ldi r14, #0 ; store zero \n" \
584 "8: addi %2, #-1\n" \
585 " stb r14, @%0 ; ACE? \n" \
588 " seth r14, #high(9b)\n" \
589 " or3 r14, r14, #low(9b)\n" \
592 ".section __ex_table,\"a\"\n" \
599 : "=&r"(__dst), "=&r"(__src), "=&r"(size), "=&r"(__c) \
600 : "0"(to), "1"(from), "2"(size), "3"(size / 4) \
601 : "r14", "memory"); \
605 /* We let the __ versions of copy_from/to_user inline, because they're often
606 * used in fast paths and have only a small space overhead.
608 static inline unsigned long __generic_copy_from_user_nocheck(void *to,
609 const void __user *from, unsigned long n)
611 __copy_user_zeroing(to,from,n);
615 static inline unsigned long __generic_copy_to_user_nocheck(void __user *to,
616 const void *from, unsigned long n)
618 __copy_user(to,from,n);
622 unsigned long __generic_copy_to_user(void *, const void *, unsigned long);
623 unsigned long __generic_copy_from_user(void *, const void *, unsigned long);
626 * __copy_to_user: - Copy a block of data into user space, with less checking.
627 * @to: Destination address, in user space.
628 * @from: Source address, in kernel space.
629 * @n: Number of bytes to copy.
631 * Context: User context only. This function may sleep.
633 * Copy data from kernel space to user space. Caller must check
634 * the specified block with access_ok() before calling this function.
636 * Returns number of bytes that could not be copied.
637 * On success, this will be zero.
639 #define __copy_to_user(to,from,n) \
640 __generic_copy_to_user_nocheck((to),(from),(n))
642 #define __copy_to_user_inatomic __copy_to_user
643 #define __copy_from_user_inatomic __copy_from_user
646 * copy_to_user: - Copy a block of data into user space.
647 * @to: Destination address, in user space.
648 * @from: Source address, in kernel space.
649 * @n: Number of bytes to copy.
651 * Context: User context only. This function may sleep.
653 * Copy data from kernel space to user space.
655 * Returns number of bytes that could not be copied.
656 * On success, this will be zero.
658 #define copy_to_user(to,from,n) \
661 __generic_copy_to_user((to),(from),(n)); \
665 * __copy_from_user: - Copy a block of data from user space, with less checking. * @to: Destination address, in kernel space.
666 * @from: Source address, in user space.
667 * @n: Number of bytes to copy.
669 * Context: User context only. This function may sleep.
671 * Copy data from user space to kernel space. Caller must check
672 * the specified block with access_ok() before calling this function.
674 * Returns number of bytes that could not be copied.
675 * On success, this will be zero.
677 * If some data could not be copied, this function will pad the copied
678 * data to the requested size using zero bytes.
680 #define __copy_from_user(to,from,n) \
681 __generic_copy_from_user_nocheck((to),(from),(n))
684 * copy_from_user: - Copy a block of data from user space.
685 * @to: Destination address, in kernel space.
686 * @from: Source address, in user space.
687 * @n: Number of bytes to copy.
689 * Context: User context only. This function may sleep.
691 * Copy data from user space to kernel space.
693 * Returns number of bytes that could not be copied.
694 * On success, this will be zero.
696 * If some data could not be copied, this function will pad the copied
697 * data to the requested size using zero bytes.
699 #define copy_from_user(to,from,n) \
702 __generic_copy_from_user((to),(from),(n)); \
705 long __must_check strncpy_from_user(char *dst, const char __user *src,
707 long __must_check __strncpy_from_user(char *dst,
708 const char __user *src, long count);
711 * __clear_user: - Zero a block of memory in user space, with less checking.
712 * @to: Destination address, in user space.
713 * @n: Number of bytes to zero.
715 * Zero a block of memory in user space. Caller must check
716 * the specified block with access_ok() before calling this function.
718 * Returns number of bytes that could not be cleared.
719 * On success, this will be zero.
721 unsigned long __clear_user(void __user *mem, unsigned long len);
724 * clear_user: - Zero a block of memory in user space.
725 * @to: Destination address, in user space.
726 * @n: Number of bytes to zero.
728 * Zero a block of memory in user space. Caller must check
729 * the specified block with access_ok() before calling this function.
731 * Returns number of bytes that could not be cleared.
732 * On success, this will be zero.
734 unsigned long clear_user(void __user *mem, unsigned long len);
737 * strlen_user: - Get the size of a string in user space.
738 * @str: The string to measure.
740 * Context: User context only. This function may sleep.
742 * Get the size of a NUL-terminated string in user space.
744 * Returns the size of the string INCLUDING the terminating NUL.
745 * On exception, returns 0.
747 * If there is a limit on the length of a valid string, you may wish to
748 * consider using strnlen_user() instead.
750 #define strlen_user(str) strnlen_user(str, ~0UL >> 1)
751 long strnlen_user(const char __user *str, long n);
753 #endif /* _ASM_M32R_UACCESS_H */