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