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>
18 #include "../afs/afs_args.h"
22 /* Upper bound on number of iovecs out uio routines will deal with. */
23 #define AFS_MAXIOVCNT 16
26 extern int afs_shuttingdown;
29 * Macros to uniquely identify the AFS vfs struct
31 #define AFS_VFSMAGIC 0x1234
32 #if defined(AFS_SUN_ENV) || defined(AFS_HPUX90_ENV) || defined(AFS_LINUX20_ENV)
33 #define AFS_VFSFSID 99
35 #if defined(AFS_SGI_ENV)
36 #define AFS_VFSFSID afs_fstype
38 #define AFS_VFSFSID AFS_MOUNT_AFS
42 /* The following are various levels of afs debugging */
43 #define AFSDEB_GENERAL 1 /* Standard debugging */
44 #define AFSDEB_NETWORK 2 /* low level afs networking */
45 #define AFSDEB_RX 4 /* RX debugging */
46 #define AFSDEB_VNLAYER 8 /* interface layer to AFS (aixops, gfsops, etc) */
48 /* generic undefined vice id */
51 /* The basic defines for the Andrew file system
52 better keep things powers of two so "& (foo-1)" hack works for masking bits */
53 #define MAXHOSTS 13 /* max hosts per single volume */
54 #define OMAXHOSTS 8 /* backwards compatibility */
55 #define MAXCELLHOSTS 8 /* max vldb servers per cell */
56 #define NBRS 15 /* max number of queued daemon requests */
57 #define NUSERS 16 /* hash table size for unixuser table */
58 #define NSERVERS 16 /* hash table size for server table */
59 #define NVOLS 64 /* hash table size for volume table */
60 #define NFENTRIES 256 /* hash table size for disk volume table */
61 #define VCSIZE 1024 /* stat cache hash table size */
62 #define DCSIZE 512 /* disk cache hash table size */
63 #define PIGGYSIZE 1350 /* max piggyback size */
64 #define MAXVOLS 128 /* max vols we can store */
65 #define MAXSYSNAME 128 /* max sysname (i.e. @sys) size */
66 #define NOTOKTIMEOUT (2*3600) /* time after which to timeout conns sans tokens */
67 #define NOPAG 0xffffffff
68 #define AFS_NCBRS 300 /* max # of call back return entries */
69 #define AFS_MAXCBRSCALL 16 /* max to return in a given call */
70 #define AFS_SALLOC_LOW_WATER 250 /* Min free blocks before allocating more */
71 #define AFS_LRALLOCSIZ 4096 /* "Large" allocated size */
73 #define AFS_NRXPACKETS 80
74 #define AFS_RXDEADTIME 50
75 #define AFS_HARDDEADTIME 120
78 /* flags to use with AFSOP_CACHEINIT */
79 #define AFSCALL_INIT_MEMCACHE 0x1 /* use a memory-based cache */
81 /* below here used only for kernel procedures */
83 /* Store synchrony flags - SYNC means that data should be forced to server's
84 * disk immediately upon completion. */
87 #define AFS_VMSYNC_INVAL 2 /* sync and invalidate pages */
88 #define AFS_LASTSTORE 4
91 /* background request structure */
94 #define BOP_NOOP 0 /* leave 0 unused */
95 #define BOP_FETCH 1 /* parm1 is chunk to get */
96 #define BOP_STORE 2 /* parm1 is chunk to store */
97 #define BOP_PATH 3 /* parm1 is path, parm2 is chunk to fetch */
99 #define B_DONTWAIT 1 /* On failure return; don't wait */
101 /* protocol is: refCount is incremented by user to take block out of free pool.
102 Next, BSTARTED is set when daemon finds request. This prevents
103 other daemons from picking up the same request. Finally, when
104 request is done, refCount is zeroed. BDONE and BWAIT are used by
105 dudes waiting for operation to proceed to a certain point before returning.
107 #define BSTARTED 1 /* request picked up by a daemon */
108 #define BUVALID 2 /* code is valid (store) */
109 #define BUWAIT 4 /* someone is waiting for BUVALID */
111 struct vcache *vnode; /* vnode to use, with vrefcount bumped */
112 struct AFS_UCRED *cred; /* credentials to use for operation */
113 long parm[BPARMS]; /* random parameters - long's work for
114 * both 32 and 64 bit platforms.
116 afs_int32 code; /* return code */
117 short refCount; /* use counter for this structure */
118 char opcode; /* what to do (store, fetch, etc) */
119 char flags; /* free, etc */
127 afs_int32 AuthHandle;
128 char HandShakeKey[8];
130 afs_int32 BeginTimestamp;
131 afs_int32 EndTimestamp;
135 afs_int32 Cell; /* better sun packing if at end of structure */
139 /* 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!) */
142 afs_int32 CellAndUnique;
145 /* The actual number of bytes in the SmallFid, not the sizeof struct. */
146 #define SIZEOF_SMALLFID 10
150 * Queues implemented with both pointers and short offsets into a disk file.
158 afs_int32 uid; /* user id making the request */
159 afs_int32 busyCount; /* how many busies we've seen so far */
160 afs_int32 flags; /* things like O_SYNC, O_NONBLOCK go here */
161 char initd; /* if non-zero, non-uid fields meaningful */
162 char accessError; /* flags for overriding error return code */
163 char volumeError; /* encountered a missing or busy volume */
164 char networkError; /* encountered network problems */
165 char permWriteError; /* fileserver returns permenent error. */
170 /* structure linked off of a server to keep track of queued returned
171 * callbacks. Sent asynchronously when we run a little low on free dudes.
174 struct afs_cbr *next;
179 #define LOCALCELL 1 /* local cell's number is always 1 */
182 #define CPrimary 1 /* on if this is the primary cell */
183 #define CNoSUID 2 /* 1 if no suid progs can run from this cell */
184 #define CHasVolRef 16 /* Volumes were referenced in this cell*/
185 #define CLinkedCell 32
188 struct afs_q lruq; /* lru q next and prev */
189 afs_int32 cell; /* unique id assigned by venus */
190 char *cellName; /* char string name of cell */
191 struct server *cellHosts[MAXCELLHOSTS]; /* volume *location* hosts for this cell */
192 struct cell *lcellp; /* Associated linked cell */
193 u_short fsport; /* file server port */
194 u_short vlport; /* volume server port */
195 short states; /* state flags */
196 short cellIndex; /* relative index number per cell */
197 time_t timeout; /* data expire time, if non-zero */
200 #define afs_PutCell(cellp, locktype)
202 /* the unixuser flag bit definitions */
203 #define UHasTokens 1 /* are the st and ct fields valid (ever set)? */
204 #define UTokensBad 2 /* are tokens bad? */
205 #define UPrimary 4 /* on iff primary identity */
206 #define UNeedsReset 8 /* needs afs_ResetAccessCache call done */
207 #define UPAGCounted 16 /* entry seen during PAG search (for stats) */
208 /* A flag used by afs_GCPAGs to keep track of
209 * which entries in afs_users need to be deleted.
210 * The lifetime of its presence in the table is the
211 * lifetime of the afs_GCPAGs function.
213 #define TMP_UPAGNotReferenced 128
215 /* values for afs_gcpags */
217 { AFS_GCPAGS_NOTCOMPILED = 0
219 , AFS_GCPAGS_USERDISABLED
223 , AFS_GCPAGS_EINEXACT
224 , AFS_GCPAGS_EPROCEND
225 , AFS_GCPAGS_EPROCWALK
226 , AFS_GCPAGS_ECREDWALK
227 , AFS_GCPAGS_EPIDCHECK
228 , AFS_GCPAGS_ENICECHECK
231 extern afs_int32 afs_gcpags;
232 extern afs_int32 afs_gcpags_procsize;
235 struct unixuser *next; /* next hash pointer */
236 afs_int32 uid; /* search based on uid and cell */
238 afs_int32 vid; /* corresponding vice id in specified cell */
239 short refCount; /* reference count for allocation */
240 char states; /* flag info */
241 afs_int32 tokenTime; /* last time tokens were set, used for timing out conn data */
242 afs_int32 stLen; /* ticket length (if kerberos, includes kvno at head) */
243 char *stp; /* pointer to ticket itself */
244 struct ClearToken ct;
245 struct afs_exporter *exporter; /* more info about the exporter for the remote user */
249 /* Per-connection block. */
250 struct conn *next; /* Next dude same server. */
251 struct unixuser *user; /* user validated with respect to. */
252 struct rx_connection *id; /* RPC connid. */
253 struct srvAddr *srvr; /* server associated with this conn */
254 short refCount; /* reference count for allocation */
255 unsigned short port; /* port associated with this connection */
256 char forceConnectFS; /* Should we try again with these tokens? */
262 /* Fid comparison routines */
263 #define FidCmp(a,b) ((a)->Fid.Unique != (b)->Fid.Unique \
264 || (a)->Fid.Vnode != (b)->Fid.Vnode \
265 || (a)->Fid.Volume != (b)->Fid.Volume \
266 || (a)->Cell != (b)->Cell)
268 #define FidMatches(afid,tvc) ((tvc)->fid.Fid.Vnode == (afid)->Fid.Vnode && \
269 (tvc)->fid.Fid.Volume == (afid)->Fid.Volume && \
270 (tvc)->fid.Cell == (afid)->Cell && \
271 ( (tvc)->fid.Fid.Unique == (afid)->Fid.Unique || \
272 (!(afid)->Fid.Unique && ((tvc)->states & CUnique))))
276 * Operations on circular queues implemented with pointers. Note: these queue
277 * objects are always located at the beginning of the structures they are linking.
279 #define QInit(q) ((q)->prev = (q)->next = (q))
280 #define QAdd(q,e) ((e)->next = (q)->next, (e)->prev = (q), \
281 (q)->next->prev = (e), (q)->next = (e))
282 #define QRemove(e) ((e)->next->prev = (e)->prev, (e)->prev->next = (e)->next)
283 #define QNext(e) ((e)->next)
284 #define QPrev(e) ((e)->prev)
285 #define QEmpty(q) ((q)->prev == (q))
286 /* this one takes q1 and sticks it on the end of q2 - that is, the other end, not the end
287 * that things are added onto. q1 shouldn't be empty, it's silly */
288 #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))
290 * Do lots of address arithmetic to go from vlruq to the base of the vcache
291 * structure. Don't move struct vnode, since we think of a struct vcache as
292 * a specialization of a struct vnode
294 #define QTOV(e) ((struct vcache *)(((char *) (e)) - (((char *)(&(((struct vcache *)(e))->vlruq))) - ((char *)(e)))))
295 #define QTOC(e) ((struct cell *)((char *) (e)))
298 #define SRVADDR_ISDOWN 0x20 /* same as SRVR_ISDOWN */
299 #define SRVADDR_NOUSE 0x40 /* Don't use this srvAddr */
301 struct srvAddr *next_bkt; /* next item in hash bucket */
302 struct srvAddr *next_sa; /* another interface on same host */
303 struct server *server; /* back to parent */
304 struct conn *conns; /* All user connections to this server */
305 afs_int32 sa_ip; /* Host addr in network byte order */
306 u_short sa_iprank; /* indiv ip address priority */
307 u_short sa_portal; /* port addr in network byte order */
312 * Values used in the flags field of the server structure below.
314 * AFS_SERVER_FLAG_ACTIVATED Has the server ever had a user connection
315 * associated with it?
317 #define AFS_SERVER_FLAG_ACTIVATED 0x01
318 #define SNO_LHOSTS 0x04
319 #define SYES_LHOSTS 0x08
320 #define SVLSRV_UUID 0x10
321 #define SRVR_ISDOWN 0x20
322 #define SRVR_MULTIHOMED 0x40
323 #define SRVR_ISGONE 0x80
329 afs_int32 addr_uniquifier;
333 struct srvAddr haddr;
336 #define sr_uuid _suid._srvUuid.suuid
337 #define sr_addr_uniquifier _suid._srvUuid.addr_uniquifier
338 #define sr_host _suid._srvId.haddr.ip
339 #define sr_portal _suid._srvId.haddr.portal
340 #define sr_rank _suid._srvId.haddr.ip_rank
341 #define sr_flags _suid._srvId.haddr.flags
342 #define sr_conns _suid._srvId.haddr.conns
343 struct server *next; /* Ptr to next server in hash chain */
344 struct cell *cell; /* Cell in which this host resides */
345 struct afs_cbr *cbrs; /* Return list of callbacks */
346 afs_int32 activationTime; /* Time when this record was first activated */
347 afs_int32 lastDowntimeStart; /* Time when last downtime incident began */
348 afs_int32 numDowntimeIncidents; /* # (completed) downtime incidents */
349 afs_int32 sumOfDowntimes; /* Total downtime experienced, in seconds */
350 struct srvAddr *addr;
351 char flags; /* Misc flags*/
354 #define afs_PutServer(servp, locktype)
356 /* structs for some pioctls - these are (or should be)
364 struct sprefrequest_33 {
365 unsigned short offset;
366 unsigned short num_servers;
370 struct sprefrequest { /* new struct for 3.4 */
371 unsigned short offset;
372 unsigned short num_servers;
373 unsigned short flags;
378 unsigned short next_offset;
379 unsigned short num_servers;
380 struct spref servers[1]; /* we overrun this array intentionally...*/
384 unsigned short flags;
385 unsigned short num_servers;
386 struct spref servers[1]; /* we overrun this array intentionally...*/
388 /* struct for GAG pioctl
391 afs_uint32 showflags, logflags, logwritethruflag, spare[3];
392 unsigned char spare2[128];
396 #define logwritethruON 1
399 afs_int32 rx_initReceiveWindow, rx_maxReceiveWindow,
400 rx_initSendWindow, rx_maxSendWindow, rxi_nSendFrags,
401 rxi_nRecvFrags, rxi_OrphanFragSize;
402 afs_int32 rx_maxReceiveSize, rx_MyMaxSendSize;
403 afs_uint32 spare[21];
406 /* struct for checkservers */
419 /* state bits for volume */
420 #define VRO 1 /* volume is readonly */
421 #define VRecheck 2 /* recheck volume info with server */
422 #define VBackup 4 /* is this a backup volume? */
423 #define VForeign 8 /* this is a non-afs volume */
424 #define VResort 16 /* server order was rearranged, sort when able */
425 #define VMoreReps 32 /* This volume has more replicas than we are */
426 /* keeping track of now -- check with VLDB */
428 enum repstate { not_busy, end_not_busy = 6, rd_busy, rdwr_busy, offline };
431 /* One structure per volume, describing where the volume is located
432 and where its mount points are. */
433 struct volume *next; /* Next volume in hash list. */
434 afs_int32 cell; /* the cell in which the volume resides */
435 afs_rwlock_t lock; /* the lock for this structure */
436 afs_int32 volume; /* This volume's ID number. */
437 char *name; /* This volume's name, or 0 if unknown */
438 struct server *serverHost[MAXHOSTS]; /* servers serving this volume */
439 enum repstate status[MAXHOSTS]; /* busy, offline, etc */
440 struct VenusFid dotdot; /* dir to access as .. */
441 struct VenusFid mtpoint; /* The mount point for this volume. */
442 afs_int32 rootVnode, rootUnique; /* Volume's root fid */
445 afs_int32 rwVol; /* For r/o vols, original read/write volume. */
446 afs_int32 accessTime; /* last time we used it */
447 afs_int32 vtix; /* volume table index */
448 afs_int32 copyDate; /* copyDate field, for tracking vol releases */
449 afs_int32 expireTime; /* for per-volume callbacks... */
450 short refCount; /* reference count for allocation */
451 char states; /* here for alignment reasons */
454 #define afs_PutVolume(av, locktype) ((av)->refCount--)
456 /* format of an entry in volume info file */
458 afs_int32 cell; /* cell for this entry */
459 afs_int32 volume; /* volume */
460 afs_int32 next; /* has index */
461 struct VenusFid dotdot; /* .. value */
462 struct VenusFid mtpoint; /* mt point's fid */
463 afs_int32 rootVnode, rootUnique; /* Volume's root fid */
467 struct SimpleLocks *next;
469 afs_int32 boff, eoff;
471 #if defined(AFS_AIX32_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
476 /* vcache state bits */
477 #define CStatd 1 /* has this file ever been stat'd? */
478 #define CBackup 2 /* file is on a backup volume */
479 #define CRO 4 /* is it on a read-only volume */
480 #define CMValid 8 /* is the mount point info valid? */
481 #define CCore 0x10 /* storing a core file, needed since we don't get an open */
482 #define CDirty 0x20 /* file has been modified since first open (... O_RDWR) */
483 #define CSafeStore 0x40 /* close must wait for store to finish (should be in fd) */
484 #define CMAPPED 0x80 /* Mapped files; primarily used by SunOS 4.0.x */
485 #define CNSHARE 0x100 /* support O_NSHARE semantics */
489 #define CWired 0x800 /* OSF hack only */
491 #define CWRITE_IGN 0x800 /* Next OS hack only */
493 #define CUnique 0x1000 /* vc's uniquifier - latest unifiquier for fid */
494 #define CForeign 0x2000 /* this is a non-afs vcache */
495 #define CHasPages 0x4000
496 #define CUnlinked 0x10000
497 #define CBulkStat 0x20000 /* loaded by a bulk stat, and not ref'd since */
498 #define CUnlinkedDel 0x40000
499 #define CVFlushed 0x80000
500 #define CCore1 0x100000 /* osf1 core file; not same as CCore above */
501 #define CWritingUFS 0x200000 /* to detect vm deadlock - used by sgi */
502 #define CCreating 0x400000 /* avoid needless store after open truncate */
503 #define CPageHog 0x800000 /* AIX - dumping large cores is a page hog. */
504 #define CDCLock 0x200000 /* Vnode lock held over call to GetDownD */
505 #define CBulkFetching 0x4000000 /* stats are being fetched by bulk stat */
506 #define CExtendedFile 0x8000000 /* extended file via ftruncate call. */
508 /* vcache vstate bits */
509 #define VRevokeWait 0x1
510 #define VPageCleaning 0x2 /* Solaris - Cache Trunc Daemon sez keep out */
513 #if !defined(AFS_FBSD_ENV)
514 #define vrefCount v.v_count
516 #define vrefCount v.v_usecount
517 #endif /* AFS_FBSD_ENV */
519 #define AFS_MAXDV 0x7fffffff /* largest dataversion number */
520 #define AFS_NOTRUNC 0x7fffffff /* largest dataversion number */
522 extern afs_int32 vmPageHog; /* counter for # of vnodes which are page hogs. */
525 * Fast map from vcache to dcache
532 afs_uint32 minLoc; /* smallest offset into dc. */
533 afs_uint32 len; /* largest offset into dc. */
536 extern afs_uint32 afs_stampValue; /* stamp for pair's usage */
537 #define MakeStamp() (++afs_stampValue)
539 /* INVARIANTs: (vlruq.next != NULL) == (vlruq.prev != NULL)
540 * nextfree => !vlruq.next && ! vlruq.prev
541 * !(avc->nextfree) && !avc->vlruq.next => (FreeVCList == avc->nextfree)
544 struct vnode v; /* Has reference count in v.v_count */
545 struct afs_q vlruq; /* lru q next and prev */
546 struct vcache *nextfree; /* next on free list (if free) */
547 struct vcache *hnext; /* Hash next */
551 afs_hyper_t DataVersion;
555 ushort Mode; /* XXXX Should be afs_int32 XXXX */
557 /* vnode type is in v.v_type */
559 afs_rwlock_t lock; /* The lock on the vcache contents. */
560 #if defined(AFS_SUN5_ENV)
561 /* Lock used to protect the activeV, multipage, and vstates fields.
562 * Do not try to get the vcache lock when the vlock is held */
564 #endif /* defined(AFS_SUN5_ENV) */
565 #if defined(AFS_SUN_ENV) || defined(AFS_ALPHA_ENV) || defined(AFS_DARWIN_ENV)
566 #if defined(AFS_SUN5_ENV)
570 afs_bozoLock_t pvnLock; /* see locks.x */
579 int ownslock; /* pid of owner of excl lock, else 0 - defect 3083 */
581 #ifdef AFS_DARWIN_ENV
582 struct lock__bsd__ rwlock;
584 afs_int32 parentVnode; /* Parent dir, if a file. */
585 afs_int32 parentUnique;
586 struct VenusFid *mvid; /* Either parent dir (if root) or root (if mt pt) */
587 char *linkData; /* Link data if a symlink. */
588 afs_hyper_t flushDV; /* data version last flushed from text */
589 afs_hyper_t mapDV; /* data version last flushed from map */
590 afs_uint32 truncPos; /* truncate file to this position at next store */
591 struct server *callback; /* The callback host, if any */
592 afs_uint32 cbExpires; /* time the callback expires */
593 struct afs_q callsort; /* queue in expiry order, sort of */
594 struct axscache *Access; /* a list of cached access bits */
595 afs_int32 anyAccess; /* System:AnyUser's access to this. */
596 afs_int32 last_looker; /* pag/uid from last lookup here */
597 #if defined(AFS_SUN5_ENV)
599 #endif /* defined(AFS_SUN5_ENV) */
600 struct SimpleLocks *slocks;
601 short opens; /* The numbers of opens, read or write, on this file. */
602 short execsOrWriters; /* The number of execs (if < 0) or writers (if > 0) of
604 short flockCount; /* count of flock readers, or -1 if writer */
605 char mvstat; /* 0->normal, 1->mt pt, 2->root. */
606 afs_uint32 states; /* state bits */
607 #if defined(AFS_SUN5_ENV)
608 afs_uint32 vstates; /* vstate bits */
609 #endif /* defined(AFS_SUN5_ENV) */
611 afs_uint32 symhintstamp;
613 struct vcache *symhint;
614 struct dcache *dchint;
616 #ifdef AFS_LINUX22_ENV
617 u_short flushcnt; /* Number of flushes which haven't released yet. */
618 u_short mapcnt; /* Number of mappings of this file. */
620 #if defined(AFS_SGI_ENV)
621 daddr_t lastr; /* for read-ahead */
623 uint64_t vc_rwlockid; /* kthread owning rwlock */
625 short vc_rwlockid; /* pid of process owning rwlock */
627 short vc_locktrips; /* # of rwlock reacquisitions */
628 sema_t vc_rwlock; /* vop_rwlock for afs */
629 pgno_t mapcnt; /* # of pages mapped */
630 struct cred *cred; /* last writer's cred */
632 struct bhv_desc vc_bhv_desc; /* vnode's behavior data. */
634 #endif /* AFS_SGI_ENV */
635 afs_int32 vc_error; /* stash write error for this vnode. */
636 int xlatordv; /* Used by nfs xlator */
637 struct AFS_UCRED *uncred;
638 int asynchrony; /* num kbytes to store behind */
640 short multiPage; /* count of multi-page getpages in progress */
644 #define afs_symhint_inval(avc)
647 #define DONT_CHECK_MODE_BITS 0
648 #define CHECK_MODE_BITS 1
649 #define CMB_ALLOW_EXEC_AS_READ 2 /* For the NFS xlator */
651 #if defined(AFS_SGI_ENV)
652 #define AVCRWLOCK(avc) (valusema(&(avc)->vc_rwlock) <= 0)
654 /* SGI vnode rwlock macros and flags. */
655 #ifndef AFS_SGI62_ENV
656 /* The following are defined here. SGI 6.2 declares them in vnode.h */
657 #define VRWLOCK_READ 0
658 #define VRWLOCK_WRITE 1
659 #define VRWLOCK_WRITE_DIRECT 2
664 #define AFS_RWLOCK_T vrwlock_t
666 #define AFS_RWLOCK_T int
667 #endif /* AFS_SGI62_ENV */
669 #include <ksys/behavior.h>
670 #define AFS_RWLOCK(V,F) \
671 afs_rwlock(&(((struct vcache *)(V))->vc_bhv_desc), (F));
672 #define AFS_RWUNLOCK(V,F) \
673 afs_rwunlock(&(((struct vcache *)(V))->vc_bhv_desc), (F));
676 #define AFS_RWLOCK(V,F) afs_rwlock((vnode_t *)(V), (F) )
677 #define AFS_RWUNLOCK(V,F) afs_rwunlock((vnode_t *)(V), (F) )
679 #else /* AFS_SGI53_ENV */
680 #define AFS_RWLOCK(V,F) afs_rwlock((V))
681 #define AFS_RWUNLOCK(V,F) afs_rwunlock((V))
682 #endif /* AFS_SGI53_ENV */
683 #endif /* AFS_SGI_ENV */
687 afs_hyper_t DataVersion;
689 afs_int32 parentVnode;
690 afs_int32 parentUnique;
694 afs_int32 randomUid[CPSIZE];
695 afs_int32 callback; /* Now a pointer to 'server' struct */
697 afs_int32 randomAccess[CPSIZE];
700 short execsOrWriters;
711 /* CM inititialization parameters. What CM actually used after calculations
712 * based on passed in arguments.
714 #define CMI_VERSION 1 /* increment when adding new fields. */
715 struct cm_initparams {
720 int cmi_nVolumeCaches;
721 int cmi_firstChunkSize;
722 int cmi_otherChunkSize;
723 int cmi_cacheSize; /* The original cache size, in 1K blocks. */
724 unsigned cmi_setTime:1;
725 unsigned cmi_memCache:1;
726 int spare[16-9]; /* size of struct is 16 * 4 = 64 bytes */
730 /*----------------------------------------------------------------------
731 * AFS Data cache definitions
733 * Each entry describes a Unix file on the local disk that is
734 * is serving as a cached copy of all or part of a Vice file.
735 * Entries live in circular queues for each hash table slot
737 * Which queue is this thing in? Good question.
738 * A struct dcache entry is in the freeDSlot queue when not associated with a cache slot (file).
739 * Otherwise, it is in the DLRU queue. The freeDSlot queue uses the lruq.next field as
740 * its "next" pointer.
742 * Cache entries in the DLRU queue are either associated with vice files, in which case
743 * they are hashed by afs_dvnextTbl and afs_dcnextTbl pointers, or they are in the freeDCList
744 * and are not associated with any vice file. This last list uses the afs_dvnextTbl pointer for
745 * its "next" pointer.
746 *----------------------------------------------------------------------*/
748 #define NULLIDX (-1) /* null index definition */
749 /* struct dcache states bits */
750 #define DWriting 8 /* file being written (used for cache validation) */
753 #define DFNextStarted 1 /* next chunk has been prefetched already */
754 #define DFEntryMod 2 /* has entry itself been modified? */
755 #define DFFetching 4 /* file is currently being fetched */
756 #define DFWaiting 8 /* someone waiting for file */
757 #define DFFetchReq 0x10 /* someone is waiting for DFFetching to go on */
760 /* flags in afs_indexFlags array */
761 #define IFEverUsed 1 /* index entry has >= 1 byte of data */
762 #define IFFree 2 /* index entry in freeDCList */
763 #define IFDataMod 4 /* file needs to be written out */
764 #define IFFlag 8 /* utility flag */
765 #define IFDirtyPages 16
766 #define IFAnyPages 32
767 #define IFDiscarded 64 /* index entry in discardDCList */
770 char *in; /* input buffer */
771 char *out; /* output buffer */
772 short in_size; /* Size of input buffer <= 2K */
773 short out_size; /* Maximum size of output buffer, <= 2K */
777 * This version of afs_ioctl is required to pass in 32 bit user space
778 * pointers into a 64 bit kernel.
789 /* CacheItems file has a header of type struct afs_fheader
790 * (keep aligned properly). Since we already have sgi_62 clients running
791 * with a 32 bit inode, a change is required to the header so that
792 * they can distinguish the old 32 bit inode CacheItems file and zap it
793 * instead of using it.
796 #define AFS_FHMAGIC 0x7635abaf /* uses version number */
798 #if defined(AFS_SUN57_64BIT_ENV)
799 #define AFS_CI_VERSION 3
801 #define AFS_CI_VERSION 2
804 afs_int32 firstCSize;
805 afs_int32 otherCSize;
808 /* kept on disk and in dcache entries */
810 struct VenusFid fid; /* Fid for this file */
811 afs_int32 modTime; /* last time this entry was modified */
812 afs_hyper_t versionNo; /* Associated data version number */
813 afs_int32 chunk; /* Relative chunk number */
814 #if defined(AFS_SGI61_ENV) || defined(AFS_SUN57_64BIT_ENV)
815 /* Using ino64_t here so that user level debugging programs compile
816 * the size correctly.
818 ino64_t inode; /* Unix inode for this chunk */
820 #if defined(AFS_LINUX_64BIT_KERNEL)
821 long inode; /* Unix inode for this chunk */
823 afs_int32 inode; /* Unix inode for this chunk */
826 afs_int32 chunkBytes; /* Num bytes in this chunk */
827 char states; /* Has this chunk been modified? */
830 /* magic numbers to specify the cache type */
832 #define AFS_FCACHE_TYPE_UFS 0x0
833 #define AFS_FCACHE_TYPE_MEM 0x1
834 #define AFS_FCACHE_TYPE_NFS 0x2
835 #define AFS_FCACHE_TYPE_EPI 0x3
839 struct afs_q lruq; /* Free queue for in-memory images */
840 afs_rwlock_t lock; /* XXX */
841 short refCount; /* Associated reference count. */
842 afs_int32 index; /* The index in the CacheInfo file*/
843 short flags; /* more flags bits */
844 afs_int32 validPos; /* number of valid bytes during fetch */
845 struct fcache f; /* disk image */
846 afs_int32 stamp; /* used with vtodc struct for hints */
848 /* this is obsolete and should be removed */
851 /* macro to mark a dcache entry as bad */
854 (x)->f.fid.Fid.Unique = 0; \
855 afs_indexUnique[(x)->index] = 0; \
856 (x)->flags |= DFEntryMod; \
860 * Convenient release macro for use when afs_PutDCache would cause
861 * deadlock on afs_xdcache lock
863 #define lockedPutDCache(ad) ((ad)->refCount--)
865 /* FakeOpen and Fake Close used to be real subroutines. They're only used in
866 * sun_subr and afs_vnodeops, and they're very frequently called, so I made
867 * them into macros. They do:
868 * FakeOpen: fake the file being open for writing. avc->lock must be held
869 * in write mode. Having the file open for writing is like having a DFS
870 * write-token: you're known to have the best version of the data around,
871 * and so the CM won't let it be overwritten by random server info.
872 * FakeClose: undo the effects of FakeOpen, noting that we want to ensure
873 * that a real close eventually gets done. We use CCore to achieve this if
874 * we would end up closing the file. avc->lock must be held in write mode */
876 #ifdef AFS_AIX_IAUTH_ENV
877 #define CRKEEP(V, C) (V)->linkData = (char*)crdup((C))
879 #define CRKEEP(V, C) crhold((C)); (V)->linkData = (char*)(C)
882 #define afs_FakeOpen(avc) { avc->opens++; avc->execsOrWriters++; }
883 #define afs_FakeClose(avc, acred) \
884 { if (avc->execsOrWriters == 1) { \
885 /* we're the last writer, just use CCore flag */ \
886 avc->states |= CCore; /* causes close to be called later */ \
888 /* The cred and vnode holds will be released in afs_FlushActiveVcaches */ \
889 VN_HOLD((struct vnode *)avc); /* So it won't disappear */ \
890 CRKEEP(avc, acred); /* Should use a better place for the creds */ \
893 /* we're not the last writer, let the last one do the store-back for us */ \
895 avc->execsOrWriters--; \
899 #define AFS_ZEROS 64 /* zero buffer */
901 /*#define afs_DirtyPages(avc) (((avc)->states & CDirty) || osi_VMDirty_p((avc)))*/
902 #define afs_DirtyPages(avc) ((avc)->states & CDirty)
904 /* The PFlush algorithm makes use of the fact that Fid.Unique is not used in
905 below hash algorithms. Change it if need be so that flushing algorithm
906 doesn't move things from one hash chain to another
908 /* extern int afs_dhashsize; */
909 #define DCHash(v, c) ((((v)->Fid.Vnode + (v)->Fid.Volume + (c))) & (afs_dhashsize-1))
910 /*Vnode, Chunk -> Hash table index*/
911 #define DVHash(v) ((((v)->Fid.Vnode + (v)->Fid.Volume )) & (afs_dhashsize-1))
912 /*Vnode -> Other hash table index*/
913 /* don't hash on the cell, our callback-breaking code sometimes fails to compute
914 the cell correctly, and only scans one hash bucket */
915 #define VCHash(fid) (((fid)->Fid.Volume + (fid)->Fid.Vnode) & (VCSIZE-1))
917 extern struct dcache **afs_indexTable; /*Pointers to in-memory dcache entries*/
918 extern afs_int32 *afs_indexUnique; /*dcache entry Fid.Unique */
919 extern afs_int32 *afs_dvnextTbl; /*Dcache hash table links */
920 extern afs_int32 *afs_dcnextTbl; /*Dcache hash table links */
921 extern afs_int32 afs_cacheFiles; /*Size of afs_indexTable*/
922 extern afs_int32 afs_cacheBlocks; /*1K blocks in cache*/
923 extern afs_int32 afs_cacheStats; /*Stat entries in cache*/
924 extern struct vcache *afs_vhashT[VCSIZE]; /*Stat cache hash table*/
925 extern afs_int32 afs_initState; /*Initialization state*/
926 extern afs_int32 afs_termState; /* Termination state */
927 extern struct VenusFid afs_rootFid; /*Root for whole file system*/
928 extern afs_int32 afs_allCBs; /* Count of callbacks*/
929 extern afs_int32 afs_oddCBs; /* Count of odd callbacks*/
930 extern afs_int32 afs_evenCBs; /* Count of even callbacks*/
931 extern afs_int32 afs_allZaps; /* Count of fid deletes */
932 extern afs_int32 afs_oddZaps; /* Count of odd fid deletes */
933 extern afs_int32 afs_evenZaps; /* Count of even fid deletes */
934 extern struct brequest afs_brs[NBRS]; /* request structures */
936 #define UHash(auid) ((auid) & (NUSERS-1))
937 #define VHash(avol) ((avol)&(NVOLS-1))
938 #define SHash(aserv) ((ntohl(aserv)) & (NSERVERS-1))
939 #define FVHash(acell,avol) (((avol)+(acell)) & (NFENTRIES-1))
941 extern struct cell *afs_GetCell();
942 extern struct cell *afs_GetCellByName();
943 extern struct unixuser *afs_GetUser();
944 extern struct volume *afs_GetVolume();
945 extern struct volume *afs_GetVolumeByName();
946 extern struct conn *afs_Conn();
947 extern struct conn *afs_ConnByHost();
948 extern struct conn *afs_ConnByMHosts();
949 extern afs_int32 afs_NewCell();
950 extern struct dcache *afs_GetDCache();
951 extern struct dcache *afs_FindDCache();
952 extern struct dcache *afs_NewDCache();
953 extern struct dcache *afs_GetDSlot();
954 extern struct vcache *afs_GetVCache();
955 extern struct brequest *afs_BQueue();
958 extern int afs_CacheInit();
959 extern void afs_StoreWarn();
960 extern void afs_AdjustSize();
961 extern void afs_ComputeCacheParms();
962 extern void afs_FlushDCache();
963 extern void afs_FlushActiveVcaches();
964 extern void afs_StuffVcache();
965 extern void afs_PutVCache();
966 extern void afs_TryToSmush();
967 extern void afs_ProcessFS();
968 extern void afs_WriteThroughDSlots();
969 extern void shutdown_cache();
971 extern void afs_shutdown();
973 extern void shutdown_osifile();
976 /* Performance hack - we could replace VerifyVCache2 with the appropriate
977 * GetVCache incantation, and could eliminate even this code from afs_UFSRead
978 * by making intentionally invalidating quick.stamp in the various callbacks
979 * expiration/breaking code */
980 #ifdef AFS_LINUX20_ENV
981 #define afs_VerifyVCache(avc, areq) \
982 (((avc)->states & CStatd) ? (vcache2inode(avc), 0) : \
983 afs_VerifyVCache2((avc),areq))
985 #ifdef AFS_DARWIN_ENV
986 #define afs_VerifyVCache(avc, areq) \
987 (((avc)->states & CStatd) ? (osi_VM_Setup(avc), 0) : \
988 afs_VerifyVCache2((avc),areq))
990 #define afs_VerifyVCache(avc, areq) \
991 (((avc)->states & CStatd) ? 0 : afs_VerifyVCache2((avc),areq))
995 #define DO_STATS 1 /* bits used by FindVCache */
998 /* values for flag param of afs_CheckVolumeNames */
999 #define AFS_VOLCHECK_EXPIRED 0x1 /* volumes whose callbacks have expired */
1000 #define AFS_VOLCHECK_BUSY 0x2 /* volumes which were marked busy */
1001 #define AFS_VOLCHECK_MTPTS 0x4 /* mount point invalidation also */
1002 #define AFS_VOLCHECK_FORCE 0x8 /* do all forcibly */
1006 #define AFS_FSPORT ((unsigned short) htons(7000))
1007 #define AFS_VLPORT ((unsigned short) htons(7003))
1009 #define afs_read(avc, uio, acred, albn, abpp, nolock) \
1010 (*(afs_cacheType->vread))(avc, uio, acred, albn, abpp, nolock)
1011 #define afs_write(avc, uio, aio, acred, nolock) \
1012 (*(afs_cacheType->vwrite))(avc, uio, aio, acred, nolock)
1014 #define afs_rdwr(avc, uio, rw, io, cred) \
1015 (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 0) : afs_read(avc, uio, cred, 0, 0, 0))
1016 #define afs_nlrdwr(avc, uio, rw, io, cred) \
1017 (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 1) : afs_read(avc, uio, cred, 0, 0, 1))
1019 extern afs_int32 afs_blocksUsed, afs_blocksDiscarded;
1020 extern afs_int32 afs_discardDCCount, afs_freeDCCount;
1021 extern afs_int32 afs_bulkStatsDone, afs_bulkStatsLost;
1022 extern int afs_TruncateDaemonRunning;
1023 extern int afs_CacheTooFull;
1024 /* Cache size truncation uses the following low and high water marks:
1025 * If the cache is more than 95% full (CM_DCACHECOUNTFREEPCT), the cache
1026 * truncation daemon is awakened and will free up space until the cache is 85%
1027 * (CM_DCACHESPACEFREEPCT - CM_DCACHEEXTRAPCT) full.
1028 * afs_UFSWrite and afs_GetDCache (when it needs to fetch data) will wait on
1029 * afs_WaitForCacheDrain if the cache is 98% (CM_WAITFORDRAINPCT) full.
1030 * afs_GetDownD wakes those processes once the cache is 95% full
1031 * (CM_CACHESIZEDRAINEDPCT).
1033 extern void afs_CacheTruncateDaemon();
1034 extern int afs_WaitForCacheDrain;
1035 #define CM_MAXDISCARDEDCHUNKS 16 /* # of chunks */
1036 #define CM_DCACHECOUNTFREEPCT 95 /* max pct of chunks in use */
1037 #define CM_DCACHESPACEFREEPCT 90 /* max pct of space in use */
1038 #define CM_DCACHEEXTRAPCT 5 /* extra to get when freeing */
1039 #define CM_CACHESIZEDRAINEDPCT 95 /* wakeup processes when down to here.*/
1040 #define CM_WAITFORDRAINPCT 98 /* sleep if cache is this full. */
1042 #define afs_CacheIsTooFull() \
1043 (afs_blocksUsed - afs_blocksDiscarded > \
1044 (CM_DCACHECOUNTFREEPCT*afs_cacheBlocks)/100 || \
1045 afs_freeDCCount - afs_discardDCCount < \
1046 ((100-CM_DCACHECOUNTFREEPCT)*afs_cacheFiles)/100)
1048 #define afs_MaybeWakeupTruncateDaemon() \
1050 if (!afs_CacheTooFull && afs_CacheIsTooFull()) { \
1051 afs_CacheTooFull = 1; \
1052 if (!afs_TruncateDaemonRunning) { \
1053 afs_osi_Wakeup((char *)afs_CacheTruncateDaemon); \
1055 } else if (!afs_TruncateDaemonRunning && \
1056 afs_blocksDiscarded > CM_MAXDISCARDEDCHUNKS) { \
1057 afs_osi_Wakeup((char *)afs_CacheTruncateDaemon); \
1061 /* Handy max length of a numeric string. */
1062 #define CVBS 12 /* max afs_int32 is 2^32 ~ 4*10^9, +1 for NULL, +luck */
1064 extern int afs_norefpanic;
1065 #define refpanic(foo) if (afs_norefpanic) \
1066 { printf( foo ); afs_norefpanic++;} else osi_Panic( foo )
1071 ** these are defined in the AIX source code sys/fs_locks.h but are not
1072 ** defined anywhere in the /usr/include directory
1074 #if defined(AFS_AIX41_ENV)
1075 #define VN_LOCK(vp) simple_lock(&(vp)->v_lock)
1076 #define VN_UNLOCK(vp) simple_unlock(&(vp)->v_lock)
1079 /* get a file's serial number from a vnode */
1080 #ifndef afs_vnodeToInumber
1081 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1082 #define afs_vnodeToInumber(V) VnodeToIno(V)
1084 #ifdef AFS_DECOSF_ENV
1085 #define afs_vnodeToInumber(V) osi_vnodeToInumber(V)
1087 #define afs_vnodeToInumber(V) (VTOI(V)->i_number)
1088 #endif /* AFS_DECOSF_ENV */
1089 #endif /* AFS_SGI62_ENV */
1092 /* get a file's device number from a vnode */
1093 #ifndef afs_vnodeToDev
1094 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS) || defined(AFS_DARWIN_ENV)
1095 #define afs_vnodeToDev(V) VnodeToDev(V)
1097 #ifdef AFS_DECOSF_ENV
1098 #define afs_vnodeToDev(V) osi_vnodeToDev(V)
1100 #define afs_vnodeToDev(V) (VTOI(V)->i_dev)
1101 #endif /* AFS_DECOSF_ENV */
1102 #endif /* AFS_SGI62_ENV */
1105 #endif /* _AFS_H_ */