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