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 #if defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
 123 #define vSetVfsp(vc, vfsp)      AFSTOV(vc)->v_mount = (vfsp)
 124 #define vSetType(vc, type)      AFSTOV(vc)->v_type = (type)
 125 #define vType(vc)               AFSTOV(vc)->v_type
 126 #else
 127 #define vType(vc)           (vc)->v.v_type
 128 #define vSetType(vc,type)   (vc)->v.v_type = (type)
 129 #define vSetVfsp(vc,vfsp)   (vc)->v.v_vfsp = (vfsp)
 130 #endif
 131
 132 #ifndef AFS_OBSD_ENV
 133 #if defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
 134 extern int (**afs_vnodeop_p) ();
 135 #define IsAfsVnode(vc)      ((vc)->v_op == afs_vnodeop_p)
 136 #define SetAfsVnode(vc)     (vc)->v_op = afs_vnodeop_p
 137 #else
 138 extern struct vnodeops *afs_ops;
 139 #define IsAfsVnode(vc)      ((vc)->v_op == afs_ops)
 140 #define SetAfsVnode(vc)     (vc)->v_op = afs_ops
 141 #endif
 142 #endif
 143
 144 #ifdef AFS_SGI65_ENV
 145 #define gop_lookupname(fnamep,segflg,followlink,compvpp) \
 146              lookupname((fnamep),(segflg),(followlink),NULL,(compvpp),\
 147                         NULL)
 148 #else
 149 #ifndef AFS_OBSD_ENV
 150 #define gop_lookupname(fnamep,segflg,followlink,compvpp) \
 151              lookupname((fnamep),(segflg),(followlink),NULL,(compvpp))
 152 #endif
 153 #endif
 154
 155 /*
 156  * In IRIX 6.5 we cannot have DEBUG turned on since certain
 157  * system-defined structures are a different size with DEBUG on, the
 158  * kernel is compiled without DEBUG on, and the resulting differences
 159  * would break our ability to interact with the rest of the kernel.
 160  *
 161  * Is DEBUG only for turning the ASSERT() macro?  If so, we should
 162  * be able to eliminate DEBUG entirely.
 163  */
 164 #if !defined(AFS_SGI65_ENV)
 165 #ifndef DEBUG
 166 #define DEBUG   1               /* Default is to enable debugging/logging */
 167 #endif
 168 #endif
 169
 170 /*
 171  * Time related macros
 172  */
 173 #define osi_GetuTime(x) osi_GetTime(x)
 174
 175 /* osi_timeval_t exists because SGI 6.x has two sizes of timeval. */
 176 /** In 64 bit Solaris the timeval structure has members that are 64 bit
 177   * In the GetTime() interface we expect pointers to afs_int32. So the need to
 178   * define osi_timeval_t to have 32 bit members. To make this less ambiguous
 179   * we now use 32 bit quantities consistently all over the code.
 180   * In 64 bit HP-UX the timeval structure has a 64 bit member.
 181   */
 182
 183
 184 #if defined(AFS_HPUX_ENV) || (defined(AFS_SUN57_ENV) && !defined(AFS_SUN510_ENV)) || defined(AFS_LINUX_64BIT_KERNEL) || (defined(AFS_SGI61_ENV) && defined(KERNEL) && defined(_K64U64))
 185 typedef struct {
 186     afs_int32 tv_sec;
 187     afs_int32 tv_usec;
 188 } osi_timeval_t;
 189 #else
 190 typedef struct timeval osi_timeval_t;
 191 #endif /* AFS_SGI61_ENV */
 192
 193 /*
 194  * osi_ThreadUnique() should yield a value that can be found in ps
 195  * output in order to draw correspondences between ICL traces and what
 196  * is going on in the system.  So if ps cannot show thread IDs it is
 197  * likely to be the process ID instead.
 198  */
 199 #ifdef AFS_FBSD50_ENV
 200 /* should use curthread, but 'ps' can't display it */
 201 #define osi_ThreadUnique()      curproc
 202 #else
 203 #define osi_ThreadUnique()      getpid()
 204 #endif
 205
 206
 207
 208 #ifdef AFS_GLOBAL_SUNLOCK
 209 #define AFS_ASSERT_GLOCK() \
 210     (ISAFS_GLOCK() || (osi_Panic("afs global lock not held at %s:%d\n", __FILE__, __LINE__), 0))
 211 #endif /* AFS_GLOBAL_SUNLOCK */
 212
 213 #ifdef RX_ENABLE_LOCKS
 214 #define RX_AFS_GLOCK()          AFS_GLOCK()
 215 #define RX_AFS_GUNLOCK()        AFS_GUNLOCK()
 216 #else
 217 #define RX_AFS_GLOCK()
 218 #define RX_AFS_GUNLOCK()
 219 #endif
 220
 221
 222
 223 #ifndef KERNEL
 224 #define AFS_GLOCK()
 225 #define AFS_GUNLOCK()
 226 #define ISAFS_GLOCK() 1
 227 #define AFS_ASSERT_GLOCK()
 228 #endif
 229
 230 /* On an MP that uses multithreading, splnet is not sufficient to provide
 231  * mutual exclusion because the other processors will not see it.  On some
 232  * early multiprocessors (SunOS413 & SGI5.2) splnet actually obtains a global
 233  * mutex, which this works in the UP expected way, it means that the whole MP
 234  * can only take one interrupt at a time; a serious performance penalty. */
 235
 236 #if ((defined(AFS_GLOBAL_SUNLOCK) || defined(RX_ENABLE_LOCKS)) && !defined(AFS_HPUX_ENV)) || !defined(KERNEL)
 237 #define SPLVAR
 238 #define NETPRI
 239 #define USERPRI
 240 #endif
 241
 242 /*
 243  * vnode/vcache ref count manipulation
 244  */
 245 #if defined(UKERNEL)
 246 #define AFS_RELE(vp) do { VN_RELE(vp); } while (0)
 247 #else /* defined(UKERNEL) */
 248 #define AFS_RELE(vp) do { AFS_GUNLOCK(); VN_RELE(vp); AFS_GLOCK(); } while (0)
 249 #endif /* defined(UKERNEL) */
 250
 251 /*
 252  * For some reason we do bare refcount manipulation in some places, for some
 253  * platforms.  The assumption is apparently that either we wouldn't call
 254  * afs_inactive anyway (because we know the ref count is high), or that it's
 255  * OK not to call it (because we don't expect CUnlinked or CDirty).
 256  * (Also, of course, the vnode is assumed to be one of ours.  Can't use this
 257  * macro for V-file vnodes.)
 258  */
 259 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 260 /* Bare refcount manipulation would probably work on this platform, but just
 261    calling VREF does not */
 262 #define AFS_FAST_HOLD(vp) osi_vnhold((vp),0)
 263 #else
 264 #define AFS_FAST_HOLD(vp) VN_HOLD(&(vp)->v)
 265 #endif
 266 #define AFS_FAST_RELE(vp) AFS_RELE(AFSTOV(vp))
 267
 268 /*
 269  * MP safe versions of routines to copy memory between user space
 270  * and kernel space. Call these to avoid taking page faults while
 271  * holding the global lock.
 272  */
 273 #ifdef AFS_GLOBAL_SUNLOCK
 274
 275 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
 276         do {                                                    \
 277             int haveGlock = ISAFS_GLOCK();                      \
 278             if (haveGlock)                                      \
 279                 AFS_GUNLOCK();                                  \
 280             CODE = copyin((SRC),(DST),(LEN));                   \
 281             if (haveGlock)                                      \
 282                 AFS_GLOCK();                                    \
 283         } while(0)
 284
 285 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
 286         do {                                                    \
 287             int haveGlock = ISAFS_GLOCK();                      \
 288             if (haveGlock)                                      \
 289                 AFS_GUNLOCK();                                  \
 290             CODE = copyinstr((SRC),(DST),(LEN),(CNT));          \
 291             if (haveGlock)                                      \
 292                 AFS_GLOCK();                                    \
 293         } while(0)
 294
 295 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
 296         do {                                                    \
 297             int haveGlock = ISAFS_GLOCK();                      \
 298             if (haveGlock)                                      \
 299                 AFS_GUNLOCK();                                  \
 300             CODE = copyout((SRC),(DST),(LEN));                  \
 301             if (haveGlock)                                      \
 302                 AFS_GLOCK();                                    \
 303         } while(0)
 304
 305 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 306 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 307         do {                                                    \
 308             int haveGlock = ISAFS_GLOCK();                      \
 309             if (haveGlock)                                      \
 310                 AFS_GUNLOCK();                                  \
 311             (UIO)->uio_rw = (RW);                               \
 312             CODE = uiomove((SRC),(LEN),(UIO));                  \
 313             if (haveGlock)                                      \
 314                 AFS_GLOCK();                                    \
 315         } while(0)
 316 #else
 317 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 318         do {                                                    \
 319             int haveGlock = ISAFS_GLOCK();                      \
 320             if (haveGlock)                                      \
 321                 AFS_GUNLOCK();                                  \
 322             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
 323             if (haveGlock)                                      \
 324                 AFS_GLOCK();                                    \
 325         } while(0)
 326 #endif
 327
 328 #else /* AFS_GLOBAL_SUNLOCK */
 329
 330 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
 331         do {                                                    \
 332             CODE = copyin((SRC),(DST),(LEN));                   \
 333         } while(0)
 334
 335 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
 336         do {                                                    \
 337             CODE = copyinstr((SRC),(DST),(LEN),(CNT));          \
 338         } while(0)
 339
 340 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
 341         do {                                                    \
 342             CODE = copyout((SRC),(DST),(LEN));                  \
 343         } while(0)
 344
 345 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 346 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 347         do {                                                    \
 348             (UIO)->uio_rw = (RW);                               \
 349             CODE = uiomove((SRC),(LEN),(UIO));                  \
 350         } while(0)
 351 #else /* AFS_OSF_ENV || AFS_FBSD_ENV */
 352 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 353         do {                                                    \
 354             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
 355         } while(0)
 356 #endif /* AFS_OSF_ENV || AFS_FBSD_ENV */
 357
 358 #endif /* AFS_GLOBAL_SUNLOCK */
 359
 360 /*
 361  * encapsulation of kernel data structure accesses
 362  */
 363 #define setuerror(erval)        u.u_error = (erval)
 364 #define getuerror()             u.u_error
 365
 366 /* Macros for vcache/vnode and vfs arguments to vnode and vfs ops.
 367  * These are required for IRIX 6.4 and later, which pass behavior pointers.
 368  * Note that the _CONVERT routines get the ";" here so that argument lists
 369  * can have arguments after the OSI_x_CONVERT macro is called.
 370  */
 371 #define OSI_VN_ARG(V) V
 372 #define OSI_VN_DECL(V) struct vnode *V
 373 #define OSI_VN_CONVERT(V)
 374 #define OSI_VC_ARG(V) V
 375 #define OSI_VC_DECL(V) struct vcache *V
 376 #define OSI_VC_CONVERT(V)
 377 #define OSI_VFS_ARG(V) V
 378 #define OSI_VFS_DECL(V) struct vfs *V
 379 #define OSI_VFS_CONVERT(V)
 380
 381
 382 /*
 383 ** Macro for Solaris 2.6 returns 1 if file is larger than 2GB; else returns 0
 384 */
 385 #define AfsLargeFileUio(uio)       0
 386 #define AfsLargeFileSize(pos, off) 0
 387
 388 /* Now include system specific OSI header file. It will redefine macros
 389  * defined here as required by the OS.
 390  */
 391 #include "osi_machdep.h"
 392
 393 /* Declare any structures which use these macros after the OSI implementation
 394  * has had the opportunity to redefine them.
 395  */
 396 extern struct AFS_UCRED afs_osi_cred, *afs_osi_credp;
 397
 398 #ifndef osi_curcred
 399 #define osi_curcred() (u.u_cred)
 400 #endif
 401
 402 #endif /* _AFS_OSI_ */