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 */
199 #define afs_PutCell(cellp, locktype)
201 /* the unixuser flag bit definitions */
202 #define UHasTokens 1 /* are the st and ct fields valid (ever set)? */
203 #define UTokensBad 2 /* are tokens bad? */
204 #define UPrimary 4 /* on iff primary identity */
205 #define UNeedsReset 8 /* needs afs_ResetAccessCache call done */
206 #define UPAGCounted 16 /* entry seen during PAG search (for stats) */
207 /* A flag used by afs_GCPAGs to keep track of
208 * which entries in afs_users need to be deleted.
209 * The lifetime of its presence in the table is the
210 * lifetime of the afs_GCPAGs function.
212 #define TMP_UPAGNotReferenced 128
214 /* values for afs_gcpags */
216 { AFS_GCPAGS_NOTCOMPILED = 0
218 , AFS_GCPAGS_USERDISABLED
222 , AFS_GCPAGS_EINEXACT
223 , AFS_GCPAGS_EPROCEND
224 , AFS_GCPAGS_EPROCWALK
225 , AFS_GCPAGS_ECREDWALK
226 , AFS_GCPAGS_EPIDCHECK
227 , AFS_GCPAGS_ENICECHECK
230 extern afs_int32 afs_gcpags;
231 extern afs_int32 afs_gcpags_procsize;
234 struct unixuser *next; /* next hash pointer */
235 afs_int32 uid; /* search based on uid and cell */
237 afs_int32 vid; /* corresponding vice id in specified cell */
238 short refCount; /* reference count for allocation */
239 char states; /* flag info */
240 afs_int32 tokenTime; /* last time tokens were set, used for timing out conn data */
241 afs_int32 stLen; /* ticket length (if kerberos, includes kvno at head) */
242 char *stp; /* pointer to ticket itself */
243 struct ClearToken ct;
244 struct afs_exporter *exporter; /* more info about the exporter for the remote user */
248 /* Per-connection block. */
249 struct conn *next; /* Next dude same server. */
250 struct unixuser *user; /* user validated with respect to. */
251 struct rx_connection *id; /* RPC connid. */
252 struct srvAddr *srvr; /* server associated with this conn */
253 short refCount; /* reference count for allocation */
254 unsigned short port; /* port associated with this connection */
255 char forceConnectFS; /* Should we try again with these tokens? */
261 /* Fid comparison routines */
262 #define FidCmp(a,b) ((a)->Fid.Unique != (b)->Fid.Unique \
263 || (a)->Fid.Vnode != (b)->Fid.Vnode \
264 || (a)->Fid.Volume != (b)->Fid.Volume \
265 || (a)->Cell != (b)->Cell)
267 #define FidMatches(afid,tvc) ((tvc)->fid.Fid.Vnode == (afid)->Fid.Vnode && \
268 (tvc)->fid.Fid.Volume == (afid)->Fid.Volume && \
269 (tvc)->fid.Cell == (afid)->Cell && \
270 ( (tvc)->fid.Fid.Unique == (afid)->Fid.Unique || \
271 (!(afid)->Fid.Unique && ((tvc)->states & CUnique))))
275 * Operations on circular queues implemented with pointers. Note: these queue
276 * objects are always located at the beginning of the structures they are linking.
278 #define QInit(q) ((q)->prev = (q)->next = (q))
279 #define QAdd(q,e) ((e)->next = (q)->next, (e)->prev = (q), \
280 (q)->next->prev = (e), (q)->next = (e))
281 #define QRemove(e) ((e)->next->prev = (e)->prev, (e)->prev->next = (e)->next)
282 #define QNext(e) ((e)->next)
283 #define QPrev(e) ((e)->prev)
284 #define QEmpty(q) ((q)->prev == (q))
285 /* this one takes q1 and sticks it on the end of q2 - that is, the other end, not the end
286 * that things are added onto. q1 shouldn't be empty, it's silly */
287 #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))
289 * Do lots of address arithmetic to go from vlruq to the base of the vcache
290 * structure. Don't move struct vnode, since we think of a struct vcache as
291 * a specialization of a struct vnode
293 #define QTOV(e) ((struct vcache *)(((char *) (e)) - (((char *)(&(((struct vcache *)(e))->vlruq))) - ((char *)(e)))))
294 #define QTOC(e) ((struct cell *)((char *) (e)))
297 #define SRVADDR_ISDOWN 0x20 /* same as SRVR_ISDOWN */
298 #define SRVADDR_NOUSE 0x40 /* Don't use this srvAddr */
300 struct srvAddr *next_bkt; /* next item in hash bucket */
301 struct srvAddr *next_sa; /* another interface on same host */
302 struct server *server; /* back to parent */
303 struct conn *conns; /* All user connections to this server */
304 afs_int32 sa_ip; /* Host addr in network byte order */
305 u_short sa_iprank; /* indiv ip address priority */
306 u_short sa_portal; /* port addr in network byte order */
311 * Values used in the flags field of the server structure below.
313 * AFS_SERVER_FLAG_ACTIVATED Has the server ever had a user connection
314 * associated with it?
316 #define AFS_SERVER_FLAG_ACTIVATED 0x01
317 #define SNO_LHOSTS 0x04
318 #define SYES_LHOSTS 0x08
319 #define SVLSRV_UUID 0x10
320 #define SRVR_ISDOWN 0x20
321 #define SRVR_MULTIHOMED 0x40
322 #define SRVR_ISGONE 0x80
328 afs_int32 addr_uniquifier;
332 struct srvAddr haddr;
335 #define sr_uuid _suid._srvUuid.suuid
336 #define sr_addr_uniquifier _suid._srvUuid.addr_uniquifier
337 #define sr_host _suid._srvId.haddr.ip
338 #define sr_portal _suid._srvId.haddr.portal
339 #define sr_rank _suid._srvId.haddr.ip_rank
340 #define sr_flags _suid._srvId.haddr.flags
341 #define sr_conns _suid._srvId.haddr.conns
342 struct server *next; /* Ptr to next server in hash chain */
343 struct cell *cell; /* Cell in which this host resides */
344 struct afs_cbr *cbrs; /* Return list of callbacks */
345 afs_int32 activationTime; /* Time when this record was first activated */
346 afs_int32 lastDowntimeStart; /* Time when last downtime incident began */
347 afs_int32 numDowntimeIncidents; /* # (completed) downtime incidents */
348 afs_int32 sumOfDowntimes; /* Total downtime experienced, in seconds */
349 struct srvAddr *addr;
350 char flags; /* Misc flags*/
353 #define afs_PutServer(servp, locktype)
355 /* structs for some pioctls - these are (or should be)
363 struct sprefrequest_33 {
364 unsigned short offset;
365 unsigned short num_servers;
369 struct sprefrequest { /* new struct for 3.4 */
370 unsigned short offset;
371 unsigned short num_servers;
372 unsigned short flags;
377 unsigned short next_offset;
378 unsigned short num_servers;
379 struct spref servers[1]; /* we overrun this array intentionally...*/
383 unsigned short flags;
384 unsigned short num_servers;
385 struct spref servers[1]; /* we overrun this array intentionally...*/
387 /* struct for GAG pioctl
390 afs_uint32 showflags, logflags, logwritethruflag, spare[3];
391 unsigned char spare2[128];
395 #define logwritethruON 1
398 afs_int32 rx_initReceiveWindow, rx_maxReceiveWindow,
399 rx_initSendWindow, rx_maxSendWindow, rxi_nSendFrags,
400 rxi_nRecvFrags, rxi_OrphanFragSize;
401 afs_int32 rx_maxReceiveSize, rx_MyMaxSendSize;
402 afs_uint32 spare[21];
405 /* struct for checkservers */
418 /* state bits for volume */
419 #define VRO 1 /* volume is readonly */
420 #define VRecheck 2 /* recheck volume info with server */
421 #define VBackup 4 /* is this a backup volume? */
422 #define VForeign 8 /* this is a non-afs volume */
423 #define VResort 16 /* server order was rearranged, sort when able */
424 #define VMoreReps 32 /* This volume has more replicas than we are */
425 /* keeping track of now -- check with VLDB */
427 enum repstate { not_busy, end_not_busy = 6, rd_busy, rdwr_busy, offline };
430 /* One structure per volume, describing where the volume is located
431 and where its mount points are. */
432 struct volume *next; /* Next volume in hash list. */
433 afs_int32 cell; /* the cell in which the volume resides */
434 afs_rwlock_t lock; /* the lock for this structure */
435 afs_int32 volume; /* This volume's ID number. */
436 char *name; /* This volume's name, or 0 if unknown */
437 struct server *serverHost[MAXHOSTS]; /* servers serving this volume */
438 enum repstate status[MAXHOSTS]; /* busy, offline, etc */
439 struct VenusFid dotdot; /* dir to access as .. */
440 struct VenusFid mtpoint; /* The mount point for this volume. */
441 afs_int32 rootVnode, rootUnique; /* Volume's root fid */
444 afs_int32 rwVol; /* For r/o vols, original read/write volume. */
445 afs_int32 accessTime; /* last time we used it */
446 afs_int32 vtix; /* volume table index */
447 afs_int32 copyDate; /* copyDate field, for tracking vol releases */
448 afs_int32 expireTime; /* for per-volume callbacks... */
449 short refCount; /* reference count for allocation */
450 char states; /* here for alignment reasons */
453 #define afs_PutVolume(av, locktype) ((av)->refCount--)
455 /* format of an entry in volume info file */
457 afs_int32 cell; /* cell for this entry */
458 afs_int32 volume; /* volume */
459 afs_int32 next; /* has index */
460 struct VenusFid dotdot; /* .. value */
461 struct VenusFid mtpoint; /* mt point's fid */
462 afs_int32 rootVnode, rootUnique; /* Volume's root fid */
466 struct SimpleLocks *next;
468 afs_int32 boff, eoff;
470 #if defined(AFS_AIX32_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
475 /* vcache state bits */
476 #define CStatd 1 /* has this file ever been stat'd? */
477 #define CBackup 2 /* file is on a backup volume */
478 #define CRO 4 /* is it on a read-only volume */
479 #define CMValid 8 /* is the mount point info valid? */
480 #define CCore 0x10 /* storing a core file, needed since we don't get an open */
481 #define CDirty 0x20 /* file has been modified since first open (... O_RDWR) */
482 #define CSafeStore 0x40 /* close must wait for store to finish (should be in fd) */
483 #define CMAPPED 0x80 /* Mapped files; primarily used by SunOS 4.0.x */
484 #define CNSHARE 0x100 /* support O_NSHARE semantics */
488 #define CWired 0x800 /* OSF hack only */
490 #define CWRITE_IGN 0x800 /* Next OS hack only */
492 #define CUnique 0x1000 /* vc's uniquifier - latest unifiquier for fid */
493 #define CForeign 0x2000 /* this is a non-afs vcache */
494 #define CHasPages 0x4000
495 #define CUnlinked 0x10000
496 #define CBulkStat 0x20000 /* loaded by a bulk stat, and not ref'd since */
497 #define CUnlinkedDel 0x40000
498 #define CVFlushed 0x80000
499 #define CCore1 0x100000 /* osf1 core file; not same as CCore above */
500 #define CWritingUFS 0x200000 /* to detect vm deadlock - used by sgi */
501 #define CCreating 0x400000 /* avoid needless store after open truncate */
502 #define CPageHog 0x800000 /* AIX - dumping large cores is a page hog. */
503 #define CDCLock 0x200000 /* Vnode lock held over call to GetDownD */
504 #define CBulkFetching 0x4000000 /* stats are being fetched by bulk stat */
505 #define CExtendedFile 0x8000000 /* extended file via ftruncate call. */
507 /* vcache vstate bits */
508 #define VRevokeWait 0x1
509 #define VPageCleaning 0x2 /* Solaris - Cache Trunc Daemon sez keep out */
512 #define vrefCount v.v_count
514 #define AFS_MAXDV 0x7fffffff /* largest dataversion number */
515 #define AFS_NOTRUNC 0x7fffffff /* largest dataversion number */
517 extern afs_int32 vmPageHog; /* counter for # of vnodes which are page hogs. */
520 * Fast map from vcache to dcache
527 afs_uint32 minLoc; /* smallest offset into dc. */
528 afs_uint32 len; /* largest offset into dc. */
531 extern afs_uint32 afs_stampValue; /* stamp for pair's usage */
532 #define MakeStamp() (++afs_stampValue)
534 /* INVARIANTs: (vlruq.next != NULL) == (vlruq.prev != NULL)
535 * nextfree => !vlruq.next && ! vlruq.prev
536 * !(avc->nextfree) && !avc->vlruq.next => (FreeVCList == avc->nextfree)
539 struct vnode v; /* Has reference count in v.v_count */
540 struct afs_q vlruq; /* lru q next and prev */
541 struct vcache *nextfree; /* next on free list (if free) */
542 struct vcache *hnext; /* Hash next */
546 afs_hyper_t DataVersion;
550 ushort Mode; /* XXXX Should be afs_int32 XXXX */
552 /* vnode type is in v.v_type */
554 afs_rwlock_t lock; /* The lock on the vcache contents. */
555 #if defined(AFS_SUN5_ENV)
556 /* Lock used to protect the activeV, multipage, and vstates fields.
557 * Do not try to get the vcache lock when the vlock is held */
559 #endif /* defined(AFS_SUN5_ENV) */
560 #if defined(AFS_SUN_ENV) || defined(AFS_ALPHA_ENV)
561 #if defined(AFS_SUN5_ENV)
565 afs_bozoLock_t pvnLock; /* see locks.x */
574 int ownslock; /* pid of owner of excl lock, else 0 - defect 3083 */
576 afs_int32 parentVnode; /* Parent dir, if a file. */
577 afs_int32 parentUnique;
578 struct VenusFid *mvid; /* Either parent dir (if root) or root (if mt pt) */
579 char *linkData; /* Link data if a symlink. */
580 afs_hyper_t flushDV; /* data version last flushed from text */
581 afs_hyper_t mapDV; /* data version last flushed from map */
582 afs_uint32 truncPos; /* truncate file to this position at next store */
583 struct server *callback; /* The callback host, if any */
584 afs_uint32 cbExpires; /* time the callback expires */
585 struct afs_q callsort; /* queue in expiry order, sort of */
586 struct axscache *Access; /* a list of cached access bits */
587 afs_int32 anyAccess; /* System:AnyUser's access to this. */
588 afs_int32 last_looker; /* pag/uid from last lookup here */
589 #if defined(AFS_SUN5_ENV)
591 #endif /* defined(AFS_SUN5_ENV) */
592 struct SimpleLocks *slocks;
593 short opens; /* The numbers of opens, read or write, on this file. */
594 short execsOrWriters; /* The number of execs (if < 0) or writers (if > 0) of
596 short flockCount; /* count of flock readers, or -1 if writer */
597 char mvstat; /* 0->normal, 1->mt pt, 2->root. */
598 afs_uint32 states; /* state bits */
599 #if defined(AFS_SUN5_ENV)
600 afs_uint32 vstates; /* vstate bits */
601 #endif /* defined(AFS_SUN5_ENV) */
603 afs_uint32 symhintstamp;
605 struct vcache *symhint;
606 struct dcache *dchint;
608 #ifdef AFS_LINUX22_ENV
609 u_short flushcnt; /* Number of flushes which haven't released yet. */
610 u_short mapcnt; /* Number of mappings of this file. */
612 #if defined(AFS_SGI_ENV)
613 daddr_t lastr; /* for read-ahead */
615 uint64_t vc_rwlockid; /* kthread owning rwlock */
617 short vc_rwlockid; /* pid of process owning rwlock */
619 short vc_locktrips; /* # of rwlock reacquisitions */
620 sema_t vc_rwlock; /* vop_rwlock for afs */
621 pgno_t mapcnt; /* # of pages mapped */
622 struct cred *cred; /* last writer's cred */
624 struct bhv_desc vc_bhv_desc; /* vnode's behavior data. */
626 #endif /* AFS_SGI_ENV */
627 afs_int32 vc_error; /* stash write error for this vnode. */
628 int xlatordv; /* Used by nfs xlator */
629 struct AFS_UCRED *uncred;
630 int asynchrony; /* num kbytes to store behind */
632 short multiPage; /* count of multi-page getpages in progress */
636 #define afs_symhint_inval(avc)
639 #define DONT_CHECK_MODE_BITS 0
640 #define CHECK_MODE_BITS 1
641 #define CMB_ALLOW_EXEC_AS_READ 2 /* For the NFS xlator */
643 #if defined(AFS_SGI_ENV)
644 #define AVCRWLOCK(avc) (valusema(&(avc)->vc_rwlock) <= 0)
646 /* SGI vnode rwlock macros and flags. */
647 #ifndef AFS_SGI62_ENV
648 /* The following are defined here. SGI 6.2 declares them in vnode.h */
649 #define VRWLOCK_READ 0
650 #define VRWLOCK_WRITE 1
651 #define VRWLOCK_WRITE_DIRECT 2
656 #define AFS_RWLOCK_T vrwlock_t
658 #define AFS_RWLOCK_T int
659 #endif /* AFS_SGI62_ENV */
661 #include <ksys/behavior.h>
662 #define AFS_RWLOCK(V,F) \
663 afs_rwlock(&(((struct vcache *)(V))->vc_bhv_desc), (F));
664 #define AFS_RWUNLOCK(V,F) \
665 afs_rwunlock(&(((struct vcache *)(V))->vc_bhv_desc), (F));
668 #define AFS_RWLOCK(V,F) afs_rwlock((vnode_t *)(V), (F) )
669 #define AFS_RWUNLOCK(V,F) afs_rwunlock((vnode_t *)(V), (F) )
671 #else /* AFS_SGI53_ENV */
672 #define AFS_RWLOCK(V,F) afs_rwlock((V))
673 #define AFS_RWUNLOCK(V,F) afs_rwunlock((V))
674 #endif /* AFS_SGI53_ENV */
675 #endif /* AFS_SGI_ENV */
679 afs_hyper_t DataVersion;
681 afs_int32 parentVnode;
682 afs_int32 parentUnique;
686 afs_int32 randomUid[CPSIZE];
687 afs_int32 callback; /* Now a pointer to 'server' struct */
689 afs_int32 randomAccess[CPSIZE];
692 short execsOrWriters;
703 /* CM inititialization parameters. What CM actually used after calculations
704 * based on passed in arguments.
706 #define CMI_VERSION 1 /* increment when adding new fields. */
707 struct cm_initparams {
712 int cmi_nVolumeCaches;
713 int cmi_firstChunkSize;
714 int cmi_otherChunkSize;
715 int cmi_cacheSize; /* The original cache size, in 1K blocks. */
716 unsigned cmi_setTime:1;
717 unsigned cmi_memCache:1;
718 int spare[16-9]; /* size of struct is 16 * 4 = 64 bytes */
722 /*----------------------------------------------------------------------
723 * AFS Data cache definitions
725 * Each entry describes a Unix file on the local disk that is
726 * is serving as a cached copy of all or part of a Vice file.
727 * Entries live in circular queues for each hash table slot
729 * Which queue is this thing in? Good question.
730 * A struct dcache entry is in the freeDSlot queue when not associated with a cache slot (file).
731 * Otherwise, it is in the DLRU queue. The freeDSlot queue uses the lruq.next field as
732 * its "next" pointer.
734 * Cache entries in the DLRU queue are either associated with vice files, in which case
735 * they are hashed by afs_dvnextTbl and afs_dcnextTbl pointers, or they are in the freeDCList
736 * and are not associated with any vice file. This last list uses the afs_dvnextTbl pointer for
737 * its "next" pointer.
738 *----------------------------------------------------------------------*/
740 #define NULLIDX (-1) /* null index definition */
741 /* struct dcache states bits */
742 #define DWriting 8 /* file being written (used for cache validation) */
745 #define DFNextStarted 1 /* next chunk has been prefetched already */
746 #define DFEntryMod 2 /* has entry itself been modified? */
747 #define DFFetching 4 /* file is currently being fetched */
748 #define DFWaiting 8 /* someone waiting for file */
749 #define DFFetchReq 0x10 /* someone is waiting for DFFetching to go on */
752 /* flags in afs_indexFlags array */
753 #define IFEverUsed 1 /* index entry has >= 1 byte of data */
754 #define IFFree 2 /* index entry in freeDCList */
755 #define IFDataMod 4 /* file needs to be written out */
756 #define IFFlag 8 /* utility flag */
757 #define IFDirtyPages 16
758 #define IFAnyPages 32
759 #define IFDiscarded 64 /* index entry in discardDCList */
762 char *in; /* input buffer */
763 char *out; /* output buffer */
764 short in_size; /* Size of input buffer <= 2K */
765 short out_size; /* Maximum size of output buffer, <= 2K */
769 * This version of afs_ioctl is required to pass in 32 bit user space
770 * pointers into a 64 bit kernel.
781 /* CacheItems file has a header of type struct afs_fheader
782 * (keep aligned properly). Since we already have sgi_62 clients running
783 * with a 32 bit inode, a change is required to the header so that
784 * they can distinguish the old 32 bit inode CacheItems file and zap it
785 * instead of using it.
788 #define AFS_FHMAGIC 0x7635abaf /* uses version number */
790 #if defined(AFS_SUN57_64BIT_ENV)
791 #define AFS_CI_VERSION 3
793 #define AFS_CI_VERSION 2
796 afs_int32 firstCSize;
797 afs_int32 otherCSize;
800 /* kept on disk and in dcache entries */
802 struct VenusFid fid; /* Fid for this file */
803 afs_int32 modTime; /* last time this entry was modified */
804 afs_hyper_t versionNo; /* Associated data version number */
805 afs_int32 chunk; /* Relative chunk number */
806 #if defined(AFS_SGI61_ENV) || defined(AFS_SUN57_64BIT_ENV)
807 /* Using ino64_t here so that user level debugging programs compile
808 * the size correctly.
810 ino64_t inode; /* Unix inode for this chunk */
812 #if defined(AFS_LINUX_64BIT_KERNEL)
813 long inode; /* Unix inode for this chunk */
815 afs_int32 inode; /* Unix inode for this chunk */
818 afs_int32 chunkBytes; /* Num bytes in this chunk */
819 char states; /* Has this chunk been modified? */
822 /* magic numbers to specify the cache type */
824 #define AFS_FCACHE_TYPE_UFS 0x0
825 #define AFS_FCACHE_TYPE_MEM 0x1
826 #define AFS_FCACHE_TYPE_NFS 0x2
827 #define AFS_FCACHE_TYPE_EPI 0x3
831 struct afs_q lruq; /* Free queue for in-memory images */
832 afs_rwlock_t lock; /* XXX */
833 short refCount; /* Associated reference count. */
834 afs_int32 index; /* The index in the CacheInfo file*/
835 short flags; /* more flags bits */
836 afs_int32 validPos; /* number of valid bytes during fetch */
837 struct fcache f; /* disk image */
838 afs_int32 stamp; /* used with vtodc struct for hints */
840 /* this is obsolete and should be removed */
843 /* macro to mark a dcache entry as bad */
846 (x)->f.fid.Fid.Unique = 0; \
847 afs_indexUnique[(x)->index] = 0; \
848 (x)->flags |= DFEntryMod; \
852 * Convenient release macro for use when afs_PutDCache would cause
853 * deadlock on afs_xdcache lock
855 #define lockedPutDCache(ad) ((ad)->refCount--)
857 /* FakeOpen and Fake Close used to be real subroutines. They're only used in
858 * sun_subr and afs_vnodeops, and they're very frequently called, so I made
859 * them into macros. They do:
860 * FakeOpen: fake the file being open for writing. avc->lock must be held
861 * in write mode. Having the file open for writing is like having a DFS
862 * write-token: you're known to have the best version of the data around,
863 * and so the CM won't let it be overwritten by random server info.
864 * FakeClose: undo the effects of FakeOpen, noting that we want to ensure
865 * that a real close eventually gets done. We use CCore to achieve this if
866 * we would end up closing the file. avc->lock must be held in write mode */
868 #ifdef AFS_AIX_IAUTH_ENV
869 #define CRKEEP(V, C) (V)->linkData = (char*)crdup((C))
871 #define CRKEEP(V, C) crhold((C)); (V)->linkData = (char*)(C)
874 #define afs_FakeOpen(avc) { avc->opens++; avc->execsOrWriters++; }
875 #define afs_FakeClose(avc, acred) \
876 { if (avc->execsOrWriters == 1) { \
877 /* we're the last writer, just use CCore flag */ \
878 avc->states |= CCore; /* causes close to be called later */ \
880 /* The cred and vnode holds will be released in afs_FlushActiveVcaches */ \
881 VN_HOLD((struct vnode *)avc); /* So it won't disappear */ \
882 CRKEEP(avc, acred); /* Should use a better place for the creds */ \
885 /* we're not the last writer, let the last one do the store-back for us */ \
887 avc->execsOrWriters--; \
891 #define AFS_ZEROS 64 /* zero buffer */
893 /*#define afs_DirtyPages(avc) (((avc)->states & CDirty) || osi_VMDirty_p((avc)))*/
894 #define afs_DirtyPages(avc) ((avc)->states & CDirty)
896 /* The PFlush algorithm makes use of the fact that Fid.Unique is not used in
897 below hash algorithms. Change it if need be so that flushing algorithm
898 doesn't move things from one hash chain to another
900 /* extern int afs_dhashsize; */
901 #define DCHash(v, c) ((((v)->Fid.Vnode + (v)->Fid.Volume + (c))) & (afs_dhashsize-1))
902 /*Vnode, Chunk -> Hash table index*/
903 #define DVHash(v) ((((v)->Fid.Vnode + (v)->Fid.Volume )) & (afs_dhashsize-1))
904 /*Vnode -> Other hash table index*/
905 /* don't hash on the cell, our callback-breaking code sometimes fails to compute
906 the cell correctly, and only scans one hash bucket */
907 #define VCHash(fid) (((fid)->Fid.Volume + (fid)->Fid.Vnode) & (VCSIZE-1))
909 extern struct dcache **afs_indexTable; /*Pointers to in-memory dcache entries*/
910 extern afs_int32 *afs_indexUnique; /*dcache entry Fid.Unique */
911 extern afs_int32 *afs_dvnextTbl; /*Dcache hash table links */
912 extern afs_int32 *afs_dcnextTbl; /*Dcache hash table links */
913 extern afs_int32 afs_cacheFiles; /*Size of afs_indexTable*/
914 extern afs_int32 afs_cacheBlocks; /*1K blocks in cache*/
915 extern afs_int32 afs_cacheStats; /*Stat entries in cache*/
916 extern struct vcache *afs_vhashT[VCSIZE]; /*Stat cache hash table*/
917 extern afs_int32 afs_initState; /*Initialization state*/
918 extern afs_int32 afs_termState; /* Termination state */
919 extern struct VenusFid afs_rootFid; /*Root for whole file system*/
920 extern afs_int32 afs_allCBs; /* Count of callbacks*/
921 extern afs_int32 afs_oddCBs; /* Count of odd callbacks*/
922 extern afs_int32 afs_evenCBs; /* Count of even callbacks*/
923 extern afs_int32 afs_allZaps; /* Count of fid deletes */
924 extern afs_int32 afs_oddZaps; /* Count of odd fid deletes */
925 extern afs_int32 afs_evenZaps; /* Count of even fid deletes */
926 extern struct brequest afs_brs[NBRS]; /* request structures */
928 #define UHash(auid) ((auid) & (NUSERS-1))
929 #define VHash(avol) ((avol)&(NVOLS-1))
930 #define SHash(aserv) ((ntohl(aserv)) & (NSERVERS-1))
931 #define FVHash(acell,avol) (((avol)+(acell)) & (NFENTRIES-1))
933 extern struct cell *afs_GetCell();
934 extern struct cell *afs_GetCellByName();
935 extern struct unixuser *afs_GetUser();
936 extern struct volume *afs_GetVolume();
937 extern struct volume *afs_GetVolumeByName();
938 extern struct conn *afs_Conn();
939 extern struct conn *afs_ConnByHost();
940 extern struct conn *afs_ConnByMHosts();
941 extern afs_int32 afs_NewCell();
942 extern struct dcache *afs_GetDCache();
943 extern struct dcache *afs_FindDCache();
944 extern struct dcache *afs_NewDCache();
945 extern struct dcache *afs_GetDSlot();
946 extern struct vcache *afs_GetVCache();
947 extern struct brequest *afs_BQueue();
950 extern int afs_CacheInit();
951 extern void afs_StoreWarn();
952 extern void afs_AdjustSize();
953 extern void afs_ComputeCacheParms();
954 extern void afs_FlushDCache();
955 extern void afs_FlushActiveVcaches();
956 extern void afs_StuffVcache();
957 extern void afs_PutVCache();
958 extern void afs_TryToSmush();
959 extern void afs_ProcessFS();
960 extern void afs_WriteThroughDSlots();
961 extern void shutdown_cache();
963 extern void afs_shutdown();
965 extern void shutdown_osifile();
968 /* Performance hack - we could replace VerifyVCache2 with the appropriate
969 * GetVCache incantation, and could eliminate even this code from afs_UFSRead
970 * by making intentionally invalidating quick.stamp in the various callbacks
971 * expiration/breaking code */
972 #ifdef AFS_LINUX20_ENV
973 #define afs_VerifyVCache(avc, areq) \
974 (((avc)->states & CStatd) ? (vcache2inode(avc), 0) : \
975 afs_VerifyVCache2((avc),areq))
977 #define afs_VerifyVCache(avc, areq) \
978 (((avc)->states & CStatd) ? 0 : afs_VerifyVCache2((avc),areq))
981 #define DO_STATS 1 /* bits used by FindVCache */
984 /* values for flag param of afs_CheckVolumeNames */
985 #define AFS_VOLCHECK_EXPIRED 0x1 /* volumes whose callbacks have expired */
986 #define AFS_VOLCHECK_BUSY 0x2 /* volumes which were marked busy */
987 #define AFS_VOLCHECK_MTPTS 0x4 /* mount point invalidation also */
988 #define AFS_VOLCHECK_FORCE 0x8 /* do all forcibly */
992 #define AFS_FSPORT ((unsigned short) htons(7000))
993 #define AFS_VLPORT ((unsigned short) htons(7003))
995 #define afs_read(avc, uio, acred, albn, abpp, nolock) \
996 (*(afs_cacheType->vread))(avc, uio, acred, albn, abpp, nolock)
997 #define afs_write(avc, uio, aio, acred, nolock) \
998 (*(afs_cacheType->vwrite))(avc, uio, aio, acred, nolock)
1000 #define afs_rdwr(avc, uio, rw, io, cred) \
1001 (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 0) : afs_read(avc, uio, cred, 0, 0, 0))
1002 #define afs_nlrdwr(avc, uio, rw, io, cred) \
1003 (((rw) == UIO_WRITE) ? afs_write(avc, uio, io, cred, 1) : afs_read(avc, uio, cred, 0, 0, 1))
1005 extern afs_int32 afs_blocksUsed, afs_blocksDiscarded;
1006 extern afs_int32 afs_discardDCCount, afs_freeDCCount;
1007 extern afs_int32 afs_bulkStatsDone, afs_bulkStatsLost;
1008 extern int afs_TruncateDaemonRunning;
1009 extern int afs_CacheTooFull;
1010 /* Cache size truncation uses the following low and high water marks:
1011 * If the cache is more than 95% full (CM_DCACHECOUNTFREEPCT), the cache
1012 * truncation daemon is awakened and will free up space until the cache is 85%
1013 * (CM_DCACHESPACEFREEPCT - CM_DCACHEEXTRAPCT) full.
1014 * afs_UFSWrite and afs_GetDCache (when it needs to fetch data) will wait on
1015 * afs_WaitForCacheDrain if the cache is 98% (CM_WAITFORDRAINPCT) full.
1016 * afs_GetDownD wakes those processes once the cache is 95% full
1017 * (CM_CACHESIZEDRAINEDPCT).
1019 extern void afs_CacheTruncateDaemon();
1020 extern int afs_WaitForCacheDrain;
1021 #define CM_MAXDISCARDEDCHUNKS 16 /* # of chunks */
1022 #define CM_DCACHECOUNTFREEPCT 95 /* max pct of chunks in use */
1023 #define CM_DCACHESPACEFREEPCT 90 /* max pct of space in use */
1024 #define CM_DCACHEEXTRAPCT 5 /* extra to get when freeing */
1025 #define CM_CACHESIZEDRAINEDPCT 95 /* wakeup processes when down to here.*/
1026 #define CM_WAITFORDRAINPCT 98 /* sleep if cache is this full. */
1028 #define afs_CacheIsTooFull() \
1029 (afs_blocksUsed - afs_blocksDiscarded > \
1030 (CM_DCACHECOUNTFREEPCT*afs_cacheBlocks)/100 || \
1031 afs_freeDCCount - afs_discardDCCount < \
1032 ((100-CM_DCACHECOUNTFREEPCT)*afs_cacheFiles)/100)
1034 #define afs_MaybeWakeupTruncateDaemon() \
1036 if (!afs_CacheTooFull && afs_CacheIsTooFull()) { \
1037 afs_CacheTooFull = 1; \
1038 if (!afs_TruncateDaemonRunning) { \
1039 afs_osi_Wakeup((char *)afs_CacheTruncateDaemon); \
1041 } else if (!afs_TruncateDaemonRunning && \
1042 afs_blocksDiscarded > CM_MAXDISCARDEDCHUNKS) { \
1043 afs_osi_Wakeup((char *)afs_CacheTruncateDaemon); \
1047 /* Handy max length of a numeric string. */
1048 #define CVBS 12 /* max afs_int32 is 2^32 ~ 4*10^9, +1 for NULL, +luck */
1050 extern int afs_norefpanic;
1051 #define refpanic(foo) if (afs_norefpanic) \
1052 { printf( foo ); afs_norefpanic++;} else osi_Panic( foo )
1057 ** these are defined in the AIX source code sys/fs_locks.h but are not
1058 ** defined anywhere in the /usr/include directory
1060 #if defined(AFS_AIX41_ENV)
1061 #define VN_LOCK(vp) simple_lock(&(vp)->v_lock)
1062 #define VN_UNLOCK(vp) simple_unlock(&(vp)->v_lock)
1065 #endif /* _AFS_H_ */