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