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