1 #ifndef __SCORE_UACCESS_H
2 #define __SCORE_UACCESS_H
4 #include <linux/kernel.h>
5 #include <linux/errno.h>
6 #include <linux/thread_info.h>
11 #define get_ds() (KERNEL_DS)
12 #define get_fs() (current_thread_info()->addr_limit)
13 #define segment_eq(a, b) ((a).seg == (b).seg)
16 * Is a address valid? This does a straighforward calculation rather
20 * - "addr" doesn't have any high-bits set
21 * - AND "size" doesn't have any high-bits set
22 * - AND "addr+size" doesn't have any high-bits set
23 * - OR we are in kernel mode.
25 * __ua_size() is a trick to avoid runtime checking of positive constant
26 * sizes; for those we already know at compile time that the size is ok.
28 #define __ua_size(size) \
29 ((__builtin_constant_p(size) && (signed long) (size) > 0) ? 0 : (size))
32 * access_ok: - Checks if a user space pointer is valid
33 * @type: Type of access: %VERIFY_READ or %VERIFY_WRITE. Note that
34 * %VERIFY_WRITE is a superset of %VERIFY_READ - if it is safe
35 * to write to a block, it is always safe to read from it.
36 * @addr: User space pointer to start of block to check
37 * @size: Size of block to check
39 * Context: User context only. This function may sleep.
41 * Checks if a pointer to a block of memory in user space is valid.
43 * Returns true (nonzero) if the memory block may be valid, false (zero)
44 * if it is definitely invalid.
46 * Note that, depending on architecture, this function probably just
47 * checks that the pointer is in the user space range - after calling
48 * this function, memory access functions may still return -EFAULT.
51 #define __access_ok(addr, size) \
52 (((long)((get_fs().seg) & \
53 ((addr) | ((addr) + (size)) | \
54 __ua_size(size)))) == 0)
56 #define access_ok(type, addr, size) \
57 likely(__access_ok((unsigned long)(addr), (size)))
60 * put_user: - Write a simple value into user space.
61 * @x: Value to copy to user space.
62 * @ptr: Destination address, in user space.
64 * Context: User context only. This function may sleep.
66 * This macro copies a single simple value from kernel space to user
67 * space. It supports simple types like char and int, but not larger
68 * data types like structures or arrays.
70 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
71 * to the result of dereferencing @ptr.
73 * Returns zero on success, or -EFAULT on error.
75 #define put_user(x, ptr) __put_user_check((x), (ptr), sizeof(*(ptr)))
78 * get_user: - Get a simple variable from user space.
79 * @x: Variable to store result.
80 * @ptr: Source address, in user space.
82 * Context: User context only. This function may sleep.
84 * This macro copies a single simple variable from user space to kernel
85 * space. It supports simple types like char and int, but not larger
86 * data types like structures or arrays.
88 * @ptr must have pointer-to-simple-variable type, and the result of
89 * dereferencing @ptr must be assignable to @x without a cast.
91 * Returns zero on success, or -EFAULT on error.
92 * On error, the variable @x is set to zero.
94 #define get_user(x, ptr) __get_user_check((x), (ptr), sizeof(*(ptr)))
97 * __put_user: - Write a simple value into user space, with less checking.
98 * @x: Value to copy to user space.
99 * @ptr: Destination address, in user space.
101 * Context: User context only. This function may sleep.
103 * This macro copies a single simple value from kernel space to user
104 * space. It supports simple types like char and int, but not larger
105 * data types like structures or arrays.
107 * @ptr must have pointer-to-simple-variable type, and @x must be assignable
108 * to the result of dereferencing @ptr.
110 * Caller must check the pointer with access_ok() before calling this
113 * Returns zero on success, or -EFAULT on error.
115 #define __put_user(x, ptr) __put_user_nocheck((x), (ptr), sizeof(*(ptr)))
118 * __get_user: - Get a simple variable from user space, with less checking.
119 * @x: Variable to store result.
120 * @ptr: Source address, in user space.
122 * Context: User context only. This function may sleep.
124 * This macro copies a single simple variable from user space to kernel
125 * space. It supports simple types like char and int, but not larger
126 * data types like structures or arrays.
128 * @ptr must have pointer-to-simple-variable type, and the result of
129 * dereferencing @ptr must be assignable to @x without a cast.
131 * Caller must check the pointer with access_ok() before calling this
134 * Returns zero on success, or -EFAULT on error.
135 * On error, the variable @x is set to zero.
137 #define __get_user(x, ptr) __get_user_nocheck((x), (ptr), sizeof(*(ptr)))
139 struct __large_struct
{ unsigned long buf
[100]; };
140 #define __m(x) (*(struct __large_struct __user *)(x))
143 * Yuck. We need two variants, one for 64bit operation and one
144 * for 32 bit mode and old iron.
146 extern void __get_user_unknown(void);
148 #define __get_user_common(val, size, ptr) \
152 __get_user_asm(val, "lb", ptr); \
155 __get_user_asm(val, "lh", ptr); \
158 __get_user_asm(val, "lw", ptr); \
161 if (__copy_from_user((void *)&val, ptr, 8) == 0) \
164 __gu_err = -EFAULT; \
167 __get_user_unknown(); \
172 #define __get_user_nocheck(x, ptr, size) \
175 __get_user_common((x), size, ptr); \
179 #define __get_user_check(x, ptr, size) \
181 long __gu_err = -EFAULT; \
182 const __typeof__(*(ptr)) __user *__gu_ptr = (ptr); \
184 if (likely(access_ok(VERIFY_READ, __gu_ptr, size))) \
185 __get_user_common((x), size, __gu_ptr); \
192 #define __get_user_asm(val, insn, addr) \
196 __asm__ __volatile__( \
197 "1:" insn " %1, %3\n" \
199 ".section .fixup,\"ax\"\n" \
204 ".section __ex_table,\"a\"\n" \
207 : "=r" (__gu_err), "=r" (__gu_tmp) \
208 : "0" (0), "o" (__m(addr)), "i" (-EFAULT)); \
210 (val) = (__typeof__(*(addr))) __gu_tmp; \
214 * Yuck. We need two variants, one for 64bit operation and one
215 * for 32 bit mode and old iron.
217 #define __put_user_nocheck(val, ptr, size) \
219 __typeof__(*(ptr)) __pu_val; \
225 __put_user_asm("sb", ptr); \
228 __put_user_asm("sh", ptr); \
231 __put_user_asm("sw", ptr); \
234 if ((__copy_to_user((void *)ptr, &__pu_val, 8)) == 0) \
237 __pu_err = -EFAULT; \
240 __put_user_unknown(); \
247 #define __put_user_check(val, ptr, size) \
249 __typeof__(*(ptr)) __user *__pu_addr = (ptr); \
250 __typeof__(*(ptr)) __pu_val = (val); \
251 long __pu_err = -EFAULT; \
253 if (likely(access_ok(VERIFY_WRITE, __pu_addr, size))) { \
256 __put_user_asm("sb", __pu_addr); \
259 __put_user_asm("sh", __pu_addr); \
262 __put_user_asm("sw", __pu_addr); \
265 if ((__copy_to_user((void *)__pu_addr, &__pu_val, 8)) == 0)\
268 __pu_err = -EFAULT; \
271 __put_user_unknown(); \
278 #define __put_user_asm(insn, ptr) \
279 __asm__ __volatile__( \
280 "1:" insn " %2, %3\n" \
282 ".section .fixup,\"ax\"\n" \
286 ".section __ex_table,\"a\"\n" \
290 : "0" (0), "r" (__pu_val), "o" (__m(ptr)), \
293 extern void __put_user_unknown(void);
294 extern int __copy_tofrom_user(void *to
, const void *from
, unsigned long len
);
296 static inline unsigned long
297 copy_from_user(void *to
, const void *from
, unsigned long len
)
299 unsigned long res
= len
;
301 if (likely(access_ok(VERIFY_READ
, from
, len
)))
302 res
= __copy_tofrom_user(to
, from
, len
);
305 memset(to
+ (len
- res
), 0, res
);
310 static inline unsigned long
311 copy_to_user(void *to
, const void *from
, unsigned long len
)
313 if (likely(access_ok(VERIFY_WRITE
, to
, len
)))
314 len
= __copy_tofrom_user(to
, from
, len
);
319 static inline unsigned long
320 __copy_from_user(void *to
, const void *from
, unsigned long len
)
322 unsigned long left
= __copy_tofrom_user(to
, from
, len
);
324 memset(to
+ (len
- left
), 0, left
);
328 #define __copy_to_user(to, from, len) \
329 __copy_tofrom_user((to), (from), (len))
331 static inline unsigned long
332 __copy_to_user_inatomic(void *to
, const void *from
, unsigned long len
)
334 return __copy_to_user(to
, from
, len
);
337 static inline unsigned long
338 __copy_from_user_inatomic(void *to
, const void *from
, unsigned long len
)
340 return __copy_tofrom_user(to
, from
, len
);
343 #define __copy_in_user(to, from, len) __copy_tofrom_user(to, from, len)
345 static inline unsigned long
346 copy_in_user(void *to
, const void *from
, unsigned long len
)
348 if (access_ok(VERIFY_READ
, from
, len
) &&
349 access_ok(VERFITY_WRITE
, to
, len
))
350 return __copy_tofrom_user(to
, from
, len
);
354 * __clear_user: - Zero a block of memory in user space, with less checking.
355 * @to: Destination address, in user space.
356 * @n: Number of bytes to zero.
358 * Zero a block of memory in user space. Caller must check
359 * the specified block with access_ok() before calling this function.
361 * Returns number of bytes that could not be cleared.
362 * On success, this will be zero.
364 extern unsigned long __clear_user(void __user
*src
, unsigned long size
);
366 static inline unsigned long clear_user(char *src
, unsigned long size
)
368 if (access_ok(VERIFY_WRITE
, src
, size
))
369 return __clear_user(src
, size
);
374 * __strncpy_from_user: - Copy a NUL terminated string from userspace, with less checking.
375 * @dst: Destination address, in kernel space. This buffer must be at
376 * least @count bytes long.
377 * @src: Source address, in user space.
378 * @count: Maximum number of bytes to copy, including the trailing NUL.
380 * Copies a NUL-terminated string from userspace to kernel space.
381 * Caller must check the specified block with access_ok() before calling
384 * On success, returns the length of the string (not including the trailing
387 * If access to userspace fails, returns -EFAULT (some data may have been
390 * If @count is smaller than the length of the string, copies @count bytes
391 * and returns @count.
393 extern int __strncpy_from_user(char *dst
, const char *src
, long len
);
395 static inline int strncpy_from_user(char *dst
, const char *src
, long len
)
397 if (access_ok(VERIFY_READ
, src
, 1))
398 return __strncpy_from_user(dst
, src
, len
);
403 extern int __strlen_user(const char *src
);
404 static inline long strlen_user(const char __user
*src
)
406 return __strlen_user(src
);
409 extern int __strnlen_user(const char *str
, long len
);
410 static inline long strnlen_user(const char __user
*str
, long len
)
412 if (!access_ok(VERIFY_READ
, str
, 0))
415 return __strnlen_user(str
, len
);
418 struct exception_table_entry
{
423 extern int fixup_exception(struct pt_regs
*regs
);
425 #endif /* __SCORE_UACCESS_H */