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;
93 extern struct uaccess_ops uaccess_mvcos_switch;
94 extern struct uaccess_ops uaccess_pt;
96 static inline int __put_user_fn(size_t size, void __user *ptr, void *x)
98 size = uaccess.copy_to_user_small(size, ptr, x);
99 return size ? -EFAULT : size;
102 static inline int __get_user_fn(size_t size, const void __user *ptr, void *x)
104 size = uaccess.copy_from_user_small(size, ptr, x);
105 return size ? -EFAULT : size;
109 * These are the main single-value transfer routines. They automatically
110 * use the right size if we just have the right pointer type.
112 #define __put_user(x, ptr) \
114 __typeof__(*(ptr)) __x = (x); \
115 int __pu_err = -EFAULT; \
116 __chk_user_ptr(ptr); \
117 switch (sizeof (*(ptr))) { \
122 __pu_err = __put_user_fn(sizeof (*(ptr)), \
132 #define put_user(x, ptr) \
135 __put_user(x, ptr); \
139 extern int __put_user_bad(void) __attribute__((noreturn));
141 #define __get_user(x, ptr) \
143 int __gu_err = -EFAULT; \
144 __chk_user_ptr(ptr); \
145 switch (sizeof(*(ptr))) { \
148 __gu_err = __get_user_fn(sizeof (*(ptr)), \
150 (x) = *(__force __typeof__(*(ptr)) *) &__x; \
154 unsigned short __x; \
155 __gu_err = __get_user_fn(sizeof (*(ptr)), \
157 (x) = *(__force __typeof__(*(ptr)) *) &__x; \
162 __gu_err = __get_user_fn(sizeof (*(ptr)), \
164 (x) = *(__force __typeof__(*(ptr)) *) &__x; \
168 unsigned long long __x; \
169 __gu_err = __get_user_fn(sizeof (*(ptr)), \
171 (x) = *(__force __typeof__(*(ptr)) *) &__x; \
181 #define get_user(x, ptr) \
184 __get_user(x, ptr); \
187 extern int __get_user_bad(void) __attribute__((noreturn));
189 #define __put_user_unaligned __put_user
190 #define __get_user_unaligned __get_user
193 * __copy_to_user: - Copy a block of data into user space, with less checking.
194 * @to: Destination address, in user space.
195 * @from: Source address, in kernel space.
196 * @n: Number of bytes to copy.
198 * Context: User context only. This function may sleep.
200 * Copy data from kernel space to user space. Caller must check
201 * the specified block with access_ok() before calling this function.
203 * Returns number of bytes that could not be copied.
204 * On success, this will be zero.
206 static inline unsigned long __must_check
207 __copy_to_user(void __user *to, const void *from, unsigned long n)
209 if (__builtin_constant_p(n) && (n <= 256))
210 return uaccess.copy_to_user_small(n, to, from);
212 return uaccess.copy_to_user(n, to, from);
215 #define __copy_to_user_inatomic __copy_to_user
216 #define __copy_from_user_inatomic __copy_from_user
219 * copy_to_user: - Copy a block of data into user space.
220 * @to: Destination address, in user space.
221 * @from: Source address, in kernel space.
222 * @n: Number of bytes to copy.
224 * Context: User context only. This function may sleep.
226 * Copy data from kernel space to user space.
228 * Returns number of bytes that could not be copied.
229 * On success, this will be zero.
231 static inline unsigned long __must_check
232 copy_to_user(void __user *to, const void *from, unsigned long n)
235 if (access_ok(VERIFY_WRITE, to, n))
236 n = __copy_to_user(to, from, n);
241 * __copy_from_user: - Copy a block of data from user space, with less checking.
242 * @to: Destination address, in kernel space.
243 * @from: Source address, in user space.
244 * @n: Number of bytes to copy.
246 * Context: User context only. This function may sleep.
248 * Copy data from user space to kernel space. Caller must check
249 * the specified block with access_ok() before calling this function.
251 * Returns number of bytes that could not be copied.
252 * On success, this will be zero.
254 * If some data could not be copied, this function will pad the copied
255 * data to the requested size using zero bytes.
257 static inline unsigned long __must_check
258 __copy_from_user(void *to, const void __user *from, unsigned long n)
260 if (__builtin_constant_p(n) && (n <= 256))
261 return uaccess.copy_from_user_small(n, from, to);
263 return uaccess.copy_from_user(n, from, to);
267 * copy_from_user: - Copy a block of data from user space.
268 * @to: Destination address, in kernel space.
269 * @from: Source address, in user space.
270 * @n: Number of bytes to copy.
272 * Context: User context only. This function may sleep.
274 * Copy data from user space to kernel space.
276 * Returns number of bytes that could not be copied.
277 * On success, this will be zero.
279 * If some data could not be copied, this function will pad the copied
280 * data to the requested size using zero bytes.
282 static inline unsigned long __must_check
283 copy_from_user(void *to, const void __user *from, unsigned long n)
286 if (access_ok(VERIFY_READ, from, n))
287 n = __copy_from_user(to, from, n);
293 static inline unsigned long __must_check
294 __copy_in_user(void __user *to, const void __user *from, unsigned long n)
296 return uaccess.copy_in_user(n, to, from);
299 static inline unsigned long __must_check
300 copy_in_user(void __user *to, const void __user *from, unsigned long n)
303 if (__access_ok(from,n) && __access_ok(to,n))
304 n = __copy_in_user(to, from, n);
309 * Copy a null terminated string from userspace.
311 static inline long __must_check
312 strncpy_from_user(char *dst, const char __user *src, long count)
316 if (access_ok(VERIFY_READ, src, 1))
317 res = uaccess.strncpy_from_user(count, src, dst);
321 static inline unsigned long
322 strnlen_user(const char __user * src, unsigned long n)
325 return uaccess.strnlen_user(n, src);
329 * strlen_user: - Get the size of a string in user space.
330 * @str: The string to measure.
332 * Context: User context only. This function may sleep.
334 * Get the size of a NUL-terminated string in user space.
336 * Returns the size of the string INCLUDING the terminating NUL.
337 * On exception, returns 0.
339 * If there is a limit on the length of a valid string, you may wish to
340 * consider using strnlen_user() instead.
342 #define strlen_user(str) strnlen_user(str, ~0UL)
348 static inline unsigned long __must_check
349 __clear_user(void __user *to, unsigned long n)
351 return uaccess.clear_user(n, to);
354 static inline unsigned long __must_check
355 clear_user(void __user *to, unsigned long n)
358 if (access_ok(VERIFY_WRITE, to, n))
359 n = uaccess.clear_user(n, to);
363 #endif /* __S390_UACCESS_H */