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