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