Blame view

mm/maccess.c 6.84 KB
457c89965   Thomas Gleixner   treewide: Add SPD...
1
  // SPDX-License-Identifier: GPL-2.0-only
c33fa9f56   Ingo Molnar   uaccess: add prob...
2
3
4
  /*
   * Access kernel memory without faulting.
   */
b95f1b31b   Paul Gortmaker   mm: Map most file...
5
  #include <linux/export.h>
c33fa9f56   Ingo Molnar   uaccess: add prob...
6
  #include <linux/mm.h>
7c7fcf762   David Howells   MN10300: Save fra...
7
  #include <linux/uaccess.h>
c33fa9f56   Ingo Molnar   uaccess: add prob...
8

3d7081822   Masami Hiramatsu   uaccess: Add non-...
9
10
11
12
13
14
15
16
17
18
19
  static __always_inline long
  probe_read_common(void *dst, const void __user *src, size_t size)
  {
  	long ret;
  
  	pagefault_disable();
  	ret = __copy_from_user_inatomic(dst, src, size);
  	pagefault_enable();
  
  	return ret ? -EFAULT : 0;
  }
e5194ee4b   Daniel Borkmann   uaccess: Add non-...
20
21
22
23
24
25
26
27
28
29
30
  static __always_inline long
  probe_write_common(void __user *dst, const void *src, size_t size)
  {
  	long ret;
  
  	pagefault_disable();
  	ret = __copy_to_user_inatomic(dst, src, size);
  	pagefault_enable();
  
  	return ret ? -EFAULT : 0;
  }
c33fa9f56   Ingo Molnar   uaccess: add prob...
31
  /**
3d7081822   Masami Hiramatsu   uaccess: Add non-...
32
   * probe_kernel_read(): safely attempt to read from a kernel-space location
c33fa9f56   Ingo Molnar   uaccess: add prob...
33
34
35
36
37
38
   * @dst: pointer to the buffer that shall take the data
   * @src: address to read from
   * @size: size of the data chunk
   *
   * Safely read from address @src to the buffer at @dst.  If a kernel fault
   * happens, handle that and return -EFAULT.
0ab32b6f1   Andrew Morton   uaccess: reimplem...
39
40
41
42
43
   *
   * We ensure that the copy_from_user is executed in atomic context so that
   * do_page_fault() doesn't attempt to take mmap_sem.  This makes
   * probe_kernel_read() suitable for use within regions where the caller
   * already holds mmap_sem, or other locks which nest inside mmap_sem.
c33fa9f56   Ingo Molnar   uaccess: add prob...
44
   */
6144a85a0   Jason Wessel   maccess,probe_ker...
45

f29c50419   Steven Rostedt   maccess,probe_ker...
46
  long __weak probe_kernel_read(void *dst, const void *src, size_t size)
6144a85a0   Jason Wessel   maccess,probe_ker...
47
      __attribute__((alias("__probe_kernel_read")));
f29c50419   Steven Rostedt   maccess,probe_ker...
48
  long __probe_kernel_read(void *dst, const void *src, size_t size)
c33fa9f56   Ingo Molnar   uaccess: add prob...
49
50
  {
  	long ret;
b4b8ac524   Jason Wessel   kgdb: fix optiona...
51
  	mm_segment_t old_fs = get_fs();
c33fa9f56   Ingo Molnar   uaccess: add prob...
52

b4b8ac524   Jason Wessel   kgdb: fix optiona...
53
  	set_fs(KERNEL_DS);
3d7081822   Masami Hiramatsu   uaccess: Add non-...
54
  	ret = probe_read_common(dst, (__force const void __user *)src, size);
b4b8ac524   Jason Wessel   kgdb: fix optiona...
55
  	set_fs(old_fs);
c33fa9f56   Ingo Molnar   uaccess: add prob...
56

3d7081822   Masami Hiramatsu   uaccess: Add non-...
57
  	return ret;
c33fa9f56   Ingo Molnar   uaccess: add prob...
58
59
60
61
  }
  EXPORT_SYMBOL_GPL(probe_kernel_read);
  
  /**
3d7081822   Masami Hiramatsu   uaccess: Add non-...
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
   * probe_user_read(): safely attempt to read from a user-space location
   * @dst: pointer to the buffer that shall take the data
   * @src: address to read from. This must be a user address.
   * @size: size of the data chunk
   *
   * Safely read from user address @src to the buffer at @dst. If a kernel fault
   * happens, handle that and return -EFAULT.
   */
  
  long __weak probe_user_read(void *dst, const void __user *src, size_t size)
      __attribute__((alias("__probe_user_read")));
  
  long __probe_user_read(void *dst, const void __user *src, size_t size)
  {
  	long ret = -EFAULT;
  	mm_segment_t old_fs = get_fs();
  
  	set_fs(USER_DS);
  	if (access_ok(src, size))
  		ret = probe_read_common(dst, src, size);
  	set_fs(old_fs);
  
  	return ret;
  }
  EXPORT_SYMBOL_GPL(probe_user_read);
  
  /**
c33fa9f56   Ingo Molnar   uaccess: add prob...
89
90
91
92
93
94
95
96
   * probe_kernel_write(): safely attempt to write to a location
   * @dst: address to write to
   * @src: pointer to the data that shall be written
   * @size: size of the data chunk
   *
   * Safely write to address @dst from the buffer at @src.  If a kernel fault
   * happens, handle that and return -EFAULT.
   */
e5194ee4b   Daniel Borkmann   uaccess: Add non-...
97

f29c50419   Steven Rostedt   maccess,probe_ker...
98
  long __weak probe_kernel_write(void *dst, const void *src, size_t size)
6144a85a0   Jason Wessel   maccess,probe_ker...
99
      __attribute__((alias("__probe_kernel_write")));
f29c50419   Steven Rostedt   maccess,probe_ker...
100
  long __probe_kernel_write(void *dst, const void *src, size_t size)
c33fa9f56   Ingo Molnar   uaccess: add prob...
101
102
  {
  	long ret;
b4b8ac524   Jason Wessel   kgdb: fix optiona...
103
  	mm_segment_t old_fs = get_fs();
c33fa9f56   Ingo Molnar   uaccess: add prob...
104

b4b8ac524   Jason Wessel   kgdb: fix optiona...
105
  	set_fs(KERNEL_DS);
e5194ee4b   Daniel Borkmann   uaccess: Add non-...
106
  	ret = probe_write_common((__force void __user *)dst, src, size);
b4b8ac524   Jason Wessel   kgdb: fix optiona...
107
  	set_fs(old_fs);
c33fa9f56   Ingo Molnar   uaccess: add prob...
108

e5194ee4b   Daniel Borkmann   uaccess: Add non-...
109
  	return ret;
c33fa9f56   Ingo Molnar   uaccess: add prob...
110
111
  }
  EXPORT_SYMBOL_GPL(probe_kernel_write);
dbb7ee0e4   Alexei Starovoitov   lib: move strncpy...
112

e5194ee4b   Daniel Borkmann   uaccess: Add non-...
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
  /**
   * probe_user_write(): safely attempt to write to a user-space location
   * @dst: address to write to
   * @src: pointer to the data that shall be written
   * @size: size of the data chunk
   *
   * Safely write to address @dst from the buffer at @src.  If a kernel fault
   * happens, handle that and return -EFAULT.
   */
  
  long __weak probe_user_write(void __user *dst, const void *src, size_t size)
      __attribute__((alias("__probe_user_write")));
  
  long __probe_user_write(void __user *dst, const void *src, size_t size)
  {
  	long ret = -EFAULT;
  	mm_segment_t old_fs = get_fs();
  
  	set_fs(USER_DS);
  	if (access_ok(dst, size))
  		ret = probe_write_common(dst, src, size);
  	set_fs(old_fs);
  
  	return ret;
  }
  EXPORT_SYMBOL_GPL(probe_user_write);
3d7081822   Masami Hiramatsu   uaccess: Add non-...
139

dbb7ee0e4   Alexei Starovoitov   lib: move strncpy...
140
141
142
143
  /**
   * strncpy_from_unsafe: - Copy a NUL terminated string from unsafe address.
   * @dst:   Destination address, in kernel space.  This buffer must be at
   *         least @count bytes long.
f144c390f   Mike Rapoport   mm: docs: fix par...
144
   * @unsafe_addr: Unsafe address.
dbb7ee0e4   Alexei Starovoitov   lib: move strncpy...
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
   * @count: Maximum number of bytes to copy, including the trailing NUL.
   *
   * Copies a NUL-terminated string from unsafe address to kernel buffer.
   *
   * On success, returns the length of the string INCLUDING the trailing NUL.
   *
   * If access fails, returns -EFAULT (some data may have been copied
   * and the trailing NUL added).
   *
   * If @count is smaller than the length of the string, copies @count-1 bytes,
   * sets the last byte of @dst buffer to NUL and returns @count.
   */
  long strncpy_from_unsafe(char *dst, const void *unsafe_addr, long count)
  {
  	mm_segment_t old_fs = get_fs();
  	const void *src = unsafe_addr;
  	long ret;
  
  	if (unlikely(count <= 0))
  		return 0;
  
  	set_fs(KERNEL_DS);
  	pagefault_disable();
  
  	do {
bd28b1459   Linus Torvalds   x86: remove more ...
170
  		ret = __get_user(*dst++, (const char __user __force *)src++);
dbb7ee0e4   Alexei Starovoitov   lib: move strncpy...
171
172
173
174
175
  	} while (dst[-1] && ret == 0 && src - unsafe_addr < count);
  
  	dst[-1] = '\0';
  	pagefault_enable();
  	set_fs(old_fs);
9dd861d55   Rasmus Villemoes   mm/maccess.c: act...
176
  	return ret ? -EFAULT : src - unsafe_addr;
dbb7ee0e4   Alexei Starovoitov   lib: move strncpy...
177
  }
3d7081822   Masami Hiramatsu   uaccess: Add non-...
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
  
  /**
   * strncpy_from_unsafe_user: - Copy a NUL terminated string from unsafe user
   *				address.
   * @dst:   Destination address, in kernel space.  This buffer must be at
   *         least @count bytes long.
   * @unsafe_addr: Unsafe user address.
   * @count: Maximum number of bytes to copy, including the trailing NUL.
   *
   * Copies a NUL-terminated string from unsafe user address to kernel buffer.
   *
   * On success, returns the length of the string INCLUDING the trailing NUL.
   *
   * If access fails, returns -EFAULT (some data may have been copied
   * and the trailing NUL added).
   *
   * If @count is smaller than the length of the string, copies @count-1 bytes,
   * sets the last byte of @dst buffer to NUL and returns @count.
   */
  long strncpy_from_unsafe_user(char *dst, const void __user *unsafe_addr,
  			      long count)
  {
  	mm_segment_t old_fs = get_fs();
  	long ret;
  
  	if (unlikely(count <= 0))
  		return 0;
  
  	set_fs(USER_DS);
  	pagefault_disable();
  	ret = strncpy_from_user(dst, unsafe_addr, count);
  	pagefault_enable();
  	set_fs(old_fs);
  
  	if (ret >= count) {
  		ret = count;
  		dst[ret - 1] = '\0';
  	} else if (ret > 0) {
  		ret++;
  	}
  
  	return ret;
  }
  
  /**
   * strnlen_unsafe_user: - Get the size of a user string INCLUDING final NUL.
   * @unsafe_addr: The string to measure.
   * @count: Maximum count (including NUL)
   *
   * Get the size of a NUL-terminated string in user space without pagefault.
   *
   * Returns the size of the string INCLUDING the terminating NUL.
   *
   * If the string is too long, returns a number larger than @count. User
   * has to check the return value against "> count".
   * On exception (or invalid count), returns 0.
   *
   * Unlike strnlen_user, this can be used from IRQ handler etc. because
   * it disables pagefaults.
   */
  long strnlen_unsafe_user(const void __user *unsafe_addr, long count)
  {
  	mm_segment_t old_fs = get_fs();
  	int ret;
  
  	set_fs(USER_DS);
  	pagefault_disable();
  	ret = strnlen_user(unsafe_addr, count);
  	pagefault_enable();
  	set_fs(old_fs);
  
  	return ret;
  }