blob: 64476bb2a1465dcf6ce15dc2a939ad1fb54fe7bf [file] [log] [blame]
H. Peter Anvin1965aae2008-10-22 22:26:29 -07001#ifndef _ASM_X86_UACCESS_64_H
2#define _ASM_X86_UACCESS_64_H
Linus Torvalds1da177e2005-04-16 15:20:36 -07003
4/*
5 * User space memory access functions
6 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/compiler.h>
8#include <linux/errno.h>
Nick Piggin16dbc6c2008-10-02 14:50:12 -07009#include <linux/lockdep.h>
Jan Beulich1b1d9252009-12-18 16:12:56 +000010#include <asm/alternative.h>
11#include <asm/cpufeature.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <asm/page.h>
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014/*
15 * Copy To/From Userspace
16 */
17
18/* Handles exceptions in both to and from, but doesn't do access_ok */
Andi Kleen95912002006-09-26 10:52:39 +020019__must_check unsigned long
Fenghua Yu954e4822012-05-24 18:19:45 -070020copy_user_enhanced_fast_string(void *to, const void *from, unsigned len);
21__must_check unsigned long
Jan Beulich1b1d9252009-12-18 16:12:56 +000022copy_user_generic_string(void *to, const void *from, unsigned len);
23__must_check unsigned long
24copy_user_generic_unrolled(void *to, const void *from, unsigned len);
25
26static __always_inline __must_check unsigned long
27copy_user_generic(void *to, const void *from, unsigned len)
28{
29 unsigned ret;
30
Fenghua Yu954e4822012-05-24 18:19:45 -070031 /*
32 * If CPU has ERMS feature, use copy_user_enhanced_fast_string.
33 * Otherwise, if CPU has rep_good feature, use copy_user_generic_string.
34 * Otherwise, use copy_user_generic_unrolled.
35 */
36 alternative_call_2(copy_user_generic_unrolled,
Jan Beulich1b1d9252009-12-18 16:12:56 +000037 copy_user_generic_string,
38 X86_FEATURE_REP_GOOD,
Fenghua Yu954e4822012-05-24 18:19:45 -070039 copy_user_enhanced_fast_string,
40 X86_FEATURE_ERMS,
Jan Beulich1b1d9252009-12-18 16:12:56 +000041 ASM_OUTPUT2("=a" (ret), "=D" (to), "=S" (from),
42 "=d" (len)),
43 "1" (to), "2" (from), "3" (len)
44 : "memory", "rcx", "r8", "r9", "r10", "r11");
45 return ret;
46}
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Andi Kleen95912002006-09-26 10:52:39 +020048__must_check unsigned long
Frederic Weisbecker3c93ca02009-11-16 15:42:18 +010049_copy_to_user(void __user *to, const void *from, unsigned len);
Andi Kleen95912002006-09-26 10:52:39 +020050__must_check unsigned long
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020051_copy_from_user(void *to, const void __user *from, unsigned len);
Andi Kleen95912002006-09-26 10:52:39 +020052__must_check unsigned long
53copy_in_user(void __user *to, const void __user *from, unsigned len);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020055static inline unsigned long __must_check copy_from_user(void *to,
56 const void __user *from,
57 unsigned long n)
58{
59 int sz = __compiletime_object_size(to);
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020060
Frederic Weisbecker3c93ca02009-11-16 15:42:18 +010061 might_fault();
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020062 if (likely(sz == -1 || sz >= n))
Heiko Carstens409d02e2010-01-05 14:19:11 +010063 n = _copy_from_user(to, from, n);
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020064#ifdef CONFIG_DEBUG_VM
65 else
66 WARN(1, "Buffer overflow detected!\n");
67#endif
Heiko Carstens409d02e2010-01-05 14:19:11 +010068 return n;
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020069}
70
Frederic Weisbecker3c93ca02009-11-16 15:42:18 +010071static __always_inline __must_check
72int copy_to_user(void __user *dst, const void *src, unsigned size)
73{
74 might_fault();
75
76 return _copy_to_user(dst, src, size);
77}
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020078
Andi Kleen95912002006-09-26 10:52:39 +020079static __always_inline __must_check
Andi Kleenff47ab4f2013-08-16 14:17:19 -070080int __copy_from_user_nocheck(void *dst, const void __user *src, unsigned size)
Joe Perchesb8963132008-03-23 01:03:49 -070081{
Andi Kleen383d0792006-09-26 10:52:40 +020082 int ret = 0;
Ingo Molnard1a76182008-10-28 16:54:49 +010083
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 if (!__builtin_constant_p(size))
Joe Perchesb8963132008-03-23 01:03:49 -070085 return copy_user_generic(dst, (__force void *)src, size);
86 switch (size) {
87 case 1:__get_user_asm(*(u8 *)dst, (u8 __user *)src,
88 ret, "b", "b", "=q", 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -070090 case 2:__get_user_asm(*(u16 *)dst, (u16 __user *)src,
91 ret, "w", "w", "=r", 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -070093 case 4:__get_user_asm(*(u32 *)dst, (u32 __user *)src,
94 ret, "l", "k", "=r", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -070096 case 8:__get_user_asm(*(u64 *)dst, (u64 __user *)src,
97 ret, "q", "", "=r", 8);
98 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 case 10:
Joe Perchesb8963132008-03-23 01:03:49 -0700100 __get_user_asm(*(u64 *)dst, (u64 __user *)src,
Hiroshi Shimamoto20a4a232008-11-13 18:06:04 -0800101 ret, "q", "", "=r", 10);
Joe Perchesb8963132008-03-23 01:03:49 -0700102 if (unlikely(ret))
103 return ret;
104 __get_user_asm(*(u16 *)(8 + (char *)dst),
105 (u16 __user *)(8 + (char __user *)src),
106 ret, "w", "w", "=r", 2);
107 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 case 16:
Joe Perchesb8963132008-03-23 01:03:49 -0700109 __get_user_asm(*(u64 *)dst, (u64 __user *)src,
110 ret, "q", "", "=r", 16);
111 if (unlikely(ret))
112 return ret;
113 __get_user_asm(*(u64 *)(8 + (char *)dst),
114 (u64 __user *)(8 + (char __user *)src),
115 ret, "q", "", "=r", 8);
116 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 default:
Joe Perchesb8963132008-03-23 01:03:49 -0700118 return copy_user_generic(dst, (__force void *)src, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 }
Joe Perchesb8963132008-03-23 01:03:49 -0700120}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Andi Kleen95912002006-09-26 10:52:39 +0200122static __always_inline __must_check
Andi Kleenff47ab4f2013-08-16 14:17:19 -0700123int __copy_from_user(void *dst, const void __user *src, unsigned size)
124{
125 might_fault();
126 return __copy_from_user_nocheck(dst, src, size);
127}
128
129static __always_inline __must_check
130int __copy_to_user_nocheck(void __user *dst, const void *src, unsigned size)
Joe Perchesb8963132008-03-23 01:03:49 -0700131{
Andi Kleen383d0792006-09-26 10:52:40 +0200132 int ret = 0;
Ingo Molnard1a76182008-10-28 16:54:49 +0100133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 if (!__builtin_constant_p(size))
Joe Perchesb8963132008-03-23 01:03:49 -0700135 return copy_user_generic((__force void *)dst, src, size);
136 switch (size) {
137 case 1:__put_user_asm(*(u8 *)src, (u8 __user *)dst,
138 ret, "b", "b", "iq", 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -0700140 case 2:__put_user_asm(*(u16 *)src, (u16 __user *)dst,
141 ret, "w", "w", "ir", 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -0700143 case 4:__put_user_asm(*(u32 *)src, (u32 __user *)dst,
144 ret, "l", "k", "ir", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -0700146 case 8:__put_user_asm(*(u64 *)src, (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200147 ret, "q", "", "er", 8);
Joe Perchesb8963132008-03-23 01:03:49 -0700148 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 case 10:
Joe Perchesb8963132008-03-23 01:03:49 -0700150 __put_user_asm(*(u64 *)src, (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200151 ret, "q", "", "er", 10);
Joe Perchesb8963132008-03-23 01:03:49 -0700152 if (unlikely(ret))
153 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 asm("":::"memory");
Joe Perchesb8963132008-03-23 01:03:49 -0700155 __put_user_asm(4[(u16 *)src], 4 + (u16 __user *)dst,
156 ret, "w", "w", "ir", 2);
157 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 case 16:
Joe Perchesb8963132008-03-23 01:03:49 -0700159 __put_user_asm(*(u64 *)src, (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200160 ret, "q", "", "er", 16);
Joe Perchesb8963132008-03-23 01:03:49 -0700161 if (unlikely(ret))
162 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 asm("":::"memory");
Joe Perchesb8963132008-03-23 01:03:49 -0700164 __put_user_asm(1[(u64 *)src], 1 + (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200165 ret, "q", "", "er", 8);
Joe Perchesb8963132008-03-23 01:03:49 -0700166 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 default:
Joe Perchesb8963132008-03-23 01:03:49 -0700168 return copy_user_generic((__force void *)dst, src, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 }
Joe Perchesb8963132008-03-23 01:03:49 -0700170}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Andi Kleen95912002006-09-26 10:52:39 +0200172static __always_inline __must_check
Andi Kleenff47ab4f2013-08-16 14:17:19 -0700173int __copy_to_user(void __user *dst, const void *src, unsigned size)
174{
175 might_fault();
176 return __copy_to_user_nocheck(dst, src, size);
177}
178
179static __always_inline __must_check
Andi Kleen95912002006-09-26 10:52:39 +0200180int __copy_in_user(void __user *dst, const void __user *src, unsigned size)
Joe Perchesb8963132008-03-23 01:03:49 -0700181{
Andi Kleen383d0792006-09-26 10:52:40 +0200182 int ret = 0;
Ingo Molnard1a76182008-10-28 16:54:49 +0100183
184 might_fault();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 if (!__builtin_constant_p(size))
Joe Perchesb8963132008-03-23 01:03:49 -0700186 return copy_user_generic((__force void *)dst,
187 (__force void *)src, size);
188 switch (size) {
189 case 1: {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 u8 tmp;
Joe Perchesb8963132008-03-23 01:03:49 -0700191 __get_user_asm(tmp, (u8 __user *)src,
192 ret, "b", "b", "=q", 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 if (likely(!ret))
Joe Perchesb8963132008-03-23 01:03:49 -0700194 __put_user_asm(tmp, (u8 __user *)dst,
195 ret, "b", "b", "iq", 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 return ret;
197 }
Joe Perchesb8963132008-03-23 01:03:49 -0700198 case 2: {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 u16 tmp;
Joe Perchesb8963132008-03-23 01:03:49 -0700200 __get_user_asm(tmp, (u16 __user *)src,
201 ret, "w", "w", "=r", 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 if (likely(!ret))
Joe Perchesb8963132008-03-23 01:03:49 -0700203 __put_user_asm(tmp, (u16 __user *)dst,
204 ret, "w", "w", "ir", 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 return ret;
206 }
207
Joe Perchesb8963132008-03-23 01:03:49 -0700208 case 4: {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 u32 tmp;
Joe Perchesb8963132008-03-23 01:03:49 -0700210 __get_user_asm(tmp, (u32 __user *)src,
211 ret, "l", "k", "=r", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 if (likely(!ret))
Joe Perchesb8963132008-03-23 01:03:49 -0700213 __put_user_asm(tmp, (u32 __user *)dst,
214 ret, "l", "k", "ir", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 return ret;
216 }
Joe Perchesb8963132008-03-23 01:03:49 -0700217 case 8: {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 u64 tmp;
Joe Perchesb8963132008-03-23 01:03:49 -0700219 __get_user_asm(tmp, (u64 __user *)src,
220 ret, "q", "", "=r", 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 if (likely(!ret))
Joe Perchesb8963132008-03-23 01:03:49 -0700222 __put_user_asm(tmp, (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200223 ret, "q", "", "er", 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 return ret;
225 }
226 default:
Joe Perchesb8963132008-03-23 01:03:49 -0700227 return copy_user_generic((__force void *)dst,
228 (__force void *)src, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 }
Joe Perchesb8963132008-03-23 01:03:49 -0700230}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Jan Beulich14722482009-11-13 11:56:24 +0000232static __must_check __always_inline int
233__copy_from_user_inatomic(void *dst, const void __user *src, unsigned size)
234{
Andi Kleenff47ab4f2013-08-16 14:17:19 -0700235 return __copy_from_user_nocheck(dst, (__force const void *)src, size);
Jan Beulich14722482009-11-13 11:56:24 +0000236}
Andi Kleenb8858082006-09-30 01:47:55 +0200237
238static __must_check __always_inline int
239__copy_to_user_inatomic(void __user *dst, const void *src, unsigned size)
240{
Andi Kleenff47ab4f2013-08-16 14:17:19 -0700241 return __copy_to_user_nocheck((__force void *)dst, src, size);
Andi Kleenb8858082006-09-30 01:47:55 +0200242}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Joe Perchesb8963132008-03-23 01:03:49 -0700244extern long __copy_user_nocache(void *dst, const void __user *src,
245 unsigned size, int zerorest);
Andi Kleen0812a572007-02-13 13:26:19 +0100246
Ingo Molnarf1800532009-03-02 11:00:57 +0100247static inline int
248__copy_from_user_nocache(void *dst, const void __user *src, unsigned size)
Andi Kleen0812a572007-02-13 13:26:19 +0100249{
Michael S. Tsirkin016be2e2013-05-26 17:31:55 +0300250 might_fault();
Ingo Molnarf1800532009-03-02 11:00:57 +0100251 return __copy_user_nocache(dst, src, size, 1);
Andi Kleen0812a572007-02-13 13:26:19 +0100252}
253
Ingo Molnarf1800532009-03-02 11:00:57 +0100254static inline int
255__copy_from_user_inatomic_nocache(void *dst, const void __user *src,
256 unsigned size)
Andi Kleen0812a572007-02-13 13:26:19 +0100257{
Ingo Molnarf1800532009-03-02 11:00:57 +0100258 return __copy_user_nocache(dst, src, size, 0);
Andi Kleen0812a572007-02-13 13:26:19 +0100259}
260
Vitaly Mayatskikh11295852008-07-02 15:48:21 +0200261unsigned long
262copy_user_handle_tail(char *to, char *from, unsigned len, unsigned zerorest);
263
H. Peter Anvin1965aae2008-10-22 22:26:29 -0700264#endif /* _ASM_X86_UACCESS_64_H */