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