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