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.
8 * Copyright (C) 2007 Maciej W. Rozycki
9 * Copyright (C) 2014, Imagination Technologies Ltd.
11 #ifndef _ASM_UACCESS_H
12 #define _ASM_UACCESS_H
14 #include <linux/kernel.h>
15 #include <linux/string.h>
16 #include <asm/asm-eva.h>
17 #include <asm/extable.h>
20 * The fs value determines whether argument validity checking should be
21 * performed or not. If get_fs() == USER_DS, checking is performed, with
22 * get_fs() == KERNEL_DS, checking is bypassed.
24 * For historical reasons, these macros are grossly misnamed.
28 #ifdef CONFIG_KVM_GUEST
29 #define __UA_LIMIT 0x40000000UL
31 #define __UA_LIMIT 0x80000000UL
34 #define __UA_ADDR ".word"
36 #define __UA_ADDU "addu"
40 #endif /* CONFIG_32BIT */
44 extern u64 __ua_limit
;
46 #define __UA_LIMIT __ua_limit
48 #define __UA_ADDR ".dword"
50 #define __UA_ADDU "daddu"
54 #endif /* CONFIG_64BIT */
57 * USER_DS is a bitmask that has the bits set that may not be set in a valid
58 * userspace address. Note that we limit 32-bit userspace to 0x7fff8000 but
59 * the arithmetic we're doing only works if the limit is a power of two, so
60 * we use 0x80000000 here on 32-bit kernels. If a process passes an invalid
61 * address in this range it's the process's problem, not ours :-)
64 #ifdef CONFIG_KVM_GUEST
65 #define KERNEL_DS ((mm_segment_t) { 0x80000000UL })
66 #define USER_DS ((mm_segment_t) { 0xC0000000UL })
68 #define KERNEL_DS ((mm_segment_t) { 0UL })
69 #define USER_DS ((mm_segment_t) { __UA_LIMIT })
72 #define get_ds() (KERNEL_DS)
73 #define get_fs() (current_thread_info()->addr_limit)
74 #define set_fs(x) (current_thread_info()->addr_limit = (x))
76 #define segment_eq(a, b) ((a).seg == (b).seg)
79 * eva_kernel_access() - determine whether kernel memory access on an EVA system
81 * Determines whether memory accesses should be performed to kernel memory
82 * on a system using Extended Virtual Addressing (EVA).
84 * Return: true if a kernel memory access on an EVA system, else false.
86 static inline bool eva_kernel_access(void)
88 if (!IS_ENABLED(CONFIG_EVA
))
91 return uaccess_kernel();
95 * Is a address valid? This does a straightforward calculation rather
99 * - "addr" doesn't have any high-bits set
100 * - AND "size" doesn't have any high-bits set
101 * - AND "addr+size" doesn't have any high-bits set
102 * - OR we are in kernel mode.
104 * __ua_size() is a trick to avoid runtime checking of positive constant
105 * sizes; for those we already know at compile time that the size is ok.
107 #define __ua_size(size) \
108 ((__builtin_constant_p(size) && (signed long) (size) > 0) ? 0 : (size))
111 * access_ok: - Checks if a user space pointer is valid
112 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
113 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
114 * to write to a block, it is always safe to read from it.
115 * @addr: User space pointer to start of block to check
116 * @size: Size of block to check
118 * Context: User context only. This function may sleep if pagefaults are
121 * Checks if a pointer to a block of memory in user space is valid.
123 * Returns true (nonzero) if the memory block may be valid, false (zero)
124 * if it is definitely invalid.
126 * Note that, depending on architecture, this function probably just
127 * checks that the pointer is in the user space range - after calling
128 * this function, memory access functions may still return -EFAULT.
131 static inline int __access_ok(const void __user
*p
, unsigned long size
)
133 unsigned long addr
= (unsigned long)p
;
134 return (get_fs().seg
& (addr
| (addr
+ size
) | __ua_size(size
))) == 0;
137 #define access_ok(type, addr, size) \
138 likely(__access_ok((addr), (size)))
141 * put_user: - Write a simple value into user space.
142 * @x: Value to copy to user space.
143 * @ptr: Destination address, in user space.
145 * Context: User context only. This function may sleep if pagefaults are
148 * This macro copies a single simple value from kernel space to user
149 * space. It supports simple types like char and int, but not larger
150 * data types like structures or arrays.
152 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
153 * to the result of dereferencing @ptr.
155 * Returns zero on success, or -EFAULT on error.
157 #define put_user(x,ptr) \
158 __put_user_check((x), (ptr), sizeof(*(ptr)))
161 * get_user: - Get a simple variable from user space.
162 * @x: Variable to store result.
163 * @ptr: Source address, in user space.
165 * Context: User context only. This function may sleep if pagefaults are
168 * This macro copies a single simple variable from user space to kernel
169 * space. It supports simple types like char and int, but not larger
170 * data types like structures or arrays.
172 * @ptr must have pointer-to-simple-variable type, and the result of
173 * dereferencing @ptr must be assignable to @x without a cast.
175 * Returns zero on success, or -EFAULT on error.
176 * On error, the variable @x is set to zero.
178 #define get_user(x,ptr) \
179 __get_user_check((x), (ptr), sizeof(*(ptr)))
182 * __put_user: - Write a simple value into user space, with less checking.
183 * @x: Value to copy to user space.
184 * @ptr: Destination address, in user space.
186 * Context: User context only. This function may sleep if pagefaults are
189 * This macro copies a single simple value from kernel space to user
190 * space. It supports simple types like char and int, but not larger
191 * data types like structures or arrays.
193 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
194 * to the result of dereferencing @ptr.
196 * Caller must check the pointer with access_ok() before calling this
199 * Returns zero on success, or -EFAULT on error.
201 #define __put_user(x,ptr) \
202 __put_user_nocheck((x), (ptr), sizeof(*(ptr)))
205 * __get_user: - Get a simple variable from user space, with less checking.
206 * @x: Variable to store result.
207 * @ptr: Source address, in user space.
209 * Context: User context only. This function may sleep if pagefaults are
212 * This macro copies a single simple variable from user space to kernel
213 * space. It supports simple types like char and int, but not larger
214 * data types like structures or arrays.
216 * @ptr must have pointer-to-simple-variable type, and the result of
217 * dereferencing @ptr must be assignable to @x without a cast.
219 * Caller must check the pointer with access_ok() before calling this
222 * Returns zero on success, or -EFAULT on error.
223 * On error, the variable @x is set to zero.
225 #define __get_user(x,ptr) \
226 __get_user_nocheck((x), (ptr), sizeof(*(ptr)))
228 struct __large_struct
{ unsigned long buf
[100]; };
229 #define __m(x) (*(struct __large_struct __user *)(x))
232 * Yuck. We need two variants, one for 64bit operation and one
233 * for 32 bit mode and old iron.
236 #define __get_kernel_common(val, size, ptr) __get_user_common(val, size, ptr)
239 * Kernel specific functions for EVA. We need to use normal load instructions
240 * to read data from kernel when operating in EVA mode. We use these macros to
241 * avoid redefining __get_user_asm for EVA.
248 #define _loadd _loadw
250 #define _loadd(reg, addr) "ld " reg ", " addr
252 #define _loadw(reg, addr) "lw " reg ", " addr
253 #define _loadh(reg, addr) "lh " reg ", " addr
254 #define _loadb(reg, addr) "lb " reg ", " addr
256 #define __get_kernel_common(val, size, ptr) \
259 case 1: __get_data_asm(val, _loadb, ptr); break; \
260 case 2: __get_data_asm(val, _loadh, ptr); break; \
261 case 4: __get_data_asm(val, _loadw, ptr); break; \
262 case 8: __GET_DW(val, _loadd, ptr); break; \
263 default: __get_user_unknown(); break; \
269 #define __GET_DW(val, insn, ptr) __get_data_asm_ll32(val, insn, ptr)
272 #define __GET_DW(val, insn, ptr) __get_data_asm(val, insn, ptr)
275 extern void __get_user_unknown(void);
277 #define __get_user_common(val, size, ptr) \
280 case 1: __get_data_asm(val, user_lb, ptr); break; \
281 case 2: __get_data_asm(val, user_lh, ptr); break; \
282 case 4: __get_data_asm(val, user_lw, ptr); break; \
283 case 8: __GET_DW(val, user_ld, ptr); break; \
284 default: __get_user_unknown(); break; \
288 #define __get_user_nocheck(x, ptr, size) \
292 if (eva_kernel_access()) { \
293 __get_kernel_common((x), size, ptr); \
295 __chk_user_ptr(ptr); \
296 __get_user_common((x), size, ptr); \
301 #define __get_user_check(x, ptr, size) \
303 int __gu_err = -EFAULT; \
304 const __typeof__(*(ptr)) __user * __gu_ptr = (ptr); \
307 if (likely(access_ok(VERIFY_READ, __gu_ptr, size))) { \
308 if (eva_kernel_access()) \
309 __get_kernel_common((x), size, __gu_ptr); \
311 __get_user_common((x), size, __gu_ptr); \
318 #define __get_data_asm(val, insn, addr) \
322 __asm__ __volatile__( \
323 "1: "insn("%1", "%3")" \n" \
326 " .section .fixup,\"ax\" \n" \
331 " .section __ex_table,\"a\" \n" \
332 " "__UA_ADDR "\t1b, 3b \n" \
334 : "=r" (__gu_err), "=r" (__gu_tmp) \
335 : "0" (0), "o" (__m(addr)), "i" (-EFAULT)); \
337 (val) = (__typeof__(*(addr))) __gu_tmp; \
341 * Get a long long 64 using 32 bit registers.
343 #define __get_data_asm_ll32(val, insn, addr) \
346 unsigned long long l; \
347 __typeof__(*(addr)) t; \
350 __asm__ __volatile__( \
351 "1: " insn("%1", "(%3)")" \n" \
352 "2: " insn("%D1", "4(%3)")" \n" \
355 " .section .fixup,\"ax\" \n" \
361 " .section __ex_table,\"a\" \n" \
362 " " __UA_ADDR " 1b, 4b \n" \
363 " " __UA_ADDR " 2b, 4b \n" \
365 : "=r" (__gu_err), "=&r" (__gu_tmp.l) \
366 : "0" (0), "r" (addr), "i" (-EFAULT)); \
368 (val) = __gu_tmp.t; \
372 #define __put_kernel_common(ptr, size) __put_user_common(ptr, size)
375 * Kernel specific functions for EVA. We need to use normal load instructions
376 * to read data from kernel when operating in EVA mode. We use these macros to
377 * avoid redefining __get_data_asm for EVA.
384 #define _stored _storew
386 #define _stored(reg, addr) "ld " reg ", " addr
389 #define _storew(reg, addr) "sw " reg ", " addr
390 #define _storeh(reg, addr) "sh " reg ", " addr
391 #define _storeb(reg, addr) "sb " reg ", " addr
393 #define __put_kernel_common(ptr, size) \
396 case 1: __put_data_asm(_storeb, ptr); break; \
397 case 2: __put_data_asm(_storeh, ptr); break; \
398 case 4: __put_data_asm(_storew, ptr); break; \
399 case 8: __PUT_DW(_stored, ptr); break; \
400 default: __put_user_unknown(); break; \
406 * Yuck. We need two variants, one for 64bit operation and one
407 * for 32 bit mode and old iron.
410 #define __PUT_DW(insn, ptr) __put_data_asm_ll32(insn, ptr)
413 #define __PUT_DW(insn, ptr) __put_data_asm(insn, ptr)
416 #define __put_user_common(ptr, size) \
419 case 1: __put_data_asm(user_sb, ptr); break; \
420 case 2: __put_data_asm(user_sh, ptr); break; \
421 case 4: __put_data_asm(user_sw, ptr); break; \
422 case 8: __PUT_DW(user_sd, ptr); break; \
423 default: __put_user_unknown(); break; \
427 #define __put_user_nocheck(x, ptr, size) \
429 __typeof__(*(ptr)) __pu_val; \
433 if (eva_kernel_access()) { \
434 __put_kernel_common(ptr, size); \
436 __chk_user_ptr(ptr); \
437 __put_user_common(ptr, size); \
442 #define __put_user_check(x, ptr, size) \
444 __typeof__(*(ptr)) __user *__pu_addr = (ptr); \
445 __typeof__(*(ptr)) __pu_val = (x); \
446 int __pu_err = -EFAULT; \
449 if (likely(access_ok(VERIFY_WRITE, __pu_addr, size))) { \
450 if (eva_kernel_access()) \
451 __put_kernel_common(__pu_addr, size); \
453 __put_user_common(__pu_addr, size); \
459 #define __put_data_asm(insn, ptr) \
461 __asm__ __volatile__( \
462 "1: "insn("%z2", "%3")" # __put_data_asm \n" \
465 " .section .fixup,\"ax\" \n" \
469 " .section __ex_table,\"a\" \n" \
470 " " __UA_ADDR " 1b, 3b \n" \
473 : "0" (0), "Jr" (__pu_val), "o" (__m(ptr)), \
477 #define __put_data_asm_ll32(insn, ptr) \
479 __asm__ __volatile__( \
480 "1: "insn("%2", "(%3)")" # __put_data_asm_ll32 \n" \
481 "2: "insn("%D2", "4(%3)")" \n" \
484 " .section .fixup,\"ax\" \n" \
488 " .section __ex_table,\"a\" \n" \
489 " " __UA_ADDR " 1b, 4b \n" \
490 " " __UA_ADDR " 2b, 4b \n" \
493 : "0" (0), "r" (__pu_val), "r" (ptr), \
497 extern void __put_user_unknown(void);
500 * We're generating jump to subroutines which will be outside the range of
504 #define __MODULE_JAL(destination) \
506 __UA_LA "\t$1, " #destination "\n\t" \
510 #define __MODULE_JAL(destination) \
511 "jal\t" #destination "\n\t"
514 #if defined(CONFIG_CPU_DADDI_WORKAROUNDS) || (defined(CONFIG_EVA) && \
515 defined(CONFIG_CPU_HAS_PREFETCH))
516 #define DADDI_SCRATCH "$3"
518 #define DADDI_SCRATCH "$0"
521 extern size_t __copy_user(void *__to
, const void *__from
, size_t __n
);
523 #define __invoke_copy_from(func, to, from, n) \
525 register void *__cu_to_r __asm__("$4"); \
526 register const void __user *__cu_from_r __asm__("$5"); \
527 register long __cu_len_r __asm__("$6"); \
530 __cu_from_r = (from); \
532 __asm__ __volatile__( \
533 ".set\tnoreorder\n\t" \
536 __UA_ADDU "\t$1, %1, %2\n\t" \
539 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
541 : "$8", "$9", "$10", "$11", "$12", "$14", "$15", "$24", "$31", \
542 DADDI_SCRATCH, "memory"); \
546 #define __invoke_copy_to(func, to, from, n) \
548 register void __user *__cu_to_r __asm__("$4"); \
549 register const void *__cu_from_r __asm__("$5"); \
550 register long __cu_len_r __asm__("$6"); \
553 __cu_from_r = (from); \
555 __asm__ __volatile__( \
557 : "+r" (__cu_to_r), "+r" (__cu_from_r), "+r" (__cu_len_r) \
559 : "$8", "$9", "$10", "$11", "$12", "$14", "$15", "$24", "$31", \
560 DADDI_SCRATCH, "memory"); \
564 #define __invoke_copy_from_kernel(to, from, n) \
565 __invoke_copy_from(__copy_user, to, from, n)
567 #define __invoke_copy_to_kernel(to, from, n) \
568 __invoke_copy_to(__copy_user, to, from, n)
570 #define ___invoke_copy_in_kernel(to, from, n) \
571 __invoke_copy_from(__copy_user, to, from, n)
574 #define __invoke_copy_from_user(to, from, n) \
575 __invoke_copy_from(__copy_user, to, from, n)
577 #define __invoke_copy_to_user(to, from, n) \
578 __invoke_copy_to(__copy_user, to, from, n)
580 #define ___invoke_copy_in_user(to, from, n) \
581 __invoke_copy_from(__copy_user, to, from, n)
585 /* EVA specific functions */
587 extern size_t __copy_from_user_eva(void *__to
, const void *__from
,
589 extern size_t __copy_to_user_eva(void *__to
, const void *__from
,
591 extern size_t __copy_in_user_eva(void *__to
, const void *__from
, size_t __n
);
594 * Source or destination address is in userland. We need to go through
597 #define __invoke_copy_from_user(to, from, n) \
598 __invoke_copy_from(__copy_from_user_eva, to, from, n)
600 #define __invoke_copy_to_user(to, from, n) \
601 __invoke_copy_to(__copy_to_user_eva, to, from, n)
603 #define ___invoke_copy_in_user(to, from, n) \
604 __invoke_copy_from(__copy_in_user_eva, to, from, n)
606 #endif /* CONFIG_EVA */
608 static inline unsigned long
609 raw_copy_to_user(void __user
*to
, const void *from
, unsigned long n
)
611 if (eva_kernel_access())
612 return __invoke_copy_to_kernel(to
, from
, n
);
614 return __invoke_copy_to_user(to
, from
, n
);
617 static inline unsigned long
618 raw_copy_from_user(void *to
, const void __user
*from
, unsigned long n
)
620 if (eva_kernel_access())
621 return __invoke_copy_from_kernel(to
, from
, n
);
623 return __invoke_copy_from_user(to
, from
, n
);
626 #define INLINE_COPY_FROM_USER
627 #define INLINE_COPY_TO_USER
629 static inline unsigned long
630 raw_copy_in_user(void __user
*to
, const void __user
*from
, unsigned long n
)
632 if (eva_kernel_access())
633 return ___invoke_copy_in_kernel(to
, from
, n
);
635 return ___invoke_copy_in_user(to
, from
, n
);
638 extern __kernel_size_t
__bzero_kernel(void __user
*addr
, __kernel_size_t size
);
639 extern __kernel_size_t
__bzero(void __user
*addr
, __kernel_size_t size
);
642 * __clear_user: - Zero a block of memory in user space, with less checking.
643 * @to: Destination address, in user space.
644 * @n: Number of bytes to zero.
646 * Zero a block of memory in user space. Caller must check
647 * the specified block with access_ok() before calling this function.
649 * Returns number of bytes that could not be cleared.
650 * On success, this will be zero.
652 static inline __kernel_size_t
653 __clear_user(void __user
*addr
, __kernel_size_t size
)
657 if (eva_kernel_access()) {
658 __asm__
__volatile__(
662 __MODULE_JAL(__bzero_kernel
)
665 : "r" (addr
), "r" (size
)
666 : "$4", "$5", "$6", __UA_t0
, __UA_t1
, "$31");
669 __asm__
__volatile__(
673 __MODULE_JAL(__bzero
)
676 : "r" (addr
), "r" (size
)
677 : "$4", "$5", "$6", __UA_t0
, __UA_t1
, "$31");
683 #define clear_user(addr,n) \
685 void __user * __cl_addr = (addr); \
686 unsigned long __cl_size = (n); \
687 if (__cl_size && access_ok(VERIFY_WRITE, \
688 __cl_addr, __cl_size)) \
689 __cl_size = __clear_user(__cl_addr, __cl_size); \
693 extern long __strncpy_from_kernel_asm(char *__to
, const char __user
*__from
, long __len
);
694 extern long __strncpy_from_user_asm(char *__to
, const char __user
*__from
, long __len
);
697 * strncpy_from_user: - Copy a NUL terminated string from userspace.
698 * @dst: Destination address, in kernel space. This buffer must be at
699 * least @count bytes long.
700 * @src: Source address, in user space.
701 * @count: Maximum number of bytes to copy, including the trailing NUL.
703 * Copies a NUL-terminated string from userspace to kernel space.
705 * On success, returns the length of the string (not including the trailing
708 * If access to userspace fails, returns -EFAULT (some data may have been
711 * If @count is smaller than the length of the string, copies @count bytes
712 * and returns @count.
715 strncpy_from_user(char *__to
, const char __user
*__from
, long __len
)
719 if (eva_kernel_access()) {
720 __asm__
__volatile__(
724 __MODULE_JAL(__strncpy_from_kernel_asm
)
727 : "r" (__to
), "r" (__from
), "r" (__len
)
728 : "$2", "$3", "$4", "$5", "$6", __UA_t0
, "$31", "memory");
731 __asm__
__volatile__(
735 __MODULE_JAL(__strncpy_from_user_asm
)
738 : "r" (__to
), "r" (__from
), "r" (__len
)
739 : "$2", "$3", "$4", "$5", "$6", __UA_t0
, "$31", "memory");
745 extern long __strnlen_kernel_asm(const char __user
*s
, long n
);
746 extern long __strnlen_user_asm(const char __user
*s
, long n
);
749 * strnlen_user: - Get the size of a string in user space.
750 * @str: The string to measure.
752 * Context: User context only. This function may sleep if pagefaults are
755 * Get the size of a NUL-terminated string in user space.
757 * Returns the size of the string INCLUDING the terminating NUL.
758 * On exception, returns 0.
759 * If the string is too long, returns a value greater than @n.
761 static inline long strnlen_user(const char __user
*s
, long n
)
766 if (eva_kernel_access()) {
767 __asm__
__volatile__(
770 __MODULE_JAL(__strnlen_kernel_asm
)
774 : "$2", "$4", "$5", __UA_t0
, "$31");
776 __asm__
__volatile__(
779 __MODULE_JAL(__strnlen_user_asm
)
783 : "$2", "$4", "$5", __UA_t0
, "$31");
789 #endif /* _ASM_UACCESS_H */