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