blob: a8d85a687cf465e29980a74fae38c09bf43884bd [file] [log] [blame]
H. Peter Anvin1965aae2008-10-22 22:26:29 -07001#ifndef _ASM_X86_UACCESS_H
2#define _ASM_X86_UACCESS_H
Glauber Costaca233862008-06-13 14:39:25 -03003/*
4 * User space memory access functions
5 */
6#include <linux/errno.h>
7#include <linux/compiler.h>
Andrey Ryabinin1771c6e2016-05-20 16:59:31 -07008#include <linux/kasan-checks.h>
Glauber Costaca233862008-06-13 14:39:25 -03009#include <linux/thread_info.h>
Glauber Costaca233862008-06-13 14:39:25 -030010#include <linux/string.h>
11#include <asm/asm.h>
12#include <asm/page.h>
H. Peter Anvin63bcff22012-09-21 12:43:12 -070013#include <asm/smap.h>
Al Viro45caf472016-09-05 11:32:44 -040014#include <asm/extable.h>
Glauber Costaca233862008-06-13 14:39:25 -030015
16#define VERIFY_READ 0
17#define VERIFY_WRITE 1
18
19/*
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.
23 *
24 * For historical reasons, these macros are grossly misnamed.
25 */
26
27#define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
28
29#define KERNEL_DS MAKE_MM_SEG(-1UL)
Linus Torvalds9063c612009-06-20 15:40:00 -070030#define USER_DS MAKE_MM_SEG(TASK_SIZE_MAX)
Glauber Costaca233862008-06-13 14:39:25 -030031
32#define get_ds() (KERNEL_DS)
Andy Lutomirski13d4ea02016-07-14 13:22:57 -070033#define get_fs() (current->thread.addr_limit)
34#define set_fs(x) (current->thread.addr_limit = (x))
Glauber Costaca233862008-06-13 14:39:25 -030035
36#define segment_eq(a, b) ((a).seg == (b).seg)
37
Andy Lutomirski13d4ea02016-07-14 13:22:57 -070038#define user_addr_max() (current->thread.addr_limit.seg)
Arun Sharmabc6ca7b2012-04-20 15:41:35 -070039#define __addr_ok(addr) \
40 ((unsigned long __force)(addr) < user_addr_max())
Glauber Costa002ca162008-06-25 11:08:51 -030041
Glauber Costaca233862008-06-13 14:39:25 -030042/*
43 * Test whether a block of memory is a valid user space address.
44 * Returns 0 if the range is valid, nonzero otherwise.
Glauber Costaca233862008-06-13 14:39:25 -030045 */
H. Peter Anvina7405762013-12-27 16:52:47 -080046static inline bool __chk_range_not_ok(unsigned long addr, unsigned long size, unsigned long limit)
Linus Torvaldsc5fe5d82013-12-27 15:30:58 -080047{
48 /*
49 * If we have used "sizeof()" for the size,
50 * we know it won't overflow the limit (but
51 * it might overflow the 'addr', so it's
52 * important to subtract the size from the
53 * limit, not add it to the address).
54 */
55 if (__builtin_constant_p(size))
Andy Lutomirski7e0f51c2015-10-05 17:47:50 -070056 return unlikely(addr > limit - size);
Linus Torvaldsc5fe5d82013-12-27 15:30:58 -080057
58 /* Arbitrary sizes? Be careful about overflow */
59 addr += size;
Andy Lutomirski7e0f51c2015-10-05 17:47:50 -070060 if (unlikely(addr < size))
H. Peter Anvina7405762013-12-27 16:52:47 -080061 return true;
Andy Lutomirski7e0f51c2015-10-05 17:47:50 -070062 return unlikely(addr > limit);
Linus Torvaldsc5fe5d82013-12-27 15:30:58 -080063}
Glauber Costaca233862008-06-13 14:39:25 -030064
Arun Sharmabc6ca7b2012-04-20 15:41:35 -070065#define __range_not_ok(addr, size, limit) \
Glauber Costaca233862008-06-13 14:39:25 -030066({ \
Glauber Costaca233862008-06-13 14:39:25 -030067 __chk_user_ptr(addr); \
Linus Torvaldsc5fe5d82013-12-27 15:30:58 -080068 __chk_range_not_ok((unsigned long __force)(addr), size, limit); \
Glauber Costaca233862008-06-13 14:39:25 -030069})
70
Peter Zijlstra2715f682016-11-22 10:57:15 +010071#ifdef CONFIG_DEBUG_ATOMIC_SLEEP
72# define WARN_ON_IN_IRQ() WARN_ON_ONCE(!in_task())
73#else
74# define WARN_ON_IN_IRQ()
75#endif
76
Glauber Costaca233862008-06-13 14:39:25 -030077/**
78 * access_ok: - Checks if a user space pointer is valid
79 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
80 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
81 * to write to a block, it is always safe to read from it.
82 * @addr: User space pointer to start of block to check
83 * @size: Size of block to check
84 *
David Hildenbrandb3c395e2015-05-11 17:52:08 +020085 * Context: User context only. This function may sleep if pagefaults are
86 * enabled.
Glauber Costaca233862008-06-13 14:39:25 -030087 *
88 * Checks if a pointer to a block of memory in user space is valid.
89 *
90 * Returns true (nonzero) if the memory block may be valid, false (zero)
91 * if it is definitely invalid.
92 *
93 * Note that, depending on architecture, this function probably just
94 * checks that the pointer is in the user space range - after calling
95 * this function, memory access functions may still return -EFAULT.
96 */
Peter Zijlstra2715f682016-11-22 10:57:15 +010097#define access_ok(type, addr, size) \
98({ \
99 WARN_ON_IN_IRQ(); \
100 likely(!__range_not_ok(addr, size, user_addr_max())); \
101})
Glauber Costaca233862008-06-13 14:39:25 -0300102
103/*
Glauber Costaca233862008-06-13 14:39:25 -0300104 * These are the main single-value transfer routines. They automatically
105 * use the right size if we just have the right pointer type.
106 *
107 * This gets kind of ugly. We want to return _two_ values in "get_user()"
108 * and yet we don't want to do any pointers, because that is too much
109 * of a performance impact. Thus we have a few rather ugly macros here,
110 * and hide all the ugliness from the user.
111 *
112 * The "__xxx" versions of the user access functions are versions that
113 * do not verify the address space, that must have been done previously
114 * with a separate "access_ok()" call (this is used when we do multiple
115 * accesses to the same area of user memory).
116 */
117
118extern int __get_user_1(void);
119extern int __get_user_2(void);
120extern int __get_user_4(void);
121extern int __get_user_8(void);
122extern int __get_user_bad(void);
123
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800124#define __uaccess_begin() stac()
125#define __uaccess_end() clac()
Dan Williamse06d7bf2018-01-29 17:02:39 -0800126#define __uaccess_begin_nospec() \
127({ \
128 stac(); \
129 barrier_nospec(); \
130})
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800131
H. Peter Anvin3578baa2013-02-12 11:47:31 -0800132/*
133 * This is a type: either unsigned long, if the argument fits into
134 * that type, or otherwise unsigned long long.
135 */
136#define __inttype(x) \
137__typeof__(__builtin_choose_expr(sizeof(x) > sizeof(0UL), 0ULL, 0UL))
Glauber Costa865e5b72008-06-25 11:05:11 -0300138
139/**
140 * get_user: - Get a simple variable from user space.
141 * @x: Variable to store result.
142 * @ptr: Source address, in user space.
143 *
David Hildenbrandb3c395e2015-05-11 17:52:08 +0200144 * Context: User context only. This function may sleep if pagefaults are
145 * enabled.
Glauber Costa865e5b72008-06-25 11:05:11 -0300146 *
147 * This macro copies a single simple variable from user space to kernel
148 * space. It supports simple types like char and int, but not larger
149 * data types like structures or arrays.
150 *
151 * @ptr must have pointer-to-simple-variable type, and the result of
152 * dereferencing @ptr must be assignable to @x without a cast.
153 *
154 * Returns zero on success, or -EFAULT on error.
155 * On error, the variable @x is set to zero.
H. Peter Anvinff52c3b2013-02-12 15:37:02 -0800156 */
157/*
H. Peter Anvin3578baa2013-02-12 11:47:31 -0800158 * Careful: we have to cast the result to the type of the pointer
159 * for sign reasons.
H. Peter Anvinff52c3b2013-02-12 15:37:02 -0800160 *
H. Peter Anvinf69fa9a2013-08-29 13:34:50 -0700161 * The use of _ASM_DX as the register specifier is a bit of a
H. Peter Anvinff52c3b2013-02-12 15:37:02 -0800162 * simplification, as gcc only cares about it as the starting point
163 * and not size: for a 64-bit value it will use %ecx:%edx on 32 bits
164 * (%ecx being the next register in gcc's x86 register sequence), and
165 * %rdx on 64 bits.
H. Peter Anvinf69fa9a2013-08-29 13:34:50 -0700166 *
167 * Clang/LLVM cares about the size of the register, but still wants
168 * the base register for something that ends up being a pair.
Glauber Costa865e5b72008-06-25 11:05:11 -0300169 */
Glauber Costa865e5b72008-06-25 11:05:11 -0300170#define get_user(x, ptr) \
171({ \
172 int __ret_gu; \
Jan-Simon Möllerbdfc0172013-08-29 21:13:05 +0200173 register __inttype(*(ptr)) __val_gu asm("%"_ASM_DX); \
Chris J Argesf05058c2016-01-21 16:49:25 -0600174 register void *__sp asm(_ASM_SP); \
Glauber Costa865e5b72008-06-25 11:05:11 -0300175 __chk_user_ptr(ptr); \
Ingo Molnard1a76182008-10-28 16:54:49 +0100176 might_fault(); \
Chris J Argesf05058c2016-01-21 16:49:25 -0600177 asm volatile("call __get_user_%P4" \
178 : "=a" (__ret_gu), "=r" (__val_gu), "+r" (__sp) \
H. Peter Anvin3578baa2013-02-12 11:47:31 -0800179 : "0" (ptr), "i" (sizeof(*(ptr)))); \
Michael S. Tsirkine182c572014-12-12 01:56:04 +0200180 (x) = (__force __typeof__(*(ptr))) __val_gu; \
Andy Lutomirskia76cf662015-10-05 17:47:49 -0700181 __builtin_expect(__ret_gu, 0); \
Glauber Costa865e5b72008-06-25 11:05:11 -0300182})
183
Glauber Costae30a44f2008-06-25 13:17:43 -0300184#define __put_user_x(size, x, ptr, __ret_pu) \
185 asm volatile("call __put_user_" #size : "=a" (__ret_pu) \
Hiroshi Shimamoto4d5d7832009-01-19 16:34:26 -0800186 : "0" ((typeof(*(ptr)))(x)), "c" (ptr) : "ebx")
Glauber Costae30a44f2008-06-25 13:17:43 -0300187
188
189
Glauber Costadc70ddf2008-06-25 11:48:29 -0300190#ifdef CONFIG_X86_32
Hiroshi Shimamoto18114f62009-01-30 18:16:46 -0800191#define __put_user_asm_u64(x, addr, err, errret) \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800192 asm volatile("\n" \
H. Peter Anvin63bcff22012-09-21 12:43:12 -0700193 "1: movl %%eax,0(%2)\n" \
Glauber Costadc70ddf2008-06-25 11:48:29 -0300194 "2: movl %%edx,4(%2)\n" \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800195 "3:" \
Glauber Costadc70ddf2008-06-25 11:48:29 -0300196 ".section .fixup,\"ax\"\n" \
197 "4: movl %3,%0\n" \
198 " jmp 3b\n" \
199 ".previous\n" \
200 _ASM_EXTABLE(1b, 4b) \
201 _ASM_EXTABLE(2b, 4b) \
202 : "=r" (err) \
Hiroshi Shimamoto18114f62009-01-30 18:16:46 -0800203 : "A" (x), "r" (addr), "i" (errret), "0" (err))
Glauber Costae30a44f2008-06-25 13:17:43 -0300204
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800205#define __put_user_asm_ex_u64(x, addr) \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800206 asm volatile("\n" \
H. Peter Anvin63bcff22012-09-21 12:43:12 -0700207 "1: movl %%eax,0(%1)\n" \
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800208 "2: movl %%edx,4(%1)\n" \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800209 "3:" \
H. Peter Anvin535c0c32012-04-20 16:57:35 -0700210 _ASM_EXTABLE_EX(1b, 2b) \
211 _ASM_EXTABLE_EX(2b, 3b) \
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800212 : : "A" (x), "r" (addr))
213
Glauber Costae30a44f2008-06-25 13:17:43 -0300214#define __put_user_x8(x, ptr, __ret_pu) \
215 asm volatile("call __put_user_8" : "=a" (__ret_pu) \
216 : "A" ((typeof(*(ptr)))(x)), "c" (ptr) : "ebx")
Glauber Costadc70ddf2008-06-25 11:48:29 -0300217#else
Hiroshi Shimamoto18114f62009-01-30 18:16:46 -0800218#define __put_user_asm_u64(x, ptr, retval, errret) \
H. Peter Anvinebe119c2009-07-20 23:27:39 -0700219 __put_user_asm(x, ptr, retval, "q", "", "er", errret)
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800220#define __put_user_asm_ex_u64(x, addr) \
H. Peter Anvinebe119c2009-07-20 23:27:39 -0700221 __put_user_asm_ex(x, addr, "q", "", "er")
Glauber Costae30a44f2008-06-25 13:17:43 -0300222#define __put_user_x8(x, ptr, __ret_pu) __put_user_x(8, x, ptr, __ret_pu)
Glauber Costadc70ddf2008-06-25 11:48:29 -0300223#endif
224
Glauber Costae30a44f2008-06-25 13:17:43 -0300225extern void __put_user_bad(void);
226
227/*
228 * Strange magic calling convention: pointer in %ecx,
229 * value in %eax(:%edx), return value in %eax. clobbers %rbx
230 */
231extern void __put_user_1(void);
232extern void __put_user_2(void);
233extern void __put_user_4(void);
234extern void __put_user_8(void);
235
Glauber Costae30a44f2008-06-25 13:17:43 -0300236/**
237 * put_user: - Write a simple value into user space.
238 * @x: Value to copy to user space.
239 * @ptr: Destination address, in user space.
240 *
David Hildenbrandb3c395e2015-05-11 17:52:08 +0200241 * Context: User context only. This function may sleep if pagefaults are
242 * enabled.
Glauber Costae30a44f2008-06-25 13:17:43 -0300243 *
244 * This macro copies a single simple value from kernel space to user
245 * space. It supports simple types like char and int, but not larger
246 * data types like structures or arrays.
247 *
248 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
249 * to the result of dereferencing @ptr.
250 *
251 * Returns zero on success, or -EFAULT on error.
252 */
253#define put_user(x, ptr) \
254({ \
255 int __ret_pu; \
256 __typeof__(*(ptr)) __pu_val; \
257 __chk_user_ptr(ptr); \
Ingo Molnard1a76182008-10-28 16:54:49 +0100258 might_fault(); \
Glauber Costae30a44f2008-06-25 13:17:43 -0300259 __pu_val = x; \
260 switch (sizeof(*(ptr))) { \
261 case 1: \
262 __put_user_x(1, __pu_val, ptr, __ret_pu); \
263 break; \
264 case 2: \
265 __put_user_x(2, __pu_val, ptr, __ret_pu); \
266 break; \
267 case 4: \
268 __put_user_x(4, __pu_val, ptr, __ret_pu); \
269 break; \
270 case 8: \
271 __put_user_x8(__pu_val, ptr, __ret_pu); \
272 break; \
273 default: \
274 __put_user_x(X, __pu_val, ptr, __ret_pu); \
275 break; \
276 } \
Andy Lutomirskia76cf662015-10-05 17:47:49 -0700277 __builtin_expect(__ret_pu, 0); \
Glauber Costae30a44f2008-06-25 13:17:43 -0300278})
279
Glauber Costadc70ddf2008-06-25 11:48:29 -0300280#define __put_user_size(x, ptr, size, retval, errret) \
281do { \
282 retval = 0; \
283 __chk_user_ptr(ptr); \
284 switch (size) { \
285 case 1: \
286 __put_user_asm(x, ptr, retval, "b", "b", "iq", errret); \
287 break; \
288 case 2: \
289 __put_user_asm(x, ptr, retval, "w", "w", "ir", errret); \
290 break; \
291 case 4: \
Hiroshi Shimamoto4d5d7832009-01-19 16:34:26 -0800292 __put_user_asm(x, ptr, retval, "l", "k", "ir", errret); \
Glauber Costadc70ddf2008-06-25 11:48:29 -0300293 break; \
294 case 8: \
Hiroshi Shimamoto18114f62009-01-30 18:16:46 -0800295 __put_user_asm_u64((__typeof__(*ptr))(x), ptr, retval, \
296 errret); \
Glauber Costadc70ddf2008-06-25 11:48:29 -0300297 break; \
298 default: \
299 __put_user_bad(); \
300 } \
301} while (0)
302
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800303/*
304 * This doesn't do __uaccess_begin/end - the exception handling
305 * around it must do that.
306 */
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800307#define __put_user_size_ex(x, ptr, size) \
308do { \
309 __chk_user_ptr(ptr); \
310 switch (size) { \
311 case 1: \
312 __put_user_asm_ex(x, ptr, "b", "b", "iq"); \
313 break; \
314 case 2: \
315 __put_user_asm_ex(x, ptr, "w", "w", "ir"); \
316 break; \
317 case 4: \
318 __put_user_asm_ex(x, ptr, "l", "k", "ir"); \
319 break; \
320 case 8: \
321 __put_user_asm_ex_u64((__typeof__(*ptr))(x), ptr); \
322 break; \
323 default: \
324 __put_user_bad(); \
325 } \
326} while (0)
327
Glauber Costa3f168222008-06-25 12:48:47 -0300328#ifdef CONFIG_X86_32
Benjamin LaHaiseb2f68032016-03-09 15:05:56 -0500329#define __get_user_asm_u64(x, ptr, retval, errret) \
330({ \
331 __typeof__(ptr) __ptr = (ptr); \
Linus Torvaldsae382ca2017-05-21 18:26:54 -0700332 asm volatile("\n" \
Benjamin LaHaiseb2f68032016-03-09 15:05:56 -0500333 "1: movl %2,%%eax\n" \
334 "2: movl %3,%%edx\n" \
Linus Torvaldsae382ca2017-05-21 18:26:54 -0700335 "3:\n" \
Benjamin LaHaiseb2f68032016-03-09 15:05:56 -0500336 ".section .fixup,\"ax\"\n" \
337 "4: mov %4,%0\n" \
338 " xorl %%eax,%%eax\n" \
339 " xorl %%edx,%%edx\n" \
340 " jmp 3b\n" \
341 ".previous\n" \
342 _ASM_EXTABLE(1b, 4b) \
343 _ASM_EXTABLE(2b, 4b) \
Linus Torvaldsae382ca2017-05-21 18:26:54 -0700344 : "=r" (retval), "=&A"(x) \
Benjamin LaHaiseb2f68032016-03-09 15:05:56 -0500345 : "m" (__m(__ptr)), "m" __m(((u32 *)(__ptr)) + 1), \
346 "i" (errret), "0" (retval)); \
347})
348
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800349#define __get_user_asm_ex_u64(x, ptr) (x) = __get_user_bad()
Glauber Costa3f168222008-06-25 12:48:47 -0300350#else
351#define __get_user_asm_u64(x, ptr, retval, errret) \
352 __get_user_asm(x, ptr, retval, "q", "", "=r", errret)
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800353#define __get_user_asm_ex_u64(x, ptr) \
354 __get_user_asm_ex(x, ptr, "q", "", "=r")
Glauber Costa3f168222008-06-25 12:48:47 -0300355#endif
356
357#define __get_user_size(x, ptr, size, retval, errret) \
358do { \
359 retval = 0; \
360 __chk_user_ptr(ptr); \
361 switch (size) { \
362 case 1: \
363 __get_user_asm(x, ptr, retval, "b", "b", "=q", errret); \
364 break; \
365 case 2: \
366 __get_user_asm(x, ptr, retval, "w", "w", "=r", errret); \
367 break; \
368 case 4: \
369 __get_user_asm(x, ptr, retval, "l", "k", "=r", errret); \
370 break; \
371 case 8: \
372 __get_user_asm_u64(x, ptr, retval, errret); \
373 break; \
374 default: \
375 (x) = __get_user_bad(); \
376 } \
377} while (0)
378
379#define __get_user_asm(x, addr, err, itype, rtype, ltype, errret) \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800380 asm volatile("\n" \
H. Peter Anvin63bcff22012-09-21 12:43:12 -0700381 "1: mov"itype" %2,%"rtype"1\n" \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800382 "2:\n" \
Glauber Costa3f168222008-06-25 12:48:47 -0300383 ".section .fixup,\"ax\"\n" \
384 "3: mov %3,%0\n" \
385 " xor"itype" %"rtype"1,%"rtype"1\n" \
386 " jmp 2b\n" \
387 ".previous\n" \
388 _ASM_EXTABLE(1b, 3b) \
389 : "=r" (err), ltype(x) \
390 : "m" (__m(addr)), "i" (errret), "0" (err))
391
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800392/*
393 * This doesn't do __uaccess_begin/end - the exception handling
394 * around it must do that.
395 */
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800396#define __get_user_size_ex(x, ptr, size) \
397do { \
398 __chk_user_ptr(ptr); \
399 switch (size) { \
400 case 1: \
401 __get_user_asm_ex(x, ptr, "b", "b", "=q"); \
402 break; \
403 case 2: \
404 __get_user_asm_ex(x, ptr, "w", "w", "=r"); \
405 break; \
406 case 4: \
407 __get_user_asm_ex(x, ptr, "l", "k", "=r"); \
408 break; \
409 case 8: \
410 __get_user_asm_ex_u64(x, ptr); \
411 break; \
412 default: \
413 (x) = __get_user_bad(); \
414 } \
415} while (0)
416
417#define __get_user_asm_ex(x, addr, itype, rtype, ltype) \
H. Peter Anvin5e883532012-09-21 12:43:15 -0700418 asm volatile("1: mov"itype" %1,%"rtype"0\n" \
419 "2:\n" \
Al Viro1c109fa2016-09-15 02:35:29 +0100420 ".section .fixup,\"ax\"\n" \
421 "3:xor"itype" %"rtype"0,%"rtype"0\n" \
422 " jmp 2b\n" \
423 ".previous\n" \
424 _ASM_EXTABLE_EX(1b, 3b) \
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800425 : ltype(x) : "m" (__m(addr)))
426
Glauber Costadc70ddf2008-06-25 11:48:29 -0300427#define __put_user_nocheck(x, ptr, size) \
428({ \
Hiroshi Shimamoto16855f82008-12-08 19:18:38 -0800429 int __pu_err; \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800430 __uaccess_begin(); \
Glauber Costadc70ddf2008-06-25 11:48:29 -0300431 __put_user_size((x), (ptr), (size), __pu_err, -EFAULT); \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800432 __uaccess_end(); \
Andy Lutomirskia76cf662015-10-05 17:47:49 -0700433 __builtin_expect(__pu_err, 0); \
Glauber Costadc70ddf2008-06-25 11:48:29 -0300434})
435
Glauber Costa3f168222008-06-25 12:48:47 -0300436#define __get_user_nocheck(x, ptr, size) \
437({ \
Hiroshi Shimamoto16855f82008-12-08 19:18:38 -0800438 int __gu_err; \
Benjamin LaHaiseb2f68032016-03-09 15:05:56 -0500439 __inttype(*(ptr)) __gu_val; \
Dan Williams065eae42018-01-29 17:02:49 -0800440 __uaccess_begin_nospec(); \
Glauber Costa3f168222008-06-25 12:48:47 -0300441 __get_user_size(__gu_val, (ptr), (size), __gu_err, -EFAULT); \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800442 __uaccess_end(); \
Glauber Costa3f168222008-06-25 12:48:47 -0300443 (x) = (__force __typeof__(*(ptr)))__gu_val; \
Andy Lutomirskia76cf662015-10-05 17:47:49 -0700444 __builtin_expect(__gu_err, 0); \
Glauber Costa3f168222008-06-25 12:48:47 -0300445})
Glauber Costadc70ddf2008-06-25 11:48:29 -0300446
447/* FIXME: this hack is definitely wrong -AK */
448struct __large_struct { unsigned long buf[100]; };
449#define __m(x) (*(struct __large_struct __user *)(x))
450
451/*
452 * Tell gcc we read from memory instead of writing: this is because
453 * we do not write to any memory gcc knows about, so there are no
454 * aliasing issues.
455 */
456#define __put_user_asm(x, addr, err, itype, rtype, ltype, errret) \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800457 asm volatile("\n" \
H. Peter Anvin63bcff22012-09-21 12:43:12 -0700458 "1: mov"itype" %"rtype"1,%2\n" \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800459 "2:\n" \
Glauber Costadc70ddf2008-06-25 11:48:29 -0300460 ".section .fixup,\"ax\"\n" \
461 "3: mov %3,%0\n" \
462 " jmp 2b\n" \
463 ".previous\n" \
464 _ASM_EXTABLE(1b, 3b) \
465 : "=r"(err) \
466 : ltype(x), "m" (__m(addr)), "i" (errret), "0" (err))
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800467
468#define __put_user_asm_ex(x, addr, itype, rtype, ltype) \
H. Peter Anvin5e883532012-09-21 12:43:15 -0700469 asm volatile("1: mov"itype" %"rtype"0,%1\n" \
470 "2:\n" \
H. Peter Anvin535c0c32012-04-20 16:57:35 -0700471 _ASM_EXTABLE_EX(1b, 2b) \
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800472 : : ltype(x), "m" (__m(addr)))
473
474/*
475 * uaccess_try and catch
476 */
477#define uaccess_try do { \
Andy Lutomirskidfa9a942016-07-14 13:22:56 -0700478 current->thread.uaccess_err = 0; \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800479 __uaccess_begin(); \
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800480 barrier();
481
Dan Williamse06d7bf2018-01-29 17:02:39 -0800482#define uaccess_try_nospec do { \
483 current->thread.uaccess_err = 0; \
484 __uaccess_begin_nospec(); \
485
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800486#define uaccess_catch(err) \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800487 __uaccess_end(); \
Andy Lutomirskidfa9a942016-07-14 13:22:56 -0700488 (err) |= (current->thread.uaccess_err ? -EFAULT : 0); \
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800489} while (0)
490
Glauber Costa8cb834e2008-06-25 14:43:30 -0300491/**
492 * __get_user: - Get a simple variable from user space, with less checking.
493 * @x: Variable to store result.
494 * @ptr: Source address, in user space.
495 *
David Hildenbrandb3c395e2015-05-11 17:52:08 +0200496 * Context: User context only. This function may sleep if pagefaults are
497 * enabled.
Glauber Costa8cb834e2008-06-25 14:43:30 -0300498 *
499 * This macro copies a single simple variable from user space to kernel
500 * space. It supports simple types like char and int, but not larger
501 * data types like structures or arrays.
502 *
503 * @ptr must have pointer-to-simple-variable type, and the result of
504 * dereferencing @ptr must be assignable to @x without a cast.
505 *
506 * Caller must check the pointer with access_ok() before calling this
507 * function.
508 *
509 * Returns zero on success, or -EFAULT on error.
510 * On error, the variable @x is set to zero.
511 */
Glauber Costadc70ddf2008-06-25 11:48:29 -0300512
Glauber Costa8cb834e2008-06-25 14:43:30 -0300513#define __get_user(x, ptr) \
514 __get_user_nocheck((x), (ptr), sizeof(*(ptr)))
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800515
Glauber Costa8cb834e2008-06-25 14:43:30 -0300516/**
517 * __put_user: - Write a simple value into user space, with less checking.
518 * @x: Value to copy to user space.
519 * @ptr: Destination address, in user space.
520 *
David Hildenbrandb3c395e2015-05-11 17:52:08 +0200521 * Context: User context only. This function may sleep if pagefaults are
522 * enabled.
Glauber Costa8cb834e2008-06-25 14:43:30 -0300523 *
524 * This macro copies a single simple value from kernel space to user
525 * space. It supports simple types like char and int, but not larger
526 * data types like structures or arrays.
527 *
528 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
529 * to the result of dereferencing @ptr.
530 *
531 * Caller must check the pointer with access_ok() before calling this
532 * function.
533 *
534 * Returns zero on success, or -EFAULT on error.
535 */
536
537#define __put_user(x, ptr) \
538 __put_user_nocheck((__typeof__(*(ptr)))(x), (ptr), sizeof(*(ptr)))
539
540#define __get_user_unaligned __get_user
541#define __put_user_unaligned __put_user
Glauber Costa865e5b72008-06-25 11:05:11 -0300542
Glauber Costa8bc7de0c2008-06-25 14:53:41 -0300543/*
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800544 * {get|put}_user_try and catch
545 *
546 * get_user_try {
547 * get_user_ex(...);
548 * } get_user_catch(err)
549 */
Dan Williams065eae42018-01-29 17:02:49 -0800550#define get_user_try uaccess_try_nospec
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800551#define get_user_catch(err) uaccess_catch(err)
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800552
553#define get_user_ex(x, ptr) do { \
554 unsigned long __gue_val; \
555 __get_user_size_ex((__gue_val), (ptr), (sizeof(*(ptr)))); \
556 (x) = (__force __typeof__(*(ptr)))__gue_val; \
557} while (0)
558
Hiroshi Shimamoto019a1362009-01-29 11:49:18 -0800559#define put_user_try uaccess_try
560#define put_user_catch(err) uaccess_catch(err)
561
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800562#define put_user_ex(x, ptr) \
563 __put_user_size_ex((__typeof__(*(ptr)))(x), (ptr), sizeof(*(ptr)))
564
Robert Richter1ac2e6c2011-06-07 11:49:55 +0200565extern unsigned long
566copy_from_user_nmi(void *to, const void __user *from, unsigned long n);
Linus Torvalds92ae03f2012-04-06 14:32:32 -0700567extern __must_check long
568strncpy_from_user(char *dst, const char __user *src, long count);
Robert Richter1ac2e6c2011-06-07 11:49:55 +0200569
Linus Torvalds5723aa92012-05-26 11:09:53 -0700570extern __must_check long strlen_user(const char __user *str);
571extern __must_check long strnlen_user(const char __user *str, long n);
572
H. Peter Anvina0528582012-09-21 12:43:11 -0700573unsigned long __must_check clear_user(void __user *mem, unsigned long len);
574unsigned long __must_check __clear_user(void __user *mem, unsigned long len);
575
Qiaowei Renf09174c2013-12-14 14:25:02 +0800576extern void __cmpxchg_wrong_size(void)
577 __compiletime_error("Bad argument size for cmpxchg");
578
579#define __user_atomic_cmpxchg_inatomic(uval, ptr, old, new, size) \
580({ \
581 int __ret = 0; \
582 __typeof__(ptr) __uval = (uval); \
583 __typeof__(*(ptr)) __old = (old); \
584 __typeof__(*(ptr)) __new = (new); \
Dan Williams065eae42018-01-29 17:02:49 -0800585 __uaccess_begin_nospec(); \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800586 switch (size) { \
587 case 1: \
588 { \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800589 asm volatile("\n" \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800590 "1:\t" LOCK_PREFIX "cmpxchgb %4, %2\n" \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800591 "2:\n" \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800592 "\t.section .fixup, \"ax\"\n" \
593 "3:\tmov %3, %0\n" \
594 "\tjmp 2b\n" \
595 "\t.previous\n" \
596 _ASM_EXTABLE(1b, 3b) \
597 : "+r" (__ret), "=a" (__old), "+m" (*(ptr)) \
598 : "i" (-EFAULT), "q" (__new), "1" (__old) \
599 : "memory" \
600 ); \
601 break; \
602 } \
603 case 2: \
604 { \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800605 asm volatile("\n" \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800606 "1:\t" LOCK_PREFIX "cmpxchgw %4, %2\n" \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800607 "2:\n" \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800608 "\t.section .fixup, \"ax\"\n" \
609 "3:\tmov %3, %0\n" \
610 "\tjmp 2b\n" \
611 "\t.previous\n" \
612 _ASM_EXTABLE(1b, 3b) \
613 : "+r" (__ret), "=a" (__old), "+m" (*(ptr)) \
614 : "i" (-EFAULT), "r" (__new), "1" (__old) \
615 : "memory" \
616 ); \
617 break; \
618 } \
619 case 4: \
620 { \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800621 asm volatile("\n" \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800622 "1:\t" LOCK_PREFIX "cmpxchgl %4, %2\n" \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800623 "2:\n" \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800624 "\t.section .fixup, \"ax\"\n" \
625 "3:\tmov %3, %0\n" \
626 "\tjmp 2b\n" \
627 "\t.previous\n" \
628 _ASM_EXTABLE(1b, 3b) \
629 : "+r" (__ret), "=a" (__old), "+m" (*(ptr)) \
630 : "i" (-EFAULT), "r" (__new), "1" (__old) \
631 : "memory" \
632 ); \
633 break; \
634 } \
635 case 8: \
636 { \
637 if (!IS_ENABLED(CONFIG_X86_64)) \
638 __cmpxchg_wrong_size(); \
639 \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800640 asm volatile("\n" \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800641 "1:\t" LOCK_PREFIX "cmpxchgq %4, %2\n" \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800642 "2:\n" \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800643 "\t.section .fixup, \"ax\"\n" \
644 "3:\tmov %3, %0\n" \
645 "\tjmp 2b\n" \
646 "\t.previous\n" \
647 _ASM_EXTABLE(1b, 3b) \
648 : "+r" (__ret), "=a" (__old), "+m" (*(ptr)) \
649 : "i" (-EFAULT), "r" (__new), "1" (__old) \
650 : "memory" \
651 ); \
652 break; \
653 } \
654 default: \
655 __cmpxchg_wrong_size(); \
656 } \
Linus Torvalds11f1a4b2015-12-17 09:45:09 -0800657 __uaccess_end(); \
Qiaowei Renf09174c2013-12-14 14:25:02 +0800658 *__uval = __old; \
659 __ret; \
660})
661
662#define user_atomic_cmpxchg_inatomic(uval, ptr, old, new) \
663({ \
664 access_ok(VERIFY_WRITE, (ptr), sizeof(*(ptr))) ? \
665 __user_atomic_cmpxchg_inatomic((uval), (ptr), \
666 (old), (new), sizeof(*(ptr))) : \
667 -EFAULT; \
668})
669
Hiroshi Shimamotofe40c0a2009-01-23 15:49:41 -0800670/*
Glauber Costa8bc7de0c2008-06-25 14:53:41 -0300671 * movsl can be slow when source and dest are not both 8-byte aligned
672 */
673#ifdef CONFIG_X86_INTEL_USERCOPY
674extern struct movsl_mask {
675 int mask;
676} ____cacheline_aligned_in_smp movsl_mask;
677#endif
678
Glauber Costa22cac162008-06-25 14:56:53 -0300679#define ARCH_HAS_NOCACHE_UACCESS 1
680
Thomas Gleixner96a388d2007-10-11 11:20:03 +0200681#ifdef CONFIG_X86_32
David Howellsa1ce3922012-10-02 18:01:25 +0100682# include <asm/uaccess_32.h>
Thomas Gleixner96a388d2007-10-11 11:20:03 +0200683#else
David Howellsa1ce3922012-10-02 18:01:25 +0100684# include <asm/uaccess_64.h>
Thomas Gleixner96a388d2007-10-11 11:20:03 +0200685#endif
Glauber Costaca233862008-06-13 14:39:25 -0300686
Jan Beulich3df7b412013-10-21 09:43:57 +0100687unsigned long __must_check _copy_from_user(void *to, const void __user *from,
688 unsigned n);
Jan Beulich7a3d9b02013-10-21 09:44:37 +0100689unsigned long __must_check _copy_to_user(void __user *to, const void *from,
690 unsigned n);
Jan Beulich3df7b412013-10-21 09:43:57 +0100691
Josh Poimboeuf0d025d22016-08-30 08:04:16 -0500692extern void __compiletime_error("usercopy buffer size is too small")
693__bad_copy_user(void);
Jan Beulich3df7b412013-10-21 09:43:57 +0100694
Josh Poimboeuf0d025d22016-08-30 08:04:16 -0500695static inline void copy_user_overflow(int size, unsigned long count)
Jan Beulich3df7b412013-10-21 09:43:57 +0100696{
697 WARN(1, "Buffer overflow detected (%d < %lu)!\n", size, count);
698}
699
Kees Cooke6971002016-09-06 11:56:01 -0700700static __always_inline unsigned long __must_check
Jan Beulich3df7b412013-10-21 09:43:57 +0100701copy_from_user(void *to, const void __user *from, unsigned long n)
702{
703 int sz = __compiletime_object_size(to);
704
705 might_fault();
706
Andrey Ryabinin1771c6e2016-05-20 16:59:31 -0700707 kasan_check_write(to, n);
708
Kees Cook5b710f32016-06-23 15:04:01 -0700709 if (likely(sz < 0 || sz >= n)) {
710 check_object_size(to, n, false);
Jan Beulich3df7b412013-10-21 09:43:57 +0100711 n = _copy_from_user(to, from, n);
Josh Poimboeuf0d025d22016-08-30 08:04:16 -0500712 } else if (!__builtin_constant_p(n))
713 copy_user_overflow(sz, n);
Jan Beulich3df7b412013-10-21 09:43:57 +0100714 else
Josh Poimboeuf0d025d22016-08-30 08:04:16 -0500715 __bad_copy_user();
Jan Beulich3df7b412013-10-21 09:43:57 +0100716
717 return n;
718}
719
Kees Cooke6971002016-09-06 11:56:01 -0700720static __always_inline unsigned long __must_check
Jan Beulich7a3d9b02013-10-21 09:44:37 +0100721copy_to_user(void __user *to, const void *from, unsigned long n)
722{
723 int sz = __compiletime_object_size(from);
724
Andrey Ryabinin1771c6e2016-05-20 16:59:31 -0700725 kasan_check_read(from, n);
726
Jan Beulich7a3d9b02013-10-21 09:44:37 +0100727 might_fault();
728
Kees Cook5b710f32016-06-23 15:04:01 -0700729 if (likely(sz < 0 || sz >= n)) {
730 check_object_size(from, n, true);
Jan Beulich7a3d9b02013-10-21 09:44:37 +0100731 n = _copy_to_user(to, from, n);
Josh Poimboeuf0d025d22016-08-30 08:04:16 -0500732 } else if (!__builtin_constant_p(n))
733 copy_user_overflow(sz, n);
Jan Beulich7a3d9b02013-10-21 09:44:37 +0100734 else
Josh Poimboeuf0d025d22016-08-30 08:04:16 -0500735 __bad_copy_user();
Jan Beulich7a3d9b02013-10-21 09:44:37 +0100736
737 return n;
738}
739
Andi Kleen10013eb2015-10-22 15:07:20 -0700740/*
741 * We rely on the nested NMI work to allow atomic faults from the NMI path; the
742 * nested NMI paths are careful to preserve CR2.
743 *
744 * Caller must use pagefault_enable/disable, or run in interrupt context,
745 * and also do a uaccess_ok() check
746 */
747#define __copy_from_user_nmi __copy_from_user_inatomic
748
Linus Torvalds404a4742016-01-21 13:02:41 -0800749/*
Linus Torvalds5b24a7a2015-12-17 09:57:27 -0800750 * The "unsafe" user accesses aren't really "unsafe", but the naming
751 * is a big fat warning: you have to not only do the access_ok()
752 * checking before using them, but you have to surround them with the
753 * user_access_begin/end() pair.
754 */
755#define user_access_begin() __uaccess_begin()
756#define user_access_end() __uaccess_end()
757
Linus Torvalds1bd44032016-08-08 13:02:01 -0700758#define unsafe_put_user(x, ptr, err_label) \
759do { \
Linus Torvalds5b24a7a2015-12-17 09:57:27 -0800760 int __pu_err; \
761 __put_user_size((x), (ptr), sizeof(*(ptr)), __pu_err, -EFAULT); \
Linus Torvalds1bd44032016-08-08 13:02:01 -0700762 if (unlikely(__pu_err)) goto err_label; \
763} while (0)
Linus Torvalds5b24a7a2015-12-17 09:57:27 -0800764
Linus Torvalds1bd44032016-08-08 13:02:01 -0700765#define unsafe_get_user(x, ptr, err_label) \
766do { \
Linus Torvalds5b24a7a2015-12-17 09:57:27 -0800767 int __gu_err; \
768 unsigned long __gu_val; \
769 __get_user_size(__gu_val, (ptr), sizeof(*(ptr)), __gu_err, -EFAULT); \
770 (x) = (__force __typeof__(*(ptr)))__gu_val; \
Linus Torvalds1bd44032016-08-08 13:02:01 -0700771 if (unlikely(__gu_err)) goto err_label; \
772} while (0)
Linus Torvalds5b24a7a2015-12-17 09:57:27 -0800773
H. Peter Anvin1965aae2008-10-22 22:26:29 -0700774#endif /* _ASM_X86_UACCESS_H */
Nick Piggin8174c432008-07-25 19:45:24 -0700775