[mirror_ubuntu-bionic-kernel.git] / include / asm-sh / uaccess_64.h

#ifndef __ASM_SH_UACCESS_64_H
#define __ASM_SH_UACCESS_64_H

/*
 * include/asm-sh/uaccess_64.h
 *
 * Copyright (C) 2000, 2001  Paolo Alberelli
 * Copyright (C) 2003, 2004  Paul Mundt
 *
 * User space memory access functions
 *
 * Copyright (C) 1999  Niibe Yutaka
 *
 *  Based on:
 *     MIPS implementation version 1.15 by
 *              Copyright (C) 1996, 1997, 1998 by Ralf Baechle
 *     and i386 version.
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file "COPYING" in the main directory of this archive
 * for more details.
 */
#include <linux/errno.h>
#include <linux/sched.h>

#define VERIFY_READ    0
#define VERIFY_WRITE   1

/*
 * The fs value determines whether argument validity checking should be
 * performed or not.  If get_fs() == USER_DS, checking is performed, with
 * get_fs() == KERNEL_DS, checking is bypassed.
 *
 * For historical reasons (Data Segment Register?), these macros are misnamed.
 */

#define MAKE_MM_SEG(s)	((mm_segment_t) { (s) })

#define KERNEL_DS	MAKE_MM_SEG(0xFFFFFFFF)
#define USER_DS		MAKE_MM_SEG(0x80000000)

#define get_ds()	(KERNEL_DS)
#define get_fs()        (current_thread_info()->addr_limit)
#define set_fs(x)       (current_thread_info()->addr_limit=(x))

#define segment_eq(a,b)	((a).seg == (b).seg)

#define __addr_ok(addr) ((unsigned long)(addr) < (current_thread_info()->addr_limit.seg))

/*
 * Uhhuh, this needs 33-bit arithmetic. We have a carry..
 *
 * sum := addr + size;  carry? --> flag = true;
 * if (sum >= addr_limit) flag = true;
 */
#define __range_ok(addr,size) (((unsigned long) (addr) + (size) < (current_thread_info()->addr_limit.seg)) ? 0 : 1)

#define access_ok(type,addr,size) (__range_ok(addr,size) == 0)
#define __access_ok(addr,size) (__range_ok(addr,size) == 0)

/*
 * Uh, these should become the main single-value transfer routines ...
 * They automatically use the right size if we just have the right
 * pointer type ...
 *
 * As MIPS uses the same address space for kernel and user data, we
 * can just do these as direct assignments.
 *
 * Careful to not
 * (a) re-use the arguments for side effects (sizeof is ok)
 * (b) require any knowledge of processes at this stage
 */
#define put_user(x,ptr)	__put_user_check((x),(ptr),sizeof(*(ptr)))
#define get_user(x,ptr) __get_user_check((x),(ptr),sizeof(*(ptr)))

/*
 * The "__xxx" versions do not do address space checking, useful when
 * doing multiple accesses to the same area (the user has to do the
 * checks by hand with "access_ok()")
 */
#define __put_user(x,ptr) __put_user_nocheck((x),(ptr),sizeof(*(ptr)))
#define __get_user(x,ptr) __get_user_nocheck((x),(ptr),sizeof(*(ptr)))

/*
 * The "xxx_ret" versions return constant specified in third argument, if
 * something bad happens. These macros can be optimized for the
 * case of just returning from the function xxx_ret is used.
 */

#define put_user_ret(x,ptr,ret) ({ \
if (put_user(x,ptr)) return ret; })

#define get_user_ret(x,ptr,ret) ({ \
if (get_user(x,ptr)) return ret; })

#define __put_user_ret(x,ptr,ret) ({ \
if (__put_user(x,ptr)) return ret; })

#define __get_user_ret(x,ptr,ret) ({ \
if (__get_user(x,ptr)) return ret; })

struct __large_struct { unsigned long buf[100]; };
#define __m(x) (*(struct __large_struct *)(x))

#define __get_user_size(x,ptr,size,retval)			\
do {								\
	retval = 0;						\
	switch (size) {						\
	case 1:							\
		retval = __get_user_asm_b(x, ptr);		\
		break;						\
	case 2:							\
		retval = __get_user_asm_w(x, ptr);		\
		break;						\
	case 4:							\
		retval = __get_user_asm_l(x, ptr);		\
		break;						\
	case 8:							\
		retval = __get_user_asm_q(x, ptr);		\
		break;						\
	default:						\
		__get_user_unknown();				\
		break;						\
	}							\
} while (0)

#define __get_user_nocheck(x,ptr,size)				\
({								\
	long __gu_err, __gu_val;				\
	__get_user_size((void *)&__gu_val, (long)(ptr),		\
			(size), __gu_err);			\
	(x) = (__typeof__(*(ptr)))__gu_val;			\
	__gu_err;						\
})

#define __get_user_check(x,ptr,size)				\
({								\
	long __gu_addr = (long)(ptr);				\
	long __gu_err = -EFAULT, __gu_val;			\
	if (__access_ok(__gu_addr, (size)))			\
		__get_user_size((void *)&__gu_val, __gu_addr,	\
				(size), __gu_err);		\
	(x) = (__typeof__(*(ptr))) __gu_val;			\
	__gu_err;						\
})

extern long __get_user_asm_b(void *, long);
extern long __get_user_asm_w(void *, long);
extern long __get_user_asm_l(void *, long);
extern long __get_user_asm_q(void *, long);
extern void __get_user_unknown(void);

#define __put_user_size(x,ptr,size,retval)			\
do {								\
	retval = 0;						\
	switch (size) {						\
	case 1:							\
		retval = __put_user_asm_b(x, ptr);		\
		break;						\
	case 2:							\
		retval = __put_user_asm_w(x, ptr);		\
		break;						\
	case 4:							\
		retval = __put_user_asm_l(x, ptr);		\
		break;						\
	case 8:							\
		retval = __put_user_asm_q(x, ptr);		\
		break;						\
	default:						\
		__put_user_unknown();				\
	}							\
} while (0)

#define __put_user_nocheck(x,ptr,size)				\
({								\
	long __pu_err;						\
	__typeof__(*(ptr)) __pu_val = (x);			\
	__put_user_size((void *)&__pu_val, (long)(ptr), (size), __pu_err); \
	__pu_err;						\
})

#define __put_user_check(x,ptr,size)				\
({								\
	long __pu_err = -EFAULT;				\
	long __pu_addr = (long)(ptr);				\
	__typeof__(*(ptr)) __pu_val = (x);			\
								\
	if (__access_ok(__pu_addr, (size)))			\
		__put_user_size((void *)&__pu_val, __pu_addr, (size), __pu_err);\
	__pu_err;						\
})

extern long __put_user_asm_b(void *, long);
extern long __put_user_asm_w(void *, long);
extern long __put_user_asm_l(void *, long);
extern long __put_user_asm_q(void *, long);
extern void __put_user_unknown(void);

\f
/* Generic arbitrary sized copy.  */
/* Return the number of bytes NOT copied */
/* XXX: should be such that: 4byte and the rest. */
extern __kernel_size_t __copy_user(void *__to, const void *__from, __kernel_size_t __n);

#define copy_to_user(to,from,n) ({ \
void *__copy_to = (void *) (to); \
__kernel_size_t __copy_size = (__kernel_size_t) (n); \
__kernel_size_t __copy_res; \
if(__copy_size && __access_ok((unsigned long)__copy_to, __copy_size)) { \
__copy_res = __copy_user(__copy_to, (void *) (from), __copy_size); \
} else __copy_res = __copy_size; \
__copy_res; })

#define copy_to_user_ret(to,from,n,retval) ({ \
if (copy_to_user(to,from,n)) \
	return retval; \
})

#define __copy_to_user(to,from,n)		\
	__copy_user((void *)(to),		\
		    (void *)(from), n)

#define __copy_to_user_ret(to,from,n,retval) ({ \
if (__copy_to_user(to,from,n)) \
	return retval; \
})

#define copy_from_user(to,from,n) ({ \
void *__copy_to = (void *) (to); \
void *__copy_from = (void *) (from); \
__kernel_size_t __copy_size = (__kernel_size_t) (n); \
__kernel_size_t __copy_res; \
if(__copy_size && __access_ok((unsigned long)__copy_from, __copy_size)) { \
__copy_res = __copy_user(__copy_to, __copy_from, __copy_size); \
} else __copy_res = __copy_size; \
__copy_res; })

#define copy_from_user_ret(to,from,n,retval) ({ \
if (copy_from_user(to,from,n)) \
	return retval; \
})

#define __copy_from_user(to,from,n)		\
	__copy_user((void *)(to),		\
		    (void *)(from), n)

#define __copy_from_user_ret(to,from,n,retval) ({ \
if (__copy_from_user(to,from,n)) \
	return retval; \
})

#define __copy_to_user_inatomic __copy_to_user
#define __copy_from_user_inatomic __copy_from_user

/* XXX: Not sure it works well..
   should be such that: 4byte clear and the rest. */
extern __kernel_size_t __clear_user(void *addr, __kernel_size_t size);

#define clear_user(addr,n) ({ \
void * __cl_addr = (addr); \
unsigned long __cl_size = (n); \
if (__cl_size && __access_ok(((unsigned long)(__cl_addr)), __cl_size)) \
__cl_size = __clear_user(__cl_addr, __cl_size); \
__cl_size; })

extern int __strncpy_from_user(unsigned long __dest, unsigned long __src, int __count);

#define strncpy_from_user(dest,src,count) ({ \
unsigned long __sfu_src = (unsigned long) (src); \
int __sfu_count = (int) (count); \
long __sfu_res = -EFAULT; \
if(__access_ok(__sfu_src, __sfu_count)) { \
__sfu_res = __strncpy_from_user((unsigned long) (dest), __sfu_src, __sfu_count); \
} __sfu_res; })

#define strlen_user(str) strnlen_user(str, ~0UL >> 1)

/*
 * Return the size of a string (including the ending 0!)
 */
extern long __strnlen_user(const char *__s, long __n);

static inline long strnlen_user(const char *s, long n)
{
	if (!__addr_ok(s))
		return 0;
	else
		return __strnlen_user(s, n);
}

struct exception_table_entry
{
	unsigned long insn, fixup;
};

#define ARCH_HAS_SEARCH_EXTABLE

/* Returns 0 if exception not found and fixup.unit otherwise.  */
extern unsigned long search_exception_table(unsigned long addr);
extern const struct exception_table_entry *search_exception_tables (unsigned long addr);

#endif /* __ASM_SH_UACCESS_64_H */
Commit	Line	Data
a23ba435 PM	1	#ifndef __ASM_SH_UACCESS_64_H
a23ba435 PM	2	#define __ASM_SH_UACCESS_64_H
1da177e4 LT	3
1da177e4 LT	4	/*
a23ba435	5	* include/asm-sh/uaccess_64.h
1da177e4 LT	6	*
	7	* Copyright (C) 2000, 2001 Paolo Alberelli
	8	* Copyright (C) 2003, 2004 Paul Mundt
	9	*
	10	* User space memory access functions
	11	*
	12	* Copyright (C) 1999 Niibe Yutaka
	13	*
	14	* Based on:
	15	* MIPS implementation version 1.15 by
	16	* Copyright (C) 1996, 1997, 1998 by Ralf Baechle
	17	* and i386 version.
	18	*
a23ba435 PM	19	* This file is subject to the terms and conditions of the GNU General Public
	20	* License. See the file "COPYING" in the main directory of this archive
	21	* for more details.
1da177e4	22	*/
1da177e4 LT	23	#include <linux/errno.h>
	24	#include <linux/sched.h>
	25
	26	#define VERIFY_READ 0
	27	#define VERIFY_WRITE 1
	28
	29	/*
	30	* The fs value determines whether argument validity checking should be
	31	* performed or not. If get_fs() == USER_DS, checking is performed, with
	32	* get_fs() == KERNEL_DS, checking is bypassed.
	33	*
	34	* For historical reasons (Data Segment Register?), these macros are misnamed.
	35	*/
	36
	37	#define MAKE_MM_SEG(s) ((mm_segment_t) { (s) })
	38
	39	#define KERNEL_DS MAKE_MM_SEG(0xFFFFFFFF)
	40	#define USER_DS MAKE_MM_SEG(0x80000000)
	41
	42	#define get_ds() (KERNEL_DS)
	43	#define get_fs() (current_thread_info()->addr_limit)
	44	#define set_fs(x) (current_thread_info()->addr_limit=(x))
	45
	46	#define segment_eq(a,b) ((a).seg == (b).seg)
	47
	48	#define __addr_ok(addr) ((unsigned long)(addr) < (current_thread_info()->addr_limit.seg))
	49
	50	/*
	51	* Uhhuh, this needs 33-bit arithmetic. We have a carry..
	52	*
	53	* sum := addr + size; carry? --> flag = true;
	54	* if (sum >= addr_limit) flag = true;
	55	*/
	56	#define __range_ok(addr,size) (((unsigned long) (addr) + (size) < (current_thread_info()->addr_limit.seg)) ? 0 : 1)
	57
	58	#define access_ok(type,addr,size) (__range_ok(addr,size) == 0)
	59	#define __access_ok(addr,size) (__range_ok(addr,size) == 0)
	60
1da177e4 LT	61	/*
	62	* Uh, these should become the main single-value transfer routines ...
	63	* They automatically use the right size if we just have the right
	64	* pointer type ...
	65	*
	66	* As MIPS uses the same address space for kernel and user data, we
	67	* can just do these as direct assignments.
	68	*
	69	* Careful to not
	70	* (a) re-use the arguments for side effects (sizeof is ok)
	71	* (b) require any knowledge of processes at this stage
	72	*/
	73	#define put_user(x,ptr) __put_user_check((x),(ptr),sizeof(*(ptr)))
	74	#define get_user(x,ptr) __get_user_check((x),(ptr),sizeof(*(ptr)))
	75
	76	/*
	77	* The "__xxx" versions do not do address space checking, useful when
	78	* doing multiple accesses to the same area (the user has to do the
	79	* checks by hand with "access_ok()")
	80	*/
	81	#define __put_user(x,ptr) __put_user_nocheck((x),(ptr),sizeof(*(ptr)))
	82	#define __get_user(x,ptr) __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
	83
	84	/*
	85	* The "xxx_ret" versions return constant specified in third argument, if
	86	* something bad happens. These macros can be optimized for the
	87	* case of just returning from the function xxx_ret is used.
	88	*/
	89
	90	#define put_user_ret(x,ptr,ret) ({ \
	91	if (put_user(x,ptr)) return ret; })
	92
	93	#define get_user_ret(x,ptr,ret) ({ \
	94	if (get_user(x,ptr)) return ret; })
	95
	96	#define __put_user_ret(x,ptr,ret) ({ \
	97	if (__put_user(x,ptr)) return ret; })
	98
	99	#define __get_user_ret(x,ptr,ret) ({ \
	100	if (__get_user(x,ptr)) return ret; })
	101
	102	struct __large_struct { unsigned long buf[100]; };
	103	#define __m(x) ((struct __large_struct )(x))
	104
	105	#define __get_user_size(x,ptr,size,retval) \
	106	do { \
	107	retval = 0; \
	108	switch (size) { \
	109	case 1: \
	110	retval = __get_user_asm_b(x, ptr); \
	111	break; \
	112	case 2: \
	113	retval = __get_user_asm_w(x, ptr); \
	114	break; \
	115	case 4: \
	116	retval = __get_user_asm_l(x, ptr); \
	117	break; \
	118	case 8: \
	119	retval = __get_user_asm_q(x, ptr); \
	120	break; \
	121	default: \
	122	__get_user_unknown(); \
	123	break; \
	124	} \
125	} while (0)
126
127	#define __get_user_nocheck(x,ptr,size) \
128	({ \
21264136 PM	129	long __gu_err, __gu_val; \
	130	__get_user_size((void *)&__gu_val, (long)(ptr), \
	131	(size), __gu_err); \
	132	(x) = (__typeof__(*(ptr)))__gu_val; \
1da177e4 LT	133	__gu_err; \
	134	})
	135
	136	#define __get_user_check(x,ptr,size) \
	137	({ \
	138	long __gu_addr = (long)(ptr); \
21264136	139	long __gu_err = -EFAULT, __gu_val; \
1da177e4	140	if (__access_ok(__gu_addr, (size))) \
21264136 PM	141	__get_user_size((void *)&__gu_val, __gu_addr, \
21264136 PM	142	(size), __gu_err); \
1da177e4 LT	143	(x) = (__typeof__(*(ptr))) __gu_val; \
	144	__gu_err; \
	145	})
	146
	147	extern long __get_user_asm_b(void *, long);
	148	extern long __get_user_asm_w(void *, long);
	149	extern long __get_user_asm_l(void *, long);
	150	extern long __get_user_asm_q(void *, long);
	151	extern void __get_user_unknown(void);
	152
	153	#define __put_user_size(x,ptr,size,retval) \
	154	do { \
	155	retval = 0; \
	156	switch (size) { \
	157	case 1: \
	158	retval = __put_user_asm_b(x, ptr); \
	159	break; \
	160	case 2: \
	161	retval = __put_user_asm_w(x, ptr); \
	162	break; \
	163	case 4: \
	164	retval = __put_user_asm_l(x, ptr); \
	165	break; \
	166	case 8: \
	167	retval = __put_user_asm_q(x, ptr); \
	168	break; \
	169	default: \
	170	__put_user_unknown(); \
	171	} \
	172	} while (0)
	173
	174	#define __put_user_nocheck(x,ptr,size) \
	175	({ \
	176	long __pu_err; \
	177	__typeof__(*(ptr)) __pu_val = (x); \
	178	__put_user_size((void *)&__pu_val, (long)(ptr), (size), __pu_err); \
	179	__pu_err; \
	180	})
	181
	182	#define __put_user_check(x,ptr,size) \
	183	({ \
	184	long __pu_err = -EFAULT; \
	185	long __pu_addr = (long)(ptr); \
	186	__typeof__(*(ptr)) __pu_val = (x); \
	187	\
	188	if (__access_ok(__pu_addr, (size))) \
	189	__put_user_size((void *)&__pu_val, __pu_addr, (size), __pu_err);\
	190	__pu_err; \
	191	})
	192
	193	extern long __put_user_asm_b(void *, long);
	194	extern long __put_user_asm_w(void *, long);
	195	extern long __put_user_asm_l(void *, long);
	196	extern long __put_user_asm_q(void *, long);
	197	extern void __put_user_unknown(void);
	198
	199	\f
	200	/* Generic arbitrary sized copy. */
	201	/* Return the number of bytes NOT copied */
	202	/* XXX: should be such that: 4byte and the rest. */
	203	extern __kernel_size_t __copy_user(void __to, const void __from, __kernel_size_t __n);
	204
	205	#define copy_to_user(to,from,n) ({ \
	206	void __copy_to = (void ) (to); \
207	__kernel_size_t __copy_size = (__kernel_size_t) (n); \
208	__kernel_size_t __copy_res; \
209	if(__copy_size && __access_ok((unsigned long)__copy_to, __copy_size)) { \
210	__copy_res = __copy_user(__copy_to, (void *) (from), __copy_size); \
211	} else __copy_res = __copy_size; \
212	__copy_res; })
213
214	#define copy_to_user_ret(to,from,n,retval) ({ \
215	if (copy_to_user(to,from,n)) \
216	return retval; \
217	})
218
219	#define __copy_to_user(to,from,n) \
220	__copy_user((void *)(to), \
221	(void *)(from), n)
222
223	#define __copy_to_user_ret(to,from,n,retval) ({ \
224	if (__copy_to_user(to,from,n)) \
225	return retval; \
226	})
227
228	#define copy_from_user(to,from,n) ({ \
229	void __copy_to = (void ) (to); \
230	void __copy_from = (void ) (from); \
231	__kernel_size_t __copy_size = (__kernel_size_t) (n); \
232	__kernel_size_t __copy_res; \
233	if(__copy_size && __access_ok((unsigned long)__copy_from, __copy_size)) { \
234	__copy_res = __copy_user(__copy_to, __copy_from, __copy_size); \
235	} else __copy_res = __copy_size; \
236	__copy_res; })
237
238	#define copy_from_user_ret(to,from,n,retval) ({ \
239	if (copy_from_user(to,from,n)) \
240	return retval; \
241	})
242
243	#define __copy_from_user(to,from,n) \
244	__copy_user((void *)(to), \
245	(void *)(from), n)
246
247	#define __copy_from_user_ret(to,from,n,retval) ({ \
248	if (__copy_from_user(to,from,n)) \
249	return retval; \
250	})
251
252	#define __copy_to_user_inatomic __copy_to_user
253	#define __copy_from_user_inatomic __copy_from_user
254
255	/* XXX: Not sure it works well..
256	should be such that: 4byte clear and the rest. */
257	extern __kernel_size_t __clear_user(void *addr, __kernel_size_t size);
258
259	#define clear_user(addr,n) ({ \
260	void * __cl_addr = (addr); \
261	unsigned long __cl_size = (n); \
262	if (__cl_size && __access_ok(((unsigned long)(__cl_addr)), __cl_size)) \
263	__cl_size = __clear_user(__cl_addr, __cl_size); \
264	__cl_size; })
265
266	extern int __strncpy_from_user(unsigned long __dest, unsigned long __src, int __count);
267
268	#define strncpy_from_user(dest,src,count) ({ \
269	unsigned long __sfu_src = (unsigned long) (src); \
270	int __sfu_count = (int) (count); \
271	long __sfu_res = -EFAULT; \
272	if(__access_ok(__sfu_src, __sfu_count)) { \
273	__sfu_res = __strncpy_from_user((unsigned long) (dest), __sfu_src, __sfu_count); \
274	} __sfu_res; })
275
276	#define strlen_user(str) strnlen_user(str, ~0UL >> 1)
277
278	/*
279	* Return the size of a string (including the ending 0!)
280	*/
281	extern long __strnlen_user(const char *__s, long __n);
282
ca5ed2f5	283	static inline long strnlen_user(const char *s, long n)
1da177e4 LT	284	{
	285	if (!__addr_ok(s))
	286	return 0;
	287	else
	288	return __strnlen_user(s, n);
	289	}
	290
	291	struct exception_table_entry
	292	{
	293	unsigned long insn, fixup;
	294	};
	295
	296	#define ARCH_HAS_SEARCH_EXTABLE
	297
1da177e4 LT	298	/* Returns 0 if exception not found and fixup.unit otherwise. */
	299	extern unsigned long search_exception_table(unsigned long addr);
	300	extern const struct exception_table_entry *search_exception_tables (unsigned long addr);
	301
a23ba435	302	#endif /* __ASM_SH_UACCESS_64_H */