include/asm-ppc64/uaccess.h

   1 #ifndef _PPC64_UACCESS_H
   2 #define _PPC64_UACCESS_H
   3
   4 /*
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version
   8  * 2 of the License, or (at your option) any later version.
   9  */
  10
  11 #ifndef __ASSEMBLY__
  12 #include <linux/sched.h>
  13 #include <linux/errno.h>
  14 #include <asm/processor.h>
  15
  16 #define VERIFY_READ     0
  17 #define VERIFY_WRITE    1
  18
  19 /*
  20  * The fs value determines whether argument validity checking should be
  21  * performed or not.  If get_fs() == USER_DS, checking is performed, with
  22  * get_fs() == KERNEL_DS, checking is bypassed.
  23  *
  24  * For historical reasons, these macros are grossly misnamed.
  25  */
  26
  27 #define MAKE_MM_SEG(s)  ((mm_segment_t) { (s) })
  28
  29 #define KERNEL_DS       MAKE_MM_SEG(0UL)
  30 #define USER_DS         MAKE_MM_SEG(0xf000000000000000UL)
  31
  32 #define get_ds()        (KERNEL_DS)
  33 #define get_fs()        (current->thread.fs)
  34 #define set_fs(val)     (current->thread.fs = (val))
  35
  36 #define segment_eq(a,b) ((a).seg == (b).seg)
  37
  38 /*
  39  * Use the alpha trick for checking ranges:
  40  *
  41  * Is a address valid? This does a straightforward calculation rather
  42  * than tests.
  43  *
  44  * Address valid if:
  45  *  - "addr" doesn't have any high-bits set
  46  *  - AND "size" doesn't have any high-bits set
  47  *  - OR we are in kernel mode.
  48  *
  49  * We dont have to check for high bits in (addr+size) because the first
  50  * two checks force the maximum result to be below the start of the
  51  * kernel region.
  52  */
  53 #define __access_ok(addr,size,segment) \
  54         (((segment).seg & (addr | size )) == 0)
  55
  56 #define access_ok(type,addr,size) \
  57         __access_ok(((unsigned long)(addr)),(size),get_fs())
  58
  59 static inline int verify_area(int type, const void __user *addr, unsigned long size)
  60 {
  61         return access_ok(type,addr,size) ? 0 : -EFAULT;
  62 }
  63
  64
  65 /*
  66  * The exception table consists of pairs of addresses: the first is the
  67  * address of an instruction that is allowed to fault, and the second is
  68  * the address at which the program should continue.  No registers are
  69  * modified, so it is entirely up to the continuation code to figure out
  70  * what to do.
  71  *
  72  * All the routines below use bits of fixup code that are out of line
  73  * with the main instruction path.  This means when everything is well,
  74  * we don't even have to jump over them.  Further, they do not intrude
  75  * on our cache or tlb entries.
  76  */
  77
  78 struct exception_table_entry
  79 {
  80         unsigned long insn, fixup;
  81 };
  82
  83 /* Returns 0 if exception not found and fixup otherwise.  */
  84 extern unsigned long search_exception_table(unsigned long);
  85
  86 /*
  87  * These are the main single-value transfer routines.  They automatically
  88  * use the right size if we just have the right pointer type.
  89  *
  90  * This gets kind of ugly. We want to return _two_ values in "get_user()"
  91  * and yet we don't want to do any pointers, because that is too much
  92  * of a performance impact. Thus we have a few rather ugly macros here,
  93  * and hide all the ugliness from the user.
  94  *
  95  * The "__xxx" versions of the user access functions are versions that
  96  * do not verify the address space, that must have been done previously
  97  * with a separate "access_ok()" call (this is used when we do multiple
  98  * accesses to the same area of user memory).
  99  *
 100  * As we use the same address space for kernel and user data on the
 101  * PowerPC, we can just do these as direct assignments.  (Of course, the
 102  * exception handling means that it's no longer "just"...)
 103  */
 104 #define get_user(x,ptr) \
 105   __get_user_check((x),(ptr),sizeof(*(ptr)))
 106 #define put_user(x,ptr) \
 107   __put_user_check((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
 108
 109 #define __get_user(x,ptr) \
 110   __get_user_nocheck((x),(ptr),sizeof(*(ptr)))
 111 #define __put_user(x,ptr) \
 112   __put_user_nocheck((__typeof__(*(ptr)))(x),(ptr),sizeof(*(ptr)))
 113
 114 extern long __put_user_bad(void);
 115
 116 #define __put_user_nocheck(x,ptr,size)                          \
 117 ({                                                              \
 118         long __pu_err;                                          \
 119         __put_user_size((x),(ptr),(size),__pu_err,-EFAULT);     \
 120         __pu_err;                                               \
 121 })
 122
 123 #define __put_user_check(x,ptr,size)                                    \
 124 ({                                                                      \
 125         long __pu_err = -EFAULT;                                        \
 126         __typeof__(*(ptr)) *__pu_addr = (ptr);                          \
 127         if (access_ok(VERIFY_WRITE,__pu_addr,size))                     \
 128                 __put_user_size((x),__pu_addr,(size),__pu_err,-EFAULT); \
 129         __pu_err;                                                       \
 130 })
 131
 132 #define __put_user_size(x,ptr,size,retval,errret)                       \
 133 do {                                                                    \
 134         might_sleep();                                                  \
 135         retval = 0;                                                     \
 136         switch (size) {                                                 \
 137           case 1: __put_user_asm(x,ptr,retval,"stb",errret); break;     \
 138           case 2: __put_user_asm(x,ptr,retval,"sth",errret); break;     \
 139           case 4: __put_user_asm(x,ptr,retval,"stw",errret); break;     \
 140           case 8: __put_user_asm(x,ptr,retval,"std",errret); break;     \
 141           default: __put_user_bad();                                    \
 142         }                                                               \
 143 } while (0)
 144
 145 /*
 146  * We don't tell gcc that we are accessing memory, but this is OK
 147  * because we do not write to any memory gcc knows about, so there
 148  * are no aliasing issues.
 149  */
 150 #define __put_user_asm(x, addr, err, op, errret)                \
 151         __asm__ __volatile__(                                   \
 152                 "1:     "op" %1,0(%2)   # put_user\n"           \
 153                 "2:\n"                                          \
 154                 ".section .fixup,\"ax\"\n"                      \
 155                 "3:     li %0,%3\n"                             \
 156                 "       b 2b\n"                                 \
 157                 ".previous\n"                                   \
 158                 ".section __ex_table,\"a\"\n"                   \
 159                 "       .align 3\n"                             \
 160                 "       .llong 1b,3b\n"                         \
 161                 ".previous"                                     \
 162                 : "=r"(err)                                     \
 163                 : "r"(x), "b"(addr), "i"(errret), "0"(err))
 164
 165
 166 #define __get_user_nocheck(x,ptr,size)                          \
 167 ({                                                              \
 168         long __gu_err, __gu_val;                                \
 169         __get_user_size(__gu_val,(ptr),(size),__gu_err,-EFAULT);\
 170         (x) = (__typeof__(*(ptr)))__gu_val;                     \
 171         __gu_err;                                               \
 172 })
 173
 174 #define __get_user_check(x,ptr,size)                                    \
 175 ({                                                                      \
 176         long __gu_err = -EFAULT, __gu_val = 0;                          \
 177         const __typeof__(*(ptr)) *__gu_addr = (ptr);                    \
 178         if (access_ok(VERIFY_READ,__gu_addr,size))                      \
 179                 __get_user_size(__gu_val,__gu_addr,(size),__gu_err,-EFAULT);\
 180         (x) = (__typeof__(*(ptr)))__gu_val;                             \
 181         __gu_err;                                                       \
 182 })
 183
 184 extern long __get_user_bad(void);
 185
 186 #define __get_user_size(x,ptr,size,retval,errret)                       \
 187 do {                                                                    \
 188         might_sleep();                                                  \
 189         retval = 0;                                                     \
 190         switch (size) {                                                 \
 191           case 1: __get_user_asm(x,ptr,retval,"lbz",errret); break;     \
 192           case 2: __get_user_asm(x,ptr,retval,"lhz",errret); break;     \
 193           case 4: __get_user_asm(x,ptr,retval,"lwz",errret); break;     \
 194           case 8: __get_user_asm(x,ptr,retval,"ld",errret);  break;     \
 195           default: (x) = __get_user_bad();                              \
 196         }                                                               \
 197 } while (0)
 198
 199 #define __get_user_asm(x, addr, err, op, errret)        \
 200         __asm__ __volatile__(                           \
 201                 "1:     "op" %1,0(%2)   # get_user\n"   \
 202                 "2:\n"                                  \
 203                 ".section .fixup,\"ax\"\n"              \
 204                 "3:     li %0,%3\n"                     \
 205                 "       li %1,0\n"                      \
 206                 "       b 2b\n"                         \
 207                 ".previous\n"                           \
 208                 ".section __ex_table,\"a\"\n"           \
 209                 "       .align 3\n"                     \
 210                 "       .llong 1b,3b\n"                 \
 211                 ".previous"                             \
 212                 : "=r"(err), "=r"(x)                    \
 213                 : "b"(addr), "i"(errret), "0"(err))
 214
 215 /* more complex routines */
 216
 217 extern unsigned long __copy_tofrom_user(void __user *to, const void __user *from,
 218                                         unsigned long size);
 219
 220 static inline unsigned long
 221 __copy_from_user(void *to, const void __user *from, unsigned long n)
 222 {
 223         might_sleep();
 224         if (__builtin_constant_p(n)) {
 225                 unsigned long ret;
 226
 227                 switch (n) {
 228                 case 1:
 229                         __get_user_size(*(u8 *)to, from, 1, ret, 1);
 230                         return ret;
 231                 case 2:
 232                         __get_user_size(*(u16 *)to, from, 2, ret, 2);
 233                         return ret;
 234                 case 4:
 235                         __get_user_size(*(u32 *)to, from, 4, ret, 4);
 236                         return ret;
 237                 case 8:
 238                         __get_user_size(*(u64 *)to, from, 8, ret, 8);
 239                         return ret;
 240                 }
 241         }
 242         return __copy_tofrom_user((void __user *) to, from, n);
 243 }
 244
 245 static inline unsigned long
 246 __copy_to_user(void __user *to, const void *from, unsigned long n)
 247 {
 248         might_sleep();
 249         if (__builtin_constant_p(n)) {
 250                 unsigned long ret;
 251
 252                 switch (n) {
 253                 case 1:
 254                         __put_user_size(*(u8 *)from, (u8 __user *)to, 1, ret, 1);
 255                         return ret;
 256                 case 2:
 257                         __put_user_size(*(u16 *)from, (u16 __user *)to, 2, ret, 2);
 258                         return ret;
 259                 case 4:
 260                         __put_user_size(*(u32 *)from, (u32 __user *)to, 4, ret, 4);
 261                         return ret;
 262                 case 8:
 263                         __put_user_size(*(u64 *)from, (u64 __user *)to, 8, ret, 8);
 264                         return ret;
 265                 }
 266         }
 267         return __copy_tofrom_user(to, (const void __user *) from, n);
 268 }
 269
 270 #define __copy_in_user(to, from, size) \
 271         __copy_tofrom_user((to), (from), (size))
 272
 273 static inline unsigned long
 274 copy_from_user(void *to, const void __user *from, unsigned long n)
 275 {
 276         if (likely(access_ok(VERIFY_READ, from, n)))
 277                 n = __copy_from_user(to, from, n);
 278         else
 279                 memset(to, 0, n);
 280         return n;
 281 }
 282
 283 static inline unsigned long
 284 copy_to_user(void __user *to, const void *from, unsigned long n)
 285 {
 286         if (likely(access_ok(VERIFY_WRITE, to, n)))
 287                 n = __copy_to_user(to, from, n);
 288         return n;
 289 }
 290
 291 static inline unsigned long
 292 copy_in_user(void __user *to, const void __user *from, unsigned long n)
 293 {
 294         might_sleep();
 295         if (likely(access_ok(VERIFY_READ, from, n) &&
 296             access_ok(VERIFY_WRITE, to, n)))
 297                 n =__copy_tofrom_user(to, from, n);
 298         return n;
 299 }
 300
 301 extern unsigned long __clear_user(void __user *addr, unsigned long size);
 302
 303 static inline unsigned long
 304 clear_user(void __user *addr, unsigned long size)
 305 {
 306         might_sleep();
 307         if (likely(access_ok(VERIFY_WRITE, addr, size)))
 308                 size = __clear_user(addr, size);
 309         return size;
 310 }
 311
 312 extern int __strncpy_from_user(char *dst, const char __user *src, long count);
 313
 314 static inline long
 315 strncpy_from_user(char *dst, const char __user *src, long count)
 316 {
 317         might_sleep();
 318         if (likely(access_ok(VERIFY_READ, src, 1)))
 319                 return __strncpy_from_user(dst, src, count);
 320         return -EFAULT;
 321 }
 322
 323 /*
 324  * Return the size of a string (including the ending 0)
 325  *
 326  * Return 0 for error
 327  */
 328 extern int __strnlen_user(const char __user *str, long len);
 329
 330 /*
 331  * Returns the length of the string at str (including the null byte),
 332  * or 0 if we hit a page we can't access,
 333  * or something > len if we didn't find a null byte.
 334  */
 335 static inline int strnlen_user(const char __user *str, long len)
 336 {
 337         might_sleep();
 338         if (likely(access_ok(VERIFY_READ, str, 1)))
 339                 return __strnlen_user(str, len);
 340         return 0;
 341 }
 342
 343 #define strlen_user(str)        strnlen_user((str), 0x7ffffffe)
 344
 345 #endif  /* __ASSEMBLY__ */
 346
 347 #endif  /* _PPC64_UACCESS_H */