blob: a78c40305447c7ae76194169f2f206a82c010396 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/prefetch.h>
Nick Piggin16dbc6c2008-10-02 14:50:12 -070010#include <linux/lockdep.h>
Jan Beulich1b1d9252009-12-18 16:12:56 +000011#include <asm/alternative.h>
12#include <asm/cpufeature.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <asm/page.h>
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015/*
16 * Copy To/From Userspace
17 */
18
19/* Handles exceptions in both to and from, but doesn't do access_ok */
Andi Kleen95912002006-09-26 10:52:39 +020020__must_check unsigned long
Jan Beulich1b1d9252009-12-18 16:12:56 +000021copy_user_generic_string(void *to, const void *from, unsigned len);
22__must_check unsigned long
23copy_user_generic_unrolled(void *to, const void *from, unsigned len);
24
25static __always_inline __must_check unsigned long
26copy_user_generic(void *to, const void *from, unsigned len)
27{
28 unsigned ret;
29
30 alternative_call(copy_user_generic_unrolled,
31 copy_user_generic_string,
32 X86_FEATURE_REP_GOOD,
33 ASM_OUTPUT2("=a" (ret), "=D" (to), "=S" (from),
34 "=d" (len)),
35 "1" (to), "2" (from), "3" (len)
36 : "memory", "rcx", "r8", "r9", "r10", "r11");
37 return ret;
38}
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Andi Kleen95912002006-09-26 10:52:39 +020040__must_check unsigned long
Frederic Weisbecker3c93ca02009-11-16 15:42:18 +010041_copy_to_user(void __user *to, const void *from, unsigned len);
Andi Kleen95912002006-09-26 10:52:39 +020042__must_check unsigned long
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020043_copy_from_user(void *to, const void __user *from, unsigned len);
Andi Kleen95912002006-09-26 10:52:39 +020044__must_check unsigned long
45copy_in_user(void __user *to, const void __user *from, unsigned len);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020047static inline unsigned long __must_check copy_from_user(void *to,
48 const void __user *from,
49 unsigned long n)
50{
51 int sz = __compiletime_object_size(to);
52 int ret = -EFAULT;
53
Frederic Weisbecker3c93ca02009-11-16 15:42:18 +010054 might_fault();
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020055 if (likely(sz == -1 || sz >= n))
56 ret = _copy_from_user(to, from, n);
57#ifdef CONFIG_DEBUG_VM
58 else
59 WARN(1, "Buffer overflow detected!\n");
60#endif
61 return ret;
62}
63
Frederic Weisbecker3c93ca02009-11-16 15:42:18 +010064static __always_inline __must_check
65int copy_to_user(void __user *dst, const void *src, unsigned size)
66{
67 might_fault();
68
69 return _copy_to_user(dst, src, size);
70}
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +020071
Andi Kleen95912002006-09-26 10:52:39 +020072static __always_inline __must_check
73int __copy_from_user(void *dst, const void __user *src, unsigned size)
Joe Perchesb8963132008-03-23 01:03:49 -070074{
Andi Kleen383d0792006-09-26 10:52:40 +020075 int ret = 0;
Ingo Molnard1a76182008-10-28 16:54:49 +010076
77 might_fault();
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 if (!__builtin_constant_p(size))
Joe Perchesb8963132008-03-23 01:03:49 -070079 return copy_user_generic(dst, (__force void *)src, size);
80 switch (size) {
81 case 1:__get_user_asm(*(u8 *)dst, (u8 __user *)src,
82 ret, "b", "b", "=q", 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -070084 case 2:__get_user_asm(*(u16 *)dst, (u16 __user *)src,
85 ret, "w", "w", "=r", 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -070087 case 4:__get_user_asm(*(u32 *)dst, (u32 __user *)src,
88 ret, "l", "k", "=r", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -070090 case 8:__get_user_asm(*(u64 *)dst, (u64 __user *)src,
91 ret, "q", "", "=r", 8);
92 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 case 10:
Joe Perchesb8963132008-03-23 01:03:49 -070094 __get_user_asm(*(u64 *)dst, (u64 __user *)src,
Hiroshi Shimamoto20a4a232008-11-13 18:06:04 -080095 ret, "q", "", "=r", 10);
Joe Perchesb8963132008-03-23 01:03:49 -070096 if (unlikely(ret))
97 return ret;
98 __get_user_asm(*(u16 *)(8 + (char *)dst),
99 (u16 __user *)(8 + (char __user *)src),
100 ret, "w", "w", "=r", 2);
101 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 case 16:
Joe Perchesb8963132008-03-23 01:03:49 -0700103 __get_user_asm(*(u64 *)dst, (u64 __user *)src,
104 ret, "q", "", "=r", 16);
105 if (unlikely(ret))
106 return ret;
107 __get_user_asm(*(u64 *)(8 + (char *)dst),
108 (u64 __user *)(8 + (char __user *)src),
109 ret, "q", "", "=r", 8);
110 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 default:
Joe Perchesb8963132008-03-23 01:03:49 -0700112 return copy_user_generic(dst, (__force void *)src, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 }
Joe Perchesb8963132008-03-23 01:03:49 -0700114}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Andi Kleen95912002006-09-26 10:52:39 +0200116static __always_inline __must_check
117int __copy_to_user(void __user *dst, const void *src, unsigned size)
Joe Perchesb8963132008-03-23 01:03:49 -0700118{
Andi Kleen383d0792006-09-26 10:52:40 +0200119 int ret = 0;
Ingo Molnard1a76182008-10-28 16:54:49 +0100120
121 might_fault();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 if (!__builtin_constant_p(size))
Joe Perchesb8963132008-03-23 01:03:49 -0700123 return copy_user_generic((__force void *)dst, src, size);
124 switch (size) {
125 case 1:__put_user_asm(*(u8 *)src, (u8 __user *)dst,
126 ret, "b", "b", "iq", 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -0700128 case 2:__put_user_asm(*(u16 *)src, (u16 __user *)dst,
129 ret, "w", "w", "ir", 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -0700131 case 4:__put_user_asm(*(u32 *)src, (u32 __user *)dst,
132 ret, "l", "k", "ir", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 return ret;
Joe Perchesb8963132008-03-23 01:03:49 -0700134 case 8:__put_user_asm(*(u64 *)src, (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200135 ret, "q", "", "er", 8);
Joe Perchesb8963132008-03-23 01:03:49 -0700136 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 case 10:
Joe Perchesb8963132008-03-23 01:03:49 -0700138 __put_user_asm(*(u64 *)src, (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200139 ret, "q", "", "er", 10);
Joe Perchesb8963132008-03-23 01:03:49 -0700140 if (unlikely(ret))
141 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 asm("":::"memory");
Joe Perchesb8963132008-03-23 01:03:49 -0700143 __put_user_asm(4[(u16 *)src], 4 + (u16 __user *)dst,
144 ret, "w", "w", "ir", 2);
145 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 case 16:
Joe Perchesb8963132008-03-23 01:03:49 -0700147 __put_user_asm(*(u64 *)src, (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200148 ret, "q", "", "er", 16);
Joe Perchesb8963132008-03-23 01:03:49 -0700149 if (unlikely(ret))
150 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 asm("":::"memory");
Joe Perchesb8963132008-03-23 01:03:49 -0700152 __put_user_asm(1[(u64 *)src], 1 + (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200153 ret, "q", "", "er", 8);
Joe Perchesb8963132008-03-23 01:03:49 -0700154 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 default:
Joe Perchesb8963132008-03-23 01:03:49 -0700156 return copy_user_generic((__force void *)dst, src, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 }
Joe Perchesb8963132008-03-23 01:03:49 -0700158}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Andi Kleen95912002006-09-26 10:52:39 +0200160static __always_inline __must_check
161int __copy_in_user(void __user *dst, const void __user *src, unsigned size)
Joe Perchesb8963132008-03-23 01:03:49 -0700162{
Andi Kleen383d0792006-09-26 10:52:40 +0200163 int ret = 0;
Ingo Molnard1a76182008-10-28 16:54:49 +0100164
165 might_fault();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 if (!__builtin_constant_p(size))
Joe Perchesb8963132008-03-23 01:03:49 -0700167 return copy_user_generic((__force void *)dst,
168 (__force void *)src, size);
169 switch (size) {
170 case 1: {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 u8 tmp;
Joe Perchesb8963132008-03-23 01:03:49 -0700172 __get_user_asm(tmp, (u8 __user *)src,
173 ret, "b", "b", "=q", 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 if (likely(!ret))
Joe Perchesb8963132008-03-23 01:03:49 -0700175 __put_user_asm(tmp, (u8 __user *)dst,
176 ret, "b", "b", "iq", 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 return ret;
178 }
Joe Perchesb8963132008-03-23 01:03:49 -0700179 case 2: {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 u16 tmp;
Joe Perchesb8963132008-03-23 01:03:49 -0700181 __get_user_asm(tmp, (u16 __user *)src,
182 ret, "w", "w", "=r", 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 if (likely(!ret))
Joe Perchesb8963132008-03-23 01:03:49 -0700184 __put_user_asm(tmp, (u16 __user *)dst,
185 ret, "w", "w", "ir", 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 return ret;
187 }
188
Joe Perchesb8963132008-03-23 01:03:49 -0700189 case 4: {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 u32 tmp;
Joe Perchesb8963132008-03-23 01:03:49 -0700191 __get_user_asm(tmp, (u32 __user *)src,
192 ret, "l", "k", "=r", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 if (likely(!ret))
Joe Perchesb8963132008-03-23 01:03:49 -0700194 __put_user_asm(tmp, (u32 __user *)dst,
195 ret, "l", "k", "ir", 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 return ret;
197 }
Joe Perchesb8963132008-03-23 01:03:49 -0700198 case 8: {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 u64 tmp;
Joe Perchesb8963132008-03-23 01:03:49 -0700200 __get_user_asm(tmp, (u64 __user *)src,
201 ret, "q", "", "=r", 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 if (likely(!ret))
Joe Perchesb8963132008-03-23 01:03:49 -0700203 __put_user_asm(tmp, (u64 __user *)dst,
Uros Bizjak155b7352009-07-19 18:06:35 +0200204 ret, "q", "", "er", 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 return ret;
206 }
207 default:
Joe Perchesb8963132008-03-23 01:03:49 -0700208 return copy_user_generic((__force void *)dst,
209 (__force void *)src, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 }
Joe Perchesb8963132008-03-23 01:03:49 -0700211}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Joe Perchesb8963132008-03-23 01:03:49 -0700213__must_check long
Andi Kleen95912002006-09-26 10:52:39 +0200214strncpy_from_user(char *dst, const char __user *src, long count);
Joe Perchesb8963132008-03-23 01:03:49 -0700215__must_check long
Andi Kleen95912002006-09-26 10:52:39 +0200216__strncpy_from_user(char *dst, const char __user *src, long count);
217__must_check long strnlen_user(const char __user *str, long n);
218__must_check long __strnlen_user(const char __user *str, long n);
219__must_check long strlen_user(const char __user *str);
220__must_check unsigned long clear_user(void __user *mem, unsigned long len);
221__must_check unsigned long __clear_user(void __user *mem, unsigned long len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Jan Beulich14722482009-11-13 11:56:24 +0000223static __must_check __always_inline int
224__copy_from_user_inatomic(void *dst, const void __user *src, unsigned size)
225{
226 return copy_user_generic(dst, (__force const void *)src, size);
227}
Andi Kleenb8858082006-09-30 01:47:55 +0200228
229static __must_check __always_inline int
230__copy_to_user_inatomic(void __user *dst, const void *src, unsigned size)
231{
232 return copy_user_generic((__force void *)dst, src, size);
233}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Joe Perchesb8963132008-03-23 01:03:49 -0700235extern long __copy_user_nocache(void *dst, const void __user *src,
236 unsigned size, int zerorest);
Andi Kleen0812a572007-02-13 13:26:19 +0100237
Ingo Molnarf1800532009-03-02 11:00:57 +0100238static inline int
239__copy_from_user_nocache(void *dst, const void __user *src, unsigned size)
Andi Kleen0812a572007-02-13 13:26:19 +0100240{
241 might_sleep();
Ingo Molnarf1800532009-03-02 11:00:57 +0100242 return __copy_user_nocache(dst, src, size, 1);
Andi Kleen0812a572007-02-13 13:26:19 +0100243}
244
Ingo Molnarf1800532009-03-02 11:00:57 +0100245static inline int
246__copy_from_user_inatomic_nocache(void *dst, const void __user *src,
247 unsigned size)
Andi Kleen0812a572007-02-13 13:26:19 +0100248{
Ingo Molnarf1800532009-03-02 11:00:57 +0100249 return __copy_user_nocache(dst, src, size, 0);
Andi Kleen0812a572007-02-13 13:26:19 +0100250}
251
Vitaly Mayatskikh11295852008-07-02 15:48:21 +0200252unsigned long
253copy_user_handle_tail(char *to, char *from, unsigned len, unsigned zerorest);
254
H. Peter Anvin1965aae2008-10-22 22:26:29 -0700255#endif /* _ASM_X86_UACCESS_64_H */