src/afs/afs.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_H_
  11 #define _AFS_H_
  12 /*
  13  * AFS system call opcodes
  14  */
  15 #ifdef KDUMP_KERNEL
  16 #include <afs/afs_args.h>
  17 #else
  18 #include "../afs/afs_args.h"
  19 #endif
  20
  21
  22 /* Upper bound on number of iovecs out uio routines will deal with. */
  23 #define AFS_MAXIOVCNT       16
  24
  25
  26 extern int afs_shuttingdown;
  27
  28 /*
  29  * Macros to uniquely identify the AFS vfs struct
  30  */
  31 #define AFS_VFSMAGIC            0x1234
  32 #if    defined(AFS_SUN_ENV) || defined(AFS_HPUX90_ENV) || defined(AFS_LINUX20_ENV)
  33 #define AFS_VFSFSID             99
  34 #else
  35 #if defined(AFS_SGI_ENV)
  36 #define AFS_VFSFSID             afs_fstype
  37 #else
  38 #define AFS_VFSFSID             AFS_MOUNT_AFS
  39 #endif
  40 #endif
  41
  42 /* Moved from VNOPS/afs_vnop_flocks so can be used in prototypes */
  43 #if     defined(AFS_HPUX102_ENV)
  44 #define AFS_FLOCK       k_flock
  45 #else
  46 #if     defined(AFS_SUN56_ENV) || defined(AFS_LINUX24_ENV)
  47 #define AFS_FLOCK       flock64
  48 #else
  49 #define AFS_FLOCK       flock
  50 #endif /* AFS_SUN65_ENV */
  51 #endif /* AFS_HPUX102_ENV */
  52
  53 /* The following are various levels of afs debugging */
  54 #define AFSDEB_GENERAL          1       /* Standard debugging */
  55 #define AFSDEB_NETWORK          2       /* low level afs networking */
  56 #define AFSDEB_RX               4       /* RX debugging */
  57 #define AFSDEB_VNLAYER          8       /* interface layer to AFS (aixops, gfsops, etc) */
  58
  59 /* generic undefined vice id */
  60 #define UNDEFVID            (-1)
  61
  62 /* The basic defines for the Andrew file system
  63     better keep things powers of two so "& (foo-1)" hack works for masking bits */
  64 #define MAXHOSTS        13          /* max hosts per single volume */
  65 #define OMAXHOSTS        8          /* backwards compatibility */
  66 #define MAXCELLHOSTS     8          /* max vldb servers per cell */
  67 #define NBRS            15          /* max number of queued daemon requests */
  68 #define NUSERS          16          /* hash table size for unixuser table */
  69 #define NSERVERS        16          /* hash table size for server table */
  70 #define NVOLS           64          /* hash table size for volume table */
  71 #define NFENTRIES       256         /* hash table size for disk volume table */
  72 #define VCSIZE         1024         /* stat cache hash table size */
  73 #define DCSIZE          512         /* disk cache hash table size */
  74 #define PIGGYSIZE       1350        /* max piggyback size */
  75 #define MAXVOLS         128         /* max vols we can store */
  76 #define MAXSYSNAME      128         /* max sysname (i.e. @sys) size */
  77 #define MAXNUMSYSNAMES  16          /* max that current constants allow */
  78 #define NOTOKTIMEOUT    (2*3600)    /* time after which to timeout conns sans tokens */
  79 #define NOPAG           0xffffffff
  80 #define AFS_NCBRS       300         /* max # of call back return entries */
  81 #define AFS_MAXCBRSCALL 16          /* max to return in a given call */
  82 #define AFS_SALLOC_LOW_WATER    250 /* Min free blocks before allocating more */
  83 #define AFS_LRALLOCSIZ  4096        /* "Large" allocated size */
  84 #define VCACHE_FREE     5
  85 #define AFS_NRXPACKETS  80
  86 #define AFS_RXDEADTIME  50
  87 #define AFS_HARDDEADTIME        120
  88
  89 struct sysname_info {
  90   char *name;
  91   short offset;
  92   char index, allocked;
  93 };
  94
  95 /* flags to use with AFSOP_CACHEINIT */
  96 #define AFSCALL_INIT_MEMCACHE        0x1         /* use a memory-based cache */
  97
  98 /* below here used only for kernel procedures */
  99 #ifdef KERNEL
 100 /* Store synchrony flags - SYNC means that data should be forced to server's
 101  * disk immediately upon completion. */
 102 #define AFS_ASYNC       0
 103 #define AFS_SYNC        1
 104 #define AFS_VMSYNC_INVAL 2      /* sync and invalidate pages */
 105 #define AFS_LASTSTORE   4
 106
 107
 108 /* background request structure */
 109 #define BPARMS          4
 110
 111 #define BOP_NOOP        0           /* leave 0 unused */
 112 #define BOP_FETCH       1           /* parm1 is chunk to get */
 113 #define BOP_STORE       2           /* parm1 is chunk to store */
 114 #define BOP_PATH        3           /* parm1 is path, parm2 is chunk to fetch */
 115
 116 #define B_DONTWAIT      1           /* On failure return; don't wait */
 117
 118 /* protocol is: refCount is incremented by user to take block out of free pool.
 119     Next, BSTARTED is set when daemon finds request.  This prevents
 120     other daemons from picking up the same request.  Finally, when
 121     request is done, refCount is zeroed.  BDONE and BWAIT are used by
 122     dudes waiting for operation to proceed to a certain point before returning.
 123 */
 124 #define BSTARTED        1           /* request picked up by a daemon */
 125 #define BUVALID         2           /* code is valid (store) */
 126 #define BUWAIT          4           /* someone is waiting for BUVALID */
 127 struct brequest {
 128     struct vcache *vnode;           /* vnode to use, with vrefcount bumped */
 129     struct AFS_UCRED *cred;         /* credentials to use for operation */
 130     afs_size_t size_parm[BPARMS];   /* random parameters */
 131     void *ptr_parm[BPARMS];         /* pointer parameters */
 132     afs_int32 code;                 /* return code */
 133     short refCount;                 /* use counter for this structure */
 134     char opcode;                    /* what to do (store, fetch, etc) */
 135     char flags;                     /* free, etc */
 136     afs_int32 ts;                   /* counter "timestamp" */
 137 };
 138
 139 struct SecretToken {
 140     char data[56];
 141 };
 142
 143 struct ClearToken {
 144         afs_int32 AuthHandle;
 145         char HandShakeKey[8];
 146         afs_int32 ViceId;
 147         afs_int32 BeginTimestamp;
 148         afs_int32 EndTimestamp;
 149 };
 150
 151 struct VenusFid {
 152     afs_int32 Cell;                         /* better sun packing if at end of structure */
 153     struct AFSFid Fid;
 154 };
 155
 156 /* Temporary struct to be passed between afs_fid and afs_vget; in SunOS4.x we can only pass a maximum of 10 bytes for a handle (we ideally need 16!) */
 157 struct SmallFid {
 158     afs_int32 Volume;
 159     afs_int32 CellAndUnique;
 160     u_short Vnode;
 161 };
 162 /* The actual number of bytes in the SmallFid, not the sizeof struct. */
 163 #define SIZEOF_SMALLFID 10
 164
 165
 166 /*
 167   * Queues implemented with both pointers and short offsets into a disk file.
 168   */
 169 struct afs_q {
 170     struct afs_q *next;
 171     struct afs_q *prev;
 172 };
 173
 174 struct vrequest {
 175     afs_int32 uid;                      /* user id making the request */
 176     afs_int32 busyCount;                /* how many busies we've seen so far */
 177     afs_int32 flags;                 /* things like O_SYNC, O_NONBLOCK go here */
 178     char initd;                 /* if non-zero, non-uid fields meaningful */
 179     char accessError;           /* flags for overriding error return code */
 180     char volumeError;           /* encountered a missing or busy volume */
 181     char networkError;          /* encountered network problems */
 182     char permWriteError;        /* fileserver returns permenent error. */
 183 };
 184 #define VOLMISSING 1
 185 #define VOLBUSY 2
 186
 187 /* structure linked off of a server to keep track of queued returned
 188  * callbacks.  Sent asynchronously when we run a little low on free dudes.
 189  */
 190 struct afs_cbr {
 191     struct afs_cbr *next;
 192     struct AFSFid fid;
 193 };
 194
 195
 196 #define LOCALCELL           1   /* local cell's number is always 1 */
 197
 198 /* cell flags */
 199 #define CPrimary            1       /* on if this is the primary cell */
 200 #define CNoSUID             2       /* 1 if no suid progs can run from this cell */
 201 #define CHasVolRef         16       /* Volumes were referenced in this cell*/
 202 #define CLinkedCell        32
 203 #define CAlias             64       /* This cell entry is an alias */
 204
 205 struct cell {
 206     struct afs_q lruq;                       /* lru q next and prev */
 207     afs_int32 cell;                                 /* unique id assigned by venus */
 208     char *cellName;                         /* char string name of cell */
 209     struct server *cellHosts[MAXCELLHOSTS]; /* volume *location* hosts for this cell */
 210     struct cell *lcellp;                    /* Associated linked cell */
 211     u_short fsport;                         /* file server port */
 212     u_short vlport;                         /* volume server port */
 213     short states;                           /* state flags */
 214     short cellIndex;                        /* relative index number per cell */
 215     short realcellIndex;                    /* as above but ignoring aliases */
 216     time_t timeout;                         /* data expire time, if non-zero */
 217     char *realName;                         /* who this cell is an alias for */
 218 };
 219
 220 #define afs_PutCell(cellp, locktype)
 221
 222 /* the unixuser flag bit definitions */
 223 #define UHasTokens      1           /* are the st and ct fields valid (ever set)? */
 224 #define UTokensBad      2           /* are tokens bad? */
 225 #define UPrimary        4           /* on iff primary identity */
 226 #define UNeedsReset     8           /* needs afs_ResetAccessCache call done */
 227 #define UPAGCounted    16           /* entry seen during PAG search (for stats) */
 228 /* A flag used by afs_GCPAGs to keep track of
 229  * which entries in afs_users need to be deleted.
 230  * The lifetime of its presence in the table is the
 231  * lifetime of the afs_GCPAGs function.
 232  */
 233 #define TMP_UPAGNotReferenced   128
 234
 235 /* values for afs_gcpags */
 236 enum
 237 { AFS_GCPAGS_NOTCOMPILED = 0
 238 , AFS_GCPAGS_OK = 1
 239 , AFS_GCPAGS_USERDISABLED
 240 , AFS_GCPAGS_EPROC0
 241 , AFS_GCPAGS_EPROCN
 242 , AFS_GCPAGS_EEQPID
 243 , AFS_GCPAGS_EINEXACT
 244 , AFS_GCPAGS_EPROCEND
 245 , AFS_GCPAGS_EPROCWALK
 246 , AFS_GCPAGS_ECREDWALK
 247 , AFS_GCPAGS_EPIDCHECK
 248 , AFS_GCPAGS_ENICECHECK
 249 };
 250
 251 extern afs_int32 afs_gcpags;
 252 extern afs_int32 afs_gcpags_procsize;
 253
 254 struct unixuser {
 255     struct unixuser *next;          /* next hash pointer */
 256     afs_int32 uid;                          /* search based on uid and cell */
 257     afs_int32 cell;
 258     afs_int32 vid;                          /* corresponding vice id in specified cell */
 259     short refCount;                 /* reference count for allocation */
 260     char states;                    /* flag info */
 261     afs_int32 tokenTime;                    /* last time tokens were set, used for timing out conn data */
 262     afs_int32 stLen;                        /* ticket length (if kerberos, includes kvno at head) */
 263     char *stp;                      /* pointer to ticket itself */
 264     struct ClearToken ct;
 265     struct afs_exporter *exporter;  /* more info about the exporter for the remote user */
 266 };
 267
 268 struct conn {
 269     /* Per-connection block. */
 270     struct conn *next;              /* Next dude same server. */
 271     struct unixuser *user;          /* user validated with respect to. */
 272     struct rx_connection *id;       /* RPC connid. */
 273     struct srvAddr *srvr;           /* server associated with this conn */
 274     short refCount;                 /* reference count for allocation */
 275     unsigned short port;            /* port associated with this connection */
 276     char forceConnectFS;            /* Should we try again with these tokens? */
 277 };
 278
 279
 280 #define SQNULL -1
 281
 282 /* Fid comparison routines */
 283 #define FidCmp(a,b) ((a)->Fid.Unique != (b)->Fid.Unique \
 284     || (a)->Fid.Vnode != (b)->Fid.Vnode \
 285     || (a)->Fid.Volume != (b)->Fid.Volume \
 286     || (a)->Cell != (b)->Cell)
 287
 288 #define FidMatches(afid,tvc) ((tvc)->fid.Fid.Vnode == (afid)->Fid.Vnode && \
 289         (tvc)->fid.Fid.Volume == (afid)->Fid.Volume && \
 290         (tvc)->fid.Cell == (afid)->Cell && \
 291         ( (tvc)->fid.Fid.Unique == (afid)->Fid.Unique || \
 292          (!(afid)->Fid.Unique && ((tvc)->states & CUnique))))
 293
 294
 295 /*
 296   * Operations on circular queues implemented with pointers.  Note: these queue
 297   * objects are always located at the beginning of the structures they are linking.
 298   */
 299 #define QInit(q)    ((q)->prev = (q)->next = (q))
 300 #define QAdd(q,e)   ((e)->next = (q)->next, (e)->prev = (q), \
 301                         (q)->next->prev = (e), (q)->next = (e))
 302 #define QRemove(e)  ((e)->next->prev = (e)->prev, (e)->prev->next = (e)->next)
 303 #define QNext(e)    ((e)->next)
 304 #define QPrev(e)    ((e)->prev)
 305 #define QEmpty(q)   ((q)->prev == (q))
 306 /* this one takes q1 and sticks it on the end of q2 - that is, the other end, not the end
 307  * that things are added onto.  q1 shouldn't be empty, it's silly */
 308 #define QCat(q1,q2) ((q2)->prev->next = (q1)->next, (q1)->next->prev=(q2)->prev, (q1)->prev->next=(q2), (q2)->prev=(q1)->prev, (q1)->prev=(q1)->next=(q1))
 309 /*
 310  * Do lots of address arithmetic to go from vlruq to the base of the vcache
 311  * structure.  Don't move struct vnode, since we think of a struct vcache as
 312  * a specialization of a struct vnode
 313  */
 314 #define QTOV(e)     ((struct vcache *)(((char *) (e)) - (((char *)(&(((struct vcache *)(e))->vlruq))) - ((char *)(e)))))
 315 #define QTOC(e)     ((struct cell *)((char *) (e)))
 316
 317 #define SRVADDR_MH      1
 318 #define SRVADDR_ISDOWN  0x20    /* same as SRVR_ISDOWN */
 319 #define  SRVADDR_NOUSE    0x40    /* Don't use this srvAddr */
 320 struct srvAddr {
 321     struct srvAddr *next_bkt;   /* next item in hash bucket */
 322     struct srvAddr *next_sa;    /* another interface on same host */
 323     struct server *server;      /* back to parent */
 324     struct conn *conns;         /* All user connections to this server */
 325     afs_int32 sa_ip;            /* Host addr in network byte order */
 326     u_short sa_iprank;          /* indiv ip address priority */
 327     u_short sa_portal;          /* port addr in network byte order */
 328     u_char sa_flags;
 329 };
 330
 331 /*
 332  * Values used in the flags field of the server structure below.
 333  *
 334  *      AFS_SERVER_FLAG_ACTIVATED Has the server ever had a user connection
 335  *                                associated with it?
 336  */
 337 #define AFS_SERVER_FLAG_ACTIVATED       0x01
 338 #define SNO_LHOSTS                      0x04
 339 #define SYES_LHOSTS                     0x08
 340 #define SVLSRV_UUID                     0x10
 341 #define SRVR_ISDOWN                     0x20
 342 #define SRVR_MULTIHOMED                 0x40
 343 #define SRVR_ISGONE                     0x80
 344 #define SNO_INLINEBULK                  0x100
 345 #define SNO_64BIT                       0x200
 346
 347 #define afs_serverSetNo64Bit(s) ((s)->srvr->server->flags |= SNO_64BIT)
 348 #define afs_serverHasNo64Bit(s) ((s)->srvr->server->flags & SNO_64BIT)
 349
 350 struct server {
 351     union {
 352         struct {
 353             afsUUID suuid;
 354             afs_int32 addr_uniquifier;
 355             afs_int32 spares[2];
 356         } _srvUuid;
 357         struct {
 358             struct srvAddr haddr;
 359         } _srvId;
 360     } _suid;
 361 #define sr_uuid         _suid._srvUuid.suuid
 362 #define sr_addr_uniquifier      _suid._srvUuid.addr_uniquifier
 363 #define sr_host         _suid._srvId.haddr.ip
 364 #define sr_portal       _suid._srvId.haddr.portal
 365 #define sr_rank         _suid._srvId.haddr.ip_rank
 366 #define sr_flags        _suid._srvId.haddr.flags
 367 #define sr_conns        _suid._srvId.haddr.conns
 368     struct server *next;        /* Ptr to next server in hash chain */
 369     struct cell *cell;          /* Cell in which this host resides */
 370     struct afs_cbr *cbrs;       /* Return list of callbacks */
 371     afs_int32 activationTime;   /* Time when this record was first activated */
 372     afs_int32 lastDowntimeStart;        /* Time when last downtime incident began */
 373     afs_int32 numDowntimeIncidents;     /* # (completed) downtime incidents */
 374     afs_int32 sumOfDowntimes;   /* Total downtime experienced, in seconds */
 375     struct srvAddr *addr;
 376     afs_uint32 flags;                   /* Misc flags*/
 377 };
 378
 379 #define afs_PutServer(servp, locktype)
 380
 381 /* structs for some pioctls  - these are (or should be)
 382  * also in venus.h
 383  */
 384 struct spref {
 385         struct in_addr host;
 386         unsigned short rank;
 387 };
 388
 389 struct sprefrequest_33 {
 390         unsigned short offset;
 391         unsigned short num_servers;
 392 };
 393
 394
 395 struct sprefrequest {             /* new struct for 3.4 */
 396         unsigned short offset;
 397         unsigned short num_servers;
 398         unsigned short flags;
 399 };
 400 #define DBservers 1
 401
 402 struct sprefinfo {
 403         unsigned short next_offset;
 404         unsigned short num_servers;
 405         struct spref servers[1];                /* we overrun this array intentionally...*/
 406 };
 407
 408 struct setspref {
 409         unsigned short flags;
 410         unsigned short num_servers;
 411         struct spref servers[1];                /* we overrun this array intentionally...*/
 412 };
 413 /* struct for GAG pioctl
 414  */
 415 struct gaginfo {
 416         afs_uint32 showflags, logflags, logwritethruflag, spare[3];
 417         unsigned char spare2[128];
 418 };
 419 #define GAGUSER    1
 420 #define GAGCONSOLE 2
 421 #define logwritethruON  1
 422
 423 struct rxparams {
 424         afs_int32 rx_initReceiveWindow, rx_maxReceiveWindow,
 425               rx_initSendWindow, rx_maxSendWindow, rxi_nSendFrags,
 426               rxi_nRecvFrags, rxi_OrphanFragSize;
 427         afs_int32 rx_maxReceiveSize, rx_MyMaxSendSize;
 428         afs_uint32 spare[21];
 429       };
 430
 431 /* struct for checkservers */
 432
 433 struct chservinfo
 434 {
 435         int magic;
 436         char tbuffer[128];
 437         int tsize;
 438         afs_int32 tinterval;
 439         afs_int32 tflags;
 440 }
 441 ;
 442
 443
 444 /* state bits for volume */
 445 #define VRO                     1               /* volume is readonly */
 446 #define VRecheck                2               /* recheck volume info with server */
 447 #define VBackup                 4               /* is this a backup volume? */
 448 #define VForeign                8               /* this is a non-afs volume */
 449 #define VResort         16   /* server order was rearranged, sort when able */
 450 #define VMoreReps       32   /* This volume has more replicas than we are   */
 451                              /* keeping track of now -- check with VLDB     */
 452
 453  enum repstate { not_busy, end_not_busy = 6, rd_busy, rdwr_busy, offline };
 454
 455 struct volume {
 456     /* One structure per volume, describing where the volume is located
 457           and where its mount points are. */
 458     struct volume *next;        /* Next volume in hash list. */
 459     afs_int32 cell;                     /* the cell in which the volume resides */
 460     afs_rwlock_t lock;          /* the lock for this structure */
 461     afs_int32 volume;           /* This volume's ID number. */
 462     char *name;                 /* This volume's name, or 0 if unknown */
 463     struct server *serverHost[MAXHOSTS];    /* servers serving this volume */
 464     enum repstate status[MAXHOSTS]; /* busy, offline, etc */
 465     struct VenusFid dotdot;     /* dir to access as .. */
 466     struct VenusFid mtpoint;    /* The mount point for this volume. */
 467     afs_int32 rootVnode, rootUnique;    /* Volume's root fid */
 468     afs_int32 roVol;
 469     afs_int32 backVol;
 470     afs_int32 rwVol;                    /* For r/o vols, original read/write volume. */
 471     afs_int32 accessTime;               /* last time we used it */
 472     afs_int32 vtix;                     /* volume table index */
 473     afs_int32 copyDate;         /* copyDate field, for tracking vol releases */
 474     afs_int32 expireTime;            /* for per-volume callbacks... */
 475     short refCount;             /* reference count for allocation */
 476     char states;                /* here for alignment reasons */
 477 };
 478
 479 #define afs_PutVolume(av, locktype) ((av)->refCount--)
 480
 481 /* format of an entry in volume info file */
 482 struct fvolume {
 483     afs_int32 cell;                     /* cell for this entry */
 484     afs_int32 volume;           /* volume */
 485     afs_int32 next;                     /* has index */
 486     struct VenusFid dotdot;     /* .. value */
 487     struct VenusFid mtpoint;    /* mt point's fid */
 488     afs_int32 rootVnode, rootUnique;    /* Volume's root fid */
 489 };
 490
 491 struct SimpleLocks {
 492     struct SimpleLocks *next;
 493     int type;
 494     afs_int32 boff, eoff;
 495     afs_int32 pid;
 496 #if     defined(AFS_AIX32_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
 497     afs_int32 sysid;
 498 #endif
 499 };
 500
 501 /* vcache state bits */
 502 #define CStatd          0x00000001      /* has this file ever been stat'd? */
 503 #define CBackup         0x00000002      /* file is on a backup volume */
 504 #define CRO             0x00000004      /* is it on a read-only volume */
 505 #define CMValid         0x00000008      /* is the mount point info valid? */
 506 #define CCore           0x00000010      /* storing a core file, needed since we don't get an open */
 507 #define CDirty          0x00000020      /* file has been modified since first open (... O_RDWR) */
 508 #define CSafeStore      0x00000040      /* close must wait for store to finish (should be in fd) */
 509 #define CMAPPED         0x00000080      /* Mapped files; primarily used by SunOS 4.0.x */
 510 #define CNSHARE         0x00000100      /* support O_NSHARE semantics */
 511 #define CLied           0x00000200
 512 #define CTruth          0x00000400
 513 #ifdef  AFS_OSF_ENV
 514 #define CWired          0x00000800      /* OSF hack only */
 515 #else
 516 #define CWRITE_IGN      0x00000800      /* Next OS hack only */
 517 #endif
 518 #define CUnique         0x00001000      /* vc's uniquifier - latest unifiquier for fid */
 519 #define CForeign        0x00002000      /* this is a non-afs vcache */
 520 #define CUnlinked       0x00010000
 521 #define CBulkStat       0x00020000      /* loaded by a bulk stat, and not ref'd since */
 522 #define CUnlinkedDel    0x00040000
 523 #define CVFlushed       0x00080000
 524 #define CCore1          0x00100000      /* osf1 core file; not same as CCore above */
 525 #define CWritingUFS     0x00200000      /* to detect vm deadlock - used by sgi */
 526 #define CCreating       0x00400000      /* avoid needless store after open truncate */
 527 #define CPageHog        0x00800000      /* AIX - dumping large cores is a page hog. */
 528 #define CDCLock         0x02000000      /* Vnode lock held over call to GetDownD */
 529 #define CBulkFetching   0x04000000      /* stats are being fetched by bulk stat */
 530 #define CExtendedFile   0x08000000      /* extended file via ftruncate call. */
 531
 532 /* vcache vstate bits */
 533 #define VRevokeWait   0x1
 534 #define VPageCleaning 0x2       /* Solaris - Cache Trunc Daemon sez keep out */
 535
 536 #define CPSIZE      2
 537 #if !defined(AFS_FBSD_ENV)
 538 #define vrefCount   v.v_count
 539 #else
 540 #define vrefCount   v.v_usecount
 541 #endif /* AFS_FBSD_ENV */
 542
 543 #ifdef AFS_LINUX24_ENV
 544 #define VREFCOUNT(v)            atomic_read(&((vnode_t *) v)->v_count)
 545 #define VREFCOUNT_SET(v, c)     atomic_set(&((vnode_t *) v)->v_count, c)
 546 #define VREFCOUNT_DEC(v)        atomic_dec(&((vnode_t *) v)->v_count)
 547 #define VREFCOUNT_INC(v)        atomic_inc(&((vnode_t *) v)->v_count)
 548 #define DLOCK()      spin_lock(&dcache_lock)
 549 #define DUNLOCK()    spin_unlock(&dcache_lock)
 550 #define DGET(d)      dget_locked(d)
 551 #define DCOUNT(d)    atomic_read(&(d)->d_count)
 552 #else
 553 #define VREFCOUNT(v)            ((v)->vrefCount)
 554 #define VREFCOUNT_SET(v, c)     (v)->vrefCount = c;
 555 #define VREFCOUNT_DEC(v)        (v)->vrefCount--;
 556 #define VREFCOUNT_INC(v)        (v)->vrefCount++;
 557 #define DLOCK()
 558 #define DUNLOCK()
 559 #define DGET(d)      dget(d)
 560 #define DCOUNT(d)    ((d)->d_count)
 561 #endif
 562
 563 #define AFS_MAXDV   0x7fffffff      /* largest dataversion number */
 564 #ifdef AFS_64BIT_CLIENT
 565 #define AFS_NOTRUNC 0x7fffffffffffffffLL  /* largest positive int64 number */
 566 #else /* AFS_64BIT_CLIENT */
 567 #define AFS_NOTRUNC 0x7fffffff      /* largest dataversion number */
 568 #endif /* AFS_64BIT_CLIENT */
 569
 570 extern afs_int32 vmPageHog; /* counter for # of vnodes which are page hogs. */
 571
 572 /*
 573  * Fast map from vcache to dcache
 574  */
 575 struct  vtodc
 576         {
 577         struct dcache * dc;
 578         afs_uint32              stamp;
 579         struct osi_file * f;
 580         afs_offs_t              minLoc; /* smallest offset into dc. */
 581         afs_offs_t              len;    /* largest offset into dc. */
 582         };
 583
 584 extern afs_uint32 afs_stampValue;               /* stamp for pair's usage */
 585 #define MakeStamp()     (++afs_stampValue)
 586
 587 #define VTOAFS(V) ((struct vcache*)(V))
 588 #define AFSTOV(V) (&(V)->v)
 589 #ifdef AFS_LINUX22_ENV
 590 #define ITOAFS(V) ((struct vcache*)(V))
 591 #define AFSTOI(V) (struct inode *)(&(V)->v)
 592 #endif
 593
 594 /* INVARIANTs: (vlruq.next != NULL) == (vlruq.prev != NULL)
 595  *             nextfree => !vlruq.next && ! vlruq.prev
 596  * !(avc->nextfree) && !avc->vlruq.next => (FreeVCList == avc->nextfree)
 597  */
 598 struct vcache {
 599     struct vnode v;                     /* Has reference count in v.v_count */
 600     struct afs_q vlruq;                 /* lru q next and prev */
 601     struct vcache *nextfree;            /* next on free list (if free) */
 602     struct vcache *hnext;               /* Hash next */
 603     struct VenusFid fid;
 604     struct mstat {
 605         afs_size_t Length;
 606         afs_hyper_t DataVersion;
 607         afs_uint32 Date;
 608         afs_uint32 Owner;
 609         afs_uint32 Group;
 610         ushort Mode;                    /* XXXX Should be afs_int32 XXXX */
 611         ushort LinkCount;
 612         /* vnode type is in v.v_type */
 613     } m;
 614     afs_rwlock_t lock;                  /* The lock on the vcache contents. */
 615 #if     defined(AFS_SUN5_ENV)
 616     /* Lock used to protect the activeV, multipage, and vstates fields.
 617      * Do not try to get the vcache lock when the vlock is held */
 618     afs_rwlock_t vlock;
 619 #endif /* defined(AFS_SUN5_ENV) */
 620 #if     defined(AFS_SUN5_ENV)
 621     krwlock_t rwlock;
 622     struct cred *credp;
 623 #endif
 624 #if defined(AFS_SUN_ENV) || defined(AFS_ALPHA_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
 625     afs_bozoLock_t pvnLock;     /* see locks.x */
 626 #endif
 627 #ifdef  AFS_AIX32_ENV
 628     afs_lock_t pvmlock;
 629     vmhandle_t vmh;
 630     int  segid;
 631     struct ucred *credp;
 632 #endif
 633 #ifdef AFS_AIX_ENV
 634     int ownslock;       /* pid of owner of excl lock, else 0 - defect 3083 */
 635 #endif
 636 #ifdef AFS_DARWIN_ENV
 637     struct lock__bsd__      rwlock;
 638 #endif
 639 #ifdef AFS_FBSD_ENV
 640     struct lock      rwlock;
 641 #endif
 642     afs_int32 parentVnode;              /* Parent dir, if a file. */
 643     afs_int32 parentUnique;
 644     struct VenusFid *mvid;              /* Either parent dir (if root) or root (if mt pt) */
 645     char *linkData;                     /* Link data if a symlink. */
 646     afs_hyper_t flushDV;                /* data version last flushed from text */
 647     afs_hyper_t mapDV;                  /* data version last flushed from map */
 648     afs_size_t truncPos;                /* truncate file to this position at next store */
 649     struct server *callback;            /* The callback host, if any */
 650     afs_uint32 cbExpires;               /* time the callback expires */
 651     struct afs_q callsort;              /* queue in expiry order, sort of */
 652     struct axscache *Access;            /* a list of cached access bits */
 653     afs_int32 anyAccess;                /* System:AnyUser's access to this. */
 654     afs_int32 last_looker;              /* pag/uid from last lookup here */
 655 #if     defined(AFS_SUN5_ENV)
 656     afs_int32 activeV;
 657 #endif /* defined(AFS_SUN5_ENV) */
 658     struct SimpleLocks *slocks;
 659     short opens;                    /* The numbers of opens, read or write, on this file. */
 660     short execsOrWriters;           /* The number of execs (if < 0) or writers (if > 0) of
 661                                        this file. */
 662     short flockCount;               /* count of flock readers, or -1 if writer */
 663     char mvstat;                        /* 0->normal, 1->mt pt, 2->root. */
 664     afs_uint32 states;                  /* state bits */
 665 #if     defined(AFS_SUN5_ENV)
 666     afs_uint32 vstates;                 /* vstate bits */
 667 #endif /* defined(AFS_SUN5_ENV) */
 668     struct vtodc quick;
 669     afs_uint32 symhintstamp;
 670     union {
 671       struct vcache *symhint;
 672       struct dcache *dchint;
 673     } h1;
 674 #ifdef AFS_LINUX22_ENV
 675     u_short flushcnt; /* Number of flushes which haven't released yet. */
 676     u_short mapcnt; /* Number of mappings of this file. */
 677 #endif
 678 #if defined(AFS_SGI_ENV)
 679     daddr_t lastr;                      /* for read-ahead */
 680 #ifdef AFS_SGI64_ENV
 681     uint64_t vc_rwlockid;               /* kthread owning rwlock */
 682 #else
 683     short vc_rwlockid;                  /* pid of process owning rwlock */
 684 #endif
 685     short vc_locktrips;                 /* # of rwlock reacquisitions */
 686     sema_t vc_rwlock;                   /* vop_rwlock for afs */
 687     pgno_t mapcnt;                      /* # of pages mapped */
 688     struct cred *cred;                  /* last writer's cred */
 689 #ifdef AFS_SGI64_ENV
 690     struct bhv_desc vc_bhv_desc;        /* vnode's behavior data. */
 691 #endif
 692 #endif /* AFS_SGI_ENV */
 693     afs_int32 vc_error;                 /* stash write error for this vnode. */
 694     int xlatordv;                       /* Used by nfs xlator */
 695     struct AFS_UCRED *uncred;
 696     int asynchrony;                     /* num kbytes to store behind */
 697 #ifdef AFS_SUN5_ENV
 698     short multiPage;            /* count of multi-page getpages in progress */
 699 #endif
 700 };
 701
 702 #define afs_symhint_inval(avc)
 703
 704
 705 #define DONT_CHECK_MODE_BITS    0
 706 #define CHECK_MODE_BITS         1
 707 #define CMB_ALLOW_EXEC_AS_READ  2 /* For the NFS xlator */
 708
 709 #if defined(AFS_SGI_ENV)
 710 #define AVCRWLOCK(avc)          (valusema(&(avc)->vc_rwlock) <= 0)
 711
 712 /* SGI vnode rwlock macros and flags. */
 713 #ifndef AFS_SGI62_ENV
 714 /* The following are defined here. SGI 6.2 declares them in vnode.h */
 715 #define VRWLOCK_READ            0
 716 #define VRWLOCK_WRITE           1
 717 #define VRWLOCK_WRITE_DIRECT    2
 718 #endif
 719
 720 #ifdef AFS_SGI53_ENV
 721 #ifdef AFS_SGI62_ENV
 722 #define AFS_RWLOCK_T vrwlock_t
 723 #else
 724 #define AFS_RWLOCK_T int
 725 #endif /* AFS_SGI62_ENV */
 726 #ifdef AFS_SGI64_ENV
 727 #include <ksys/behavior.h>
 728 #define AFS_RWLOCK(V,F) \
 729         afs_rwlock(&VTOAFS(V)->vc_bhv_desc, (F));
 730 #define AFS_RWUNLOCK(V,F) \
 731         afs_rwunlock(&VTOAFS(V)->vc_bhv_desc, (F));
 732
 733 #else
 734 #define AFS_RWLOCK(V,F) afs_rwlock((vnode_t *)(V), (F) )
 735 #define AFS_RWUNLOCK(V,F) afs_rwunlock((vnode_t *)(V), (F) )
 736 #endif
 737 #else /* AFS_SGI53_ENV */
 738 #define AFS_RWLOCK(V,F) afs_rwlock((V))
 739 #define AFS_RWUNLOCK(V,F) afs_rwunlock((V))
 740 #endif /* AFS_SGI53_ENV */
 741 #endif /* AFS_SGI_ENV */
 742
 743 struct vcxstat {
 744     struct VenusFid fid;
 745     afs_hyper_t DataVersion;
 746     afs_rwlock_t lock;
 747     afs_int32 parentVnode;
 748     afs_int32 parentUnique;
 749     afs_hyper_t flushDV;
 750     afs_hyper_t mapDV;
 751     afs_int32 truncPos;
 752     afs_int32 randomUid[CPSIZE];
 753     afs_int32 callback;         /* Now a pointer to 'server' struct */
 754     afs_int32 cbExpires;
 755     afs_int32 randomAccess[CPSIZE];
 756     afs_int32 anyAccess;
 757     short opens;
 758     short execsOrWriters;
 759     short flockCount;
 760     char mvstat;
 761     afs_uint32 states;
 762 };
 763
 764 struct sbstruct {
 765   int sb_thisfile;
 766   int sb_default;
 767 };
 768
 769 /* CM inititialization parameters. What CM actually used after calculations
 770  * based on passed in arguments.
 771  */
 772 #define CMI_VERSION 1 /* increment when adding new fields. */
 773 struct cm_initparams {
 774     int cmi_version;
 775     int cmi_nChunkFiles;
 776     int cmi_nStatCaches;
 777     int cmi_nDataCaches;
 778     int cmi_nVolumeCaches;
 779     int cmi_firstChunkSize;
 780     int cmi_otherChunkSize;
 781     int cmi_cacheSize;  /* The original cache size, in 1K blocks. */
 782     unsigned cmi_setTime:1;
 783     unsigned cmi_memCache:1;
 784     int spare[16-9]; /* size of struct is 16 * 4 = 64 bytes */
 785 };
 786
 787
 788 /*----------------------------------------------------------------------
 789  * AFS Data cache definitions
 790  *
 791  * Each entry describes a Unix file on the local disk that is
 792  * is serving as a cached copy of all or part of a Vice file.
 793  * Entries live in circular queues for each hash table slot
 794  *
 795  * Which queue is this thing in?  Good question.
 796  * A struct dcache entry is in the freeDSlot queue when not associated with a cache slot (file).
 797  * Otherwise, it is in the DLRU queue.  The freeDSlot queue uses the lruq.next field as
 798  * its "next" pointer.
 799  *
 800  * Cache entries in the DLRU queue are either associated with vice files, in which case
 801  * they are hashed by afs_dvnextTbl and afs_dcnextTbl pointers, or they are in the freeDCList
 802  * and are not associated with any vice file.  This last list uses the afs_dvnextTbl pointer for
 803  * its "next" pointer.
 804  *----------------------------------------------------------------------*/
 805
 806 #define NULLIDX     (-1)        /* null index definition */
 807 /* struct dcache states bits */
 808 #define DWriting    8           /* file being written (used for cache validation) */
 809
 810 /* dcache data flags */
 811 #define DFEntryMod      0x02    /* has entry itself been modified? */
 812 #define DFFetching      0x04    /* file is currently being fetched */
 813
 814 /* dcache meta flags */
 815 #define DFNextStarted   0x01    /* next chunk has been prefetched already */
 816 #define DFFetchReq      0x10    /* someone is waiting for DFFetching to go on */
 817
 818
 819 /* flags in afs_indexFlags array */
 820 #define IFEverUsed      1               /* index entry has >= 1 byte of data */
 821 #define IFFree          2               /* index entry in freeDCList */
 822 #define IFDataMod       4               /* file needs to be written out */
 823 #define IFFlag          8               /* utility flag */
 824 #define IFDirtyPages    16
 825 #define IFAnyPages      32
 826 #define IFDiscarded     64              /* index entry in discardDCList */
 827
 828 struct afs_ioctl {
 829         char *in;               /* input buffer */
 830         char *out;              /* output buffer */
 831         short in_size;          /* Size of input buffer <= 2K */
 832         short out_size;         /* Maximum size of output buffer, <= 2K */
 833 };
 834
 835 /*
 836  * This version of afs_ioctl is required to pass in 32 bit user space
 837  * pointers into a 64 bit kernel.
 838  */
 839
 840 struct afs_ioctl32 {
 841     unsigned int in;
 842     unsigned int out;
 843     short in_size;
 844     short out_size;
 845 };
 846
 847
 848 /* CacheItems file has a header of type struct afs_fheader
 849  * (keep aligned properly). Since we already have sgi_62 clients running
 850  * with a 32 bit inode, a change is required to the header so that
 851  * they can distinguish the old 32 bit inode CacheItems file and zap it
 852  * instead of using it.
 853  */
 854 struct afs_fheader {
 855 #define AFS_FHMAGIC         0x7635abaf /* uses version number */
 856     afs_int32 magic;
 857 #if defined(AFS_SUN57_64BIT_ENV)
 858 #define AFS_CI_VERSION 3
 859 #else
 860 #define AFS_CI_VERSION 2
 861 #endif
 862     afs_int32 version;
 863     afs_int32 firstCSize;
 864     afs_int32 otherCSize;
 865 };
 866
 867 /* kept on disk and in dcache entries */
 868 struct fcache {
 869     struct VenusFid fid;        /* Fid for this file */
 870     afs_int32 modTime;          /* last time this entry was modified */
 871     afs_hyper_t versionNo;      /* Associated data version number */
 872     afs_int32 chunk;            /* Relative chunk number */
 873 #if defined(AFS_SGI61_ENV) || defined(AFS_SUN57_64BIT_ENV)
 874     /* Using ino64_t here so that user level debugging programs compile
 875      * the size correctly.
 876      */
 877     ino64_t inode;              /* Unix inode for this chunk */
 878 #else
 879 #if defined(AFS_LINUX_64BIT_KERNEL)
 880     long inode;                 /* Unix inode for this chunk */
 881 #else
 882     afs_int32 inode;            /* Unix inode for this chunk */
 883 #endif
 884 #endif
 885     afs_int32 chunkBytes;       /* Num bytes in this chunk */
 886     char states;                /* Has this chunk been modified? */
 887 };
 888
 889 /* magic numbers to specify the cache type */
 890
 891 #define AFS_FCACHE_TYPE_UFS 0x0
 892 #define AFS_FCACHE_TYPE_MEM 0x1
 893 #define AFS_FCACHE_TYPE_NFS 0x2
 894 #define AFS_FCACHE_TYPE_EPI 0x3
 895
 896 /* kept in memory */
 897 struct dcache {
 898     struct afs_q lruq;          /* Free queue for in-memory images */
 899     afs_rwlock_t lock;          /* Protects validPos, some f */
 900     afs_rwlock_t tlock;         /* Atomizes updates to refCount */
 901     afs_rwlock_t mflock;        /* Atomizes accesses/updates to mflags */
 902     afs_size_t validPos;        /* number of valid bytes during fetch */
 903     afs_int32 index;            /* The index in the CacheInfo file*/
 904     short refCount;             /* Associated reference count. */
 905     char dflags;                /* Data flags */
 906     char mflags;                /* Meta flags */
 907     struct fcache f;            /* disk image */
 908     afs_int32 stamp;            /* used with vtodc struct for hints */
 909
 910     /*
 911      * Locking rules:
 912      *
 913      * dcache.lock protects the actual contents of the cache file (in
 914      * f.inode), subfields of f except those noted below, dflags and
 915      * validPos.
 916      *
 917      * dcache.tlock is used to make atomic updates to refCount.  Zero
 918      * refCount dcache entries are protected by afs_xdcache instead of
 919      * tlock.
 920      *
 921      * dcache.mflock is used to access and update mflags.  It cannot be
 922      * held without holding the corresponding dcache.lock.  Updating
 923      * mflags requires holding dcache.lock(R) and dcache.mflock(W), and
 924      * checking for mflags requires dcache.lock(R) and dcache.mflock(R).
 925      * Note that dcache.lock(W) gives you the right to update mflags,
 926      * as dcache.mflock(W) can only be held with dcache.lock(R).
 927      *
 928      * dcache.stamp is protected by the associated vcache lock, because
 929      * it's only purpose is to establish correspondence between vcache
 930      * and dcache entries.
 931      *
 932      * dcache.index, dcache.f.fid, dcache.f.chunk and dcache.f.inode are
 933      * write-protected by afs_xdcache and read-protected by refCount.
 934      * Once an entry is referenced, these values cannot change, and if
 935      * it's on the free list (with refCount=0), it can be reused for a
 936      * different file/chunk.  These values can only be written while
 937      * holding afs_xdcache(W) and allocating this dcache entry (thereby
 938      * ensuring noone else has a refCount on it).
 939      */
 940 };
 941 /* this is obsolete and should be removed */
 942 #define ihint stamp
 943
 944 /* macro to mark a dcache entry as bad */
 945 #define ZapDCE(x) \
 946     do { \
 947         (x)->f.fid.Fid.Unique = 0; \
 948         afs_indexUnique[(x)->index] = 0; \
 949         (x)->dflags |= DFEntryMod; \
 950     } while(0)
 951
 952 /* FakeOpen and Fake Close used to be real subroutines.  They're only used in
 953  * sun_subr and afs_vnodeops, and they're very frequently called, so I made
 954  * them into macros.  They do:
 955  * FakeOpen:  fake the file being open for writing.  avc->lock must be held
 956  * in write mode.  Having the file open for writing is like having a DFS
 957  * write-token: you're known to have the best version of the data around,
 958  * and so the CM won't let it be overwritten by random server info.
 959  * FakeClose:  undo the effects of FakeOpen, noting that we want to ensure
 960  * that a real close eventually gets done.  We use CCore to achieve this if
 961  * we would end up closing the file.  avc->lock must be held in write mode */
 962
 963 #ifdef AFS_AIX_IAUTH_ENV
 964 #define CRKEEP(V, C)  (V)->linkData = (char*)crdup((C))
 965 #else
 966 #define CRKEEP(V, C)  crhold((C)); (V)->linkData = (char*)(C)
 967 #endif
 968
 969 #define afs_FakeOpen(avc) { avc->opens++; avc->execsOrWriters++; }
 970 #define afs_FakeClose(avc, acred) \
 971 { if (avc->execsOrWriters == 1) {  \
 972         /* we're the last writer, just use CCore flag */   \
 973         avc->states |= CCore;   /* causes close to be called later */ \
 974                                                                       \
 975         /* The cred and vnode holds will be released in afs_FlushActiveVcaches */  \
 976         VN_HOLD(AFSTOV(avc));   /* So it won't disappear */           \
 977         CRKEEP(avc, acred); /* Should use a better place for the creds */ \
 978     }                                                                         \
 979     else {                                                                    \
 980         /* we're not the last writer, let the last one do the store-back for us */    \
 981         avc->opens--;                                                         \
 982         avc->execsOrWriters--;                                                \
 983     }                                                                         \
 984 }
 985
 986 #define AFS_ZEROS   64      /* zero buffer */
 987
 988 /*#define afs_DirtyPages(avc)   (((avc)->states & CDirty) || osi_VMDirty_p((avc)))*/
 989 #define afs_DirtyPages(avc)     ((avc)->states & CDirty)
 990
 991 /* The PFlush algorithm makes use of the fact that Fid.Unique is not used in
 992   below hash algorithms.  Change it if need be so that flushing algorithm
 993   doesn't move things from one hash chain to another
 994 */
 995 /* extern int afs_dhashsize; */
 996 #define DCHash(v, c)    ((((v)->Fid.Vnode + (v)->Fid.Volume + (c))) & (afs_dhashsize-1))
 997         /*Vnode, Chunk -> Hash table index*/
 998 #define DVHash(v)       ((((v)->Fid.Vnode + (v)->Fid.Volume )) & (afs_dhashsize-1))
 999         /*Vnode -> Other hash table index*/
1000 /* don't hash on the cell, our callback-breaking code sometimes fails to compute
1001     the cell correctly, and only scans one hash bucket */
1002 #define VCHash(fid)     (((fid)->Fid.Volume + (fid)->Fid.Vnode) & (VCSIZE-1))
1003
1004 extern struct dcache **afs_indexTable;          /*Pointers to in-memory dcache entries*/
1005 extern afs_int32 *afs_indexUnique;                      /*dcache entry Fid.Unique */
1006 extern afs_int32 *afs_dvnextTbl;                        /*Dcache hash table links */
1007 extern afs_int32 *afs_dcnextTbl;                        /*Dcache hash table links */
1008 extern afs_int32 afs_cacheFiles;                        /*Size of afs_indexTable*/
1009 extern afs_int32 afs_cacheBlocks;                       /*1K blocks in cache*/
1010 extern afs_int32 afs_cacheStats;                        /*Stat entries in cache*/
1011 extern struct vcache *afs_vhashT[VCSIZE];       /*Stat cache hash table*/
1012 extern afs_int32 afs_initState;                 /*Initialization state*/
1013 extern afs_int32 afs_termState;                 /* Termination state */
1014 extern struct VenusFid afs_rootFid;             /*Root for whole file system*/
1015 extern afs_int32 afs_allCBs;                            /* Count of callbacks*/
1016 extern afs_int32 afs_oddCBs;                            /* Count of odd callbacks*/
1017 extern afs_int32 afs_evenCBs;                   /* Count of even callbacks*/
1018 extern afs_int32 afs_allZaps;                   /* Count of fid deletes */
1019 extern afs_int32 afs_oddZaps;                   /* Count of odd fid deletes */
1020 extern afs_int32 afs_evenZaps;                  /* Count of even fid deletes */
1021 extern struct brequest afs_brs[NBRS];           /* request structures */
1022
1023 #define UHash(auid)     ((auid) & (NUSERS-1))
1024 #define VHash(avol)     ((avol)&(NVOLS-1))
1025 #define SHash(aserv)    ((ntohl(aserv)) & (NSERVERS-1))
1026 #define FVHash(acell,avol)  (((avol)+(acell)) & (NFENTRIES-1))
1027
1028 /* Performance hack - we could replace VerifyVCache2 with the appropriate
1029  * GetVCache incantation, and could eliminate even this code from afs_UFSRead
1030  * by making intentionally invalidating quick.stamp in the various callbacks
1031  * expiration/breaking code */
1032 #ifdef AFS_LINUX20_ENV
1033 #define afs_VerifyVCache(avc, areq)  \
1034   (((avc)->states & CStatd) ? (vcache2inode(avc), 0) : \
1035    afs_VerifyVCache2((avc),areq))
1036 #else
1037 #ifdef AFS_DARWIN_ENV
1038 #define afs_VerifyVCache(avc, areq)  \
1039   (((avc)->states & CStatd) ? (osi_VM_Setup(avc), 0) : \
1040    afs_VerifyVCache2((avc),areq))
1041 #else
1042 #define afs_VerifyVCache(avc, areq)  \
1043   (((avc)->states & CStatd) ? 0 : afs_VerifyVCache2((avc),areq))
1044 #endif
1045 #endif
1046
1047 #define DO_STATS 1  /* bits used by FindVCache */
1048 #define DO_VLRU 2
1049
1050 /* values for flag param of afs_CheckVolumeNames */
1051 #define AFS_VOLCHECK_EXPIRED    0x1     /* volumes whose callbacks have expired */
1052 #define AFS_VOLCHECK_BUSY       0x2     /* volumes which were marked busy */
1053 #define AFS_VOLCHECK_MTPTS      0x4     /* mount point invalidation also */
1054 #define AFS_VOLCHECK_FORCE      0x8     /* do all forcibly */
1055
1056 #endif /* KERNEL */
1057
1058 #define AFS_FSPORT          ((unsigned short) htons(7000))
1059 #define AFS_VLPORT          ((unsigned short) htons(7003))
1060
1061 #define afs_read(avc, uio, acred, albn, abpp, nolock) \
1062         (*(afs_cacheType->vread))(avc, uio, acred, albn, abpp, nolock)
1063 #define afs_write(avc, uio, aio, acred, nolock) \
1064         (*(afs_cacheType->vwrite))(avc, uio, aio, acred, nolock)
1065
1066 #define afs_rdwr(avc, uio, rw, io, cred) \
1067     (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 0) : afs_read(avc, uio, cred, 0, 0, 0))
1068 #define afs_nlrdwr(avc, uio, rw, io, cred) \
1069     (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 1) : afs_read(avc, uio, cred, 0, 0, 1))
1070
1071 /* Cache size truncation uses the following low and high water marks:
1072  * If the cache is more than 95% full (CM_DCACHECOUNTFREEPCT), the cache
1073  * truncation daemon is awakened and will free up space until the cache is 85%
1074  * (CM_DCACHESPACEFREEPCT - CM_DCACHEEXTRAPCT) full.
1075  * afs_UFSWrite and afs_GetDCache (when it needs to fetch data) will wait on
1076  * afs_WaitForCacheDrain if the cache is 98% (CM_WAITFORDRAINPCT) full.
1077  * afs_GetDownD wakes those processes once the cache is 95% full
1078  * (CM_CACHESIZEDRAINEDPCT).
1079  */
1080 #define CM_MAXDISCARDEDCHUNKS   16      /* # of chunks */
1081 #define CM_DCACHECOUNTFREEPCT   95      /* max pct of chunks in use */
1082 #define CM_DCACHESPACEFREEPCT   90      /* max pct of space in use */
1083 #define CM_DCACHEEXTRAPCT        5      /* extra to get when freeing */
1084 #define CM_CACHESIZEDRAINEDPCT  95      /* wakeup processes when down to here.*/
1085 #define CM_WAITFORDRAINPCT      98      /* sleep if cache is this full. */
1086
1087 #define afs_CacheIsTooFull() \
1088     (afs_blocksUsed - afs_blocksDiscarded > \
1089         (CM_DCACHECOUNTFREEPCT*afs_cacheBlocks)/100 || \
1090      afs_freeDCCount - afs_discardDCCount < \
1091         ((100-CM_DCACHECOUNTFREEPCT)*afs_cacheFiles)/100)
1092
1093 /* Handy max length of a numeric string. */
1094 #define CVBS    12  /* max afs_int32 is 2^32 ~ 4*10^9, +1 for NULL, +luck */
1095
1096 #define refpanic(foo) if (afs_norefpanic) \
1097         { printf( foo ); afs_norefpanic++;} else osi_Panic( foo )
1098
1099 /*
1100 ** these are defined in the AIX source code sys/fs_locks.h but are not
1101 ** defined anywhere in the /usr/include directory
1102 */
1103 #if     defined(AFS_AIX41_ENV)
1104 #define VN_LOCK(vp)             simple_lock(&(vp)->v_lock)
1105 #define VN_UNLOCK(vp)           simple_unlock(&(vp)->v_lock)
1106 #endif
1107
1108 /* get a file's serial number from a vnode */
1109 #ifndef afs_vnodeToInumber
1110 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1111 #define afs_vnodeToInumber(V) VnodeToIno(V)
1112 #else
1113 #ifdef AFS_DECOSF_ENV
1114 #define afs_vnodeToInumber(V) osi_vnodeToInumber(V)
1115 #else
1116 #define afs_vnodeToInumber(V) (VTOI(V)->i_number)
1117 #endif /* AFS_DECOSF_ENV */
1118 #endif /* AFS_SGI62_ENV */
1119 #endif
1120
1121 /* get a file's device number from a vnode */
1122 #ifndef afs_vnodeToDev
1123 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1124 #define afs_vnodeToDev(V) VnodeToDev(V)
1125 #else
1126 #ifdef AFS_DECOSF_ENV
1127 #define afs_vnodeToDev(V) osi_vnodeToDev(V)
1128 #else
1129 #define afs_vnodeToDev(V) (VTOI(V)->i_dev)
1130 #endif /* AFS_DECOSF_ENV */
1131 #endif /* AFS_SGI62_ENV */
1132 #endif
1133
1134
1135 /* Note: this should agree with the definition in kdump.c */
1136 #if     defined(AFS_OSF_ENV)
1137 #if     !defined(UKERNEL)
1138 #define AFS_USEBUFFERS  1
1139 #endif
1140 #endif
1141
1142 #if !defined(UKERNEL) && !defined(HAVE_STRUCT_BUF)
1143 /* declare something so that prototypes don't flip out */
1144 /* this is really a sick hack, but appears struct buf stuff is only actually passed
1145 around as a pointer, except with libuafs, in which case it is actually defined */
1146
1147 struct buf {
1148         int bogus;
1149 };
1150 #endif
1151
1152 /* fakestat support: opaque storage for afs_EvalFakeStat to remember
1153  * what vcache should be released.
1154  */
1155 struct afs_fakestat_state {
1156     char valid;
1157     char did_eval;
1158     char need_release;
1159     struct vcache *root_vp;
1160 };
1161
1162 extern int afs_fakestat_enable;
1163
1164 struct buffer {
1165     ino_t fid[1];       /* Unique cache key + i/o addressing */
1166     afs_int32 page;
1167     afs_int32 accesstime;
1168     struct buffer *hashNext;
1169     char *data;
1170     char lockers;
1171     char dirty;
1172     char hashIndex;
1173 #if AFS_USEBUFFERS
1174     struct buf *bufp;
1175 #endif
1176     afs_rwlock_t lock;          /* the lock for this structure */
1177 };
1178
1179 /* afs_memcache.c */
1180 struct memCacheEntry {
1181     int size;      /* # of valid bytes in this entry */
1182     int dataSize;  /* size of allocated data area */
1183     afs_lock_t afs_memLock;
1184     char *data;    /* bytes */
1185 };
1186
1187 #endif  /* _AFS_H_ */
1188