2 * Based on arch/arm/include/asm/uaccess.h
4 * Copyright (C) 2012 ARM Ltd.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #ifndef __ASM_UACCESS_H
19 #define __ASM_UACCESS_H
22 * User space memory access functions
24 #include <linux/string.h>
25 #include <linux/thread_info.h>
27 #include <asm/alternative.h>
28 #include <asm/cpufeature.h>
29 #include <asm/ptrace.h>
30 #include <asm/sysreg.h>
31 #include <asm/errno.h>
32 #include <asm/memory.h>
33 #include <asm/compiler.h>
36 #define VERIFY_WRITE 1
39 * The exception table consists of pairs of addresses: the first is the
40 * address of an instruction that is allowed to fault, and the second is
41 * the address at which the program should continue. No registers are
42 * modified, so it is entirely up to the continuation code to figure out
45 * All the routines below use bits of fixup code that are out of line
46 * with the main instruction path. This means when everything is well,
47 * we don't even have to jump over them. Further, they do not intrude
48 * on our cache or tlb entries.
51 struct exception_table_entry
53 unsigned long insn
, fixup
;
56 extern int fixup_exception(struct pt_regs
*regs
);
58 #define KERNEL_DS (-1UL)
59 #define get_ds() (KERNEL_DS)
61 #define USER_DS TASK_SIZE_64
62 #define get_fs() (current_thread_info()->addr_limit)
64 static inline void set_fs(mm_segment_t fs
)
66 current_thread_info()->addr_limit
= fs
;
69 #define segment_eq(a, b) ((a) == (b))
72 * Return 1 if addr < current->addr_limit, 0 otherwise.
74 #define __addr_ok(addr) \
77 asm("cmp %1, %0; cset %0, lo" \
79 : "r" (addr), "0" (current_thread_info()->addr_limit) \
85 * Test whether a block of memory is a valid user space address.
86 * Returns 1 if the range is valid, 0 otherwise.
88 * This is equivalent to the following test:
89 * (u65)addr + (u65)size <= current->addr_limit
91 * This needs 65-bit arithmetic.
93 #define __range_ok(addr, size) \
95 unsigned long flag, roksum; \
96 __chk_user_ptr(addr); \
97 asm("adds %1, %1, %3; ccmp %1, %4, #2, cc; cset %0, ls" \
98 : "=&r" (flag), "=&r" (roksum) \
99 : "1" (addr), "Ir" (size), \
100 "r" (current_thread_info()->addr_limit) \
105 #define access_ok(type, addr, size) __range_ok(addr, size)
106 #define user_addr_max get_fs
109 * The "__xxx" versions of the user access functions do not verify the address
110 * space - it must have been done previously with a separate "access_ok()"
113 * The "__xxx_error" versions set the third argument to -EFAULT if an error
114 * occurs, and leave it unchanged on success.
116 #define __get_user_asm(instr, reg, x, addr, err) \
118 "1: " instr " " reg "1, [%2]\n" \
120 " .section .fixup, \"ax\"\n" \
126 " .section __ex_table,\"a\"\n" \
130 : "+r" (err), "=&r" (x) \
131 : "r" (addr), "i" (-EFAULT))
133 #define __get_user_err(x, ptr, err) \
135 unsigned long __gu_val; \
136 __chk_user_ptr(ptr); \
137 asm(ALTERNATIVE("nop", SET_PSTATE_PAN(0), ARM64_HAS_PAN, \
138 CONFIG_ARM64_PAN)); \
139 switch (sizeof(*(ptr))) { \
141 __get_user_asm("ldrb", "%w", __gu_val, (ptr), (err)); \
144 __get_user_asm("ldrh", "%w", __gu_val, (ptr), (err)); \
147 __get_user_asm("ldr", "%w", __gu_val, (ptr), (err)); \
150 __get_user_asm("ldr", "%", __gu_val, (ptr), (err)); \
155 (x) = (__force __typeof__(*(ptr)))__gu_val; \
156 asm(ALTERNATIVE("nop", SET_PSTATE_PAN(1), ARM64_HAS_PAN, \
157 CONFIG_ARM64_PAN)); \
160 #define __get_user(x, ptr) \
163 __get_user_err((x), (ptr), __gu_err); \
167 #define __get_user_error(x, ptr, err) \
169 __get_user_err((x), (ptr), (err)); \
173 #define __get_user_unaligned __get_user
175 #define get_user(x, ptr) \
177 __typeof__(*(ptr)) __user *__p = (ptr); \
179 access_ok(VERIFY_READ, __p, sizeof(*__p)) ? \
180 __get_user((x), __p) : \
181 ((x) = 0, -EFAULT); \
184 #define __put_user_asm(instr, reg, x, addr, err) \
186 "1: " instr " " reg "1, [%2]\n" \
188 " .section .fixup,\"ax\"\n" \
193 " .section __ex_table,\"a\"\n" \
198 : "r" (x), "r" (addr), "i" (-EFAULT))
200 #define __put_user_err(x, ptr, err) \
202 __typeof__(*(ptr)) __pu_val = (x); \
203 __chk_user_ptr(ptr); \
204 asm(ALTERNATIVE("nop", SET_PSTATE_PAN(0), ARM64_HAS_PAN, \
205 CONFIG_ARM64_PAN)); \
206 switch (sizeof(*(ptr))) { \
208 __put_user_asm("strb", "%w", __pu_val, (ptr), (err)); \
211 __put_user_asm("strh", "%w", __pu_val, (ptr), (err)); \
214 __put_user_asm("str", "%w", __pu_val, (ptr), (err)); \
217 __put_user_asm("str", "%", __pu_val, (ptr), (err)); \
222 asm(ALTERNATIVE("nop", SET_PSTATE_PAN(1), ARM64_HAS_PAN, \
223 CONFIG_ARM64_PAN)); \
226 #define __put_user(x, ptr) \
229 __put_user_err((x), (ptr), __pu_err); \
233 #define __put_user_error(x, ptr, err) \
235 __put_user_err((x), (ptr), (err)); \
239 #define __put_user_unaligned __put_user
241 #define put_user(x, ptr) \
243 __typeof__(*(ptr)) __user *__p = (ptr); \
245 access_ok(VERIFY_WRITE, __p, sizeof(*__p)) ? \
246 __put_user((x), __p) : \
250 extern unsigned long __must_check
__copy_from_user(void *to
, const void __user
*from
, unsigned long n
);
251 extern unsigned long __must_check
__copy_to_user(void __user
*to
, const void *from
, unsigned long n
);
252 extern unsigned long __must_check
__copy_in_user(void __user
*to
, const void __user
*from
, unsigned long n
);
253 extern unsigned long __must_check
__clear_user(void __user
*addr
, unsigned long n
);
255 static inline unsigned long __must_check
copy_from_user(void *to
, const void __user
*from
, unsigned long n
)
257 if (access_ok(VERIFY_READ
, from
, n
))
258 n
= __copy_from_user(to
, from
, n
);
259 else /* security hole - plug it */
264 static inline unsigned long __must_check
copy_to_user(void __user
*to
, const void *from
, unsigned long n
)
266 if (access_ok(VERIFY_WRITE
, to
, n
))
267 n
= __copy_to_user(to
, from
, n
);
271 static inline unsigned long __must_check
copy_in_user(void __user
*to
, const void __user
*from
, unsigned long n
)
273 if (access_ok(VERIFY_READ
, from
, n
) && access_ok(VERIFY_WRITE
, to
, n
))
274 n
= __copy_in_user(to
, from
, n
);
278 #define __copy_to_user_inatomic __copy_to_user
279 #define __copy_from_user_inatomic __copy_from_user
281 static inline unsigned long __must_check
clear_user(void __user
*to
, unsigned long n
)
283 if (access_ok(VERIFY_WRITE
, to
, n
))
284 n
= __clear_user(to
, n
);
288 extern long strncpy_from_user(char *dest
, const char __user
*src
, long count
);
290 extern __must_check
long strlen_user(const char __user
*str
);
291 extern __must_check
long strnlen_user(const char __user
*str
, long n
);
293 #endif /* __ASM_UACCESS_H */