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 #if defined(HAVE_LINUX_CURRENT_KERNEL_TIME)
  79 static inline time_t osi_Time(void) {
  80     struct timespec xtime;
  81     xtime = current_kernel_time();
  82     return xtime.tv_sec;
  83 }
  84 #else
  85 # define osi_Time() (xtime.tv_sec)
  86 #endif
  87
  88
  89
  90 #ifdef AFS_LINUX_64BIT_KERNEL
  91 # define osi_GetTime(V)                                 \
  92     do {                                               \
  93        struct timeval __afs_tv;                              \
  94        do_gettimeofday(&__afs_tv);                           \
  95        (V)->tv_sec = (afs_int32)__afs_tv.tv_sec;             \
  96        (V)->tv_usec = (afs_int32)__afs_tv.tv_usec;           \
  97     } while (0)
  98 #else
  99 # define osi_GetTime(V) do_gettimeofday((V))
 100 #endif
 101
 102 #undef gop_lookupname
 103 #define gop_lookupname osi_lookupname
 104
 105 #undef gop_lookupname_user
 106 #define gop_lookupname_user osi_lookupname
 107
 108 #define osi_vnhold(V, N) do { VN_HOLD(AFSTOV(V)); } while (0)
 109 #define VN_HOLD(V) osi_Assert(igrab((V)) == (V))
 110 #define VN_RELE(V) iput((V))
 111
 112 #define afs_suser(x) capable(CAP_SYS_ADMIN)
 113 extern int afs_osi_Wakeup(void *event);
 114 static inline void
 115 wakeup(void *event)
 116 {
 117     afs_osi_Wakeup(event);
 118 }
 119
 120 #define vType(V) ((AFSTOV((V)))->i_mode & S_IFMT)
 121 #define vSetType(V, type) AFSTOV((V))->i_mode = ((type) | (AFSTOV((V))->i_mode & ~S_IFMT))      /* preserve mode */
 122 #define vSetVfsp(V, vfsp)                               /* unused */
 123 #define IsAfsVnode(V) ((V)->i_sb == afs_globalVFS)      /* test superblock instead */
 124 #define SetAfsVnode(V)                                  /* unnecessary */
 125
 126 #include <asm/uaccess.h>
 127
 128 #define copyin(F, T, C)  (copy_from_user ((char*)(T), (char*)(F), (C)) > 0 ? EFAULT : 0)
 129 static inline long copyinstr(char *from, char *to, int count, int *length) {
 130     long tmp;
 131     tmp = strncpy_from_user(to, from, count);
 132     if (tmp < 0)
 133             return EFAULT;
 134     *length = tmp;
 135     return 0;
 136 }
 137 #define copyout(F, T, C) (copy_to_user ((char*)(T), (char*)(F), (C)) > 0 ? EFAULT : 0)
 138
 139 /* kernel print statements */
 140 #define printf(args...) printk(args)
 141 #define uprintf(args...) printk(args)
 142
 143
 144 #ifndef NGROUPS
 145 #define NGROUPS NGROUPS_SMALL
 146 #endif
 147
 148 #ifdef STRUCT_GROUP_INFO_HAS_GID
 149 /* compat macro for Linux 4.9 */
 150 #define GROUP_AT(gi,x)  ((gi)->gid[x])
 151 #endif
 152
 153 typedef struct task_struct afs_proc_t;
 154
 155 #ifdef HAVE_LINUX_KUID_T
 156
 157 #include <linux/uidgid.h>
 158 typedef kuid_t afs_kuid_t;
 159 typedef kgid_t afs_kgid_t;
 160 extern struct user_namespace *afs_ns;
 161 # ifdef CONFIG_USER_NS
 162 #  define afs_current_user_ns() current_user_ns()
 163 # else
 164 /* Here current_user_ns() expands to GPL-only init_user_ns symbol! */
 165 #  define afs_current_user_ns() ((struct user_namespace *)NULL)
 166 # endif
 167
 168 static inline kuid_t afs_make_kuid(uid_t uid) {
 169     return make_kuid(afs_ns, uid);
 170 }
 171 static inline kgid_t afs_make_kgid(gid_t gid) {
 172     return make_kgid(afs_ns, gid);
 173 }
 174 static inline uid_t afs_from_kuid(kuid_t kuid) {
 175     return from_kuid(afs_ns, kuid);
 176 }
 177 static inline uid_t afs_from_kgid(kgid_t kgid) {
 178     return from_kgid(afs_ns, kgid);
 179 }
 180
 181 #else
 182
 183 typedef uid_t afs_kuid_t;
 184 typedef gid_t afs_kgid_t;
 185
 186 static inline afs_kuid_t afs_make_kuid(uid_t uid) {return uid;}
 187 static inline afs_kgid_t afs_make_kgid(gid_t gid) {return gid;}
 188 static inline uid_t afs_from_kuid(afs_kuid_t kuid) {return kuid;}
 189 static inline gid_t afs_from_kgid(afs_kgid_t kgid) {return kgid;}
 190 static inline unsigned char uid_eq(uid_t a, uid_t b) {return a == b;}
 191 static inline unsigned char gid_eq(gid_t a, gid_t b) {return a == b;}
 192 static inline unsigned char uid_lt(uid_t a, uid_t b) {return a < b;}
 193 static inline unsigned char gid_lt(gid_t a, gid_t b) {return a < b;}
 194 #define GLOBAL_ROOT_UID ((afs_kuid_t) 0)
 195 #define GLOBAL_ROOT_GID ((afs_kgid_t) 0)
 196
 197 #endif
 198
 199 /* Credentials.  For newer kernels we use the kernel structure directly. */
 200 #if defined(STRUCT_TASK_STRUCT_HAS_CRED)
 201
 202 typedef struct cred afs_ucred_t;
 203 typedef struct cred cred_t;
 204
 205 # define afs_cr_uid(cred) (afs_from_kuid((cred)->fsuid))
 206 # define afs_cr_gid(cred) (afs_from_kgid((cred)->fsgid))
 207 # define afs_cr_ruid(cred) (afs_from_kuid((cred)->uid))
 208 # define afs_cr_rgid(cred) (afs_from_kgid((cred)->gid))
 209 # define afs_cr_group_info(cred) ((cred)->group_info)
 210 # define crhold(c) (get_cred(c))
 211 static inline void
 212 afs_set_cr_uid(cred_t *cred, uid_t uid) {
 213     cred->fsuid = afs_make_kuid(uid);
 214 }
 215 static inline void
 216 afs_set_cr_gid(cred_t *cred, gid_t gid) {
 217     cred->fsgid = afs_make_kgid(gid);
 218 }
 219 static inline void
 220 afs_set_cr_ruid(cred_t *cred, uid_t uid) {
 221     cred->uid = afs_make_kuid(uid);
 222 }
 223 static inline void
 224 afs_set_cr_rgid(cred_t *cred, gid_t gid) {
 225     cred->gid = afs_make_kgid(gid);
 226 }
 227 static inline void
 228 afs_set_cr_group_info(cred_t *cred, struct group_info *group_info) {
 229     cred->group_info = group_info;
 230 }
 231
 232 # define current_group_info() (current->cred->group_info)
 233 # define task_gid(task) (task->cred->gid)
 234 # define task_user(task) (task->cred->user)
 235 # if defined(STRUCT_CRED_HAS_SESSION_KEYRING)
 236 #  define task_session_keyring(task) (task->cred->session_keyring)
 237 #  define current_session_keyring() (current->cred->session_keyring)
 238 # else
 239 #  define task_session_keyring(task) (task->cred->tgcred->session_keyring)
 240 #  define current_session_keyring() (current->cred->tgcred->session_keyring)
 241 # endif
 242
 243 #else
 244
 245 typedef struct afs_cred {
 246     atomic_t cr_ref;
 247     uid_t cr_uid;
 248     uid_t cr_ruid;
 249     gid_t cr_gid;
 250     gid_t cr_rgid;
 251     struct group_info *cr_group_info;
 252 } cred_t;
 253
 254 typedef struct afs_cred afs_ucred_t;
 255 # define afs_cr_group_info(cred) ((cred)->cr_group_info)
 256 static inline void
 257 afs_set_cr_group_info(cred_t *cred, struct group_info *group_info) {
 258     cred->cr_group_info = group_info;
 259 }
 260
 261 # define current_group_info() (current->group_info)
 262 # if !defined(task_gid)
 263 #  define task_gid(task) (task->gid)
 264 # endif
 265 # if !defined(task_uid)
 266 #  define task_uid(task) (task->uid)
 267 # endif
 268 # define task_user(task) (task->user)
 269 # define task_session_keyring(task) (task->signal->session_keyring)
 270 # define current_session_keyring() (current->signal->session_keyring)
 271 # define crhold(c) atomic_inc(&(c)->cr_ref)
 272
 273 #endif /* defined(STRUCT_TASK_STRUCT_HAS_CRED) */
 274
 275 #if !defined(current_cred)
 276 # define current_gid() (current->gid)
 277 # define current_uid() (current->uid)
 278 # define current_fsgid() (current->fsgid)
 279 # define current_fsuid() (current->fsuid)
 280 #endif
 281
 282 /* UIO manipulation */
 283 typedef enum { AFS_UIOSYS, AFS_UIOUSER } uio_seg_t;
 284 typedef enum { UIO_READ, UIO_WRITE } uio_flag_t;
 285 struct uio {
 286     struct iovec *uio_iov;
 287     int uio_iovcnt;
 288     afs_offs_t uio_offset;
 289     uio_seg_t uio_seg;
 290     int uio_resid;
 291     uio_flag_t uio_flag;
 292 };
 293 #define afsio_iov       uio_iov
 294 #define afsio_iovcnt    uio_iovcnt
 295 #define afsio_offset    uio_offset
 296 #define afsio_seg       uio_segflg
 297 #define afsio_fmode     uio_fmode
 298 #define afsio_resid     uio_resid
 299
 300 /* Get/set the inode in the osifile struct. */
 301 #define FILE_INODE(F) (F)->f_dentry->d_inode
 302
 303 #define OSIFILE_INODE(a) FILE_INODE((a)->filp)
 304
 305 #if defined(AFS_LINUX_64BIT_KERNEL) && !defined(AFS_ALPHA_LINUX20_ENV) && !defined(AFS_IA64_LINUX20_ENV)
 306 # define NEED_IOCTL32
 307 #endif
 308
 309 #include <linux/version.h>
 310 #include <linux/sched.h>
 311 #include <linux/wait.h>
 312
 313 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
 314 extern struct mutex afs_global_lock;
 315 #else
 316 extern struct semaphore afs_global_lock;
 317 # define mutex_lock(lock) down(lock)
 318 # define mutex_unlock(lock) up(lock)
 319 #endif
 320 extern int afs_global_owner;
 321
 322 #define AFS_GLOCK() \
 323 do { \
 324          mutex_lock(&afs_global_lock); \
 325          if (afs_global_owner) \
 326              osi_Panic("afs_global_lock already held by pid %d", \
 327                        afs_global_owner); \
 328          afs_global_owner = current->pid; \
 329 } while (0)
 330
 331 #define ISAFS_GLOCK() (afs_global_owner == current->pid)
 332
 333 #define AFS_GUNLOCK() \
 334 do { \
 335     if (!ISAFS_GLOCK()) \
 336         osi_Panic("afs global lock not held at %s:%d", __FILE__, __LINE__); \
 337     afs_global_owner = 0; \
 338     mutex_unlock(&afs_global_lock); \
 339 } while (0)
 340
 341 #define osi_InitGlock()
 342
 343 #ifdef AFS_AMD64_LINUX20_ENV
 344 /* RHEL5 beta's kernel doesn't define these. They aren't gonna change, so... */
 345
 346 # ifndef __NR_ia32_afs_syscall
 347 #  define __NR_ia32_afs_syscall 137
 348 # endif
 349 # ifndef __NR_ia32_setgroups
 350 #  define __NR_ia32_setgroups 81
 351 # endif
 352 # ifndef __NR_ia32_setgroups32
 353 #  define __NR_ia32_setgroups32 206
 354 # endif
 355 # ifndef __NR_ia32_close
 356 #  define __NR_ia32_close 6
 357 # endif
 358 # ifndef __NR_ia32_chdir
 359 #  define __NR_ia32_chdir 12
 360 # endif
 361 # ifndef __NR_ia32_break
 362 #  define __NR_ia32_break 17
 363 # endif
 364 # ifndef __NR_ia32_stty
 365 #  define __NR_ia32_stty 31
 366 # endif
 367 # ifndef __NR_ia32_gtty
 368 #  define __NR_ia32_gtty 32
 369 # endif
 370 # ifndef __NR_ia32_ftime
 371 #  define __NR_ia32_ftime 35
 372 # endif
 373 # ifndef __NR_ia32_prof
 374 #  define __NR_ia32_prof 44
 375 # endif
 376 # ifndef __NR_ia32_lock
 377 #  define __NR_ia32_lock 53
 378 # endif
 379 # ifndef __NR_ia32_mpx
 380 #  define __NR_ia32_mpx 56
 381 # endif
 382 # ifndef __NR_ia32_exit
 383 #  define __NR_ia32_exit 1
 384 # endif
 385 # ifndef __NR_ia32_mount
 386 #  define __NR_ia32_mount 21
 387 # endif
 388 # ifndef __NR_ia32_read
 389 #  define __NR_ia32_read 3
 390 # endif
 391 # ifndef __NR_ia32_write
 392 #  define __NR_ia32_write 4
 393 # endif
 394 # ifndef __NR_ia32_open
 395 #  define __NR_ia32_open 5
 396 # endif
 397 # ifndef __NR_ia32_close
 398 #  define __NR_ia32_close 6
 399 # endif
 400 # ifndef __NR_ia32_unlink
 401 #  define __NR_ia32_unlink 10
 402 # endif
 403 #endif
 404
 405 #define osi_procname(procname, size) strncpy(procname, current->comm, size)
 406
 407 #endif /* OSI_MACHDEP_H_ */