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