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