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