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