src/afs/LINUX/osi_machdep.h

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 /*
  11  * Linux implementation.
  12  *
  13  */
  14
  15 #ifndef OSI_MACHDEP_H_
  16 #define OSI_MACHDEP_H_
  17
  18 /* Only needed for xdr.h in glibc 2.1.x */
  19 #ifndef quad_t
  20 # define quad_t __quad_t
  21 # define u_quad_t __u_quad_t
  22 #endif
  23
  24 #undef getuerror
  25
  26 #ifdef STRUCT_TASK_STRUCT_HAS_TGID
  27 # define getpid() current->tgid
  28 # ifdef STRUCT_TASK_STRUCT_HAS_REAL_PARENT
  29 #  define getppid() current->real_parent->tgid
  30 # elif defined(STRUCT_TASK_STRUCT_HAS_PARENT)
  31 #  define getppid() current->parent->tgid
  32 # else
  33 #  define getppid() current->p_opptr->tgid
  34 # endif
  35 #else /* !STRUCT_TASK_STRUCT_HAS_TGID */
  36 # define getpid() current->pid
  37 # ifdef STRUCT_TASK_STRUCT_HAS_REAL_PARENT
  38 #  define getppid() current->real_parent->pid
  39 # elif defined(STRUCT_TASK_STRUCT_HAS_PARENT)
  40 #  define getppid() current->parent->pid
  41 # else
  42 #  define getppid() current->p_opptr->pid
  43 # endif
  44 #endif /* STRUCT_TASK_STRUCT_HAS_TGID */
  45
  46 #ifdef RECALC_SIGPENDING_TAKES_VOID
  47 # define RECALC_SIGPENDING(X) recalc_sigpending()
  48 #else
  49 # define RECALC_SIGPENDING(X) recalc_sigpending(X)
  50 #endif
  51
  52 #if defined (STRUCT_TASK_STRUCT_HAS_SIGMASK_LOCK)
  53 # define SIG_LOCK(X) spin_lock_irq(&X->sigmask_lock)
  54 # define SIG_UNLOCK(X) spin_unlock_irq(&X->sigmask_lock)
  55 #elif defined (STRUCT_TASK_STRUCT_HAS_SIGHAND)
  56 # define SIG_LOCK(X) spin_lock_irq(&X->sighand->siglock)
  57 # define SIG_UNLOCK(X) spin_unlock_irq(&X->sighand->siglock)
  58 #else
  59 # define SIG_LOCK(X) spin_lock_irq(&X->sig->siglock)
  60 # define SIG_UNLOCK(X) spin_unlock_irq(&X->sig->siglock)
  61 #endif
  62
  63 #if defined (STRUCT_TASK_STRUCT_HAS_RLIM)
  64 # define TASK_STRUCT_RLIM rlim
  65 #elif defined (STRUCT_TASK_STRUCT_HAS_SIGNAL_RLIM)
  66 # define TASK_STRUCT_RLIM signal->rlim
  67 #else
  68 # error Not sure what to do about rlim (should be in the Linux task struct somewhere....)
  69 #endif
  70
  71
  72 #define afs_hz HZ
  73 #include "h/sched.h"
  74 /* in case cred.h is present but not included in sched.h */
  75 #if defined(HAVE_LINUX_CRED_H)
  76 #include "h/cred.h"
  77 #endif
  78
  79 #include "afs/sysincludes.h"
  80
  81 #if !defined(HAVE_LINUX_TIME_T)
  82 typedef time64_t time_t;
  83 #endif
  84
  85 #if defined(HAVE_LINUX_KTIME_GET_COARSE_REAL_TS64)
  86 static inline time_t osi_Time(void) {
  87     struct timespec64 xtime;
  88     ktime_get_coarse_real_ts64(&xtime);
  89     return xtime.tv_sec;
  90 }
  91 #elif defined(HAVE_LINUX_CURRENT_KERNEL_TIME)
  92 static inline time_t osi_Time(void) {
  93     struct timespec xtime;
  94     xtime = current_kernel_time();
  95     return xtime.tv_sec;
  96 }
  97 #else
  98 # define osi_Time() (xtime.tv_sec)
  99 #endif
 100
 101 #if defined(HAVE_LINUX_KTIME_GET_REAL_TS64)
 102 static inline void
 103 osi_GetTime(osi_timeval32_t *atv)
 104 {
 105     struct timespec64 now;
 106     ktime_get_real_ts64(&now);
 107     atv->tv_sec = now.tv_sec;
 108     atv->tv_usec = now.tv_nsec / 1000;
 109 }
 110 #else
 111 static inline void
 112 osi_GetTime(osi_timeval32_t *atv)
 113 {
 114     struct timeval now;
 115     do_gettimeofday(&now);
 116     atv->tv_sec = now.tv_sec;
 117     atv->tv_usec = now.tv_usec;
 118 }
 119 #endif
 120
 121 #undef gop_lookupname
 122 #define gop_lookupname osi_lookupname
 123
 124 #undef gop_lookupname_user
 125 #define gop_lookupname_user osi_lookupname
 126
 127 #define VN_HOLD(V) osi_Assert(igrab((V)) == (V))
 128 #define VN_RELE(V) iput((V))
 129
 130 #define afs_suser(x) capable(CAP_SYS_ADMIN)
 131 extern int afs_osi_Wakeup(void *event);
 132 static inline void
 133 wakeup(void *event)
 134 {
 135     afs_osi_Wakeup(event);
 136 }
 137
 138 #define vType(V) ((AFSTOV((V)))->i_mode & S_IFMT)
 139 #define vSetType(V, type) AFSTOV((V))->i_mode = ((type) | (AFSTOV((V))->i_mode & ~S_IFMT))      /* preserve mode */
 140 #define vSetVfsp(V, vfsp)                               /* unused */
 141 #define IsAfsVnode(V) ((V)->i_sb == afs_globalVFS)      /* test superblock instead */
 142 #define SetAfsVnode(V)                                  /* unnecessary */
 143
 144 #if defined(HAVE_LINUX_UACCESS_H)
 145 #include <linux/uaccess.h>
 146 #else
 147 #include <asm/uaccess.h>
 148 #endif
 149
 150 #define copyin(F, T, C)  (copy_from_user ((char*)(T), (char*)(F), (C)) > 0 ? EFAULT : 0)
 151 static inline long copyinstr(char *from, char *to, int count, int *length) {
 152     long tmp;
 153     tmp = strncpy_from_user(to, from, count);
 154     if (tmp < 0)
 155             return EFAULT;
 156     *length = tmp;
 157     return 0;
 158 }
 159 #define copyout(F, T, C) (copy_to_user ((char*)(T), (char*)(F), (C)) > 0 ? EFAULT : 0)
 160
 161 /*
 162  * Test to see for 64/32bit compatibility mode
 163  * Return non-zero if in a 64bit kernel and handing a 32bit syscall
 164  */
 165 #if defined(AFS_LINUX_64BIT_KERNEL) && !defined(AFS_ALPHA_LINUX20_ENV) && !defined(AFS_IA64_LINUX20_ENV)
 166 static inline int
 167 afs_in_compat_syscall(void)
 168 {
 169 # if defined(HAVE_LINUX_IN_COMPAT_SYSCALL)
 170     return in_compat_syscall();
 171 # elif defined(AFS_SPARC64_LINUX26_ENV)
 172     return test_thread_flag(TIF_32BIT);
 173 # elif defined(AFS_SPARC64_LINUX24_ENV)
 174     return (current->thread.flags & SPARC_FLAG_32BIT) != 0;
 175 # elif defined(AFS_SPARC64_LINUX20_ENV)
 176     return (current->tss.flags & SPARC_FLAG_32BIT) != 0;
 177 # elif defined(AFS_AMD64_LINUX26_ENV)
 178     return test_thread_flag(TIF_IA32);
 179 # elif defined(AFS_AMD64_LINUX20_ENV)
 180     return (current->thread.flags & THREAD_IA32) != 0;
 181 # elif defined(AFS_PPC64_LINUX26_ENV)
 182 #  if defined(STRUCT_TASK_STRUCT_HAS_THREAD_INFO)
 183     return (current->thread_info->flags & _TIF_32BIT) != 0;
 184 #  else
 185     return (task_thread_info(current)->flags & _TIF_32BIT) != 0;
 186 #  endif
 187 # elif defined(AFS_PPC64_LINUX20_ENV)
 188    return (current->thread.flags & PPC_FLAG_32BIT) != 0;
 189 # elif defined(AFS_S390X_LINUX26_ENV)
 190    return test_thread_flag(TIF_31BIT);
 191 # elif defined(AFS_S390X_LINUX20_ENV)
 192   return (current->thread.flags & S390_FLAG_31BIT) != 0;
 193 # elif defined(AFS_ARM64_LINUX26_ENV)
 194   return is_compat_task();
 195 # else
 196 #  error afs_in_compat_syscall not done for this linux
 197 # endif
 198 }
 199 #endif /* AFS_LINUX_64BIT_KERNEL */
 200
 201 /* kernel print statements */
 202 #define printf(args...) printk(args)
 203 #define uprintf(args...) printk(args)
 204
 205
 206 #ifndef NGROUPS
 207 #define NGROUPS NGROUPS_SMALL
 208 #endif
 209
 210 #ifdef STRUCT_GROUP_INFO_HAS_GID
 211 /* compat macro for Linux 4.9 */
 212 #define GROUP_AT(gi,x)  ((gi)->gid[x])
 213 #endif
 214
 215 typedef struct task_struct afs_proc_t;
 216
 217 #ifdef HAVE_LINUX_KUID_T
 218
 219 #include <linux/uidgid.h>
 220 typedef kuid_t afs_kuid_t;
 221 typedef kgid_t afs_kgid_t;
 222 extern struct user_namespace *afs_ns;
 223 # ifdef CONFIG_USER_NS
 224 #  define afs_current_user_ns() current_user_ns()
 225 # else
 226 /* Here current_user_ns() expands to GPL-only init_user_ns symbol! */
 227 #  define afs_current_user_ns() ((struct user_namespace *)NULL)
 228 # endif
 229
 230 static inline kuid_t afs_make_kuid(uid_t uid) {
 231     return make_kuid(afs_ns, uid);
 232 }
 233 static inline kgid_t afs_make_kgid(gid_t gid) {
 234     return make_kgid(afs_ns, gid);
 235 }
 236 static inline uid_t afs_from_kuid(kuid_t kuid) {
 237     return from_kuid(afs_ns, kuid);
 238 }
 239 static inline uid_t afs_from_kgid(kgid_t kgid) {
 240     return from_kgid(afs_ns, kgid);
 241 }
 242
 243 #else
 244
 245 typedef uid_t afs_kuid_t;
 246 typedef gid_t afs_kgid_t;
 247
 248 static inline afs_kuid_t afs_make_kuid(uid_t uid) {return uid;}
 249 static inline afs_kgid_t afs_make_kgid(gid_t gid) {return gid;}
 250 static inline uid_t afs_from_kuid(afs_kuid_t kuid) {return kuid;}
 251 static inline gid_t afs_from_kgid(afs_kgid_t kgid) {return kgid;}
 252 static inline unsigned char uid_eq(uid_t a, uid_t b) {return a == b;}
 253 static inline unsigned char gid_eq(gid_t a, gid_t b) {return a == b;}
 254 static inline unsigned char uid_lt(uid_t a, uid_t b) {return a < b;}
 255 static inline unsigned char gid_lt(gid_t a, gid_t b) {return a < b;}
 256 #define GLOBAL_ROOT_UID ((afs_kuid_t) 0)
 257 #define GLOBAL_ROOT_GID ((afs_kgid_t) 0)
 258
 259 #endif
 260
 261 /* Credentials.  For newer kernels we use the kernel structure directly. */
 262 #if defined(STRUCT_TASK_STRUCT_HAS_CRED)
 263
 264 typedef struct cred afs_ucred_t;
 265 typedef struct cred cred_t;
 266
 267 # define afs_cr_uid(cred) (afs_from_kuid((cred)->fsuid))
 268 # define afs_cr_gid(cred) (afs_from_kgid((cred)->fsgid))
 269 # define afs_cr_ruid(cred) (afs_from_kuid((cred)->uid))
 270 # define afs_cr_rgid(cred) (afs_from_kgid((cred)->gid))
 271 # define afs_cr_group_info(cred) ((cred)->group_info)
 272 # define crhold(c) (get_cred(c))
 273 static inline void
 274 afs_set_cr_uid(cred_t *cred, uid_t uid) {
 275     cred->fsuid = afs_make_kuid(uid);
 276 }
 277 static inline void
 278 afs_set_cr_gid(cred_t *cred, gid_t gid) {
 279     cred->fsgid = afs_make_kgid(gid);
 280 }
 281 static inline void
 282 afs_set_cr_ruid(cred_t *cred, uid_t uid) {
 283     cred->uid = afs_make_kuid(uid);
 284 }
 285 static inline void
 286 afs_set_cr_rgid(cred_t *cred, gid_t gid) {
 287     cred->gid = afs_make_kgid(gid);
 288 }
 289 static inline void
 290 afs_set_cr_group_info(cred_t *cred, struct group_info *group_info) {
 291     cred->group_info = group_info;
 292 }
 293
 294 # define current_group_info() (current->cred->group_info)
 295 # define task_gid(task) (task->cred->gid)
 296 # define task_user(task) (task->cred->user)
 297 # if defined(STRUCT_CRED_HAS_SESSION_KEYRING)
 298 #  define task_session_keyring(task) (task->cred->session_keyring)
 299 #  define current_session_keyring() (current->cred->session_keyring)
 300 # else
 301 #  define task_session_keyring(task) (task->cred->tgcred->session_keyring)
 302 #  define current_session_keyring() (current->cred->tgcred->session_keyring)
 303 # endif
 304
 305 #else
 306
 307 typedef struct afs_cred {
 308     atomic_t cr_ref;
 309     uid_t cr_uid;
 310     uid_t cr_ruid;
 311     gid_t cr_gid;
 312     gid_t cr_rgid;
 313     struct group_info *cr_group_info;
 314 } cred_t;
 315
 316 typedef struct afs_cred afs_ucred_t;
 317 # define afs_cr_group_info(cred) ((cred)->cr_group_info)
 318 static inline void
 319 afs_set_cr_group_info(cred_t *cred, struct group_info *group_info) {
 320     cred->cr_group_info = group_info;
 321 }
 322
 323 # define current_group_info() (current->group_info)
 324 # if !defined(task_gid)
 325 #  define task_gid(task) (task->gid)
 326 # endif
 327 # if !defined(task_uid)
 328 #  define task_uid(task) (task->uid)
 329 # endif
 330 # define task_user(task) (task->user)
 331 # define task_session_keyring(task) (task->signal->session_keyring)
 332 # define current_session_keyring() (current->signal->session_keyring)
 333 # define crhold(c) atomic_inc(&(c)->cr_ref)
 334
 335 #endif /* defined(STRUCT_TASK_STRUCT_HAS_CRED) */
 336
 337 #if !defined(current_cred)
 338 # define current_gid() (current->gid)
 339 # define current_uid() (current->uid)
 340 # define current_fsgid() (current->fsgid)
 341 # define current_fsuid() (current->fsuid)
 342 #endif
 343
 344 /* UIO manipulation */
 345 typedef enum { AFS_UIOSYS, AFS_UIOUSER } uio_seg_t;
 346 typedef enum { UIO_READ, UIO_WRITE } uio_flag_t;
 347 struct uio {
 348     struct iovec *uio_iov;
 349     int uio_iovcnt;
 350     afs_offs_t uio_offset;
 351     uio_seg_t uio_seg;
 352     int uio_resid;
 353     uio_flag_t uio_flag;
 354 };
 355 #define afsio_iov       uio_iov
 356 #define afsio_iovcnt    uio_iovcnt
 357 #define afsio_offset    uio_offset
 358 #define afsio_seg       uio_segflg
 359 #define afsio_fmode     uio_fmode
 360 #define afsio_resid     uio_resid
 361
 362 /* Get/set the inode in the osifile struct. */
 363 #define FILE_INODE(F) (F)->f_dentry->d_inode
 364
 365 #define OSIFILE_INODE(a) FILE_INODE((a)->filp)
 366
 367 #if defined(AFS_LINUX_64BIT_KERNEL) && !defined(AFS_ALPHA_LINUX20_ENV) && !defined(AFS_IA64_LINUX20_ENV)
 368 # define NEED_IOCTL32
 369 #endif
 370
 371 #include <linux/version.h>
 372 #include <linux/sched.h>
 373 #include <linux/wait.h>
 374
 375 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
 376 extern struct mutex afs_global_lock;
 377 #else
 378 extern struct semaphore afs_global_lock;
 379 # define mutex_lock(lock) down(lock)
 380 # define mutex_unlock(lock) up(lock)
 381 #endif
 382 extern int afs_global_owner;
 383
 384 #define AFS_GLOCK() \
 385 do { \
 386          mutex_lock(&afs_global_lock); \
 387          if (afs_global_owner) \
 388              osi_Panic("afs_global_lock already held by pid %d", \
 389                        afs_global_owner); \
 390          afs_global_owner = current->pid; \
 391 } while (0)
 392
 393 #define ISAFS_GLOCK() (afs_global_owner == current->pid)
 394
 395 #define AFS_GUNLOCK() \
 396 do { \
 397     if (!ISAFS_GLOCK()) \
 398         osi_Panic("afs global lock not held at %s:%d", __FILE__, __LINE__); \
 399     afs_global_owner = 0; \
 400     mutex_unlock(&afs_global_lock); \
 401 } while (0)
 402
 403 #define osi_InitGlock()
 404
 405 #ifdef AFS_AMD64_LINUX20_ENV
 406 /* RHEL5 beta's kernel doesn't define these. They aren't gonna change, so... */
 407
 408 # ifndef __NR_ia32_afs_syscall
 409 #  define __NR_ia32_afs_syscall 137
 410 # endif
 411 # ifndef __NR_ia32_setgroups
 412 #  define __NR_ia32_setgroups 81
 413 # endif
 414 # ifndef __NR_ia32_setgroups32
 415 #  define __NR_ia32_setgroups32 206
 416 # endif
 417 # ifndef __NR_ia32_close
 418 #  define __NR_ia32_close 6
 419 # endif
 420 # ifndef __NR_ia32_chdir
 421 #  define __NR_ia32_chdir 12
 422 # endif
 423 # ifndef __NR_ia32_break
 424 #  define __NR_ia32_break 17
 425 # endif
 426 # ifndef __NR_ia32_stty
 427 #  define __NR_ia32_stty 31
 428 # endif
 429 # ifndef __NR_ia32_gtty
 430 #  define __NR_ia32_gtty 32
 431 # endif
 432 # ifndef __NR_ia32_ftime
 433 #  define __NR_ia32_ftime 35
 434 # endif
 435 # ifndef __NR_ia32_prof
 436 #  define __NR_ia32_prof 44
 437 # endif
 438 # ifndef __NR_ia32_lock
 439 #  define __NR_ia32_lock 53
 440 # endif
 441 # ifndef __NR_ia32_mpx
 442 #  define __NR_ia32_mpx 56
 443 # endif
 444 # ifndef __NR_ia32_exit
 445 #  define __NR_ia32_exit 1
 446 # endif
 447 # ifndef __NR_ia32_mount
 448 #  define __NR_ia32_mount 21
 449 # endif
 450 # ifndef __NR_ia32_read
 451 #  define __NR_ia32_read 3
 452 # endif
 453 # ifndef __NR_ia32_write
 454 #  define __NR_ia32_write 4
 455 # endif
 456 # ifndef __NR_ia32_open
 457 #  define __NR_ia32_open 5
 458 # endif
 459 # ifndef __NR_ia32_close
 460 #  define __NR_ia32_close 6
 461 # endif
 462 # ifndef __NR_ia32_unlink
 463 #  define __NR_ia32_unlink 10
 464 # endif
 465 #endif
 466
 467 #define osi_procname(procname, size) strncpy(procname, current->comm, size)
 468
 469 #endif /* OSI_MACHDEP_H_ */