Linux Audio

Check our new training course

Loading...
v3.1
  1#ifndef __ASM_GENERIC_UACCESS_H
  2#define __ASM_GENERIC_UACCESS_H
  3
  4/*
  5 * User space memory access functions, these should work
  6 * on a ny machine that has kernel and user data in the same
  7 * address space, e.g. all NOMMU machines.
  8 */
  9#include <linux/sched.h>
 10#include <linux/mm.h>
 11#include <linux/string.h>
 12
 13#include <asm/segment.h>
 14
 15#define MAKE_MM_SEG(s)	((mm_segment_t) { (s) })
 16
 17#ifndef KERNEL_DS
 18#define KERNEL_DS	MAKE_MM_SEG(~0UL)
 19#endif
 20
 21#ifndef USER_DS
 22#define USER_DS		MAKE_MM_SEG(TASK_SIZE - 1)
 23#endif
 24
 25#ifndef get_fs
 26#define get_ds()	(KERNEL_DS)
 27#define get_fs()	(current_thread_info()->addr_limit)
 28
 29static inline void set_fs(mm_segment_t fs)
 30{
 31	current_thread_info()->addr_limit = fs;
 32}
 33#endif
 34
 
 35#define segment_eq(a, b) ((a).seg == (b).seg)
 
 36
 37#define VERIFY_READ	0
 38#define VERIFY_WRITE	1
 39
 40#define access_ok(type, addr, size) __access_ok((unsigned long)(addr),(size))
 41
 42/*
 43 * The architecture should really override this if possible, at least
 44 * doing a check on the get_fs()
 45 */
 46#ifndef __access_ok
 47static inline int __access_ok(unsigned long addr, unsigned long size)
 48{
 49	return 1;
 50}
 51#endif
 52
 53/*
 54 * The exception table consists of pairs of addresses: the first is the
 55 * address of an instruction that is allowed to fault, and the second is
 56 * the address at which the program should continue.  No registers are
 57 * modified, so it is entirely up to the continuation code to figure out
 58 * what to do.
 59 *
 60 * All the routines below use bits of fixup code that are out of line
 61 * with the main instruction path.  This means when everything is well,
 62 * we don't even have to jump over them.  Further, they do not intrude
 63 * on our cache or tlb entries.
 64 */
 65
 66struct exception_table_entry
 67{
 68	unsigned long insn, fixup;
 69};
 70
 71/* Returns 0 if exception not found and fixup otherwise.  */
 72extern unsigned long search_exception_table(unsigned long);
 73
 74/*
 75 * architectures with an MMU should override these two
 76 */
 77#ifndef __copy_from_user
 78static inline __must_check long __copy_from_user(void *to,
 79		const void __user * from, unsigned long n)
 80{
 81	if (__builtin_constant_p(n)) {
 82		switch(n) {
 83		case 1:
 84			*(u8 *)to = *(u8 __force *)from;
 85			return 0;
 86		case 2:
 87			*(u16 *)to = *(u16 __force *)from;
 88			return 0;
 89		case 4:
 90			*(u32 *)to = *(u32 __force *)from;
 91			return 0;
 92#ifdef CONFIG_64BIT
 93		case 8:
 94			*(u64 *)to = *(u64 __force *)from;
 95			return 0;
 96#endif
 97		default:
 98			break;
 99		}
100	}
101
102	memcpy(to, (const void __force *)from, n);
103	return 0;
104}
105#endif
106
107#ifndef __copy_to_user
108static inline __must_check long __copy_to_user(void __user *to,
109		const void *from, unsigned long n)
110{
111	if (__builtin_constant_p(n)) {
112		switch(n) {
113		case 1:
114			*(u8 __force *)to = *(u8 *)from;
115			return 0;
116		case 2:
117			*(u16 __force *)to = *(u16 *)from;
118			return 0;
119		case 4:
120			*(u32 __force *)to = *(u32 *)from;
121			return 0;
122#ifdef CONFIG_64BIT
123		case 8:
124			*(u64 __force *)to = *(u64 *)from;
125			return 0;
126#endif
127		default:
128			break;
129		}
130	}
131
132	memcpy((void __force *)to, from, n);
133	return 0;
134}
135#endif
136
137/*
138 * These are the main single-value transfer routines.  They automatically
139 * use the right size if we just have the right pointer type.
140 * This version just falls back to copy_{from,to}_user, which should
141 * provide a fast-path for small values.
142 */
143#define __put_user(x, ptr) \
144({								\
145	__typeof__(*(ptr)) __x = (x);				\
146	int __pu_err = -EFAULT;					\
147        __chk_user_ptr(ptr);                                    \
148	switch (sizeof (*(ptr))) {				\
149	case 1:							\
150	case 2:							\
151	case 4:							\
152	case 8:							\
153		__pu_err = __put_user_fn(sizeof (*(ptr)),	\
154					 ptr, &__x);		\
155		break;						\
156	default:						\
157		__put_user_bad();				\
158		break;						\
159	 }							\
160	__pu_err;						\
161})
162
163#define put_user(x, ptr)					\
164({								\
165	might_sleep();						\
166	access_ok(VERIFY_WRITE, ptr, sizeof(*ptr)) ?		\
167		__put_user(x, ptr) :				\
 
168		-EFAULT;					\
169})
170
 
 
171static inline int __put_user_fn(size_t size, void __user *ptr, void *x)
172{
173	size = __copy_to_user(ptr, x, size);
174	return size ? -EFAULT : size;
175}
176
 
 
 
 
177extern int __put_user_bad(void) __attribute__((noreturn));
178
179#define __get_user(x, ptr)					\
180({								\
181	int __gu_err = -EFAULT;					\
182	__chk_user_ptr(ptr);					\
183	switch (sizeof(*(ptr))) {				\
184	case 1: {						\
185		unsigned char __x;				\
186		__gu_err = __get_user_fn(sizeof (*(ptr)),	\
187					 ptr, &__x);		\
188		(x) = *(__force __typeof__(*(ptr)) *) &__x;	\
189		break;						\
190	};							\
191	case 2: {						\
192		unsigned short __x;				\
193		__gu_err = __get_user_fn(sizeof (*(ptr)),	\
194					 ptr, &__x);		\
195		(x) = *(__force __typeof__(*(ptr)) *) &__x;	\
196		break;						\
197	};							\
198	case 4: {						\
199		unsigned int __x;				\
200		__gu_err = __get_user_fn(sizeof (*(ptr)),	\
201					 ptr, &__x);		\
202		(x) = *(__force __typeof__(*(ptr)) *) &__x;	\
203		break;						\
204	};							\
205	case 8: {						\
206		unsigned long long __x;				\
207		__gu_err = __get_user_fn(sizeof (*(ptr)),	\
208					 ptr, &__x);		\
209		(x) = *(__force __typeof__(*(ptr)) *) &__x;	\
210		break;						\
211	};							\
212	default:						\
213		__get_user_bad();				\
214		break;						\
215	}							\
216	__gu_err;						\
217})
218
219#define get_user(x, ptr)					\
220({								\
221	might_sleep();						\
222	access_ok(VERIFY_READ, ptr, sizeof(*ptr)) ?		\
223		__get_user(x, ptr) :				\
 
224		-EFAULT;					\
225})
226
 
227static inline int __get_user_fn(size_t size, const void __user *ptr, void *x)
228{
229	size = __copy_from_user(x, ptr, size);
230	return size ? -EFAULT : size;
231}
232
 
 
 
 
233extern int __get_user_bad(void) __attribute__((noreturn));
234
235#ifndef __copy_from_user_inatomic
236#define __copy_from_user_inatomic __copy_from_user
237#endif
238
239#ifndef __copy_to_user_inatomic
240#define __copy_to_user_inatomic __copy_to_user
241#endif
242
243static inline long copy_from_user(void *to,
244		const void __user * from, unsigned long n)
245{
246	might_sleep();
247	if (access_ok(VERIFY_READ, from, n))
248		return __copy_from_user(to, from, n);
249	else
250		return n;
251}
252
253static inline long copy_to_user(void __user *to,
254		const void *from, unsigned long n)
255{
256	might_sleep();
257	if (access_ok(VERIFY_WRITE, to, n))
258		return __copy_to_user(to, from, n);
259	else
260		return n;
261}
262
263/*
264 * Copy a null terminated string from userspace.
265 */
266#ifndef __strncpy_from_user
267static inline long
268__strncpy_from_user(char *dst, const char __user *src, long count)
269{
270	char *tmp;
271	strncpy(dst, (const char __force *)src, count);
272	for (tmp = dst; *tmp && count > 0; tmp++, count--)
273		;
274	return (tmp - dst);
275}
276#endif
277
278static inline long
279strncpy_from_user(char *dst, const char __user *src, long count)
280{
281	if (!access_ok(VERIFY_READ, src, 1))
282		return -EFAULT;
283	return __strncpy_from_user(dst, src, count);
284}
285
286/*
287 * Return the size of a string (including the ending 0)
288 *
289 * Return 0 on exception, a value greater than N if too long
290 */
291#ifndef __strnlen_user
292#define __strnlen_user strnlen
293#endif
294
 
 
 
 
 
295static inline long strnlen_user(const char __user *src, long n)
296{
297	if (!access_ok(VERIFY_READ, src, 1))
298		return 0;
299	return __strnlen_user(src, n);
300}
301
302static inline long strlen_user(const char __user *src)
303{
304	return strnlen_user(src, 32767);
305}
306
307/*
308 * Zero Userspace
309 */
310#ifndef __clear_user
311static inline __must_check unsigned long
312__clear_user(void __user *to, unsigned long n)
313{
314	memset((void __force *)to, 0, n);
315	return 0;
316}
317#endif
318
319static inline __must_check unsigned long
320clear_user(void __user *to, unsigned long n)
321{
322	might_sleep();
323	if (!access_ok(VERIFY_WRITE, to, n))
324		return n;
325
326	return __clear_user(to, n);
327}
328
329#endif /* __ASM_GENERIC_UACCESS_H */
v4.6
  1#ifndef __ASM_GENERIC_UACCESS_H
  2#define __ASM_GENERIC_UACCESS_H
  3
  4/*
  5 * User space memory access functions, these should work
  6 * on any machine that has kernel and user data in the same
  7 * address space, e.g. all NOMMU machines.
  8 */
  9#include <linux/sched.h>
 
 10#include <linux/string.h>
 11
 12#include <asm/segment.h>
 13
 14#define MAKE_MM_SEG(s)	((mm_segment_t) { (s) })
 15
 16#ifndef KERNEL_DS
 17#define KERNEL_DS	MAKE_MM_SEG(~0UL)
 18#endif
 19
 20#ifndef USER_DS
 21#define USER_DS		MAKE_MM_SEG(TASK_SIZE - 1)
 22#endif
 23
 24#ifndef get_fs
 25#define get_ds()	(KERNEL_DS)
 26#define get_fs()	(current_thread_info()->addr_limit)
 27
 28static inline void set_fs(mm_segment_t fs)
 29{
 30	current_thread_info()->addr_limit = fs;
 31}
 32#endif
 33
 34#ifndef segment_eq
 35#define segment_eq(a, b) ((a).seg == (b).seg)
 36#endif
 37
 38#define VERIFY_READ	0
 39#define VERIFY_WRITE	1
 40
 41#define access_ok(type, addr, size) __access_ok((unsigned long)(addr),(size))
 42
 43/*
 44 * The architecture should really override this if possible, at least
 45 * doing a check on the get_fs()
 46 */
 47#ifndef __access_ok
 48static inline int __access_ok(unsigned long addr, unsigned long size)
 49{
 50	return 1;
 51}
 52#endif
 53
 54/*
 55 * The exception table consists of pairs of addresses: the first is the
 56 * address of an instruction that is allowed to fault, and the second is
 57 * the address at which the program should continue.  No registers are
 58 * modified, so it is entirely up to the continuation code to figure out
 59 * what to do.
 60 *
 61 * All the routines below use bits of fixup code that are out of line
 62 * with the main instruction path.  This means when everything is well,
 63 * we don't even have to jump over them.  Further, they do not intrude
 64 * on our cache or tlb entries.
 65 */
 66
 67struct exception_table_entry
 68{
 69	unsigned long insn, fixup;
 70};
 71
 72/* Returns 0 if exception not found and fixup otherwise.  */
 73extern unsigned long search_exception_table(unsigned long);
 74
 75/*
 76 * architectures with an MMU should override these two
 77 */
 78#ifndef __copy_from_user
 79static inline __must_check long __copy_from_user(void *to,
 80		const void __user * from, unsigned long n)
 81{
 82	if (__builtin_constant_p(n)) {
 83		switch(n) {
 84		case 1:
 85			*(u8 *)to = *(u8 __force *)from;
 86			return 0;
 87		case 2:
 88			*(u16 *)to = *(u16 __force *)from;
 89			return 0;
 90		case 4:
 91			*(u32 *)to = *(u32 __force *)from;
 92			return 0;
 93#ifdef CONFIG_64BIT
 94		case 8:
 95			*(u64 *)to = *(u64 __force *)from;
 96			return 0;
 97#endif
 98		default:
 99			break;
100		}
101	}
102
103	memcpy(to, (const void __force *)from, n);
104	return 0;
105}
106#endif
107
108#ifndef __copy_to_user
109static inline __must_check long __copy_to_user(void __user *to,
110		const void *from, unsigned long n)
111{
112	if (__builtin_constant_p(n)) {
113		switch(n) {
114		case 1:
115			*(u8 __force *)to = *(u8 *)from;
116			return 0;
117		case 2:
118			*(u16 __force *)to = *(u16 *)from;
119			return 0;
120		case 4:
121			*(u32 __force *)to = *(u32 *)from;
122			return 0;
123#ifdef CONFIG_64BIT
124		case 8:
125			*(u64 __force *)to = *(u64 *)from;
126			return 0;
127#endif
128		default:
129			break;
130		}
131	}
132
133	memcpy((void __force *)to, from, n);
134	return 0;
135}
136#endif
137
138/*
139 * These are the main single-value transfer routines.  They automatically
140 * use the right size if we just have the right pointer type.
141 * This version just falls back to copy_{from,to}_user, which should
142 * provide a fast-path for small values.
143 */
144#define __put_user(x, ptr) \
145({								\
146	__typeof__(*(ptr)) __x = (x);				\
147	int __pu_err = -EFAULT;					\
148        __chk_user_ptr(ptr);                                    \
149	switch (sizeof (*(ptr))) {				\
150	case 1:							\
151	case 2:							\
152	case 4:							\
153	case 8:							\
154		__pu_err = __put_user_fn(sizeof (*(ptr)),	\
155					 ptr, &__x);		\
156		break;						\
157	default:						\
158		__put_user_bad();				\
159		break;						\
160	 }							\
161	__pu_err;						\
162})
163
164#define put_user(x, ptr)					\
165({								\
166	void *__p = (ptr);					\
167	might_fault();						\
168	access_ok(VERIFY_WRITE, __p, sizeof(*ptr)) ?		\
169		__put_user((x), ((__typeof__(*(ptr)) *)__p)) :	\
170		-EFAULT;					\
171})
172
173#ifndef __put_user_fn
174
175static inline int __put_user_fn(size_t size, void __user *ptr, void *x)
176{
177	size = __copy_to_user(ptr, x, size);
178	return size ? -EFAULT : size;
179}
180
181#define __put_user_fn(sz, u, k)	__put_user_fn(sz, u, k)
182
183#endif
184
185extern int __put_user_bad(void) __attribute__((noreturn));
186
187#define __get_user(x, ptr)					\
188({								\
189	int __gu_err = -EFAULT;					\
190	__chk_user_ptr(ptr);					\
191	switch (sizeof(*(ptr))) {				\
192	case 1: {						\
193		unsigned char __x;				\
194		__gu_err = __get_user_fn(sizeof (*(ptr)),	\
195					 ptr, &__x);		\
196		(x) = *(__force __typeof__(*(ptr)) *) &__x;	\
197		break;						\
198	};							\
199	case 2: {						\
200		unsigned short __x;				\
201		__gu_err = __get_user_fn(sizeof (*(ptr)),	\
202					 ptr, &__x);		\
203		(x) = *(__force __typeof__(*(ptr)) *) &__x;	\
204		break;						\
205	};							\
206	case 4: {						\
207		unsigned int __x;				\
208		__gu_err = __get_user_fn(sizeof (*(ptr)),	\
209					 ptr, &__x);		\
210		(x) = *(__force __typeof__(*(ptr)) *) &__x;	\
211		break;						\
212	};							\
213	case 8: {						\
214		unsigned long long __x;				\
215		__gu_err = __get_user_fn(sizeof (*(ptr)),	\
216					 ptr, &__x);		\
217		(x) = *(__force __typeof__(*(ptr)) *) &__x;	\
218		break;						\
219	};							\
220	default:						\
221		__get_user_bad();				\
222		break;						\
223	}							\
224	__gu_err;						\
225})
226
227#define get_user(x, ptr)					\
228({								\
229	const void *__p = (ptr);				\
230	might_fault();						\
231	access_ok(VERIFY_READ, __p, sizeof(*ptr)) ?		\
232		__get_user((x), (__typeof__(*(ptr)) *)__p) :	\
233		-EFAULT;					\
234})
235
236#ifndef __get_user_fn
237static inline int __get_user_fn(size_t size, const void __user *ptr, void *x)
238{
239	size = __copy_from_user(x, ptr, size);
240	return size ? -EFAULT : size;
241}
242
243#define __get_user_fn(sz, u, k)	__get_user_fn(sz, u, k)
244
245#endif
246
247extern int __get_user_bad(void) __attribute__((noreturn));
248
249#ifndef __copy_from_user_inatomic
250#define __copy_from_user_inatomic __copy_from_user
251#endif
252
253#ifndef __copy_to_user_inatomic
254#define __copy_to_user_inatomic __copy_to_user
255#endif
256
257static inline long copy_from_user(void *to,
258		const void __user * from, unsigned long n)
259{
260	might_fault();
261	if (access_ok(VERIFY_READ, from, n))
262		return __copy_from_user(to, from, n);
263	else
264		return n;
265}
266
267static inline long copy_to_user(void __user *to,
268		const void *from, unsigned long n)
269{
270	might_fault();
271	if (access_ok(VERIFY_WRITE, to, n))
272		return __copy_to_user(to, from, n);
273	else
274		return n;
275}
276
277/*
278 * Copy a null terminated string from userspace.
279 */
280#ifndef __strncpy_from_user
281static inline long
282__strncpy_from_user(char *dst, const char __user *src, long count)
283{
284	char *tmp;
285	strncpy(dst, (const char __force *)src, count);
286	for (tmp = dst; *tmp && count > 0; tmp++, count--)
287		;
288	return (tmp - dst);
289}
290#endif
291
292static inline long
293strncpy_from_user(char *dst, const char __user *src, long count)
294{
295	if (!access_ok(VERIFY_READ, src, 1))
296		return -EFAULT;
297	return __strncpy_from_user(dst, src, count);
298}
299
300/*
301 * Return the size of a string (including the ending 0)
302 *
303 * Return 0 on exception, a value greater than N if too long
304 */
305#ifndef __strnlen_user
306#define __strnlen_user(s, n) (strnlen((s), (n)) + 1)
307#endif
308
309/*
310 * Unlike strnlen, strnlen_user includes the nul terminator in
311 * its returned count. Callers should check for a returned value
312 * greater than N as an indication the string is too long.
313 */
314static inline long strnlen_user(const char __user *src, long n)
315{
316	if (!access_ok(VERIFY_READ, src, 1))
317		return 0;
318	return __strnlen_user(src, n);
319}
320
321static inline long strlen_user(const char __user *src)
322{
323	return strnlen_user(src, 32767);
324}
325
326/*
327 * Zero Userspace
328 */
329#ifndef __clear_user
330static inline __must_check unsigned long
331__clear_user(void __user *to, unsigned long n)
332{
333	memset((void __force *)to, 0, n);
334	return 0;
335}
336#endif
337
338static inline __must_check unsigned long
339clear_user(void __user *to, unsigned long n)
340{
341	might_fault();
342	if (!access_ok(VERIFY_WRITE, to, n))
343		return n;
344
345	return __clear_user(to, n);
346}
347
348#endif /* __ASM_GENERIC_UACCESS_H */