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