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