1 #ifndef _ASM_M32R_UACCESS_H
2 #define _ASM_M32R_UACCESS_H
5 * linux/include/asm-m32r/uaccess.h
8 * Copyright (C) 2004, 2006 Hirokazu Takata <takata at linux-m32r.org>
12 * User space memory access functions
14 #include <linux/errno.h>
15 #include <linux/thread_info.h>
19 #define VERIFY_WRITE 1
22 * The fs value determines whether argument validity checking should be
23 * performed or not. If get_fs() == USER_DS, checking is performed, with
24 * get_fs() == KERNEL_DS, checking is bypassed.
26 * For historical reasons, these macros are grossly misnamed.
29 #define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
33 #define KERNEL_DS MAKE_MM_SEG(0xFFFFFFFF)
34 #define USER_DS MAKE_MM_SEG(PAGE_OFFSET)
35 #define get_ds() (KERNEL_DS)
36 #define get_fs() (current_thread_info()->addr_limit)
37 #define set_fs(x) (current_thread_info()->addr_limit = (x))
39 #else /* not CONFIG_MMU */
41 #define KERNEL_DS MAKE_MM_SEG(0xFFFFFFFF)
42 #define USER_DS MAKE_MM_SEG(0xFFFFFFFF)
43 #define get_ds() (KERNEL_DS)
45 static inline mm_segment_t get_fs(void)
50 static inline void set_fs(mm_segment_t s)
54 #endif /* not CONFIG_MMU */
56 #define segment_eq(a,b) ((a).seg == (b).seg)
58 #define __addr_ok(addr) \
59 ((unsigned long)(addr) < (current_thread_info()->addr_limit.seg))
62 * Test whether a block of memory is a valid user space address.
63 * Returns 0 if the range is valid, nonzero otherwise.
65 * This is equivalent to the following test:
66 * (u33)addr + (u33)size >= (u33)current->addr_limit.seg
68 * This needs 33-bit arithmetic. We have a carry...
70 #define __range_ok(addr,size) ({ \
71 unsigned long flag, roksum; \
72 __chk_user_ptr(addr); \
74 " cmpu %1, %1 ; clear cbit\n" \
75 " addx %1, %3 ; set cbit if overflow\n" \
79 : "=&r" (flag), "=r" (roksum) \
80 : "1" (addr), "r" ((int)(size)), \
81 "r" (current_thread_info()->addr_limit.seg), "r" (0) \
86 * access_ok: - Checks if a user space pointer is valid
87 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
88 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
89 * to write to a block, it is always safe to read from it.
90 * @addr: User space pointer to start of block to check
91 * @size: Size of block to check
93 * Context: User context only. This function may sleep.
95 * Checks if a pointer to a block of memory in user space is valid.
97 * Returns true (nonzero) if the memory block may be valid, false (zero)
98 * if it is definitely invalid.
100 * Note that, depending on architecture, this function probably just
101 * checks that the pointer is in the user space range - after calling
102 * this function, memory access functions may still return -EFAULT.
105 #define access_ok(type,addr,size) (likely(__range_ok(addr,size) == 0))
107 static inline int access_ok(int type, const void *addr, unsigned long size)
109 extern unsigned long memory_start, memory_end;
110 unsigned long val = (unsigned long)addr;
112 return ((val >= memory_start) && ((val + size) < memory_end));
114 #endif /* CONFIG_MMU */
117 * The exception table consists of pairs of addresses: the first is the
118 * address of an instruction that is allowed to fault, and the second is
119 * the address at which the program should continue. No registers are
120 * modified, so it is entirely up to the continuation code to figure out
123 * All the routines below use bits of fixup code that are out of line
124 * with the main instruction path. This means when everything is well,
125 * we don't even have to jump over them. Further, they do not intrude
126 * on our cache or tlb entries.
129 struct exception_table_entry
131 unsigned long insn, fixup;
134 extern int fixup_exception(struct pt_regs *regs);
137 * These are the main single-value transfer routines. They automatically
138 * use the right size if we just have the right pointer type.
140 * This gets kind of ugly. We want to return _two_ values in "get_user()"
141 * and yet we don't want to do any pointers, because that is too much
142 * of a performance impact. Thus we have a few rather ugly macros here,
143 * and hide all the uglyness from the user.
145 * The "__xxx" versions of the user access functions are versions that
146 * do not verify the address space, that must have been done previously
147 * with a separate "access_ok()" call (this is used when we do multiple
148 * accesses to the same area of user memory).
151 /* Careful: we have to cast the result to the type of the pointer for sign
154 * get_user: - Get a simple variable from user space.
155 * @x: Variable to store result.
156 * @ptr: Source address, in user space.
158 * Context: User context only. This function may sleep.
160 * This macro copies a single simple variable from user space to kernel
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 the result of
165 * dereferencing @ptr must be assignable to @x without a cast.
167 * Returns zero on success, or -EFAULT on error.
168 * On error, the variable @x is set to zero.
170 #define get_user(x,ptr) \
171 __get_user_check((x),(ptr),sizeof(*(ptr)))
174 * put_user: - Write a simple value into user space.
175 * @x: Value to copy to user space.
176 * @ptr: Destination address, in user space.
178 * Context: User context only. This function may sleep.
180 * This macro copies a single simple value from kernel space to user
181 * space. It supports simple types like char and int, but not larger
182 * data types like structures or arrays.
184 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
185 * to the result of dereferencing @ptr.
187 * Returns zero on success, or -EFAULT on error.
189 #define put_user(x,ptr) \
190 __put_user_check((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
193 * __get_user: - Get a simple variable from user space, with less checking.
194 * @x: Variable to store result.
195 * @ptr: Source address, in user space.
197 * Context: User context only. This function may sleep.
199 * This macro copies a single simple variable from user space to kernel
200 * space. It supports simple types like char and int, but not larger
201 * data types like structures or arrays.
203 * @ptr must have pointer-to-simple-variable type, and the result of
204 * dereferencing @ptr must be assignable to @x without a cast.
206 * Caller must check the pointer with access_ok() before calling this
209 * Returns zero on success, or -EFAULT on error.
210 * On error, the variable @x is set to zero.
212 #define __get_user(x,ptr) \
213 __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
215 #define __get_user_nocheck(x,ptr,size) \
218 unsigned long __gu_val; \
220 __get_user_size(__gu_val,(ptr),(size),__gu_err); \
221 (x) = (__typeof__(*(ptr)))__gu_val; \
225 #define __get_user_check(x,ptr,size) \
227 long __gu_err = -EFAULT; \
228 unsigned long __gu_val = 0; \
229 const __typeof__(*(ptr)) __user *__gu_addr = (ptr); \
231 if (access_ok(VERIFY_READ,__gu_addr,size)) \
232 __get_user_size(__gu_val,__gu_addr,(size),__gu_err); \
233 (x) = (__typeof__(*(ptr)))__gu_val; \
237 extern long __get_user_bad(void);
239 #define __get_user_size(x,ptr,size,retval) \
242 __chk_user_ptr(ptr); \
244 case 1: __get_user_asm(x,ptr,retval,"ub"); break; \
245 case 2: __get_user_asm(x,ptr,retval,"uh"); break; \
246 case 4: __get_user_asm(x,ptr,retval,""); break; \
247 default: (x) = __get_user_bad(); \
251 #define __get_user_asm(x, addr, err, itype) \
252 __asm__ __volatile__( \
254 "1: ld"itype" %1,@%2\n" \
257 ".section .fixup,\"ax\"\n" \
260 " seth r14,#high(2b)\n" \
261 " or3 r14,r14,#low(2b)\n" \
264 ".section __ex_table,\"a\"\n" \
268 : "=&r" (err), "=&r" (x) \
269 : "r" (addr), "i" (-EFAULT), "0" (err) \
273 * __put_user: - Write a simple value into user space, with less checking.
274 * @x: Value to copy to user space.
275 * @ptr: Destination address, in user space.
277 * Context: User context only. This function may sleep.
279 * This macro copies a single simple value from kernel space to user
280 * space. It supports simple types like char and int, but not larger
281 * data types like structures or arrays.
283 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
284 * to the result of dereferencing @ptr.
286 * Caller must check the pointer with access_ok() before calling this
289 * Returns zero on success, or -EFAULT on error.
291 #define __put_user(x,ptr) \
292 __put_user_nocheck((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
295 #define __put_user_nocheck(x,ptr,size) \
299 __put_user_size((x),(ptr),(size),__pu_err); \
304 #define __put_user_check(x,ptr,size) \
306 long __pu_err = -EFAULT; \
307 __typeof__(*(ptr)) __user *__pu_addr = (ptr); \
309 if (access_ok(VERIFY_WRITE,__pu_addr,size)) \
310 __put_user_size((x),__pu_addr,(size),__pu_err); \
314 #if defined(__LITTLE_ENDIAN__)
315 #define __put_user_u64(x, addr, err) \
316 __asm__ __volatile__( \
320 "2: st %H1,@(4,%2)\n" \
323 ".section .fixup,\"ax\"\n" \
326 " seth r14,#high(3b)\n" \
327 " or3 r14,r14,#low(3b)\n" \
330 ".section __ex_table,\"a\"\n" \
336 : "r" (x), "r" (addr), "i" (-EFAULT), "0" (err) \
339 #elif defined(__BIG_ENDIAN__)
340 #define __put_user_u64(x, addr, err) \
341 __asm__ __volatile__( \
345 "2: st %L1,@(4,%2)\n" \
348 ".section .fixup,\"ax\"\n" \
351 " seth r14,#high(3b)\n" \
352 " or3 r14,r14,#low(3b)\n" \
355 ".section __ex_table,\"a\"\n" \
361 : "r" (x), "r" (addr), "i" (-EFAULT), "0" (err) \
364 #error no endian defined
367 extern void __put_user_bad(void);
369 #define __put_user_size(x,ptr,size,retval) \
372 __chk_user_ptr(ptr); \
374 case 1: __put_user_asm(x,ptr,retval,"b"); break; \
375 case 2: __put_user_asm(x,ptr,retval,"h"); break; \
376 case 4: __put_user_asm(x,ptr,retval,""); break; \
377 case 8: __put_user_u64((__typeof__(*ptr))(x),ptr,retval); break;\
378 default: __put_user_bad(); \
382 struct __large_struct { unsigned long buf[100]; };
383 #define __m(x) (*(struct __large_struct *)(x))
386 * Tell gcc we read from memory instead of writing: this is because
387 * we do not write to any memory gcc knows about, so there are no
390 #define __put_user_asm(x, addr, err, itype) \
391 __asm__ __volatile__( \
393 "1: st"itype" %1,@%2\n" \
396 ".section .fixup,\"ax\"\n" \
399 " seth r14,#high(2b)\n" \
400 " or3 r14,r14,#low(2b)\n" \
403 ".section __ex_table,\"a\"\n" \
408 : "r" (x), "r" (addr), "i" (-EFAULT), "0" (err) \
412 * Here we special-case 1, 2 and 4-byte copy_*_user invocations. On a fault
413 * we return the initial request size (1, 2 or 4), as copy_*_user should do.
414 * If a store crosses a page boundary and gets a fault, the m32r will not write
415 * anything, so this is accurate.
419 * Copy To/From Userspace
422 /* Generic arbitrary sized copy. */
423 /* Return the number of bytes NOT copied. */
424 #define __copy_user(to,from,size) \
426 unsigned long __dst, __src, __c; \
427 __asm__ __volatile__ ( \
430 " beq %0, %1, 9f\n" \
432 " and3 r14, r14, #3\n" \
434 " and3 %2, %2, #3\n" \
436 " addi %0, #-4 ; word_copy \n" \
438 "0: ld r14, @%1+\n" \
441 "1: st r14, @+%0\n" \
446 "2: ldb r14, @%1 ; byte_copy \n" \
448 "3: stb r14, @%0\n" \
455 ".section .fixup,\"ax\"\n" \
464 "7: seth r14, #high(9b)\n" \
465 " or3 r14, r14, #low(9b)\n" \
468 ".section __ex_table,\"a\"\n" \
475 : "=&r" (__dst), "=&r" (__src), "=&r" (size), \
477 : "0" (to), "1" (from), "2" (size), "3" (size / 4) \
478 : "r14", "memory"); \
481 #define __copy_user_zeroing(to,from,size) \
483 unsigned long __dst, __src, __c; \
484 __asm__ __volatile__ ( \
487 " beq %0, %1, 9f\n" \
489 " and3 r14, r14, #3\n" \
491 " and3 %2, %2, #3\n" \
493 " addi %0, #-4 ; word_copy \n" \
495 "0: ld r14, @%1+\n" \
498 "1: st r14, @+%0\n" \
503 "2: ldb r14, @%1 ; byte_copy \n" \
505 "3: stb r14, @%0\n" \
512 ".section .fixup,\"ax\"\n" \
521 "7: ldi r14, #0 ; store zero \n" \
523 "8: addi %2, #-1\n" \
524 " stb r14, @%0 ; ACE? \n" \
527 " seth r14, #high(9b)\n" \
528 " or3 r14, r14, #low(9b)\n" \
531 ".section __ex_table,\"a\"\n" \
538 : "=&r" (__dst), "=&r" (__src), "=&r" (size), \
540 : "0" (to), "1" (from), "2" (size), "3" (size / 4) \
541 : "r14", "memory"); \
545 /* We let the __ versions of copy_from/to_user inline, because they're often
546 * used in fast paths and have only a small space overhead.
548 static inline unsigned long __generic_copy_from_user_nocheck(void *to,
549 const void __user *from, unsigned long n)
551 __copy_user_zeroing(to,from,n);
555 static inline unsigned long __generic_copy_to_user_nocheck(void __user *to,
556 const void *from, unsigned long n)
558 __copy_user(to,from,n);
562 unsigned long __generic_copy_to_user(void __user *, const void *, unsigned long);
563 unsigned long __generic_copy_from_user(void *, const void __user *, unsigned long);
566 * __copy_to_user: - Copy a block of data into user space, with less checking.
567 * @to: Destination address, in user space.
568 * @from: Source address, in kernel space.
569 * @n: Number of bytes to copy.
571 * Context: User context only. This function may sleep.
573 * Copy data from kernel space to user space. Caller must check
574 * the specified block with access_ok() before calling this function.
576 * Returns number of bytes that could not be copied.
577 * On success, this will be zero.
579 #define __copy_to_user(to,from,n) \
580 __generic_copy_to_user_nocheck((to),(from),(n))
582 #define __copy_to_user_inatomic __copy_to_user
583 #define __copy_from_user_inatomic __copy_from_user
586 * copy_to_user: - Copy a block of data into user space.
587 * @to: Destination address, in user space.
588 * @from: Source address, in kernel space.
589 * @n: Number of bytes to copy.
591 * Context: User context only. This function may sleep.
593 * Copy data from kernel space to user space.
595 * Returns number of bytes that could not be copied.
596 * On success, this will be zero.
598 #define copy_to_user(to,from,n) \
601 __generic_copy_to_user((to),(from),(n)); \
605 * __copy_from_user: - Copy a block of data from user space, with less checking. * @to: Destination address, in kernel space.
606 * @from: Source address, in user space.
607 * @n: Number of bytes to copy.
609 * Context: User context only. This function may sleep.
611 * Copy data from user space to kernel space. Caller must check
612 * the specified block with access_ok() before calling this function.
614 * Returns number of bytes that could not be copied.
615 * On success, this will be zero.
617 * If some data could not be copied, this function will pad the copied
618 * data to the requested size using zero bytes.
620 #define __copy_from_user(to,from,n) \
621 __generic_copy_from_user_nocheck((to),(from),(n))
624 * copy_from_user: - Copy a block of data from user space.
625 * @to: Destination address, in kernel space.
626 * @from: Source address, in user space.
627 * @n: Number of bytes to copy.
629 * Context: User context only. This function may sleep.
631 * Copy data from user space to kernel space.
633 * Returns number of bytes that could not be copied.
634 * On success, this will be zero.
636 * If some data could not be copied, this function will pad the copied
637 * data to the requested size using zero bytes.
639 #define copy_from_user(to,from,n) \
642 __generic_copy_from_user((to),(from),(n)); \
645 long __must_check strncpy_from_user(char *dst, const char __user *src,
647 long __must_check __strncpy_from_user(char *dst,
648 const char __user *src, long count);
651 * __clear_user: - Zero a block of memory in user space, with less checking.
652 * @to: Destination address, in user space.
653 * @n: Number of bytes to zero.
655 * Zero a block of memory in user space. Caller must check
656 * the specified block with access_ok() before calling this function.
658 * Returns number of bytes that could not be cleared.
659 * On success, this will be zero.
661 unsigned long __clear_user(void __user *mem, unsigned long len);
664 * clear_user: - Zero a block of memory in user space.
665 * @to: Destination address, in user space.
666 * @n: Number of bytes to zero.
668 * Zero a block of memory in user space. Caller must check
669 * the specified block with access_ok() before calling this function.
671 * Returns number of bytes that could not be cleared.
672 * On success, this will be zero.
674 unsigned long clear_user(void __user *mem, unsigned long len);
677 * strlen_user: - Get the size of a string in user space.
678 * @str: The string to measure.
680 * Context: User context only. This function may sleep.
682 * Get the size of a NUL-terminated string in user space.
684 * Returns the size of the string INCLUDING the terminating NUL.
685 * On exception, returns 0.
687 * If there is a limit on the length of a valid string, you may wish to
688 * consider using strnlen_user() instead.
690 #define strlen_user(str) strnlen_user(str, ~0UL >> 1)
691 long strnlen_user(const char __user *str, long n);
693 #endif /* _ASM_M32R_UACCESS_H */