src/afs/afs_osi.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 #ifndef _AFS_OSI_
  11 #define _AFS_OSI_
  12
  13 #include "h/types.h"
  14 #include "h/param.h"
  15
  16 #ifdef AFS_FBSD50_ENV
  17 #include <sys/condvar.h>
  18 #endif
  19
  20 #ifdef AFS_NBSD_ENV
  21 #include <sys/lock.h>
  22 #endif
  23
  24 #ifdef AFS_LINUX20_ENV
  25 #ifndef _LINUX_CODA_FS_I
  26 #define _LINUX_CODA_FS_I
  27 #define _CODA_HEADER_
  28 struct coda_inode_info {
  29 };
  30 #endif
  31 #ifndef _LINUX_XFS_FS_I
  32 #define _LINUX_XFS_FS_I
  33 struct xfs_inode_info {
  34 };
  35 #endif
  36 #include "h/fs.h"
  37 #include "h/mm.h"
  38 #endif
  39
  40
  41 /* this is just a dummy type decl, we're really using struct sockets here */
  42 struct osi_socket {
  43     int junk;
  44 };
  45
  46 struct osi_stat {
  47     afs_int32 size;             /* file size in bytes */
  48     afs_int32 mtime;            /* modification date */
  49     afs_int32 atime;            /* access time */
  50 };
  51
  52 struct osi_file {
  53     afs_int32 size;             /* file size in bytes XXX Must be first field XXX */
  54 #ifdef AFS_LINUX26_ENV
  55     struct file *filp;          /* May need this if we really open the file. */
  56 #else
  57 #ifdef AFS_LINUX22_ENV
  58     struct dentry dentry;       /* merely to hold the pointer to the inode. */
  59     struct file file;           /* May need this if we really open the file. */
  60 #else
  61     struct vnode *vnode;
  62 #endif
  63 #endif
  64 #if     defined(AFS_HPUX102_ENV)
  65     k_off_t offset;
  66 #else
  67 #if defined(AFS_AIX51_ENV) && defined(AFS_64BIT_KERNEL)
  68     afs_offs_t offset;
  69 #else
  70     afs_int32 offset;
  71 #endif
  72 #endif
  73     int (*proc) (struct osi_file * afile, afs_int32 code);      /* proc, which, if not null, is called on writes */
  74     char *rock;                 /* rock passed to proc */
  75 #if defined(UKERNEL)
  76     int fd;                     /* file descriptor for user space files */
  77 #endif                          /* defined(UKERNEL) */
  78 };
  79
  80 struct osi_dev {
  81 #if defined(AFS_XBSD_ENV)
  82     struct mount *mp;
  83     struct vnode *held_vnode;
  84 #elif defined(AFS_AIX42_ENV)
  85     dev_t dev;
  86 #else
  87     afs_int32 dev;
  88 #endif
  89 };
  90
  91 struct afs_osi_WaitHandle {
  92 #ifdef AFS_FBSD_ENV
  93     struct cv wh_condvar;
  94     int wh_inited;
  95 #else
  96     caddr_t proc;               /* process waiting */
  97 #endif
  98 };
  99
 100 #define osi_SetFileProc(x,p)    ((x)->proc=(p))
 101 #define osi_SetFileRock(x,r)    ((x)->rock=(r))
 102 #define osi_GetFileProc(x)      ((x)->proc)
 103 #define osi_GetFileRock(x)      ((x)->rock)
 104
 105 #ifdef  AFS_TEXT_ENV
 106 #define osi_FlushText(vp) if (hcmp((vp)->f.m.DataVersion, (vp)->flushDV) > 0) \
 107                             osi_FlushText_really(vp)
 108 #else
 109 #define osi_FlushText(vp)
 110 #endif
 111
 112
 113 #define AFSOP_STOP_RXEVENT   214        /* stop rx event deamon */
 114 #define AFSOP_STOP_COMPLETE  215        /* afs has been shutdown */
 115 #define AFSOP_STOP_RXK_LISTENER   217   /* stop rx listener daemon */
 116
 117
 118 #define osi_NPACKETS    20      /* number of cluster pkts to alloc */
 119
 120 /*
 121  * Alloc declarations.
 122  */
 123 #if !defined(AFS_OBSD44_ENV) && !defined(AFS_NBSD_ENV)
 124 #define afs_osi_Alloc_NoSleep afs_osi_Alloc
 125 #endif
 126
 127 /*
 128  * Default vnode related macros
 129  *
 130  * Darwin, all of the BSDs, and Linux have their own
 131  */
 132 #if !defined(AFS_DARWIN_ENV) && !defined(AFS_XBSD_ENV) && !defined(AFS_LINUX20_ENV)
 133 # define        vType(vc)           (vc)->v.v_type
 134 # define        vSetType(vc,type)   (vc)->v.v_type = (type)
 135 # define        vSetVfsp(vc,vfsp)   (vc)->v.v_vfsp = (vfsp)
 136 extern struct vnodeops *afs_ops;
 137 # define        IsAfsVnode(v)       ((v)->v_op == afs_ops)
 138 # define        SetAfsVnode(v)      (v)->v_op = afs_ops
 139 #endif
 140
 141 /*
 142  * In IRIX 6.5 we cannot have DEBUG turned on since certain
 143  * system-defined structures are a different size with DEBUG on, the
 144  * kernel is compiled without DEBUG on, and the resulting differences
 145  * would break our ability to interact with the rest of the kernel.
 146  *
 147  * Is DEBUG only for turning the ASSERT() macro?  If so, we should
 148  * be able to eliminate DEBUG entirely.
 149  */
 150 #if !defined(AFS_SGI65_ENV)
 151 #ifndef DEBUG
 152 #define DEBUG   1               /* Default is to enable debugging/logging */
 153 #endif
 154 #endif
 155
 156 /*
 157  * Time related macros
 158  */
 159 #define osi_GetuTime(x) osi_GetTime(x)
 160
 161 /* osi_timeval_t exists because SGI 6.x has two sizes of timeval. */
 162 /** In 64 bit Solaris the timeval structure has members that are 64 bit
 163   * In the GetTime() interface we expect pointers to afs_int32. So the need to
 164   * define osi_timeval_t to have 32 bit members. To make this less ambiguous
 165   * we now use 32 bit quantities consistently all over the code.
 166   * In 64 bit HP-UX the timeval structure has a 64 bit member.
 167   */
 168
 169 #if defined(AFS_HPUX_ENV) || defined(AFS_LINUX_64BIT_KERNEL) || (defined(AFS_SGI61_ENV) && defined(KERNEL) && defined(_K64U64))
 170 typedef struct {
 171     afs_int32 tv_sec;
 172     afs_int32 tv_usec;
 173 } osi_timeval_t;
 174 #elif defined(AFS_SUN57_ENV)
 175 typedef struct timeval32 osi_timeval_t;
 176 #else
 177 typedef struct timeval osi_timeval_t;
 178 #endif /* AFS_SGI61_ENV */
 179
 180 #ifndef UKERNEL
 181 #define osi_getpid()            getpid()
 182 #endif
 183
 184 /*
 185  * osi_ThreadUnique() should yield a value that can be found in ps
 186  * output in order to draw correspondences between ICL traces and what
 187  * is going on in the system.  So if ps cannot show thread IDs it is
 188  * likely to be the process ID instead.
 189  */
 190 #ifdef AFS_FBSD50_ENV
 191 /* should use curthread, but 'ps' can't display it */
 192 #define osi_ThreadUnique()      (curproc->p_pid)
 193 #elif defined(AFS_LINUX_ENV)
 194 #define osi_ThreadUnique()      (current->pid)
 195 #elif defined(UKERNEL)
 196 #define osi_ThreadUnique()      osi_getpid()
 197 #else
 198 #define osi_ThreadUnique()      getpid()
 199 #endif
 200
 201
 202
 203 #ifdef AFS_GLOBAL_SUNLOCK
 204 #define AFS_ASSERT_GLOCK() \
 205     do { if (!ISAFS_GLOCK()) osi_Panic("afs global lock not held at %s:%d\n", __FILE__, __LINE__); } while (0)
 206 #endif /* AFS_GLOBAL_SUNLOCK */
 207
 208 #ifdef RX_ENABLE_LOCKS
 209 #define RX_AFS_GLOCK()          AFS_GLOCK()
 210 #define RX_AFS_GUNLOCK()        AFS_GUNLOCK()
 211 #else
 212 #define RX_AFS_GLOCK()
 213 #define RX_AFS_GUNLOCK()
 214 #endif
 215
 216
 217
 218 #ifndef KERNEL
 219 #define AFS_GLOCK()
 220 #define AFS_GUNLOCK()
 221 #define ISAFS_GLOCK() 1
 222 #define AFS_ASSERT_GLOCK()
 223 #endif
 224
 225 /* On an MP that uses multithreading, splnet is not sufficient to provide
 226  * mutual exclusion because the other processors will not see it.  On some
 227  * early multiprocessors (SunOS413 & SGI5.2) splnet actually obtains a global
 228  * mutex, which this works in the UP expected way, it means that the whole MP
 229  * can only take one interrupt at a time; a serious performance penalty. */
 230
 231 #if ((defined(AFS_GLOBAL_SUNLOCK) || defined(RX_ENABLE_LOCKS)) && !defined(AFS_HPUX_ENV)) || !defined(KERNEL)
 232 #define SPLVAR
 233 #define NETPRI
 234 #define USERPRI
 235 #endif
 236
 237 /*
 238  * vnode/vcache ref count manipulation
 239  */
 240 #if defined(UKERNEL)
 241 #define AFS_RELE(vp) do { VN_RELE(vp); } while (0)
 242 #else /* defined(UKERNEL) */
 243 #define AFS_RELE(vp) do { AFS_GUNLOCK(); VN_RELE(vp); AFS_GLOCK(); } while (0)
 244 #endif /* defined(UKERNEL) */
 245
 246 /*
 247  * For some reason we do bare refcount manipulation in some places, for some
 248  * platforms.  The assumption is apparently that either we wouldn't call
 249  * afs_inactive anyway (because we know the ref count is high), or that it's
 250  * OK not to call it (because we don't expect CUnlinked or CDirty).
 251  * (Also, of course, the vnode is assumed to be one of ours.  Can't use this
 252  * macro for V-file vnodes.)
 253  */
 254 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 255 /* Bare refcount manipulation would probably work on this platform, but just
 256    calling VREF does not */
 257 #define AFS_FAST_HOLD(vp) osi_vnhold((vp),0)
 258 #elif defined(AFS_AIX_ENV)
 259 #define AFS_FAST_HOLD(vp) VREFCOUNT_INC(vp)
 260 #else
 261 #define AFS_FAST_HOLD(vp) VN_HOLD(AFSTOV(vp))
 262 #endif
 263 #ifdef AFS_AIX_ENV
 264 #define AFS_FAST_RELE(vp) VREFCOUNT_DEC(vp)
 265 #else
 266 #define AFS_FAST_RELE(vp) AFS_RELE(AFSTOV(vp))
 267 #endif
 268
 269 /*
 270  * MP safe versions of routines to copy memory between user space
 271  * and kernel space. Call these to avoid taking page faults while
 272  * holding the global lock.
 273  */
 274 #if defined(CAST_USER_ADDR_T) && !defined(UKERNEL) && !defined(AFS_DARWIN100_ENV)
 275 #define __U(X) CAST_USER_ADDR_T((X))
 276 #else
 277 #define __U(X) (X)
 278 #endif
 279 #ifdef AFS_GLOBAL_SUNLOCK
 280
 281 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
 282         do {                                                    \
 283             int haveGlock = ISAFS_GLOCK();                      \
 284             if (haveGlock)                                      \
 285                 AFS_GUNLOCK();                                  \
 286             CODE = copyin(__U((SRC)),(DST),(LEN));      \
 287             if (haveGlock)                                      \
 288                 AFS_GLOCK();                                    \
 289         } while(0)
 290
 291 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
 292         do {                                                    \
 293             int haveGlock = ISAFS_GLOCK();                      \
 294             if (haveGlock)                                      \
 295                 AFS_GUNLOCK();                                  \
 296             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
 297             if (haveGlock)                                      \
 298                 AFS_GLOCK();                                    \
 299         } while(0)
 300
 301 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
 302         do {                                                    \
 303             int haveGlock = ISAFS_GLOCK();                      \
 304             if (haveGlock)                                      \
 305                 AFS_GUNLOCK();                                  \
 306             CODE = copyout((SRC),__U((DST)),(LEN));                     \
 307             if (haveGlock)                                      \
 308                 AFS_GLOCK();                                    \
 309         } while(0)
 310
 311 #if defined(AFS_DARWIN80_ENV)
 312 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 313         do {                                                    \
 314             int haveGlock = ISAFS_GLOCK();                      \
 315             if (haveGlock)                                      \
 316                 AFS_GUNLOCK();                                  \
 317             uio_setrw((UIO),(RW));                              \
 318             CODE = uiomove((SRC),(LEN),(UIO));                  \
 319             if (haveGlock)                                      \
 320                 AFS_GLOCK();                                    \
 321         } while(0)
 322 #else
 323 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 324 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 325         do {                                                    \
 326             int haveGlock = ISAFS_GLOCK();                      \
 327             if (haveGlock)                                      \
 328                 AFS_GUNLOCK();                                  \
 329             (UIO)->uio_rw = (RW);                               \
 330             CODE = uiomove((SRC),(LEN),(UIO));                  \
 331             if (haveGlock)                                      \
 332                 AFS_GLOCK();                                    \
 333         } while(0)
 334 #else
 335 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 336         do {                                                    \
 337             int haveGlock = ISAFS_GLOCK();                      \
 338             if (haveGlock)                                      \
 339                 AFS_GUNLOCK();                                  \
 340             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
 341             if (haveGlock)                                      \
 342                 AFS_GLOCK();                                    \
 343         } while(0)
 344 #endif
 345 #endif /* AFS_DARWIN80_ENV */
 346
 347 #else /* AFS_GLOBAL_SUNLOCK */
 348
 349 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
 350         do {                                                    \
 351             CODE = copyin(__U((SRC)),(DST),(LEN));                      \
 352         } while(0)
 353
 354 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
 355         do {                                                    \
 356             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
 357         } while(0)
 358
 359 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
 360         do {                                                    \
 361             CODE = copyout((SRC),__U((DST)),(LEN));                     \
 362         } while(0)
 363
 364 #if defined(AFS_DARWIN80_ENV)
 365 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 366         do {                                                    \
 367             uio_setrw((UIO),(RW));                              \
 368             CODE = uiomove((SRC),(LEN),(UIO));                  \
 369         } while(0)
 370 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 371 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 372         do {                                                    \
 373             (UIO)->uio_rw = (RW);                               \
 374             CODE = uiomove((SRC),(LEN),(UIO));                  \
 375         } while(0)
 376 #else
 377 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 378         do {                                                    \
 379             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
 380         } while(0)
 381 #endif
 382
 383 #endif /* AFS_GLOBAL_SUNLOCK */
 384
 385 #ifdef AFS_DARWIN80_ENV
 386 #define AFS_UIO_OFFSET(uio) uio_offset(uio)
 387 #define AFS_UIO_RESID(uio) (int)uio_resid(uio)
 388 #define AFS_UIO_SETOFFSET(uio, off) uio_setoffset(uio, off)
 389 #define AFS_UIO_SETRESID(uio, val) uio_setresid(uio, val)
 390 #else
 391 #define AFS_UIO_OFFSET(uio) (uio)->uio_offset
 392 #define AFS_UIO_RESID(uio) (uio)->uio_resid
 393 #define AFS_UIO_SETOFFSET(uio, off) (uio)->uio_offset = off
 394 #define AFS_UIO_SETRESID(uio, val) (uio)->uio_resid = val
 395 #endif
 396
 397
 398 /*
 399  * encapsulation of kernel data structure accesses
 400  */
 401 #ifndef UKERNEL
 402 #define setuerror(erval)        u.u_error = (erval)
 403 #define getuerror()             u.u_error
 404 #endif
 405
 406 /* Macros for vcache/vnode and vfs arguments to vnode and vfs ops.
 407  * These are required for IRIX 6.4 and later, which pass behavior pointers.
 408  * Note that the _CONVERT routines get the ";" here so that argument lists
 409  * can have arguments after the OSI_x_CONVERT macro is called.
 410  */
 411 #define OSI_VN_ARG(V) V
 412 #define OSI_VN_DECL(V) struct vnode *V
 413 #define OSI_VN_CONVERT(V)
 414 #define OSI_VC_ARG(V) V
 415 #define OSI_VC_DECL(V) struct vcache *V
 416 #define OSI_VC_CONVERT(V)
 417 #define OSI_VFS_ARG(V) V
 418 #define OSI_VFS_DECL(V) struct vfs *V
 419 #define OSI_VFS_CONVERT(V)
 420
 421
 422 /*
 423 ** Macro for Solaris 2.6 returns 1 if file is larger than 2GB; else returns 0
 424 */
 425 #define AfsLargeFileUio(uio)       0
 426 #define AfsLargeFileSize(pos, off) 0
 427
 428 /* Now include system specific OSI header file. It will redefine macros
 429  * defined here as required by the OS.
 430  */
 431 #include "osi_machdep.h"
 432
 433 /* Declare any structures which use these macros after the OSI implementation
 434  * has had the opportunity to redefine them.
 435  */
 436 extern afs_ucred_t afs_osi_cred, *afs_osi_credp;
 437
 438 #ifndef osi_curcred
 439 #define osi_curcred() (u.u_cred)
 440 #endif
 441
 442 #endif /* _AFS_OSI_ */