2 * arch/arm/include/asm/uaccess.h
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 #ifndef _ASMARM_UACCESS_H
9 #define _ASMARM_UACCESS_H
12 * User space memory access functions
14 #include <linux/string.h>
15 #include <asm/memory.h>
16 #include <asm/domain.h>
17 #include <asm/unified.h>
18 #include <asm/compiler.h>
20 #include <asm/extable.h>
23 * These two functions allow hooking accesses to userspace to increase
24 * system integrity by ensuring that the kernel can not inadvertantly
25 * perform such accesses (eg, via list poison values) which could then
26 * be exploited for priviledge escalation.
28 static inline unsigned int uaccess_save_and_enable(void)
30 #ifdef CONFIG_CPU_SW_DOMAIN_PAN
31 unsigned int old_domain = get_domain();
33 /* Set the current domain access to permit user accesses */
34 set_domain((old_domain & ~domain_mask(DOMAIN_USER)) |
35 domain_val(DOMAIN_USER, DOMAIN_CLIENT));
43 static inline void uaccess_restore(unsigned int flags)
45 #ifdef CONFIG_CPU_SW_DOMAIN_PAN
46 /* Restore the user access mask */
52 * These two are intentionally not defined anywhere - if the kernel
53 * code generates any references to them, that's a bug.
55 extern int __get_user_bad(void);
56 extern int __put_user_bad(void);
59 * Note that this is actually 0x1,0000,0000
61 #define KERNEL_DS 0x00000000
65 #define USER_DS TASK_SIZE
66 #define get_fs() (current_thread_info()->addr_limit)
68 static inline void set_fs(mm_segment_t fs)
70 current_thread_info()->addr_limit = fs;
73 * Prevent a mispredicted conditional call to set_fs from forwarding
74 * the wrong address limit to access_ok under speculation.
79 modify_domain(DOMAIN_KERNEL, fs ? DOMAIN_CLIENT : DOMAIN_MANAGER);
82 #define segment_eq(a, b) ((a) == (b))
84 /* We use 33-bit arithmetic here... */
85 #define __range_ok(addr, size) ({ \
86 unsigned long flag, roksum; \
87 __chk_user_ptr(addr); \
88 __asm__(".syntax unified\n" \
89 "adds %1, %2, %3; sbcscc %1, %1, %0; movcc %0, #0" \
90 : "=&r" (flag), "=&r" (roksum) \
91 : "r" (addr), "Ir" (size), "0" (current_thread_info()->addr_limit) \
96 * This is a type: either unsigned long, if the argument fits into
97 * that type, or otherwise unsigned long long.
99 #define __inttype(x) \
100 __typeof__(__builtin_choose_expr(sizeof(x) > sizeof(0UL), 0ULL, 0UL))
103 * Sanitise a uaccess pointer such that it becomes NULL if addr+size
104 * is above the current addr_limit.
106 #define uaccess_mask_range_ptr(ptr, size) \
107 ((__typeof__(ptr))__uaccess_mask_range_ptr(ptr, size))
108 static inline void __user *__uaccess_mask_range_ptr(const void __user *ptr,
111 void __user *safe_ptr = (void __user *)ptr;
118 " addhs %1, %1, #1\n"
119 " subshs %1, %1, %2\n"
121 : "+r" (safe_ptr), "=&r" (tmp)
122 : "r" (size), "r" (current_thread_info()->addr_limit)
130 * Single-value transfer routines. They automatically use the right
131 * size if we just have the right pointer type. Note that the functions
132 * which read from user space (*get_*) need to take care not to leak
133 * kernel data even if the calling code is buggy and fails to check
134 * the return value. This means zeroing out the destination variable
135 * or buffer on error. Normally this is done out of line by the
136 * fixup code, but there are a few places where it intrudes on the
137 * main code path. When we only write to user space, there is no
140 extern int __get_user_1(void *);
141 extern int __get_user_2(void *);
142 extern int __get_user_4(void *);
143 extern int __get_user_32t_8(void *);
144 extern int __get_user_8(void *);
145 extern int __get_user_64t_1(void *);
146 extern int __get_user_64t_2(void *);
147 extern int __get_user_64t_4(void *);
149 #define __GUP_CLOBBER_1 "lr", "cc"
150 #ifdef CONFIG_CPU_USE_DOMAINS
151 #define __GUP_CLOBBER_2 "ip", "lr", "cc"
153 #define __GUP_CLOBBER_2 "lr", "cc"
155 #define __GUP_CLOBBER_4 "lr", "cc"
156 #define __GUP_CLOBBER_32t_8 "lr", "cc"
157 #define __GUP_CLOBBER_8 "lr", "cc"
159 #define __get_user_x(__r2, __p, __e, __l, __s) \
160 __asm__ __volatile__ ( \
161 __asmeq("%0", "r0") __asmeq("%1", "r2") \
162 __asmeq("%3", "r1") \
163 "bl __get_user_" #__s \
164 : "=&r" (__e), "=r" (__r2) \
165 : "0" (__p), "r" (__l) \
166 : __GUP_CLOBBER_##__s)
168 /* narrowing a double-word get into a single 32bit word register: */
170 #define __get_user_x_32t(__r2, __p, __e, __l, __s) \
171 __get_user_x(__r2, __p, __e, __l, 32t_8)
173 #define __get_user_x_32t __get_user_x
177 * storing result into proper least significant word of 64bit target var,
178 * different only for big endian case where 64 bit __r2 lsw is r3:
181 #define __get_user_x_64t(__r2, __p, __e, __l, __s) \
182 __asm__ __volatile__ ( \
183 __asmeq("%0", "r0") __asmeq("%1", "r2") \
184 __asmeq("%3", "r1") \
185 "bl __get_user_64t_" #__s \
186 : "=&r" (__e), "=r" (__r2) \
187 : "0" (__p), "r" (__l) \
188 : __GUP_CLOBBER_##__s)
190 #define __get_user_x_64t __get_user_x
194 #define __get_user_check(x, p) \
196 unsigned long __limit = current_thread_info()->addr_limit - 1; \
197 register typeof(*(p)) __user *__p asm("r0") = (p); \
198 register __inttype(x) __r2 asm("r2"); \
199 register unsigned long __l asm("r1") = __limit; \
200 register int __e asm("r0"); \
201 unsigned int __ua_flags = uaccess_save_and_enable(); \
202 switch (sizeof(*(__p))) { \
204 if (sizeof((x)) >= 8) \
205 __get_user_x_64t(__r2, __p, __e, __l, 1); \
207 __get_user_x(__r2, __p, __e, __l, 1); \
210 if (sizeof((x)) >= 8) \
211 __get_user_x_64t(__r2, __p, __e, __l, 2); \
213 __get_user_x(__r2, __p, __e, __l, 2); \
216 if (sizeof((x)) >= 8) \
217 __get_user_x_64t(__r2, __p, __e, __l, 4); \
219 __get_user_x(__r2, __p, __e, __l, 4); \
222 if (sizeof((x)) < 8) \
223 __get_user_x_32t(__r2, __p, __e, __l, 4); \
225 __get_user_x(__r2, __p, __e, __l, 8); \
227 default: __e = __get_user_bad(); break; \
229 uaccess_restore(__ua_flags); \
230 x = (typeof(*(p))) __r2; \
234 #define get_user(x, p) \
237 __get_user_check(x, p); \
240 extern int __put_user_1(void *, unsigned int);
241 extern int __put_user_2(void *, unsigned int);
242 extern int __put_user_4(void *, unsigned int);
243 extern int __put_user_8(void *, unsigned long long);
245 #define __put_user_check(__pu_val, __ptr, __err, __s) \
247 unsigned long __limit = current_thread_info()->addr_limit - 1; \
248 register typeof(__pu_val) __r2 asm("r2") = __pu_val; \
249 register const void __user *__p asm("r0") = __ptr; \
250 register unsigned long __l asm("r1") = __limit; \
251 register int __e asm("r0"); \
252 __asm__ __volatile__ ( \
253 __asmeq("%0", "r0") __asmeq("%2", "r2") \
254 __asmeq("%3", "r1") \
255 "bl __put_user_" #__s \
257 : "0" (__p), "r" (__r2), "r" (__l) \
258 : "ip", "lr", "cc"); \
262 #else /* CONFIG_MMU */
265 * uClinux has only one addr space, so has simplified address limits.
267 #define USER_DS KERNEL_DS
269 #define segment_eq(a, b) (1)
270 #define __addr_ok(addr) ((void)(addr), 1)
271 #define __range_ok(addr, size) ((void)(addr), 0)
272 #define get_fs() (KERNEL_DS)
274 static inline void set_fs(mm_segment_t fs)
278 #define get_user(x, p) __get_user(x, p)
279 #define __put_user_check __put_user_nocheck
281 #endif /* CONFIG_MMU */
283 #define access_ok(addr, size) (__range_ok(addr, size) == 0)
285 #define user_addr_max() \
286 (uaccess_kernel() ? ~0UL : get_fs())
288 #ifdef CONFIG_CPU_SPECTRE
290 * When mitigating Spectre variant 1, it is not worth fixing the non-
291 * verifying accessors, because we need to add verification of the
292 * address space there. Force these to use the standard get_user()
295 #define __get_user(x, ptr) get_user(x, ptr)
299 * The "__xxx" versions of the user access functions do not verify the
300 * address space - it must have been done previously with a separate
301 * "access_ok()" call.
303 * The "xxx_error" versions set the third argument to EFAULT if an
304 * error occurs, and leave it unchanged on success. Note that these
305 * versions are void (ie, don't return a value as such).
307 #define __get_user(x, ptr) \
310 __get_user_err((x), (ptr), __gu_err); \
314 #define __get_user_err(x, ptr, err) \
316 unsigned long __gu_addr = (unsigned long)(ptr); \
317 unsigned long __gu_val; \
318 unsigned int __ua_flags; \
319 __chk_user_ptr(ptr); \
321 __ua_flags = uaccess_save_and_enable(); \
322 switch (sizeof(*(ptr))) { \
323 case 1: __get_user_asm_byte(__gu_val, __gu_addr, err); break; \
324 case 2: __get_user_asm_half(__gu_val, __gu_addr, err); break; \
325 case 4: __get_user_asm_word(__gu_val, __gu_addr, err); break; \
326 default: (__gu_val) = __get_user_bad(); \
328 uaccess_restore(__ua_flags); \
329 (x) = (__typeof__(*(ptr)))__gu_val; \
332 #define __get_user_asm(x, addr, err, instr) \
333 __asm__ __volatile__( \
334 "1: " TUSER(instr) " %1, [%2], #0\n" \
336 " .pushsection .text.fixup,\"ax\"\n" \
342 " .pushsection __ex_table,\"a\"\n" \
346 : "+r" (err), "=&r" (x) \
347 : "r" (addr), "i" (-EFAULT) \
350 #define __get_user_asm_byte(x, addr, err) \
351 __get_user_asm(x, addr, err, ldrb)
353 #if __LINUX_ARM_ARCH__ >= 6
355 #define __get_user_asm_half(x, addr, err) \
356 __get_user_asm(x, addr, err, ldrh)
361 #define __get_user_asm_half(x, __gu_addr, err) \
363 unsigned long __b1, __b2; \
364 __get_user_asm_byte(__b1, __gu_addr, err); \
365 __get_user_asm_byte(__b2, __gu_addr + 1, err); \
366 (x) = __b1 | (__b2 << 8); \
369 #define __get_user_asm_half(x, __gu_addr, err) \
371 unsigned long __b1, __b2; \
372 __get_user_asm_byte(__b1, __gu_addr, err); \
373 __get_user_asm_byte(__b2, __gu_addr + 1, err); \
374 (x) = (__b1 << 8) | __b2; \
378 #endif /* __LINUX_ARM_ARCH__ >= 6 */
380 #define __get_user_asm_word(x, addr, err) \
381 __get_user_asm(x, addr, err, ldr)
385 #define __put_user_switch(x, ptr, __err, __fn) \
387 const __typeof__(*(ptr)) __user *__pu_ptr = (ptr); \
388 __typeof__(*(ptr)) __pu_val = (x); \
389 unsigned int __ua_flags; \
391 __ua_flags = uaccess_save_and_enable(); \
392 switch (sizeof(*(ptr))) { \
393 case 1: __fn(__pu_val, __pu_ptr, __err, 1); break; \
394 case 2: __fn(__pu_val, __pu_ptr, __err, 2); break; \
395 case 4: __fn(__pu_val, __pu_ptr, __err, 4); break; \
396 case 8: __fn(__pu_val, __pu_ptr, __err, 8); break; \
397 default: __err = __put_user_bad(); break; \
399 uaccess_restore(__ua_flags); \
402 #define put_user(x, ptr) \
405 __put_user_switch((x), (ptr), __pu_err, __put_user_check); \
409 #ifdef CONFIG_CPU_SPECTRE
411 * When mitigating Spectre variant 1.1, all accessors need to include
412 * verification of the address space.
414 #define __put_user(x, ptr) put_user(x, ptr)
417 #define __put_user(x, ptr) \
420 __put_user_switch((x), (ptr), __pu_err, __put_user_nocheck); \
424 #define __put_user_nocheck(x, __pu_ptr, __err, __size) \
426 unsigned long __pu_addr = (unsigned long)__pu_ptr; \
427 __put_user_nocheck_##__size(x, __pu_addr, __err); \
430 #define __put_user_nocheck_1 __put_user_asm_byte
431 #define __put_user_nocheck_2 __put_user_asm_half
432 #define __put_user_nocheck_4 __put_user_asm_word
433 #define __put_user_nocheck_8 __put_user_asm_dword
435 #define __put_user_asm(x, __pu_addr, err, instr) \
436 __asm__ __volatile__( \
437 "1: " TUSER(instr) " %1, [%2], #0\n" \
439 " .pushsection .text.fixup,\"ax\"\n" \
444 " .pushsection __ex_table,\"a\"\n" \
449 : "r" (x), "r" (__pu_addr), "i" (-EFAULT) \
452 #define __put_user_asm_byte(x, __pu_addr, err) \
453 __put_user_asm(x, __pu_addr, err, strb)
455 #if __LINUX_ARM_ARCH__ >= 6
457 #define __put_user_asm_half(x, __pu_addr, err) \
458 __put_user_asm(x, __pu_addr, err, strh)
463 #define __put_user_asm_half(x, __pu_addr, err) \
465 unsigned long __temp = (__force unsigned long)(x); \
466 __put_user_asm_byte(__temp, __pu_addr, err); \
467 __put_user_asm_byte(__temp >> 8, __pu_addr + 1, err); \
470 #define __put_user_asm_half(x, __pu_addr, err) \
472 unsigned long __temp = (__force unsigned long)(x); \
473 __put_user_asm_byte(__temp >> 8, __pu_addr, err); \
474 __put_user_asm_byte(__temp, __pu_addr + 1, err); \
478 #endif /* __LINUX_ARM_ARCH__ >= 6 */
480 #define __put_user_asm_word(x, __pu_addr, err) \
481 __put_user_asm(x, __pu_addr, err, str)
484 #define __reg_oper0 "%R2"
485 #define __reg_oper1 "%Q2"
487 #define __reg_oper0 "%Q2"
488 #define __reg_oper1 "%R2"
491 #define __put_user_asm_dword(x, __pu_addr, err) \
492 __asm__ __volatile__( \
493 ARM( "1: " TUSER(str) " " __reg_oper1 ", [%1], #4\n" ) \
494 ARM( "2: " TUSER(str) " " __reg_oper0 ", [%1]\n" ) \
495 THUMB( "1: " TUSER(str) " " __reg_oper1 ", [%1]\n" ) \
496 THUMB( "2: " TUSER(str) " " __reg_oper0 ", [%1, #4]\n" ) \
498 " .pushsection .text.fixup,\"ax\"\n" \
503 " .pushsection __ex_table,\"a\"\n" \
508 : "+r" (err), "+r" (__pu_addr) \
509 : "r" (x), "i" (-EFAULT) \
512 #endif /* !CONFIG_CPU_SPECTRE */
515 extern unsigned long __must_check
516 arm_copy_from_user(void *to, const void __user *from, unsigned long n);
518 static inline unsigned long __must_check
519 raw_copy_from_user(void *to, const void __user *from, unsigned long n)
521 unsigned int __ua_flags;
523 __ua_flags = uaccess_save_and_enable();
524 n = arm_copy_from_user(to, from, n);
525 uaccess_restore(__ua_flags);
529 extern unsigned long __must_check
530 arm_copy_to_user(void __user *to, const void *from, unsigned long n);
531 extern unsigned long __must_check
532 __copy_to_user_std(void __user *to, const void *from, unsigned long n);
534 static inline unsigned long __must_check
535 raw_copy_to_user(void __user *to, const void *from, unsigned long n)
537 #ifndef CONFIG_UACCESS_WITH_MEMCPY
538 unsigned int __ua_flags;
539 __ua_flags = uaccess_save_and_enable();
540 n = arm_copy_to_user(to, from, n);
541 uaccess_restore(__ua_flags);
544 return arm_copy_to_user(to, from, n);
548 extern unsigned long __must_check
549 arm_clear_user(void __user *addr, unsigned long n);
550 extern unsigned long __must_check
551 __clear_user_std(void __user *addr, unsigned long n);
553 static inline unsigned long __must_check
554 __clear_user(void __user *addr, unsigned long n)
556 unsigned int __ua_flags = uaccess_save_and_enable();
557 n = arm_clear_user(addr, n);
558 uaccess_restore(__ua_flags);
563 static inline unsigned long
564 raw_copy_from_user(void *to, const void __user *from, unsigned long n)
566 memcpy(to, (const void __force *)from, n);
569 static inline unsigned long
570 raw_copy_to_user(void __user *to, const void *from, unsigned long n)
572 memcpy((void __force *)to, from, n);
575 #define __clear_user(addr, n) (memset((void __force *)addr, 0, n), 0)
577 #define INLINE_COPY_TO_USER
578 #define INLINE_COPY_FROM_USER
580 static inline unsigned long __must_check clear_user(void __user *to, unsigned long n)
582 if (access_ok(to, n))
583 n = __clear_user(to, n);
587 /* These are from lib/ code, and use __get_user() and friends */
588 extern long strncpy_from_user(char *dest, const char __user *src, long count);
590 extern __must_check long strnlen_user(const char __user *str, long n);
592 #endif /* _ASMARM_UACCESS_H */