include/asm-s390/uaccess.h

   1 /*
   2  *  include/asm-s390/uaccess.h
   3  *
   4  *  S390 version
   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)
   8  *
   9  *  Derived from "include/asm-i386/uaccess.h"
  10  */
  11 #ifndef __S390_UACCESS_H
  12 #define __S390_UACCESS_H
  13
  14 /*
  15  * User space memory access functions
  16  */
  17 #include <linux/sched.h>
  18 #include <linux/errno.h>
  19
  20 #define VERIFY_READ     0
  21 #define VERIFY_WRITE    1
  22
  23
  24 /*
  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.
  28  *
  29  * For historical reasons, these macros are grossly misnamed.
  30  */
  31
  32 #define MAKE_MM_SEG(a)  ((mm_segment_t) { (a) })
  33
  34
  35 #define KERNEL_DS       MAKE_MM_SEG(0)
  36 #define USER_DS         MAKE_MM_SEG(1)
  37
  38 #define get_ds()        (KERNEL_DS)
  39 #define get_fs()        (current->thread.mm_segment)
  40
  41 #ifdef __s390x__
  42 #define set_fs(x) \
  43 ({                                                                      \
  44         unsigned long __pto;                                            \
  45         current->thread.mm_segment = (x);                               \
  46         __pto = current->thread.mm_segment.ar4 ?                        \
  47                 S390_lowcore.user_asce : S390_lowcore.kernel_asce;      \
  48         asm volatile ("lctlg 7,7,%0" : : "m" (__pto) );                 \
  49 })
  50 #else /* __s390x__ */
  51 #define set_fs(x) \
  52 ({                                                                      \
  53         unsigned long __pto;                                            \
  54         current->thread.mm_segment = (x);                               \
  55         __pto = current->thread.mm_segment.ar4 ?                        \
  56                 S390_lowcore.user_asce : S390_lowcore.kernel_asce;      \
  57         asm volatile ("lctl  7,7,%0" : : "m" (__pto) );                 \
  58 })
  59 #endif /* __s390x__ */
  60
  61 #define segment_eq(a,b) ((a).ar4 == (b).ar4)
  62
  63
  64 static inline int __access_ok(const void __user *addr, unsigned long size)
  65 {
  66         return 1;
  67 }
  68 #define access_ok(type,addr,size) __access_ok(addr,size)
  69
  70 /*
  71  * The exception table consists of pairs of addresses: the first is the
  72  * address of an instruction that is allowed to fault, and the second is
  73  * the address at which the program should continue.  No registers are
  74  * modified, so it is entirely up to the continuation code to figure out
  75  * what to do.
  76  *
  77  * All the routines below use bits of fixup code that are out of line
  78  * with the main instruction path.  This means when everything is well,
  79  * we don't even have to jump over them.  Further, they do not intrude
  80  * on our cache or tlb entries.
  81  */
  82
  83 struct exception_table_entry
  84 {
  85         unsigned long insn, fixup;
  86 };
  87
  88 struct uaccess_ops {
  89         size_t (*copy_from_user)(size_t, const void __user *, void *);
  90         size_t (*copy_from_user_small)(size_t, const void __user *, void *);
  91         size_t (*copy_to_user)(size_t, void __user *, const void *);
  92         size_t (*copy_to_user_small)(size_t, void __user *, const void *);
  93         size_t (*copy_in_user)(size_t, void __user *, const void __user *);
  94         size_t (*clear_user)(size_t, void __user *);
  95         size_t (*strnlen_user)(size_t, const char __user *);
  96         size_t (*strncpy_from_user)(size_t, const char __user *, char *);
  97         int (*futex_atomic_op)(int op, int __user *, int oparg, int *old);
  98         int (*futex_atomic_cmpxchg)(int __user *, int old, int new);
  99 };
 100
 101 extern struct uaccess_ops uaccess;
 102 extern struct uaccess_ops uaccess_std;
 103
 104 static inline int __put_user_fn(size_t size, void __user *ptr, void *x)
 105 {
 106         size = uaccess.copy_to_user_small(size, ptr, x);
 107         return size ? -EFAULT : size;
 108 }
 109
 110 static inline int __get_user_fn(size_t size, const void __user *ptr, void *x)
 111 {
 112         size = uaccess.copy_from_user_small(size, ptr, x);
 113         return size ? -EFAULT : size;
 114 }
 115
 116 /*
 117  * These are the main single-value transfer routines.  They automatically
 118  * use the right size if we just have the right pointer type.
 119  */
 120 #define __put_user(x, ptr) \
 121 ({                                                              \
 122         __typeof__(*(ptr)) __x = (x);                           \
 123         int __pu_err = -EFAULT;                                 \
 124         __chk_user_ptr(ptr);                                    \
 125         switch (sizeof (*(ptr))) {                              \
 126         case 1:                                                 \
 127         case 2:                                                 \
 128         case 4:                                                 \
 129         case 8:                                                 \
 130                 __pu_err = __put_user_fn(sizeof (*(ptr)),       \
 131                                          ptr, &__x);            \
 132                 break;                                          \
 133         default:                                                \
 134                 __put_user_bad();                               \
 135                 break;                                          \
 136          }                                                      \
 137         __pu_err;                                               \
 138 })
 139
 140 #define put_user(x, ptr)                                        \
 141 ({                                                              \
 142         might_sleep();                                          \
 143         __put_user(x, ptr);                                     \
 144 })
 145
 146
 147 extern int __put_user_bad(void) __attribute__((noreturn));
 148
 149 #define __get_user(x, ptr)                                      \
 150 ({                                                              \
 151         int __gu_err = -EFAULT;                                 \
 152         __chk_user_ptr(ptr);                                    \
 153         switch (sizeof(*(ptr))) {                               \
 154         case 1: {                                               \
 155                 unsigned char __x;                              \
 156                 __gu_err = __get_user_fn(sizeof (*(ptr)),       \
 157                                          ptr, &__x);            \
 158                 (x) = *(__force __typeof__(*(ptr)) *) &__x;     \
 159                 break;                                          \
 160         };                                                      \
 161         case 2: {                                               \
 162                 unsigned short __x;                             \
 163                 __gu_err = __get_user_fn(sizeof (*(ptr)),       \
 164                                          ptr, &__x);            \
 165                 (x) = *(__force __typeof__(*(ptr)) *) &__x;     \
 166                 break;                                          \
 167         };                                                      \
 168         case 4: {                                               \
 169                 unsigned int __x;                               \
 170                 __gu_err = __get_user_fn(sizeof (*(ptr)),       \
 171                                          ptr, &__x);            \
 172                 (x) = *(__force __typeof__(*(ptr)) *) &__x;     \
 173                 break;                                          \
 174         };                                                      \
 175         case 8: {                                               \
 176                 unsigned long long __x;                         \
 177                 __gu_err = __get_user_fn(sizeof (*(ptr)),       \
 178                                          ptr, &__x);            \
 179                 (x) = *(__force __typeof__(*(ptr)) *) &__x;     \
 180                 break;                                          \
 181         };                                                      \
 182         default:                                                \
 183                 __get_user_bad();                               \
 184                 break;                                          \
 185         }                                                       \
 186         __gu_err;                                               \
 187 })
 188
 189 #define get_user(x, ptr)                                        \
 190 ({                                                              \
 191         might_sleep();                                          \
 192         __get_user(x, ptr);                                     \
 193 })
 194
 195 extern int __get_user_bad(void) __attribute__((noreturn));
 196
 197 #define __put_user_unaligned __put_user
 198 #define __get_user_unaligned __get_user
 199
 200 /**
 201  * __copy_to_user: - Copy a block of data into user space, with less checking.
 202  * @to:   Destination address, in user space.
 203  * @from: Source address, in kernel space.
 204  * @n:    Number of bytes to copy.
 205  *
 206  * Context: User context only.  This function may sleep.
 207  *
 208  * Copy data from kernel space to user space.  Caller must check
 209  * the specified block with access_ok() before calling this function.
 210  *
 211  * Returns number of bytes that could not be copied.
 212  * On success, this will be zero.
 213  */
 214 static inline unsigned long
 215 __copy_to_user(void __user *to, const void *from, unsigned long n)
 216 {
 217         if (__builtin_constant_p(n) && (n <= 256))
 218                 return uaccess.copy_to_user_small(n, to, from);
 219         else
 220                 return uaccess.copy_to_user(n, to, from);
 221 }
 222
 223 #define __copy_to_user_inatomic __copy_to_user
 224 #define __copy_from_user_inatomic __copy_from_user
 225
 226 /**
 227  * copy_to_user: - Copy a block of data into user space.
 228  * @to:   Destination address, in user space.
 229  * @from: Source address, in kernel space.
 230  * @n:    Number of bytes to copy.
 231  *
 232  * Context: User context only.  This function may sleep.
 233  *
 234  * Copy data from kernel space to user space.
 235  *
 236  * Returns number of bytes that could not be copied.
 237  * On success, this will be zero.
 238  */
 239 static inline unsigned long
 240 copy_to_user(void __user *to, const void *from, unsigned long n)
 241 {
 242         might_sleep();
 243         if (access_ok(VERIFY_WRITE, to, n))
 244                 n = __copy_to_user(to, from, n);
 245         return n;
 246 }
 247
 248 /**
 249  * __copy_from_user: - Copy a block of data from user space, with less checking.
 250  * @to:   Destination address, in kernel space.
 251  * @from: Source address, in user space.
 252  * @n:    Number of bytes to copy.
 253  *
 254  * Context: User context only.  This function may sleep.
 255  *
 256  * Copy data from user space to kernel space.  Caller must check
 257  * the specified block with access_ok() before calling this function.
 258  *
 259  * Returns number of bytes that could not be copied.
 260  * On success, this will be zero.
 261  *
 262  * If some data could not be copied, this function will pad the copied
 263  * data to the requested size using zero bytes.
 264  */
 265 static inline unsigned long
 266 __copy_from_user(void *to, const void __user *from, unsigned long n)
 267 {
 268         if (__builtin_constant_p(n) && (n <= 256))
 269                 return uaccess.copy_from_user_small(n, from, to);
 270         else
 271                 return uaccess.copy_from_user(n, from, to);
 272 }
 273
 274 /**
 275  * copy_from_user: - Copy a block of data from user space.
 276  * @to:   Destination address, in kernel space.
 277  * @from: Source address, in user space.
 278  * @n:    Number of bytes to copy.
 279  *
 280  * Context: User context only.  This function may sleep.
 281  *
 282  * Copy data from user space to kernel space.
 283  *
 284  * Returns number of bytes that could not be copied.
 285  * On success, this will be zero.
 286  *
 287  * If some data could not be copied, this function will pad the copied
 288  * data to the requested size using zero bytes.
 289  */
 290 static inline unsigned long
 291 copy_from_user(void *to, const void __user *from, unsigned long n)
 292 {
 293         might_sleep();
 294         if (access_ok(VERIFY_READ, from, n))
 295                 n = __copy_from_user(to, from, n);
 296         else
 297                 memset(to, 0, n);
 298         return n;
 299 }
 300
 301 static inline unsigned long
 302 __copy_in_user(void __user *to, const void __user *from, unsigned long n)
 303 {
 304         return uaccess.copy_in_user(n, to, from);
 305 }
 306
 307 static inline unsigned long
 308 copy_in_user(void __user *to, const void __user *from, unsigned long n)
 309 {
 310         might_sleep();
 311         if (__access_ok(from,n) && __access_ok(to,n))
 312                 n = __copy_in_user(to, from, n);
 313         return n;
 314 }
 315
 316 /*
 317  * Copy a null terminated string from userspace.
 318  */
 319 static inline long
 320 strncpy_from_user(char *dst, const char __user *src, long count)
 321 {
 322         long res = -EFAULT;
 323         might_sleep();
 324         if (access_ok(VERIFY_READ, src, 1))
 325                 res = uaccess.strncpy_from_user(count, src, dst);
 326         return res;
 327 }
 328
 329 static inline unsigned long
 330 strnlen_user(const char __user * src, unsigned long n)
 331 {
 332         might_sleep();
 333         return uaccess.strnlen_user(n, src);
 334 }
 335
 336 /**
 337  * strlen_user: - Get the size of a string in user space.
 338  * @str: The string to measure.
 339  *
 340  * Context: User context only.  This function may sleep.
 341  *
 342  * Get the size of a NUL-terminated string in user space.
 343  *
 344  * Returns the size of the string INCLUDING the terminating NUL.
 345  * On exception, returns 0.
 346  *
 347  * If there is a limit on the length of a valid string, you may wish to
 348  * consider using strnlen_user() instead.
 349  */
 350 #define strlen_user(str) strnlen_user(str, ~0UL)
 351
 352 /*
 353  * Zero Userspace
 354  */
 355
 356 static inline unsigned long
 357 __clear_user(void __user *to, unsigned long n)
 358 {
 359         return uaccess.clear_user(n, to);
 360 }
 361
 362 static inline unsigned long
 363 clear_user(void __user *to, unsigned long n)
 364 {
 365         might_sleep();
 366         if (access_ok(VERIFY_WRITE, to, n))
 367                 n = uaccess.clear_user(n, to);
 368         return n;
 369 }
 370
 371 #endif /* __S390_UACCESS_H */