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