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