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