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