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