xref: /openbmc/linux/lib/usercopy.c (revision 74e19ef0)
1b2441318SGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0
2f5a1a536SAleksa Sarai #include <linux/bitops.h>
34d0e9df5SAlbert van der Linde #include <linux/fault-inject-usercopy.h>
476d6f06cSMarco Elver #include <linux/instrumented.h>
576d6f06cSMarco Elver #include <linux/uaccess.h>
6*74e19ef0SDave Hansen #include <linux/nospec.h>
7d597580dSAl Viro 
8d597580dSAl Viro /* out-of-line parts */
9d597580dSAl Viro 
10d597580dSAl Viro #ifndef INLINE_COPY_FROM_USER
_copy_from_user(void * to,const void __user * from,unsigned long n)11d597580dSAl Viro unsigned long _copy_from_user(void *to, const void __user *from, unsigned long n)
12d597580dSAl Viro {
13d597580dSAl Viro 	unsigned long res = n;
149c5f6908SAl Viro 	might_fault();
154d0e9df5SAlbert van der Linde 	if (!should_fail_usercopy() && likely(access_ok(from, n))) {
16*74e19ef0SDave Hansen 		/*
17*74e19ef0SDave Hansen 		 * Ensure that bad access_ok() speculation will not
18*74e19ef0SDave Hansen 		 * lead to nasty side effects *after* the copy is
19*74e19ef0SDave Hansen 		 * finished:
20*74e19ef0SDave Hansen 		 */
21*74e19ef0SDave Hansen 		barrier_nospec();
2233b75c1dSAlexander Potapenko 		instrument_copy_from_user_before(to, from, n);
23d597580dSAl Viro 		res = raw_copy_from_user(to, from, n);
2433b75c1dSAlexander Potapenko 		instrument_copy_from_user_after(to, from, n, res);
259c5f6908SAl Viro 	}
26d597580dSAl Viro 	if (unlikely(res))
27d597580dSAl Viro 		memset(to + (n - res), 0, res);
28d597580dSAl Viro 	return res;
29d597580dSAl Viro }
30d597580dSAl Viro EXPORT_SYMBOL(_copy_from_user);
31d597580dSAl Viro #endif
32d597580dSAl Viro 
33d597580dSAl Viro #ifndef INLINE_COPY_TO_USER
_copy_to_user(void __user * to,const void * from,unsigned long n)34a0e94598SChristophe Leroy unsigned long _copy_to_user(void __user *to, const void *from, unsigned long n)
35d597580dSAl Viro {
369c5f6908SAl Viro 	might_fault();
374d0e9df5SAlbert van der Linde 	if (should_fail_usercopy())
384d0e9df5SAlbert van der Linde 		return n;
3996d4f267SLinus Torvalds 	if (likely(access_ok(to, n))) {
4076d6f06cSMarco Elver 		instrument_copy_to_user(to, from, n);
41d597580dSAl Viro 		n = raw_copy_to_user(to, from, n);
429c5f6908SAl Viro 	}
43d597580dSAl Viro 	return n;
44d597580dSAl Viro }
45d597580dSAl Viro EXPORT_SYMBOL(_copy_to_user);
46d597580dSAl Viro #endif
47f5a1a536SAleksa Sarai 
48f5a1a536SAleksa Sarai /**
49f5a1a536SAleksa Sarai  * check_zeroed_user: check if a userspace buffer only contains zero bytes
50f5a1a536SAleksa Sarai  * @from: Source address, in userspace.
51f5a1a536SAleksa Sarai  * @size: Size of buffer.
52f5a1a536SAleksa Sarai  *
53f5a1a536SAleksa Sarai  * This is effectively shorthand for "memchr_inv(from, 0, size) == NULL" for
54f5a1a536SAleksa Sarai  * userspace addresses (and is more efficient because we don't care where the
55f5a1a536SAleksa Sarai  * first non-zero byte is).
56f5a1a536SAleksa Sarai  *
57f5a1a536SAleksa Sarai  * Returns:
58f5a1a536SAleksa Sarai  *  * 0: There were non-zero bytes present in the buffer.
59f5a1a536SAleksa Sarai  *  * 1: The buffer was full of zero bytes.
60f5a1a536SAleksa Sarai  *  * -EFAULT: access to userspace failed.
61f5a1a536SAleksa Sarai  */
check_zeroed_user(const void __user * from,size_t size)62f5a1a536SAleksa Sarai int check_zeroed_user(const void __user *from, size_t size)
63f5a1a536SAleksa Sarai {
64f5a1a536SAleksa Sarai 	unsigned long val;
65f5a1a536SAleksa Sarai 	uintptr_t align = (uintptr_t) from % sizeof(unsigned long);
66f5a1a536SAleksa Sarai 
67f5a1a536SAleksa Sarai 	if (unlikely(size == 0))
68f5a1a536SAleksa Sarai 		return 1;
69f5a1a536SAleksa Sarai 
70f5a1a536SAleksa Sarai 	from -= align;
71f5a1a536SAleksa Sarai 	size += align;
72f5a1a536SAleksa Sarai 
7341cd7805SChristophe Leroy 	if (!user_read_access_begin(from, size))
74f5a1a536SAleksa Sarai 		return -EFAULT;
75f5a1a536SAleksa Sarai 
76f5a1a536SAleksa Sarai 	unsafe_get_user(val, (unsigned long __user *) from, err_fault);
77f5a1a536SAleksa Sarai 	if (align)
78f5a1a536SAleksa Sarai 		val &= ~aligned_byte_mask(align);
79f5a1a536SAleksa Sarai 
80f5a1a536SAleksa Sarai 	while (size > sizeof(unsigned long)) {
81f5a1a536SAleksa Sarai 		if (unlikely(val))
82f5a1a536SAleksa Sarai 			goto done;
83f5a1a536SAleksa Sarai 
84f5a1a536SAleksa Sarai 		from += sizeof(unsigned long);
85f5a1a536SAleksa Sarai 		size -= sizeof(unsigned long);
86f5a1a536SAleksa Sarai 
87f5a1a536SAleksa Sarai 		unsafe_get_user(val, (unsigned long __user *) from, err_fault);
88f5a1a536SAleksa Sarai 	}
89f5a1a536SAleksa Sarai 
90f5a1a536SAleksa Sarai 	if (size < sizeof(unsigned long))
91f5a1a536SAleksa Sarai 		val &= aligned_byte_mask(size);
92f5a1a536SAleksa Sarai 
93f5a1a536SAleksa Sarai done:
9441cd7805SChristophe Leroy 	user_read_access_end();
95f5a1a536SAleksa Sarai 	return (val == 0);
96f5a1a536SAleksa Sarai err_fault:
9741cd7805SChristophe Leroy 	user_read_access_end();
98f5a1a536SAleksa Sarai 	return -EFAULT;
99f5a1a536SAleksa Sarai }
100f5a1a536SAleksa Sarai EXPORT_SYMBOL(check_zeroed_user);
101