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