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