blob: f5dcb5204dcd5b27e8b8e9a1b87612a28cda10c6 [file] [log] [blame]
H. Peter Anvin1965aae2008-10-22 22:26:29 -07001#ifndef _ASM_X86_UACCESS_32_H
2#define _ASM_X86_UACCESS_32_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/errno.h>
8#include <linux/thread_info.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/string.h>
H. Peter Anvin14e6d172008-02-04 16:47:59 +010010#include <asm/asm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <asm/page.h>
12
Joe Perchesb1fcec72008-03-23 01:03:48 -070013unsigned long __must_check __copy_to_user_ll
14 (void __user *to, const void *from, unsigned long n);
15unsigned long __must_check __copy_from_user_ll
16 (void *to, const void __user *from, unsigned long n);
17unsigned long __must_check __copy_from_user_ll_nozero
18 (void *to, const void __user *from, unsigned long n);
19unsigned long __must_check __copy_from_user_ll_nocache
20 (void *to, const void __user *from, unsigned long n);
21unsigned long __must_check __copy_from_user_ll_nocache_nozero
22 (void *to, const void __user *from, unsigned long n);
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Aneesh Kumar K.V6d1c4262007-05-02 19:27:06 +020024/**
25 * __copy_to_user_inatomic: - Copy a block of data into user space, with less checking.
26 * @to: Destination address, in user space.
27 * @from: Source address, in kernel space.
28 * @n: Number of bytes to copy.
29 *
30 * Context: User context only.
31 *
32 * Copy data from kernel space to user space. Caller must check
33 * the specified block with access_ok() before calling this function.
34 * The caller should also make sure he pins the user space address
Sergey Senozhatsky4fe48782009-09-17 15:54:01 +030035 * so that we don't result in page fault and sleep.
Aneesh Kumar K.V6d1c4262007-05-02 19:27:06 +020036 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 * Here we special-case 1, 2 and 4-byte copy_*_user invocations. On a fault
38 * we return the initial request size (1, 2 or 4), as copy_*_user should do.
39 * If a store crosses a page boundary and gets a fault, the x86 will not write
40 * anything, so this is accurate.
41 */
42
Ingo Molnar652050a2006-01-14 13:21:30 -080043static __always_inline unsigned long __must_check
Linus Torvalds1da177e2005-04-16 15:20:36 -070044__copy_to_user_inatomic(void __user *to, const void *from, unsigned long n)
45{
46 if (__builtin_constant_p(n)) {
47 unsigned long ret;
48
49 switch (n) {
50 case 1:
Joe Perchesb1fcec72008-03-23 01:03:48 -070051 __put_user_size(*(u8 *)from, (u8 __user *)to,
52 1, ret, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 return ret;
54 case 2:
Joe Perchesb1fcec72008-03-23 01:03:48 -070055 __put_user_size(*(u16 *)from, (u16 __user *)to,
56 2, ret, 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 return ret;
58 case 4:
Joe Perchesb1fcec72008-03-23 01:03:48 -070059 __put_user_size(*(u32 *)from, (u32 __user *)to,
60 4, ret, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 return ret;
Chris Wilson6a907732015-04-15 10:51:26 +010062 case 8:
63 __put_user_size(*(u64 *)from, (u64 __user *)to,
64 8, ret, 8);
65 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 }
67 }
68 return __copy_to_user_ll(to, from, n);
69}
70
Randy Dunlap9c7fff62006-10-11 01:22:10 -070071/**
72 * __copy_to_user: - Copy a block of data into user space, with less checking.
73 * @to: Destination address, in user space.
74 * @from: Source address, in kernel space.
75 * @n: Number of bytes to copy.
76 *
David Hildenbrandb3c395e2015-05-11 17:52:08 +020077 * Context: User context only. This function may sleep if pagefaults are
78 * enabled.
Randy Dunlap9c7fff62006-10-11 01:22:10 -070079 *
80 * Copy data from kernel space to user space. Caller must check
81 * the specified block with access_ok() before calling this function.
82 *
83 * Returns number of bytes that could not be copied.
84 * On success, this will be zero.
85 */
Ingo Molnar652050a2006-01-14 13:21:30 -080086static __always_inline unsigned long __must_check
Linus Torvalds1da177e2005-04-16 15:20:36 -070087__copy_to_user(void __user *to, const void *from, unsigned long n)
88{
Ingo Molnard1a76182008-10-28 16:54:49 +010089 might_fault();
90 return __copy_to_user_inatomic(to, from, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091}
92
Ingo Molnar652050a2006-01-14 13:21:30 -080093static __always_inline unsigned long
Linus Torvalds1da177e2005-04-16 15:20:36 -070094__copy_from_user_inatomic(void *to, const void __user *from, unsigned long n)
95{
NeilBrown7c12d812006-06-25 05:48:02 -070096 /* Avoid zeroing the tail if the copy fails..
97 * If 'n' is constant and 1, 2, or 4, we do still zero on a failure,
98 * but as the zeroing behaviour is only significant when n is not
99 * constant, that shouldn't be a problem.
100 */
101 if (__builtin_constant_p(n)) {
102 unsigned long ret;
103
104 switch (n) {
105 case 1:
106 __get_user_size(*(u8 *)to, from, 1, ret, 1);
107 return ret;
108 case 2:
109 __get_user_size(*(u16 *)to, from, 2, ret, 2);
110 return ret;
111 case 4:
112 __get_user_size(*(u32 *)to, from, 4, ret, 4);
113 return ret;
114 }
115 }
116 return __copy_from_user_ll_nozero(to, from, n);
117}
Randy Dunlap9c7fff62006-10-11 01:22:10 -0700118
119/**
120 * __copy_from_user: - Copy a block of data from user space, with less checking.
121 * @to: Destination address, in kernel space.
122 * @from: Source address, in user space.
123 * @n: Number of bytes to copy.
124 *
David Hildenbrandb3c395e2015-05-11 17:52:08 +0200125 * Context: User context only. This function may sleep if pagefaults are
126 * enabled.
Randy Dunlap9c7fff62006-10-11 01:22:10 -0700127 *
128 * Copy data from user space to kernel space. Caller must check
129 * the specified block with access_ok() before calling this function.
130 *
131 * Returns number of bytes that could not be copied.
132 * On success, this will be zero.
133 *
134 * If some data could not be copied, this function will pad the copied
135 * data to the requested size using zero bytes.
136 *
137 * An alternate version - __copy_from_user_inatomic() - may be called from
138 * atomic context and will fail rather than sleep. In this case the
139 * uncopied bytes will *NOT* be padded with zeros. See fs/filemap.h
140 * for explanation of why this is needed.
141 */
NeilBrown7c12d812006-06-25 05:48:02 -0700142static __always_inline unsigned long
143__copy_from_user(void *to, const void __user *from, unsigned long n)
144{
Ingo Molnard1a76182008-10-28 16:54:49 +0100145 might_fault();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 if (__builtin_constant_p(n)) {
147 unsigned long ret;
148
149 switch (n) {
150 case 1:
151 __get_user_size(*(u8 *)to, from, 1, ret, 1);
152 return ret;
153 case 2:
154 __get_user_size(*(u16 *)to, from, 2, ret, 2);
155 return ret;
156 case 4:
157 __get_user_size(*(u32 *)to, from, 4, ret, 4);
158 return ret;
159 }
160 }
161 return __copy_from_user_ll(to, from, n);
162}
163
NeilBrown7c12d812006-06-25 05:48:02 -0700164static __always_inline unsigned long __copy_from_user_nocache(void *to,
Hiro Yoshiokac22ce142006-06-23 02:04:16 -0700165 const void __user *from, unsigned long n)
166{
Ingo Molnard1a76182008-10-28 16:54:49 +0100167 might_fault();
Hiro Yoshiokac22ce142006-06-23 02:04:16 -0700168 if (__builtin_constant_p(n)) {
169 unsigned long ret;
170
171 switch (n) {
172 case 1:
173 __get_user_size(*(u8 *)to, from, 1, ret, 1);
174 return ret;
175 case 2:
176 __get_user_size(*(u16 *)to, from, 2, ret, 2);
177 return ret;
178 case 4:
179 __get_user_size(*(u32 *)to, from, 4, ret, 4);
180 return ret;
181 }
182 }
183 return __copy_from_user_ll_nocache(to, from, n);
184}
185
Ingo Molnar652050a2006-01-14 13:21:30 -0800186static __always_inline unsigned long
Joe Perchesb1fcec72008-03-23 01:03:48 -0700187__copy_from_user_inatomic_nocache(void *to, const void __user *from,
188 unsigned long n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
NeilBrown7c12d812006-06-25 05:48:02 -0700190 return __copy_from_user_ll_nocache_nozero(to, from, n);
Hiro Yoshiokac22ce142006-06-23 02:04:16 -0700191}
192
H. Peter Anvin1965aae2008-10-22 22:26:29 -0700193#endif /* _ASM_X86_UACCESS_32_H */