2 * include/asm-s390/uaccess.h
5 * Copyright (C) 1999,2000 IBM Deutschland Entwicklung GmbH, IBM Corporation
6 * Author(s): Hartmut Penner (hp@de.ibm.com),
7 * Martin Schwidefsky (schwidefsky@de.ibm.com)
9 * Derived from "include/asm-i386/uaccess.h"
11 #ifndef __S390_UACCESS_H
12 #define __S390_UACCESS_H
15 * User space memory access functions
17 #include <linux/sched.h>
18 #include <linux/errno.h>
21 #define VERIFY_WRITE 1
25 * The fs value determines whether argument validity checking should be
26 * performed or not. If get_fs() == USER_DS, checking is performed, with
27 * get_fs() == KERNEL_DS, checking is bypassed.
29 * For historical reasons, these macros are grossly misnamed.
32 #define MAKE_MM_SEG(a) ((mm_segment_t) { (a) })
35 #define KERNEL_DS MAKE_MM_SEG(0)
36 #define USER_DS MAKE_MM_SEG(1)
38 #define get_ds() (KERNEL_DS)
39 #define get_fs() (current->thread.mm_segment)
43 unsigned long __pto; \
44 current->thread.mm_segment = (x); \
45 __pto = current->thread.mm_segment.ar4 ? \
46 S390_lowcore.user_asce : S390_lowcore.kernel_asce; \
47 __ctl_load(__pto, 7, 7); \
50 #define segment_eq(a,b) ((a).ar4 == (b).ar4)
53 static inline int __access_ok(const void __user *addr, unsigned long size)
57 #define access_ok(type,addr,size) __access_ok(addr,size)
60 * The exception table consists of pairs of addresses: the first is the
61 * address of an instruction that is allowed to fault, and the second is
62 * the address at which the program should continue. No registers are
63 * modified, so it is entirely up to the continuation code to figure out
66 * All the routines below use bits of fixup code that are out of line
67 * with the main instruction path. This means when everything is well,
68 * we don't even have to jump over them. Further, they do not intrude
69 * on our cache or tlb entries.
72 struct exception_table_entry
74 unsigned long insn, fixup;
78 size_t (*copy_from_user)(size_t, const void __user *, void *);
79 size_t (*copy_from_user_small)(size_t, const void __user *, void *);
80 size_t (*copy_to_user)(size_t, void __user *, const void *);
81 size_t (*copy_to_user_small)(size_t, void __user *, const void *);
82 size_t (*copy_in_user)(size_t, void __user *, const void __user *);
83 size_t (*clear_user)(size_t, void __user *);
84 size_t (*strnlen_user)(size_t, const char __user *);
85 size_t (*strncpy_from_user)(size_t, const char __user *, char *);
86 int (*futex_atomic_op)(int op, int __user *, int oparg, int *old);
87 int (*futex_atomic_cmpxchg)(int __user *, int old, int new);
90 extern struct uaccess_ops uaccess;
91 extern struct uaccess_ops uaccess_std;
92 extern struct uaccess_ops uaccess_mvcos;
94 static inline int __put_user_fn(size_t size, void __user *ptr, void *x)
96 size = uaccess.copy_to_user_small(size, ptr, x);
97 return size ? -EFAULT : size;
100 static inline int __get_user_fn(size_t size, const void __user *ptr, void *x)
102 size = uaccess.copy_from_user_small(size, ptr, x);
103 return size ? -EFAULT : size;
107 * These are the main single-value transfer routines. They automatically
108 * use the right size if we just have the right pointer type.
110 #define __put_user(x, ptr) \
112 __typeof__(*(ptr)) __x = (x); \
113 int __pu_err = -EFAULT; \
114 __chk_user_ptr(ptr); \
115 switch (sizeof (*(ptr))) { \
120 __pu_err = __put_user_fn(sizeof (*(ptr)), \
130 #define put_user(x, ptr) \
133 __put_user(x, ptr); \
137 extern int __put_user_bad(void) __attribute__((noreturn));
139 #define __get_user(x, ptr) \
141 int __gu_err = -EFAULT; \
142 __chk_user_ptr(ptr); \
143 switch (sizeof(*(ptr))) { \
146 __gu_err = __get_user_fn(sizeof (*(ptr)), \
148 (x) = *(__force __typeof__(*(ptr)) *) &__x; \
152 unsigned short __x; \
153 __gu_err = __get_user_fn(sizeof (*(ptr)), \
155 (x) = *(__force __typeof__(*(ptr)) *) &__x; \
160 __gu_err = __get_user_fn(sizeof (*(ptr)), \
162 (x) = *(__force __typeof__(*(ptr)) *) &__x; \
166 unsigned long long __x; \
167 __gu_err = __get_user_fn(sizeof (*(ptr)), \
169 (x) = *(__force __typeof__(*(ptr)) *) &__x; \
179 #define get_user(x, ptr) \
182 __get_user(x, ptr); \
185 extern int __get_user_bad(void) __attribute__((noreturn));
187 #define __put_user_unaligned __put_user
188 #define __get_user_unaligned __get_user
191 * __copy_to_user: - Copy a block of data into user space, with less checking.
192 * @to: Destination address, in user space.
193 * @from: Source address, in kernel space.
194 * @n: Number of bytes to copy.
196 * Context: User context only. This function may sleep.
198 * Copy data from kernel space to user space. Caller must check
199 * the specified block with access_ok() before calling this function.
201 * Returns number of bytes that could not be copied.
202 * On success, this will be zero.
204 static inline unsigned long
205 __copy_to_user(void __user *to, const void *from, unsigned long n)
207 if (__builtin_constant_p(n) && (n <= 256))
208 return uaccess.copy_to_user_small(n, to, from);
210 return uaccess.copy_to_user(n, to, from);
213 #define __copy_to_user_inatomic __copy_to_user
214 #define __copy_from_user_inatomic __copy_from_user
217 * copy_to_user: - Copy a block of data into user space.
218 * @to: Destination address, in user space.
219 * @from: Source address, in kernel space.
220 * @n: Number of bytes to copy.
222 * Context: User context only. This function may sleep.
224 * Copy data from kernel space to user space.
226 * Returns number of bytes that could not be copied.
227 * On success, this will be zero.
229 static inline unsigned long
230 copy_to_user(void __user *to, const void *from, unsigned long n)
233 if (access_ok(VERIFY_WRITE, to, n))
234 n = __copy_to_user(to, from, n);
239 * __copy_from_user: - Copy a block of data from user space, with less checking.
240 * @to: Destination address, in kernel space.
241 * @from: Source address, in user space.
242 * @n: Number of bytes to copy.
244 * Context: User context only. This function may sleep.
246 * Copy data from user space to kernel space. Caller must check
247 * the specified block with access_ok() before calling this function.
249 * Returns number of bytes that could not be copied.
250 * On success, this will be zero.
252 * If some data could not be copied, this function will pad the copied
253 * data to the requested size using zero bytes.
255 static inline unsigned long
256 __copy_from_user(void *to, const void __user *from, unsigned long n)
258 if (__builtin_constant_p(n) && (n <= 256))
259 return uaccess.copy_from_user_small(n, from, to);
261 return uaccess.copy_from_user(n, from, to);
265 * copy_from_user: - Copy a block of data from user space.
266 * @to: Destination address, in kernel space.
267 * @from: Source address, in user space.
268 * @n: Number of bytes to copy.
270 * Context: User context only. This function may sleep.
272 * Copy data from user space to kernel space.
274 * Returns number of bytes that could not be copied.
275 * On success, this will be zero.
277 * If some data could not be copied, this function will pad the copied
278 * data to the requested size using zero bytes.
280 static inline unsigned long
281 copy_from_user(void *to, const void __user *from, unsigned long n)
284 if (access_ok(VERIFY_READ, from, n))
285 n = __copy_from_user(to, from, n);
291 static inline unsigned long
292 __copy_in_user(void __user *to, const void __user *from, unsigned long n)
294 return uaccess.copy_in_user(n, to, from);
297 static inline unsigned long
298 copy_in_user(void __user *to, const void __user *from, unsigned long n)
301 if (__access_ok(from,n) && __access_ok(to,n))
302 n = __copy_in_user(to, from, n);
307 * Copy a null terminated string from userspace.
310 strncpy_from_user(char *dst, const char __user *src, long count)
314 if (access_ok(VERIFY_READ, src, 1))
315 res = uaccess.strncpy_from_user(count, src, dst);
319 static inline unsigned long
320 strnlen_user(const char __user * src, unsigned long n)
323 return uaccess.strnlen_user(n, src);
327 * strlen_user: - Get the size of a string in user space.
328 * @str: The string to measure.
330 * Context: User context only. This function may sleep.
332 * Get the size of a NUL-terminated string in user space.
334 * Returns the size of the string INCLUDING the terminating NUL.
335 * On exception, returns 0.
337 * If there is a limit on the length of a valid string, you may wish to
338 * consider using strnlen_user() instead.
340 #define strlen_user(str) strnlen_user(str, ~0UL)
346 static inline unsigned long
347 __clear_user(void __user *to, unsigned long n)
349 return uaccess.clear_user(n, to);
352 static inline unsigned long
353 clear_user(void __user *to, unsigned long n)
356 if (access_ok(VERIFY_WRITE, to, n))
357 n = uaccess.clear_user(n, to);
361 #endif /* __S390_UACCESS_H */