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 /*
 182  * We use osi_timeval32_t because the native timeval varies in size on
 183  * different platforms.  We require a fixed size timeval, at least for the
 184  * xstats.
 185  */
 186 #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))
 187 typedef struct {
 188     afs_int32 tv_sec;
 189     afs_int32 tv_usec;
 190 } osi_timeval32_t;
 191 #elif defined(AFS_SUN5_ENV)
 192 typedef struct timeval32 osi_timeval32_t;
 193 #else
 194 typedef struct timeval osi_timeval32_t;
 195 #endif /* AFS_SGI61_ENV */
 196
 197 #ifndef UKERNEL
 198 #define osi_getpid()            getpid()
 199 #endif
 200
 201 /*
 202  * osi_ThreadUnique() should yield a value that can be found in ps
 203  * output in order to draw correspondences between ICL traces and what
 204  * is going on in the system.  So if ps cannot show thread IDs it is
 205  * likely to be the process ID instead.
 206  */
 207 #ifdef AFS_FBSD_ENV
 208 /* should use curthread, but 'ps' can't display it */
 209 #define osi_ThreadUnique()      (curproc->p_pid)
 210 #elif defined(UKERNEL)
 211 #define osi_ThreadUnique()      osi_getpid()
 212 #else
 213 #define osi_ThreadUnique()      getpid()
 214 #endif
 215
 216
 217
 218 #ifdef AFS_GLOBAL_SUNLOCK
 219 #define AFS_ASSERT_GLOCK() \
 220     do { if (!ISAFS_GLOCK()) osi_Panic("afs global lock not held at %s:%d\n", __FILE__, __LINE__); } while (0)
 221 #endif /* AFS_GLOBAL_SUNLOCK */
 222
 223 #ifdef RX_ENABLE_LOCKS
 224 #define RX_AFS_GLOCK()          AFS_GLOCK()
 225 #define RX_AFS_GUNLOCK()        AFS_GUNLOCK()
 226 #else
 227 #define RX_AFS_GLOCK()
 228 #define RX_AFS_GUNLOCK()
 229 #endif
 230
 231
 232
 233 #ifndef KERNEL
 234 #define AFS_GLOCK()
 235 #define AFS_GUNLOCK()
 236 #define ISAFS_GLOCK() 1
 237 #define AFS_ASSERT_GLOCK()
 238 #endif
 239
 240 /* On an MP that uses multithreading, splnet is not sufficient to provide
 241  * mutual exclusion because the other processors will not see it.  On some
 242  * early multiprocessors (SGI5.2) splnet actually obtains a global
 243  * mutex, which this works in the UP expected way, it means that the whole MP
 244  * can only take one interrupt at a time; a serious performance penalty. */
 245
 246 #if ((defined(AFS_GLOBAL_SUNLOCK) || defined(RX_ENABLE_LOCKS)) && !defined(AFS_HPUX_ENV)) || !defined(KERNEL)
 247 #define SPLVAR
 248 #define NETPRI
 249 #define USERPRI
 250 #endif
 251
 252 /*
 253  * vnode/vcache ref count manipulation
 254  */
 255 #if defined(UKERNEL)
 256 #define AFS_RELE(vp) do { VN_RELE(vp); } while (0)
 257 #else /* defined(UKERNEL) */
 258 #define AFS_RELE(vp) do { AFS_GUNLOCK(); VN_RELE(vp); AFS_GLOCK(); } while (0)
 259 #endif /* defined(UKERNEL) */
 260
 261 /*
 262  * For some reason we do bare refcount manipulation in some places, for some
 263  * platforms.  The assumption is apparently that either we wouldn't call
 264  * afs_inactive anyway (because we know the ref count is high), or that it's
 265  * OK not to call it (because we don't expect CUnlinked or CDirty).
 266  * (Also, of course, the vnode is assumed to be one of ours.  Can't use this
 267  * macro for V-file vnodes.)
 268  */
 269 #ifdef AFS_AIX_ENV
 270 #define AFS_FAST_RELE(vp) VREFCOUNT_DEC(vp)
 271 #else
 272 #define AFS_FAST_RELE(vp) AFS_RELE(AFSTOV(vp))
 273 #endif
 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 #if defined(CAST_USER_ADDR_T) && !defined(UKERNEL) && !defined(AFS_DARWIN100_ENV)
 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_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 #elif defined(AFS_DARWIN_ENV) || (defined(AFS_XBSD_ENV) && !defined(AFS_NBSD40_ENV))
 377 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 378         do {                                                    \
 379             (UIO)->uio_rw = (RW);                               \
 380             CODE = uiomove((SRC),(LEN),(UIO));                  \
 381         } while(0)
 382 #else
 383 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
 384         do {                                                    \
 385             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
 386         } while(0)
 387 #endif
 388
 389 #endif /* AFS_GLOBAL_SUNLOCK */
 390
 391 #ifdef AFS_DARWIN80_ENV
 392 #define AFS_UIO_OFFSET(uio) uio_offset(uio)
 393 #define AFS_UIO_RESID(uio) (int)uio_resid(uio)
 394 #define AFS_UIO_SETOFFSET(uio, off) uio_setoffset(uio, off)
 395 #define AFS_UIO_SETRESID(uio, val) uio_setresid(uio, val)
 396 #else
 397 #define AFS_UIO_OFFSET(uio) (uio)->uio_offset
 398 #define AFS_UIO_RESID(uio) (uio)->uio_resid
 399 #define AFS_UIO_SETOFFSET(uio, off) (uio)->uio_offset = off
 400 #define AFS_UIO_SETRESID(uio, val) (uio)->uio_resid = val
 401 #endif
 402
 403
 404 /*
 405  * encapsulation of kernel data structure accesses
 406  */
 407 #ifndef UKERNEL
 408 #define setuerror(erval)        u.u_error = (erval)
 409 #define getuerror()             u.u_error
 410 #endif
 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 afs_ucred_t afs_osi_cred, *afs_osi_credp;
 443
 444 #ifndef osi_curcred
 445 #define osi_curcred() (u.u_cred)
 446 #endif
 447
 448 #ifdef AFS_PAG_ONEGROUP_ENV
 449 #define AFS_NUMPAGGROUPS 1
 450 #else
 451 #define AFS_NUMPAGGROUPS 2
 452 #endif
 453
 454 #endif /* _AFS_OSI_ */