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