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