2 * Copyright 2000, International Business Machines Corporation and others.
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
13 * AFS system call opcodes
16 #include <afs/afs_args.h>
17 #include <afs/afs_consts.h>
19 #include "afs/afs_args.h"
20 #include "afs/afs_consts.h"
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.
30 #define AFS_MIN_FRAGSIZE 1023
32 /* Upper bound on number of iovecs out uio routines will deal with. */
33 #define AFS_MAXIOVCNT 16
36 extern int afs_shuttingdown;
39 * Macros to uniquely identify the AFS vfs struct
41 #define AFS_VFSMAGIC 0x1234
42 #if defined(AFS_SUN5_ENV) || defined(AFS_HPUX90_ENV) || defined(AFS_LINUX20_ENV)
43 #define AFS_VFSFSID 99
45 #if defined(AFS_SGI_ENV)
46 #define AFS_VFSFSID afs_fstype
48 #define AFS_VFSFSID AFS_MOUNT_AFS
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
56 #if defined(AFS_SUN56_ENV) || (defined(AFS_LINUX24_ENV) && !(defined(AFS_LINUX26_ENV) && defined(AFS_LINUX_64BIT_KERNEL)))
57 #define AFS_FLOCK flock64
59 #define AFS_FLOCK flock
60 #endif /* AFS_SUN65_ENV */
61 #endif /* AFS_HPUX102_ENV */
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) */
69 /* generic undefined vice id */
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 */
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)
100 extern afs_int32 afs_rx_deadtime;
101 extern afs_int32 afs_rx_harddead;
102 extern afs_int32 afs_rx_idledead;
104 struct sysname_info {
107 signed char index, allocked;
110 /* flags to use with AFSOP_CACHEINIT */
111 #define AFSCALL_INIT_MEMCACHE 0x1 /* use a memory-based cache */
113 /* below here used only for kernel procedures */
115 /* Store synchrony flags - SYNC means that data should be forced to server's
116 * disk immediately upon completion. */
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 */
123 /* background request structure */
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 */
131 #if defined(AFS_CACHE_BYPASS)
132 #define BOP_FETCH_NOCACHE 4 /* parms are: vnode ptr, offset, segment ptr, addr, cred ptr */
134 #ifdef AFS_DARWIN_ENV
135 #define BOP_MOVE 5 /* ptr1 afs_uspc_param ptr2 sname ptr3 dname */
138 #define B_DONTWAIT 1 /* On failure return; don't wait */
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.
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 */
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" */
166 afs_int32 AuthHandle;
167 char HandShakeKey[8];
169 afs_int32 BeginTimestamp;
170 afs_int32 EndTimestamp;
174 afs_int32 Cell; /* better sun packing if at end of structure */
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!) */
181 afs_int32 CellAndUnique;
184 /* The actual number of bytes in the SmallFid, not the sizeof struct. */
185 #define SIZEOF_SMALLFID 10
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
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))
213 /* Given a pointer to an afs_q within a structure, go back to the address of
214 * the parent structure
217 #define QEntry(queue, structure, member) \
218 ((structure *)((char *)(queue)-(char *)(&((structure *)NULL)->member)))
220 /* And implement operations for individual lists in terms of the above macro */
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)
227 * List of free slot numbers
229 struct afs_slotlist {
231 struct afs_slotlist *next;
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];
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.
254 struct afs_cbr **pprev;
255 struct afs_cbr *next;
257 struct afs_cbr **hash_pprev;
258 struct afs_cbr *hash_next;
261 unsigned int dynalloc:1;
264 /* cellinfo file magic number */
265 #define AFS_CELLINFO_MAGIC 0xf32817cd
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 */
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 */
292 struct cell_name *next;
299 struct cell_alias *next;
305 #define afs_PutCell(cellp, locktype)
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.
319 #define TMP_UPAGNotReferenced 128
321 /* unixuser notify events */
322 #define UTokensObtained 1
323 #define UTokensDropped 2
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
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;
343 struct ClearToken clearToken;
347 struct rxkadToken rxkad;
351 struct tokenJar *next;
357 struct unixuser *next; /* next hash pointer */
358 afs_int32 uid; /* search based on uid and cell */
360 afs_int32 viceId; /* Optional viced ID corresponding to current tokens */
361 short refCount; /* reference count for allocation */
362 char states; /* flag info */
363 afs_int32 tokenTime; /* last time tokens were set, used for timing out conn data */
364 struct tokenJar *tokens;
365 struct afs_exporter *exporter; /* more info about the exporter for the remote user */
366 void *cellinfo; /* pointer to cell info (PAG manager only) */
370 /* Per-connection block. */
371 struct afs_conn *next; /* Next dude same server. */
372 struct unixuser *user; /* user validated with respect to. */
373 struct rx_connection *id; /* RPC connid. */
374 struct srvAddr *srvr; /* server associated with this conn */
375 short refCount; /* reference count for allocation */
376 unsigned short port; /* port associated with this connection */
377 char forceConnectFS; /* Should we try again with these tokens? */
383 /* Fid comparison routines */
384 #define FidCmp(a,b) ((a)->Fid.Unique != (b)->Fid.Unique \
385 || (a)->Fid.Vnode != (b)->Fid.Vnode \
386 || (a)->Fid.Volume != (b)->Fid.Volume \
387 || (a)->Cell != (b)->Cell)
389 #define FidMatches(afid,tvc) ((tvc)->f.fid.Fid.Vnode == (afid)->Fid.Vnode && \
390 (tvc)->f.fid.Fid.Volume == (afid)->Fid.Volume && \
391 (tvc)->f.fid.Cell == (afid)->Cell && \
392 ( (tvc)->f.fid.Fid.Unique == (afid)->Fid.Unique || \
393 (!(afid)->Fid.Unique && ((tvc)->f.states & CUnique))))
397 #define SRVADDR_ISDOWN 0x20 /* same as SRVR_ISDOWN */
398 #define SRVADDR_NOUSE 0x40 /* Don't use this srvAddr */
400 struct srvAddr *next_bkt; /* next item in hash bucket */
401 struct srvAddr *next_sa; /* another interface on same host */
402 struct server *server; /* back to parent */
403 struct afs_conn *conns; /* All user connections to this server */
404 afs_int32 sa_ip; /* Host addr in network byte order */
405 u_short sa_iprank; /* indiv ip address priority */
406 u_short sa_portal; /* port addr in network byte order */
411 * Values used in the flags field of the server structure below.
413 * AFS_SERVER_FLAG_ACTIVATED Has the server ever had a user connection
414 * associated with it?
416 #define AFS_SERVER_FLAG_ACTIVATED 0x01
417 #define SNO_LHOSTS 0x04
418 #define SYES_LHOSTS 0x08
419 #define SVLSRV_UUID 0x10
420 #define SRVR_ISDOWN 0x20
421 #define SRVR_MULTIHOMED 0x40
422 #define SRVR_ISGONE 0x80
423 #define SNO_INLINEBULK 0x100
424 #define SNO_64BIT 0x200
425 #define SCAPS_KNOWN 0x400
427 #define SRV_CAPABILITIES(ts) \
428 { if ( !(ts->flags & SCAPS_KNOWN)) afs_GetCapabilities(ts); ts->capabilities; }
430 #define afs_serverSetNo64Bit(s) ((s)->srvr->server->flags |= SNO_64BIT)
431 #define afs_serverHasNo64Bit(s) ((s)->srvr->server->flags & SNO_64BIT)
437 afs_int32 addr_uniquifier;
441 struct srvAddr haddr;
444 #define sr_uuid _suid._srvUuid.suuid
445 #define sr_addr_uniquifier _suid._srvUuid.addr_uniquifier
446 #define sr_host _suid._srvId.haddr.ip
447 #define sr_portal _suid._srvId.haddr.portal
448 #define sr_rank _suid._srvId.haddr.ip_rank
449 #define sr_flags _suid._srvId.haddr.flags
450 #define sr_conns _suid._srvId.haddr.conns
451 struct server *next; /* Ptr to next server in hash chain */
452 struct cell *cell; /* Cell in which this host resides */
453 struct afs_cbr *cbrs; /* Return list of callbacks */
454 afs_int32 activationTime; /* Time when this record was first activated */
455 afs_int32 lastDowntimeStart; /* Time when last downtime incident began */
456 afs_int32 numDowntimeIncidents; /* # (completed) downtime incidents */
457 afs_int32 sumOfDowntimes; /* Total downtime experienced, in seconds */
458 struct srvAddr *addr;
459 afs_uint32 flags; /* Misc flags */
460 afs_int32 capabilities;
463 #define afs_PutServer(servp, locktype)
465 /* structs for some pioctls - these are (or should be)
473 struct sprefrequest_33 {
474 unsigned short offset;
475 unsigned short num_servers;
479 struct sprefrequest { /* new struct for 3.4 */
480 unsigned short offset;
481 unsigned short num_servers;
482 unsigned short flags;
487 unsigned short next_offset;
488 unsigned short num_servers;
489 struct spref servers[1]; /* we overrun this array intentionally... */
493 unsigned short flags;
494 unsigned short num_servers;
495 struct spref servers[1]; /* we overrun this array intentionally... */
497 /* struct for GAG pioctl
500 afs_uint32 showflags, logflags, logwritethruflag, spare[3];
501 unsigned char spare2[128];
505 #define logwritethruON 1
508 afs_int32 rx_initReceiveWindow, rx_maxReceiveWindow, rx_initSendWindow,
509 rx_maxSendWindow, rxi_nSendFrags, rxi_nRecvFrags, rxi_OrphanFragSize;
510 afs_int32 rx_maxReceiveSize, rx_MyMaxSendSize;
511 afs_uint32 spare[21];
514 /* struct for checkservers */
525 /* state bits for volume */
526 #define VRO 1 /* volume is readonly */
527 #define VRecheck 2 /* recheck volume info with server */
528 #define VBackup 4 /* is this a backup volume? */
529 #define VForeign 8 /* this is a non-afs volume */
530 #define VResort 16 /* server order was rearranged, sort when able */
531 #define VMoreReps 32 /* This volume has more replicas than we are */
532 /* keeping track of now -- check with VLDB */
534 enum repstate { not_busy, end_not_busy = 6, rd_busy, rdwr_busy, offline };
537 /* One structure per volume, describing where the volume is located
538 * and where its mount points are. */
539 struct volume *next; /* Next volume in hash list. */
540 afs_int32 cell; /* the cell in which the volume resides */
541 afs_rwlock_t lock; /* the lock for this structure */
542 afs_int32 volume; /* This volume's ID number. */
543 char *name; /* This volume's name, or 0 if unknown */
544 struct server *serverHost[AFS_MAXHOSTS]; /* servers serving this volume */
545 enum repstate status[AFS_MAXHOSTS]; /* busy, offline, etc */
546 struct VenusFid dotdot; /* dir to access as .. */
547 struct VenusFid mtpoint; /* The mount point for this volume. */
548 afs_int32 rootVnode, rootUnique; /* Volume's root fid */
551 afs_int32 rwVol; /* For r/o vols, original read/write volume. */
552 afs_int32 accessTime; /* last time we used it */
553 afs_int32 vtix; /* volume table index */
554 afs_int32 copyDate; /* copyDate field, for tracking vol releases */
555 afs_int32 expireTime; /* for per-volume callbacks... */
556 short refCount; /* reference count for allocation */
557 char states; /* here for alignment reasons */
560 #define afs_PutVolume(av, locktype) ((av)->refCount--)
562 /* format of an entry in volume info file */
564 afs_int32 cell; /* cell for this entry */
565 afs_int32 volume; /* volume */
566 afs_int32 next; /* has index */
567 struct VenusFid dotdot; /* .. value */
568 struct VenusFid mtpoint; /* mt point's fid */
569 afs_int32 rootVnode, rootUnique; /* Volume's root fid */
573 struct SimpleLocks *next;
575 afs_int32 boff, eoff;
577 #if defined(AFS_AIX32_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
582 /* vcache state bits */
583 #define CStatd 0x00000001 /* has this file ever been stat'd? */
584 #define CBackup 0x00000002 /* file is on a backup volume */
585 #define CRO 0x00000004 /* is it on a read-only volume */
586 #define CMValid 0x00000008 /* is the mount point info valid? */
587 #define CCore 0x00000010 /* storing a core file, needed since we don't get an open */
588 #define CDirty 0x00000020 /* file has been modified since first open (... O_RDWR) */
589 #define CSafeStore 0x00000040 /* close must wait for store to finish (should be in fd) */
590 #define CMAPPED 0x00000080 /* Mapped files; primarily used by SunOS 4.0.x */
591 #define CNSHARE 0x00000100 /* support O_NSHARE semantics */
592 #define CLied 0x00000200
593 #define CTruth 0x00000400
595 #if defined(AFS_DARWIN80_ENV)
596 #define CDeadVnode 0x00000800
597 #elif defined(AFS_DARWIN_ENV)
598 #define CUBCinit 0x00000800
600 #define CWRITE_IGN 0x00000800 /* Next OS hack only */
603 #define CUnique 0x00001000 /* vc's uniquifier - latest unifiquier for fid */
604 #define CForeign 0x00002000 /* this is a non-afs vcache */
605 #define CReadDir 0x00004000 /* readdir in progress */
606 #define CUnlinked 0x00010000
607 #define CBulkStat 0x00020000 /* loaded by a bulk stat, and not ref'd since */
608 #define CUnlinkedDel 0x00040000
609 #define CVFlushed 0x00080000
610 #ifdef AFS_LINUX22_ENV
611 #define CPageWrite 0x00200000 /* to detect vm deadlock - linux */
612 #elif defined(AFS_SGI_ENV)
613 #define CWritingUFS 0x00200000 /* to detect vm deadlock - used by sgi */
614 #elif defined(AFS_DARWIN80_ENV)
615 #define CEvent 0x00200000 /* to preclude deadlock when sending events */
617 #define CCreating 0x00400000 /* avoid needless store after open truncate */
618 #define CPageHog 0x00800000 /* AIX - dumping large cores is a page hog. */
619 #define CDCLock 0x02000000 /* Vnode lock held over call to GetDownD */
620 #define CBulkFetching 0x04000000 /* stats are being fetched by bulk stat */
621 #define CExtendedFile 0x08000000 /* extended file via ftruncate call. */
622 #define CVInit 0x10000000 /* being initialized */
623 #define CMetaDirty 0x20000000 /* vnode meta-data needs to be flushed */
625 /* vcache vstate bits */
626 #define VRevokeWait 0x1
627 #define VPageCleaning 0x2 /* Solaris - Cache Trunc Daemon sez keep out */
629 /* Dirty disconnected vcache flags. */
630 #define VDisconSetTime 0x00000001 /* set time. */
631 #define VDisconSetMode 0x00000002 /* set mode. */
632 /* XXX: to be continued ? */
633 #define VDisconTrunc 0x00000020 /* truncate file. */
634 #define VDisconSetAttrMask 0x0000003F /* Masks for setattr ops. */
635 #define VDisconWriteClose 0x00000400 /* Write op on file close. */
636 #define VDisconWriteFlush 0x00000800 /* Write op on normal fsync/flush. */
637 #define VDisconWriteOsiFlush 0x00001000 /* Write op on osi flush. */
639 #define VDisconRemove 0x00002000 /* Remove vnop. */
640 #define VDisconCreate 0x00004000 /* Create vnop. */
641 #define VDisconCreated 0x00008000 /* A file that was created during
642 this resync operation */
643 #define VDisconRename 0x00010000 /* Rename vnop. */
644 #define VDisconRenameSameDir 0x00020000 /* Rename in same dir. */
646 /*... to be continued ... */
648 #if defined(AFS_CACHE_BYPASS)
649 /* vcache (file) cachingStates bits */
650 #define FCSDesireBypass 0x1 /* This file should bypass the cache */
651 #define FCSBypass 0x2 /* This file is currently NOT being cached */
652 #define FCSManuallySet 0x4 /* The bypass flags were set, or reset, manually (via pioctl)
653 and should not be overridden by the file's name */
655 /* Flag values used by the Transition routines */
656 #define TRANSChangeDesiredBit 0x1 /* The Transition routine should set or
657 * reset the FCSDesireBypass bit */
658 #define TRANSVcacheIsLocked 0x2 /* The Transition routine does not need to
659 * lock vcache (it's already locked) */
660 #define TRANSSetManualBit 0x4 /* The Transition routine should set FCSManuallySet so that
661 * filename checking does not override pioctl requests */
662 #endif /* AFS_CACHE_BYPASS */
665 #if defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV)
666 #define vrefCount v->v_usecount
668 #define vrefCount v.v_count
669 #endif /* AFS_XBSD_ENV */
671 #if defined(AFS_DARWIN80_ENV)
672 #define VREFCOUNT_GT(v, y) vnode_isinuse(AFSTOV(v), (y))
673 #elif defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV)
674 #define VREFCOUNT(v) ((v)->vrefCount)
675 #define VREFCOUNT_GT(v, y) (AFSTOV(v)->v_usecount > (y))
676 #elif defined(AFS_LINUX24_ENV)
677 #define VREFCOUNT(v) atomic_read(&(AFSTOV(v)->v_count))
678 #define VREFCOUNT_GT(v, y) (VREFCOUNT(v)>y)
679 #define VREFCOUNT_SET(v, c) atomic_set(&(AFSTOV(v)->v_count), c)
680 #define VREFCOUNT_DEC(v) atomic_dec(&(AFSTOV(v)->v_count))
681 #define VREFCOUNT_INC(v) atomic_inc(&(AFSTOV(v)->v_count))
683 #define VREFCOUNT(v) ((v)->vrefCount)
684 #define VREFCOUNT_GT(v,y) ((v)->vrefCount > (y))
685 #define VREFCOUNT_SET(v, c) (v)->vrefCount = c;
686 #define VREFCOUNT_DEC(v) (v)->vrefCount--;
687 #define VREFCOUNT_INC(v) (v)->vrefCount++;
688 #define d_unhash(d) list_empty(&(d)->d_hash)
689 #define dget_locked(d) dget(d)
692 #define AFS_MAXDV 0x7fffffff /* largest dataversion number */
693 #ifdef AFS_64BIT_CLIENT
694 #define AFS_NOTRUNC 0x7fffffffffffffffLL /* largest positive int64 number */
695 #else /* AFS_64BIT_CLIENT */
696 #define AFS_NOTRUNC 0x7fffffff /* largest dataversion number */
697 #endif /* AFS_64BIT_CLIENT */
699 extern afs_int32 vmPageHog; /* counter for # of vnodes which are page hogs. */
701 #if defined(AFS_DARWIN80_ENV)
702 #define VTOAFS(v) ((struct vcache *)vnode_fsnode((v)))
703 #define AFSTOV(vc) ((vc)->v)
704 #elif defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV) || (defined(AFS_LINUX22_ENV) && !defined(STRUCT_SUPER_OPERATIONS_HAS_ALLOC_INODE))
705 #define VTOAFS(v) ((struct vcache *)(v)->v_data)
706 #define AFSTOV(vc) ((vc)->v)
708 #define VTOAFS(V) ((struct vcache *)(V))
709 #define AFSTOV(V) (&(V)->v)
717 /* VCache elements which are kept on disk, and in the kernel */
722 afs_hyper_t DataVersion;
726 afs_uint16 Mode; /* XXXX Should be afs_int32 XXXX */
727 afs_uint16 LinkCount;
728 #ifdef AFS_DARWIN80_ENV
731 /* vnode type is in v.v_type */
734 struct afs_vnuniq parent;
736 /*! Truncate file to this position at the next store */
739 /*! System:AnyUser's access to this. */
745 /*! Disconnected flags for this vcache element. */
746 afs_uint32 ddirty_flags;
747 /*! Shadow vnode + unique keep the shadow dir location. */
748 struct afs_vnuniq shadow;
749 /*! The old parent FID for renamed vnodes */
750 struct afs_vnuniq oldParent;
753 /* INVARIANTs: (vlruq.next != NULL) == (vlruq.prev != NULL)
754 * nextfree => !vlruq.next && ! vlruq.prev
755 * !(avc->nextfree) && !avc->vlruq.next => (FreeVCList == avc->nextfree)
758 #if defined(AFS_XBSD_ENV) || defined(AFS_DARWIN_ENV) || (defined(AFS_LINUX22_ENV) && !defined(STRUCT_SUPER_OPERATIONS_HAS_ALLOC_INODE))
761 struct vnode v; /* Has reference count in v.v_count */
763 struct afs_q vlruq; /* lru q next and prev */
764 #if !defined(AFS_LINUX22_ENV)
765 struct vcache *nextfree; /* next on free list (if free) */
767 struct vcache *hnext; /* Hash next */
768 struct afs_q vhashq; /* Hashed per-volume list */
769 /*! Queue of dirty vcaches. Lock with afs_disconDirtyLock */
771 /*! Queue of vcaches with shadow entries. Lock with afs_disconDirtyLock */
772 struct afs_q shadowq;
773 /*! Queue of vcaches with dirty metadata. Locked by afs_xvcdirty */
774 struct afs_q metadirty;
775 /*! Vcaches slot number in the disk backup. Protected by tvc->lock */
778 afs_rwlock_t lock; /* The lock on the vcache contents. */
779 #if defined(AFS_SUN5_ENV)
780 /* Lock used to protect the activeV, multipage, and vstates fields.
781 * Do not try to get the vcache lock when the vlock is held */
783 #endif /* defined(AFS_SUN5_ENV) */
784 #if defined(AFS_SUN5_ENV)
788 #ifdef AFS_BOZONLOCK_ENV
789 afs_bozoLock_t pvnLock; /* see locks.x */
794 #if defined(AFS_AIX51_ENV)
802 int ownslock; /* pid of owner of excl lock, else 0 - defect 3083 */
804 #ifdef AFS_DARWIN80_ENV
806 #elif defined(AFS_DARWIN_ENV)
807 struct lock__bsd__ rwlock;
810 #if !defined(AFS_DFBSD_ENV)
815 struct VenusFid *mvid; /* Either parent dir (if root) or root (if mt pt) */
816 char *linkData; /* Link data if a symlink. */
817 afs_hyper_t flushDV; /* data version last flushed from text */
818 afs_hyper_t mapDV; /* data version last flushed from map */
819 struct server *callback; /* The callback host, if any */
820 afs_uint32 cbExpires; /* time the callback expires */
821 struct afs_q callsort; /* queue in expiry order, sort of */
822 struct axscache *Access; /* a list of cached access bits */
823 afs_int32 last_looker; /* pag/uid from last lookup here */
824 #if defined(AFS_SUN5_ENV)
826 #endif /* defined(AFS_SUN5_ENV) */
827 struct SimpleLocks *slocks;
828 short opens; /* The numbers of opens, read or write, on this file. */
829 short execsOrWriters; /* The number of execs (if < 0) or writers (if > 0) of
831 short flockCount; /* count of flock readers, or -1 if writer */
832 char mvstat; /* 0->normal, 1->mt pt, 2->root. */
834 #if defined(AFS_CACHE_BYPASS)
835 char cachingStates; /* Caching policies for this file */
836 afs_uint32 cachingTransitions; /* # of times file has flopped between caching and not */
837 #if defined(AFS_LINUX24_ENV)
838 off_t next_seq_offset; /* Next sequential offset (used by prefetch/readahead) */
840 off_t next_seq_blk_offset; /* accounted in blocks for Solaris & IRIX */
844 #if defined(AFS_SUN5_ENV)
845 afs_uint32 vstates; /* vstate bits */
846 #endif /* defined(AFS_SUN5_ENV) */
847 struct dcache *dchint;
848 struct dcache *dcreaddir; /* dcache for in-progress readdir */
849 unsigned int readdir_pid; /* pid of the thread in readdir */
850 #ifdef AFS_LINUX22_ENV
851 u_short mapcnt; /* Number of mappings of this file. */
853 #if defined(AFS_SGI_ENV)
854 daddr_t lastr; /* for read-ahead */
856 uint64_t vc_rwlockid; /* kthread owning rwlock */
858 short vc_rwlockid; /* pid of process owning rwlock */
860 short vc_locktrips; /* # of rwlock reacquisitions */
861 sema_t vc_rwlock; /* vop_rwlock for afs */
862 pgno_t mapcnt; /* # of pages mapped */
863 struct cred *cred; /* last writer's cred */
865 struct bhv_desc vc_bhv_desc; /* vnode's behavior data. */
867 #endif /* AFS_SGI_ENV */
868 #if defined(AFS_LINUX26_ENV)
869 cred_t *cred; /* last writer's cred */
871 afs_int32 vc_error; /* stash write error for this vnode. */
872 int xlatordv; /* Used by nfs xlator */
874 int asynchrony; /* num kbytes to store behind */
876 short multiPage; /* count of multi-page getpages in progress */
880 #define DONT_CHECK_MODE_BITS 0
881 #define CHECK_MODE_BITS 1
882 #define CMB_ALLOW_EXEC_AS_READ 2 /* For the NFS xlator */
884 #if defined(AFS_SGI_ENV)
885 #define AVCRWLOCK(avc) (valusema(&(avc)->vc_rwlock) <= 0)
887 /* SGI vnode rwlock macros and flags. */
888 #ifndef AFS_SGI62_ENV
889 /* The following are defined here. SGI 6.2 declares them in vnode.h */
890 #define VRWLOCK_READ 0
891 #define VRWLOCK_WRITE 1
892 #define VRWLOCK_WRITE_DIRECT 2
897 #define AFS_RWLOCK_T vrwlock_t
899 #define AFS_RWLOCK_T int
900 #endif /* AFS_SGI62_ENV */
902 #include <ksys/behavior.h>
903 #define AFS_RWLOCK(V,F) \
904 afs_rwlock(&VTOAFS(V)->vc_bhv_desc, (F));
905 #define AFS_RWUNLOCK(V,F) \
906 afs_rwunlock(&VTOAFS(V)->vc_bhv_desc, (F));
909 #define AFS_RWLOCK(V,F) afs_rwlock((vnode_t *)(V), (F) )
910 #define AFS_RWUNLOCK(V,F) afs_rwunlock((vnode_t *)(V), (F) )
912 #else /* AFS_SGI53_ENV */
913 #define AFS_RWLOCK(V,F) afs_rwlock((V))
914 #define AFS_RWUNLOCK(V,F) afs_rwunlock((V))
915 #endif /* AFS_SGI53_ENV */
916 #endif /* AFS_SGI_ENV */
920 afs_hyper_t DataVersion;
922 afs_int32 parentVnode;
923 afs_int32 parentUnique;
927 afs_int32 randomUid[CPSIZE];
928 afs_int32 callback; /* Now a pointer to 'server' struct */
930 afs_int32 randomAccess[CPSIZE];
933 short execsOrWriters;
940 afs_int32 callerAccess;
951 /* CM inititialization parameters. What CM actually used after calculations
952 * based on passed in arguments.
954 #define CMI_VERSION 1 /* increment when adding new fields. */
955 struct cm_initparams {
960 int cmi_nVolumeCaches;
961 int cmi_firstChunkSize;
962 int cmi_otherChunkSize;
963 int cmi_cacheSize; /* The original cache size, in 1K blocks. */
964 unsigned cmi_setTime:1;
965 unsigned cmi_memCache:1;
966 int spare[16 - 9]; /* size of struct is 16 * 4 = 64 bytes */
970 /*----------------------------------------------------------------------
971 * AFS Data cache definitions
973 * Each entry describes a Unix file on the local disk that is
974 * is serving as a cached copy of all or part of a Vice file.
975 * Entries live in circular queues for each hash table slot
977 * Which queue is this thing in? Good question.
978 * A struct dcache entry is in the freeDSlot queue when not associated with a cache slot (file).
979 * Otherwise, it is in the DLRU queue. The freeDSlot queue uses the lruq.next field as
980 * its "next" pointer.
982 * Cache entries in the DLRU queue are either associated with vice files, in which case
983 * they are hashed by afs_dvnextTbl and afs_dcnextTbl pointers, or they are in the freeDCList
984 * and are not associated with any vice file. This last list uses the afs_dvnextTbl pointer for
985 * its "next" pointer.
986 *----------------------------------------------------------------------*/
988 #define NULLIDX (-1) /* null index definition */
989 /* struct dcache states bits */
993 #define DWriting 8 /* file being written (used for cache validation) */
995 /* dcache data flags */
996 #define DFEntryMod 0x02 /* has entry itself been modified? */
997 #define DFFetching 0x04 /* file is currently being fetched */
999 /* dcache meta flags */
1000 #define DFNextStarted 0x01 /* next chunk has been prefetched already */
1001 #define DFFetchReq 0x10 /* someone is waiting for DFFetching to go on */
1004 /* flags in afs_indexFlags array */
1005 #define IFEverUsed 1 /* index entry has >= 1 byte of data */
1006 #define IFFree 2 /* index entry in freeDCList */
1007 #define IFDataMod 4 /* file needs to be written out */
1008 #define IFFlag 8 /* utility flag */
1009 #define IFDirtyPages 16 /* Solaris-only. contains dirty pages */
1010 #define IFAnyPages 32
1011 #define IFDiscarded 64 /* index entry in discardDCList */
1013 #ifdef AFS_DARWIN100_ENV
1014 typedef user_addr_t iparmtype; /* 64 bit */
1015 typedef user_addr_t uparmtype; /* 64 bit */
1017 typedef char * uparmtype;
1018 #ifdef AFS_SGI65_ENV
1019 typedef afs_uint32 iparmtype;
1021 typedef long iparmtype;
1025 #if SIZEOF_VOID_P == SIZEOF_UNSIGNED_INT
1026 # define uintptrsz unsigned int
1027 #elif SIZEOF_VOID_P == SIZEOF_UNSIGNED_LONG
1028 # define uintptrsz unsigned long
1029 #elif SIZEOF_VOID_P == SIZEOF_UNSIGNED_LONG_LONG
1030 # define uintptrsz unsigned long long
1032 # error "Unable to determine casting for pointers"
1036 uparmtype in; /* input buffer */
1037 uparmtype out; /* output buffer */
1038 short in_size; /* Size of input buffer <= 2K */
1039 short out_size; /* Maximum size of output buffer, <= 2K */
1043 * This version of afs_ioctl is required to pass in 32 bit user space
1044 * pointers into a 64 bit kernel.
1047 struct afs_ioctl32 {
1055 /* CacheItems file has a header of type struct afs_fheader
1056 * (keep aligned properly). Since we already have sgi_62 clients running
1057 * with a 32 bit inode, a change is required to the header so that
1058 * they can distinguish the old 32 bit inode CacheItems file and zap it
1059 * instead of using it.
1061 struct afs_fheader {
1062 #define AFS_FHMAGIC 0x7635abaf /* uses version number */
1064 #define AFS_CI_VERSION 4
1066 afs_uint32 dataSize;
1067 afs_int32 firstCSize;
1068 afs_int32 otherCSize;
1071 #if defined(AFS_CACHE_VNODE_PATH)
1072 typedef char *afs_ufs_dcache_id_t;
1073 #elif defined(AFS_SGI61_ENV) || defined(AFS_SUN57_64BIT_ENV)
1074 /* Using ino64_t here so that user level debugging programs compile
1075 * the size correctly.
1077 typedef ino64_t afs_ufs_dcache_id_t;
1078 #elif defined(AFS_LINUX26_ENV)
1079 #define MAX_FH_LEN 10
1081 #if defined(NEW_EXPORT_OPS)
1084 __u32 raw[MAX_FH_LEN];
1085 } afs_ufs_dcache_id_t;
1086 extern int cache_fh_type;
1087 extern int cache_fh_len;
1088 #elif defined(AFS_LINUX_64BIT_KERNEL) && !defined(AFS_S390X_LINUX24_ENV)
1089 typedef long afs_ufs_dcache_id_t;
1090 #elif defined(AFS_AIX51_ENV) || defined(AFS_HPUX1123_ENV)
1091 typedef ino_t afs_ufs_dcache_id_t;
1093 typedef afs_int32 afs_ufs_dcache_id_t;
1096 typedef afs_int32 afs_mem_dcache_id_t;
1099 afs_ufs_dcache_id_t ufs;
1100 afs_mem_dcache_id_t mem;
1103 /* it does not compile outside kernel */
1105 afs_int32 fid; /* is adc->index, the cache file number */
1106 afs_dcache_id_t inode; /* is adc->f.inode, the inode number of the cac\
1109 afs_int32 accesstime;
1110 struct buffer *hashNext;
1115 afs_rwlock_t lock; /* the lock for this structure */
1118 /* kept on disk and in dcache entries */
1120 struct VenusFid fid; /* Fid for this file */
1121 afs_int32 modTime; /* last time this entry was modified */
1122 afs_hyper_t versionNo; /* Associated data version number */
1123 afs_int32 chunk; /* Relative chunk number */
1124 afs_dcache_id_t inode; /* Unix inode for this chunk */
1125 afs_int32 chunkBytes; /* Num bytes in this chunk */
1126 char states; /* Has this chunk been modified? */
1129 /* magic numbers to specify the cache type */
1131 #define AFS_FCACHE_TYPE_UFS 0x0
1132 #define AFS_FCACHE_TYPE_MEM 0x1
1133 #define AFS_FCACHE_TYPE_NFS 0x2
1134 #define AFS_FCACHE_TYPE_EPI 0x3
1136 /* kept in memory */
1138 struct afs_q lruq; /* Free queue for in-memory images */
1139 struct afs_q dirty; /* Queue of dirty entries that need written */
1140 afs_rwlock_t lock; /* Protects validPos, some f */
1141 afs_rwlock_t tlock; /* Atomizes updates to refCount */
1142 afs_rwlock_t mflock; /* Atomizes accesses/updates to mflags */
1143 afs_size_t validPos; /* number of valid bytes during fetch */
1144 afs_int32 index; /* The index in the CacheInfo file */
1145 short refCount; /* Associated reference count. */
1146 char dflags; /* Data flags */
1147 char mflags; /* Meta flags */
1148 struct fcache f; /* disk image */
1149 afs_int32 bucket; /* which bucket these dcache entries are in */
1153 * dcache.lock protects the actual contents of the cache file (in
1154 * f.inode), subfields of f except those noted below, dflags and
1157 * dcache.tlock is used to make atomic updates to refCount. Zero
1158 * refCount dcache entries are protected by afs_xdcache instead of
1161 * dcache.mflock is used to access and update mflags. It cannot be
1162 * held without holding the corresponding dcache.lock. Updating
1163 * mflags requires holding dcache.lock(R) and dcache.mflock(W), and
1164 * checking for mflags requires dcache.lock(R) and dcache.mflock(R).
1165 * Note that dcache.lock(W) gives you the right to update mflags,
1166 * as dcache.mflock(W) can only be held with dcache.lock(R).
1168 * dcache.index, dcache.f.fid, dcache.f.chunk and dcache.f.inode are
1169 * write-protected by afs_xdcache and read-protected by refCount.
1170 * Once an entry is referenced, these values cannot change, and if
1171 * it's on the free list (with refCount=0), it can be reused for a
1172 * different file/chunk. These values can only be written while
1173 * holding afs_xdcache(W) and allocating this dcache entry (thereby
1174 * ensuring noone else has a refCount on it).
1178 /* afs_memcache.c */
1179 struct memCacheEntry {
1180 int size; /* # of valid bytes in this entry */
1181 int dataSize; /* size of allocated data area */
1182 afs_lock_t afs_memLock;
1183 char *data; /* bytes */
1186 struct afs_FetchOutput {
1187 struct AFSVolSync tsync;
1188 struct AFSFetchStatus OutStatus;
1189 struct AFSCallBack CallBack;
1192 /* macro to mark a dcache entry as bad */
1195 (x)->f.fid.Fid.Unique = 0; \
1196 afs_indexUnique[(x)->index] = 0; \
1197 (x)->dflags |= DFEntryMod; \
1200 /* FakeOpen and Fake Close used to be real subroutines. They're only used in
1201 * sun_subr and afs_vnodeops, and they're very frequently called, so I made
1202 * them into macros. They do:
1203 * FakeOpen: fake the file being open for writing. avc->lock must be held
1204 * in write mode. Having the file open for writing is like having a DFS
1205 * write-token: you're known to have the best version of the data around,
1206 * and so the CM won't let it be overwritten by random server info.
1207 * FakeClose: undo the effects of FakeOpen, noting that we want to ensure
1208 * that a real close eventually gets done. We use CCore to achieve this if
1209 * we would end up closing the file. avc->lock must be held in write mode */
1211 #ifdef AFS_AIX_IAUTH_ENV
1212 #define CRKEEP(V, C) (V)->linkData = (char*)crdup((C))
1214 #define CRKEEP(V, C) crhold((C)); (V)->linkData = (char*)(C)
1217 #define afs_FakeOpen(avc) { avc->opens++; avc->execsOrWriters++; }
1218 #define afs_FakeClose(avc, acred) \
1219 { if (avc->execsOrWriters == 1) { \
1220 /* we're the last writer, just use CCore flag */ \
1221 avc->f.states |= CCore; /* causes close to be called later */ \
1223 /* The cred and vnode holds will be released in afs_FlushActiveVcaches */ \
1224 AFS_FAST_HOLD(avc); /* So it won't disappear */ \
1225 CRKEEP(avc, acred); /* Should use a better place for the creds */ \
1228 /* we're not the last writer, let the last one do the store-back for us */ \
1230 avc->execsOrWriters--; \
1234 #define AFS_ZEROS 64 /* zero buffer */
1236 /*#define afs_DirtyPages(avc) (((avc)->f.states & CDirty) || osi_VMDirty_p((avc)))*/
1237 #define afs_DirtyPages(avc) ((avc)->f.states & CDirty)
1239 #define afs_InReadDir(avc) (((avc)->f.states & CReadDir) && (avc)->readdir_pid == MyPidxx2Pid(MyPidxx))
1241 /* The PFlush algorithm makes use of the fact that Fid.Unique is not used in
1242 below hash algorithms. Change it if need be so that flushing algorithm
1243 doesn't move things from one hash chain to another
1245 /* extern int afs_dhashsize; */
1246 #define DCHash(v, c) ((((v)->Fid.Vnode + (v)->Fid.Volume + (c))) & (afs_dhashsize-1))
1247 /*Vnode, Chunk -> Hash table index */
1248 #define DVHash(v) ((((v)->Fid.Vnode + (v)->Fid.Volume )) & (afs_dhashsize-1))
1249 /*Vnode -> Other hash table index */
1250 /* don't hash on the cell, our callback-breaking code sometimes fails to compute
1251 the cell correctly, and only scans one hash bucket */
1252 #define VCHash(fid) (((fid)->Fid.Volume + (fid)->Fid.Vnode) & (VCSIZE-1))
1253 /* Hash only on volume to speed up volume callbacks. */
1254 #define VCHashV(fid) ((fid)->Fid.Volume & (VCSIZE-1))
1256 extern struct dcache **afs_indexTable; /*Pointers to in-memory dcache entries */
1257 extern afs_int32 *afs_indexUnique; /*dcache entry Fid.Unique */
1258 extern afs_int32 *afs_dvnextTbl; /*Dcache hash table links */
1259 extern afs_int32 *afs_dcnextTbl; /*Dcache hash table links */
1260 extern afs_int32 afs_cacheFiles; /*Size of afs_indexTable */
1261 extern afs_int32 afs_cacheBlocks; /*1K blocks in cache */
1262 extern afs_int32 afs_cacheStats; /*Stat entries in cache */
1263 extern struct vcache *afs_vhashT[VCSIZE]; /*Stat cache hash table */
1264 extern struct afs_q afs_vhashTV[VCSIZE]; /* cache hash table on volume */
1265 extern afs_int32 afs_initState; /*Initialization state */
1266 extern afs_int32 afs_termState; /* Termination state */
1267 extern struct VenusFid afs_rootFid; /*Root for whole file system */
1268 extern afs_int32 afs_allCBs; /* Count of callbacks */
1269 extern afs_int32 afs_oddCBs; /* Count of odd callbacks */
1270 extern afs_int32 afs_evenCBs; /* Count of even callbacks */
1271 extern afs_int32 afs_allZaps; /* Count of fid deletes */
1272 extern afs_int32 afs_oddZaps; /* Count of odd fid deletes */
1273 extern afs_int32 afs_evenZaps; /* Count of even fid deletes */
1274 extern struct brequest afs_brs[NBRS]; /* request structures */
1276 #define UHash(auid) ((auid) & (NUSERS-1))
1277 #define VHash(avol) ((avol)&(NVOLS-1))
1278 #define SHash(aserv) ((ntohl(aserv)) & (NSERVERS-1))
1279 #define FVHash(acell,avol) (((avol)+(acell)) & (NFENTRIES-1))
1281 /* Performance hack - we could replace VerifyVCache2 with the appropriate
1282 * GetVCache incantation, and could eliminate even this code from afs_UFSRead
1283 * by making intentionally invalidating quick.stamp in the various callbacks
1284 * expiration/breaking code */
1285 #ifdef AFS_DARWIN_ENV
1286 #define afs_VerifyVCache(avc, areq) \
1287 (((avc)->f.states & CStatd) ? (osi_VM_Setup(avc, 0), 0) : \
1288 afs_VerifyVCache2((avc),areq))
1290 #define afs_VerifyVCache(avc, areq) \
1291 (((avc)->f.states & CStatd) ? 0 : afs_VerifyVCache2((avc),areq))
1294 #define DO_STATS 1 /* bits used by FindVCache */
1298 #define FIND_CDEAD 16
1300 /* values for flag param of afs_CheckVolumeNames */
1301 #define AFS_VOLCHECK_EXPIRED 0x1 /* volumes whose callbacks have expired */
1302 #define AFS_VOLCHECK_BUSY 0x2 /* volumes which were marked busy */
1303 #define AFS_VOLCHECK_MTPTS 0x4 /* mount point invalidation also */
1304 #define AFS_VOLCHECK_FORCE 0x8 /* do all forcibly */
1308 #define AFS_FSPORT ((unsigned short) htons(7000))
1309 #define AFS_VLPORT ((unsigned short) htons(7003))
1311 #define afs_read(avc, uio, acred, albn, abpp, nolock) \
1312 (*(afs_cacheType->vread))(avc, uio, acred, albn, abpp, nolock)
1313 #define afs_write(avc, uio, aio, acred, nolock) \
1314 (*(afs_cacheType->vwrite))(avc, uio, aio, acred, nolock)
1316 #define afs_rdwr(avc, uio, rw, io, cred) \
1317 (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 0) : afs_read(avc, uio, cred, 0, 0, 0))
1318 #define afs_nlrdwr(avc, uio, rw, io, cred) \
1319 (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 1) : afs_read(avc, uio, cred, 0, 0, 1))
1321 /* Cache size truncation uses the following low and high water marks:
1322 * If the cache is more than 95% full (CM_DCACHECOUNTFREEPCT), the cache
1323 * truncation daemon is awakened and will free up space until the cache is 85%
1324 * (CM_DCACHESPACEFREEPCT - CM_DCACHEEXTRAPCT) full.
1325 * afs_UFSWrite and afs_GetDCache (when it needs to fetch data) will wait on
1326 * afs_WaitForCacheDrain if the cache is 98% (CM_WAITFORDRAINPCT) full.
1327 * afs_GetDownD wakes those processes once the cache is 95% full
1328 * (CM_CACHESIZEDRAINEDPCT).
1330 #define CM_MAXDISCARDEDCHUNKS 16 /* # of chunks */
1331 #define CM_DCACHECOUNTFREEPCT 95 /* max pct of chunks in use */
1332 #define CM_DCACHESPACEFREEPCT 90 /* max pct of space in use */
1333 #define CM_DCACHEEXTRAPCT 5 /* extra to get when freeing */
1334 #define CM_CACHESIZEDRAINEDPCT 95 /* wakeup processes when down to here. */
1335 #define CM_WAITFORDRAINPCT 98 /* sleep if cache is this full. */
1337 /* when afs_cacheBlocks is large, settle for slightly decreased precision */
1338 #define PERCENT(p, v) \
1339 ((afs_cacheBlocks & 0xffe00000) ? ((v) / 100 * (p)) : ((p) * (v) / 100))
1341 #define afs_CacheIsTooFull() \
1342 (afs_blocksUsed - afs_blocksDiscarded > \
1343 PERCENT(CM_DCACHECOUNTFREEPCT, afs_cacheBlocks) || \
1344 afs_freeDCCount - afs_discardDCCount < \
1345 PERCENT(100 - CM_DCACHECOUNTFREEPCT, afs_cacheFiles))
1347 /* Handy max length of a numeric string. */
1348 #define CVBS 12 /* max afs_int32 is 2^32 ~ 4*10^9, +1 for NULL, +luck */
1350 #define refpanic(foo) if (afs_norefpanic) \
1351 { printf( foo ); afs_norefpanic++;} else osi_Panic( foo )
1354 ** these are defined in the AIX source code sys/fs_locks.h but are not
1355 ** defined anywhere in the /usr/include directory
1357 #if defined(AFS_AIX41_ENV)
1358 #define VN_LOCK(vp) simple_lock(&(vp)->v_lock)
1359 #define VN_UNLOCK(vp) simple_unlock(&(vp)->v_lock)
1362 /* get a file's serial number from a vnode */
1363 #ifndef afs_vnodeToInumber
1364 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1365 #define afs_vnodeToInumber(V) VnodeToIno(V)
1367 #define afs_vnodeToInumber(V) (VTOI(V)->i_number)
1368 #endif /* AFS_SGI62_ENV */
1371 /* get a file's device number from a vnode */
1372 #ifndef afs_vnodeToDev
1373 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1374 #define afs_vnodeToDev(V) VnodeToDev(V)
1375 #elif defined(UKERNEL)
1376 #define afs_vnodeToDev(V) (VTOI(V) ? (VTOI(V)->i_dev) : (-1))
1378 #define afs_vnodeToDev(V) (VTOI(V)->i_dev)
1382 /* declare something so that prototypes don't flip out */
1383 /* appears struct buf stuff is only actually passed around as a pointer,
1384 except with libuafs, in which case it is actually defined */
1388 struct rxfs_storeVariables {
1389 struct rx_call *call;
1390 struct vcache *vcache;
1394 afs_int32 hasNo64bit;
1395 struct AFSStoreStatus InStatus;
1399 int (*prepare)(void *rock, afs_uint32 size, afs_uint32 *bytestoxfer);
1400 int (*read)(void *rock, struct osi_file *tfile, afs_uint32 offset,
1401 afs_uint32 tlen, afs_uint32 *bytesread);
1402 int (*write)(void *rock, afs_uint32 tlen, afs_uint32 *byteswritten);
1403 int (*status)(void *rock);
1404 int (*padd)(void *rock, afs_uint32 tlen);
1405 int (*close)(void *rock, struct AFSFetchStatus *OutStatus,
1406 afs_int32 *doProcessFS);
1407 int (*destroy)(void **rock, afs_int32 error);
1408 int (*storeproc)(struct storeOps *, void *, struct dcache *, int *,
1413 int (*more)(void *rock, afs_int32 *length, afs_uint32 *moredata);
1414 int (*read)(void *rock, afs_uint32 tlen, afs_uint32 *bytesread);
1415 int (*write)(void *rock, struct osi_file *fp, afs_uint32 offset,
1416 afs_uint32 tlen, afs_uint32 *byteswritten);
1417 int (*close)(void *rock, struct vcache *avc, struct dcache *adc,
1418 struct afs_FetchOutput *Outputs);
1419 int (*destroy)(void **rock, afs_int32 error);
1422 /* fakestat support: opaque storage for afs_EvalFakeStat to remember
1423 * what vcache should be released.
1425 struct afs_fakestat_state {
1429 struct vcache *root_vp;
1432 extern int afs_fakestat_enable;
1434 #ifdef AFS_MAXVCOUNT_ENV
1435 extern int afsd_dynamic_vcaches;
1437 #define afsd_dynamic_vcaches 0
1441 * Wrappers for access to credentials structure members
1442 * Linux uses the kernel cred structure if available, with the
1443 * wrappers defined in LINUX/osi_machdep.h
1445 #if defined(AFS_NBSD40_ENV)
1446 /* in osi_machdep.h as expected */
1447 #elif !(defined(AFS_LINUX26_ENV) && defined(STRUCT_TASK_STRUCT_HAS_CRED))
1448 #define afs_cr_uid(cred) ((cred)->cr_uid)
1449 #define afs_cr_gid(cred) ((cred)->cr_gid)
1450 #define afs_cr_ruid(cred) ((cred)->cr_ruid)
1451 #define afs_cr_rgid(cred) ((cred)->cr_rgid)
1454 afs_set_cr_uid(afs_ucred_t *cred, uid_t uid) {
1458 afs_set_cr_gid(afs_ucred_t *cred, gid_t gid) {
1462 afs_set_cr_ruid(afs_ucred_t *cred, uid_t uid) {
1463 cred->cr_ruid = uid;
1466 afs_set_cr_rgid(afs_ucred_t *cred, gid_t gid) {
1467 cred->cr_rgid = gid;
1470 #endif /* _AFS_H_ */