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