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