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