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