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