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