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