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