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