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_FBSD_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 struct vcache;
 142 extern int osi_TryEvictVCache(struct vcache *, int *);
 143 extern struct vcache *osi_NewVnode(void);
 144 extern void osi_PrePopulateVCache(struct vcache *);
 145 extern void osi_PostPopulateVCache(struct vcache *);
 146 extern void osi_AttachVnode(struct vcache *, int seq);
 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 #if defined(AFS_HPUX_ENV) || defined(AFS_LINUX_64BIT_KERNEL) || (defined(AFS_SGI61_ENV) && defined(KERNEL) && defined(_K64U64))
 177 typedef struct {
 178     afs_int32 tv_sec;
 179     afs_int32 tv_usec;
 180 } osi_timeval_t;
 181 #elif defined(AFS_SUN57_ENV)
 182 typedef struct timeval32 osi_timeval_t;
 183 #else
 184 typedef struct timeval osi_timeval_t;
 185 #endif /* AFS_SGI61_ENV */
 186
 187 #ifndef UKERNEL
 188 #define osi_getpid()            getpid()
 189 #endif
 190
 191 /*
 192  * osi_ThreadUnique() should yield a value that can be found in ps
 193  * output in order to draw correspondences between ICL traces and what
 194  * is going on in the system.  So if ps cannot show thread IDs it is
 195  * likely to be the process ID instead.
 196  */
 197 #ifdef AFS_FBSD_ENV
 198 /* should use curthread, but 'ps' can't display it */
 199 #define osi_ThreadUnique()      (curproc->p_pid)
 200 #elif defined(AFS_LINUX_ENV)
 201 #define osi_ThreadUnique()      (current->pid)
 202 #elif defined(UKERNEL)
 203 #define osi_ThreadUnique()      osi_getpid()
 204 #else
 205 #define osi_ThreadUnique()      getpid()
 206 #endif
 207
 208
 209
 210 #ifdef AFS_GLOBAL_SUNLOCK
 211 #define AFS_ASSERT_GLOCK() \
 212     do { if (!ISAFS_GLOCK()) osi_Panic("afs global lock not held at %s:%d\n", __FILE__, __LINE__); } while (0)
 213 #endif /* AFS_GLOBAL_SUNLOCK */
 214
 215 #ifdef RX_ENABLE_LOCKS
 216 #define RX_AFS_GLOCK()          AFS_GLOCK()
 217 #define RX_AFS_GUNLOCK()        AFS_GUNLOCK()
 218 #else
 219 #define RX_AFS_GLOCK()
 220 #define RX_AFS_GUNLOCK()
 221 #endif
 222
 223
 224
 225 #ifndef KERNEL
 226 #define AFS_GLOCK()
 227 #define AFS_GUNLOCK()
 228 #define ISAFS_GLOCK() 1
 229 #define AFS_ASSERT_GLOCK()
 230 #endif
 231
 232 /* On an MP that uses multithreading, splnet is not sufficient to provide
 233  * mutual exclusion because the other processors will not see it.  On some
 234  * early multiprocessors (SunOS413 & SGI5.2) splnet actually obtains a global
 235  * mutex, which this works in the UP expected way, it means that the whole MP
 236  * can only take one interrupt at a time; a serious performance penalty. */
 237
 238 #if ((defined(AFS_GLOBAL_SUNLOCK) || defined(RX_ENABLE_LOCKS)) && !defined(AFS_HPUX_ENV)) || !defined(KERNEL)
 239 #define SPLVAR
 240 #define NETPRI
 241 #define USERPRI
 242 #endif
 243
 244 /*
 245  * vnode/vcache ref count manipulation
 246  */
 247 #if defined(UKERNEL)
 248 #define AFS_RELE(vp) do { VN_RELE(vp); } while (0)
 249 #else /* defined(UKERNEL) */
 250 #define AFS_RELE(vp) do { AFS_GUNLOCK(); VN_RELE(vp); AFS_GLOCK(); } while (0)
 251 #endif /* defined(UKERNEL) */
 252
 253 /*
 254  * For some reason we do bare refcount manipulation in some places, for some
 255  * platforms.  The assumption is apparently that either we wouldn't call
 256  * afs_inactive anyway (because we know the ref count is high), or that it's
 257  * OK not to call it (because we don't expect CUnlinked or CDirty).
 258  * (Also, of course, the vnode is assumed to be one of ours.  Can't use this
 259  * macro for V-file vnodes.)
 260  */
 261 /* osi_vnhold is defined in PLATFORM/osi_machdep.h */
 262 #define AFS_FAST_HOLD(vp) osi_vnhold((vp), 0)
 263
 264 #ifdef AFS_AIX_ENV
 265 #define AFS_FAST_RELE(vp) VREFCOUNT_DEC(vp)
 266 #else
 267 #define AFS_FAST_RELE(vp) AFS_RELE(AFSTOV(vp))
 268 #endif
 269
 270 /*
 271  * MP safe versions of routines to copy memory between user space
 272  * and kernel space. Call these to avoid taking page faults while
 273  * holding the global lock.
 274  */
 275 #if defined(CAST_USER_ADDR_T) && !defined(UKERNEL) && !defined(AFS_DARWIN100_ENV)
 276 #define __U(X) CAST_USER_ADDR_T((X))
 277 #else
 278 #define __U(X) (X)
 279 #endif
 280 #ifdef AFS_GLOBAL_SUNLOCK
 281
 282 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
 283         do {                                                    \
 284             int haveGlock = ISAFS_GLOCK();                      \
 285             if (haveGlock)                                      \
 286                 AFS_GUNLOCK();                                  \
 287             CODE = copyin(__U((SRC)),(DST),(LEN));      \
 288             if (haveGlock)                                      \
 289                 AFS_GLOCK();                                    \
 290         } while(0)
 291
 292 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
 293         do {                                                    \
 294             int haveGlock = ISAFS_GLOCK();                      \
 295             if (haveGlock)                                      \
 296                 AFS_GUNLOCK();                                  \
 297             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
 298             if (haveGlock)                                      \
 299                 AFS_GLOCK();                                    \
 300         } while(0)
 301
 302 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
 303         do {                                                    \
 304             int haveGlock = ISAFS_GLOCK();                      \
 305             if (haveGlock)                                      \
 306                 AFS_GUNLOCK();                                  \
 307             CODE = copyout((SRC),__U((DST)),(LEN));                     \
 308             if (haveGlock)                                      \
 309                 AFS_GLOCK();                                    \
 310         } while(0)
 311
 312 #if defined(AFS_DARWIN80_ENV)
 313 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 314         do {                                                    \
 315             int haveGlock = ISAFS_GLOCK();                      \
 316             if (haveGlock)                                      \
 317                 AFS_GUNLOCK();                                  \
 318             uio_setrw((UIO),(RW));                              \
 319             CODE = uiomove((SRC),(LEN),(UIO));                  \
 320             if (haveGlock)                                      \
 321                 AFS_GLOCK();                                    \
 322         } while(0)
 323 #else
 324 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 325 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 326         do {                                                    \
 327             int haveGlock = ISAFS_GLOCK();                      \
 328             if (haveGlock)                                      \
 329                 AFS_GUNLOCK();                                  \
 330             (UIO)->uio_rw = (RW);                               \
 331             CODE = uiomove((SRC),(LEN),(UIO));                  \
 332             if (haveGlock)                                      \
 333                 AFS_GLOCK();                                    \
 334         } while(0)
 335 #else
 336 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 337         do {                                                    \
 338             int haveGlock = ISAFS_GLOCK();                      \
 339             if (haveGlock)                                      \
 340                 AFS_GUNLOCK();                                  \
 341             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
 342             if (haveGlock)                                      \
 343                 AFS_GLOCK();                                    \
 344         } while(0)
 345 #endif
 346 #endif /* AFS_DARWIN80_ENV */
 347
 348 #else /* AFS_GLOBAL_SUNLOCK */
 349
 350 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
 351         do {                                                    \
 352             CODE = copyin(__U((SRC)),(DST),(LEN));                      \
 353         } while(0)
 354
 355 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
 356         do {                                                    \
 357             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
 358         } while(0)
 359
 360 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
 361         do {                                                    \
 362             CODE = copyout((SRC),__U((DST)),(LEN));                     \
 363         } while(0)
 364
 365 #if defined(AFS_DARWIN80_ENV)
 366 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 367         do {                                                    \
 368             uio_setrw((UIO),(RW));                              \
 369             CODE = uiomove((SRC),(LEN),(UIO));                  \
 370         } while(0)
 371 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 372 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 373         do {                                                    \
 374             (UIO)->uio_rw = (RW);                               \
 375             CODE = uiomove((SRC),(LEN),(UIO));                  \
 376         } while(0)
 377 #else
 378 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 379         do {                                                    \
 380             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
 381         } while(0)
 382 #endif
 383
 384 #endif /* AFS_GLOBAL_SUNLOCK */
 385
 386 #ifdef AFS_DARWIN80_ENV
 387 #define AFS_UIO_OFFSET(uio) uio_offset(uio)
 388 #define AFS_UIO_RESID(uio) (int)uio_resid(uio)
 389 #define AFS_UIO_SETOFFSET(uio, off) uio_setoffset(uio, off)
 390 #define AFS_UIO_SETRESID(uio, val) uio_setresid(uio, val)
 391 #else
 392 #define AFS_UIO_OFFSET(uio) (uio)->uio_offset
 393 #define AFS_UIO_RESID(uio) (uio)->uio_resid
 394 #define AFS_UIO_SETOFFSET(uio, off) (uio)->uio_offset = off
 395 #define AFS_UIO_SETRESID(uio, val) (uio)->uio_resid = val
 396 #endif
 397
 398
 399 /*
 400  * encapsulation of kernel data structure accesses
 401  */
 402 #ifndef UKERNEL
 403 #define setuerror(erval)        u.u_error = (erval)
 404 #define getuerror()             u.u_error
 405 #endif
 406
 407 /* Macros for vcache/vnode and vfs arguments to vnode and vfs ops.
 408  * These are required for IRIX 6.4 and later, which pass behavior pointers.
 409  * Note that the _CONVERT routines get the ";" here so that argument lists
 410  * can have arguments after the OSI_x_CONVERT macro is called.
 411  */
 412 #define OSI_VN_ARG(V) V
 413 #define OSI_VN_DECL(V) struct vnode *V
 414 #define OSI_VN_CONVERT(V)
 415 #define OSI_VC_ARG(V) V
 416 #define OSI_VC_DECL(V) struct vcache *V
 417 #define OSI_VC_CONVERT(V)
 418 #define OSI_VFS_ARG(V) V
 419 #define OSI_VFS_DECL(V) struct vfs *V
 420 #define OSI_VFS_CONVERT(V)
 421
 422
 423 /*
 424 ** Macro for Solaris 2.6 returns 1 if file is larger than 2GB; else returns 0
 425 */
 426 #define AfsLargeFileUio(uio)       0
 427 #define AfsLargeFileSize(pos, off) 0
 428
 429 /* Now include system specific OSI header file. It will redefine macros
 430  * defined here as required by the OS.
 431  */
 432 #include "osi_machdep.h"
 433
 434 /* Declare any structures which use these macros after the OSI implementation
 435  * has had the opportunity to redefine them.
 436  */
 437 extern afs_ucred_t afs_osi_cred, *afs_osi_credp;
 438
 439 #ifndef osi_curcred
 440 #define osi_curcred() (u.u_cred)
 441 #endif
 442
 443 #endif /* _AFS_OSI_ */