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