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