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