src/afs/afs.h

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