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