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