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