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