vcache-cleanup-20050529
[openafs.git] / src / afs / afs_cbqueue.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /*
11  * This package is used to actively manage the expiration of callbacks,
12  * so that the rest of the cache manager doesn't need to compute
13  * whether a callback has expired or not, but can tell with one simple
14  * check, that is, whether the CStatd bit is on or off.
15  *
16  * The base of the hash table moves periodically (every 128 seconds)
17  * QueueCallback rarely touches the first 3 slots in the hash table
18  * (only when called from CheckCallbacks) since MinTimeOut in
19  * viced/callback.c is currently 7 minutes. 
20  * Therefore, CheckCallbacks should be able to run concurrently with
21  * QueueCallback, given the proper locking, of course.
22  *
23  * Note:
24  * 1. CheckCallbacks and BumpBase never run simultaneously.  This is because
25  * they are only called from afs_Daemon.  Therefore, base and basetime will 
26  * always be consistent during CheckCallbacks.
27  * 2. cbHashT [base] rarely (if ever) gets stuff queued in it.  The only way 
28  * that could happen is CheckCallbacks might fencepost and move something in
29  * place, or BumpBase might push some stuff up.
30  * 3. Hash chains aren't particularly sorted. 
31  * 4. The file server keeps its callback state around for 3 minutes
32  * longer than it promises the cache manager in order to account for
33  * clock skew, network delay, and other bogeymen.
34  *
35  * For now I just use one large lock, which is fine on a uniprocessor,
36  * since it's not held during any RPCs or low-priority I/O operations. 
37  * To make this code MP-fast, you need no more locks than processors, 
38  * but probably more than one.  In measurements on MP-safe implementations, 
39  * I have never seen any contention over the xcbhash lock.
40  *
41  * Incompatible operations:
42  * Enqueue and "dequeue of first vcache" in same slot
43  * dequeue and "dequeue of preceding vcache" in same slot
44  * dequeue and "dequeue of successive vcache" in same slot
45  * BumpBase pushing a list and enqueue in the new base slot
46  * Two enqueues in same slot
47  * more...
48  *
49  * Certain invariants exist:
50  *    1  Callback expiration times granted by a file server will never
51  *       decrease for a particular vnode UNLESS a CallBack RPC is invoked
52  *       by the server in the interim.  
53  *    2  A vcache will always expire no sooner than the slot in which it is
54  *       currently enqueued.  Callback times granted by the server may 
55  *       increase, in which case the vcache will be updated in-place.  As a 
56  *       result, it may expire later than the slot in which it is enqueued.  
57  *       Not to worry, the CheckCallbacks code will move it if neccessary.
58  *       This approach means that busy vnodes won't be continually moved 
59  *       around within the expiry queue: they are only moved when they
60  *       finally advance to the lead bucket.
61  *    3  Anything which has a callback on it must be in the expiry
62  *       queue.  In AFS 3.3, that means everything but symlinks (which
63  *       are immutable), including contents of Read-Only volumes
64  *       (which have callbacks by virtue of the whole-volume callback)
65  *
66  * QueueCallback only checks that its vcache is in the list
67  * somewhere, counting on invariant #1 to guarantee that the vcache
68  * won't be in a slot later than QueueCallback would otherwise place
69  * it. Therefore, whenever we turn off the CStatd bit on the vcache, we
70  * *must* remove the vcache from the expiry queue.  Otherwise, we
71  * might have missed a CallBack RPC, and a subsequent callback might be
72  * granted with a shorter expiration time.
73  */
74 #include <afsconfig.h>
75 #include "afs/param.h"
76
77 RCSID
78     ("$Header$");
79
80 #include "afs/sysincludes.h"    /*Standard vendor system headers */
81 #include "afsincludes.h"        /*AFS-based standard headers */
82 #include "afs/afs_cbqueue.h"
83 #include "afs/afs.h"
84 #include "afs/lock.h"
85 #include "afs/afs_stats.h"
86
87 static unsigned int base = 0;
88 static unsigned int basetime = 0;
89 static struct vcache *debugvc;  /* used only for post-mortem debugging */
90 struct bucket {
91     struct afs_q head;
92     /*  struct afs_lock lock;  only if you want lots of locks... */
93 };
94 static struct bucket cbHashT[CBHTSIZE];
95 struct afs_lock afs_xcbhash;
96
97 /* afs_QueueCallback
98  * Takes a write-locked vcache pointer and a callback expiration time
99  * as returned by the file server (ie, in units of 128 seconds from "now").
100  * 
101  * Uses the time as an index into a hash table, and inserts the vcache
102  * structure into the overflow chain.
103  * 
104  * If the vcache is already on some hash chain, leave it there.
105  * CheckCallbacks will get to it eventually.  In the meantime, it
106  * might get flushed, or it might already be on the right hash chain, 
107  * so why bother messing with it now?
108  *
109  * NOTE: The caller must hold a write lock on afs_xcbhash
110  */
111
112 void
113 afs_QueueCallback(struct vcache *avc, unsigned int atime, struct volume *avp)
114 {
115     if (avp && (avp->expireTime < avc->cbExpires))
116         avp->expireTime = avc->cbExpires;
117     if (!(avc->callsort.next)) {
118         atime = (atime + base) % CBHTSIZE;
119         QAdd(&(cbHashT[atime].head), &(avc->callsort));
120     }
121
122     return;
123 }                               /* afs_QueueCallback */
124
125 /* afs_DequeueCallback
126  * Takes a write-locked vcache pointer and removes it from the callback
127  * hash table, without knowing beforehand which slot it was in.
128  *
129  * for now, just get a lock on everything when doing the dequeue, don't
130  * worry about getting a lock on the individual slot.
131  * 
132  * the only other places that do anything like dequeues are CheckCallbacks
133  * and BumpBase.
134  *
135  * NOTE: The caller must hold a write lock on afs_xcbhash
136  */
137 void
138 afs_DequeueCallback(struct vcache *avc)
139 {
140
141     debugvc = avc;
142     if (avc->callsort.prev) {
143         QRemove(&(avc->callsort));
144         avc->callsort.prev = avc->callsort.next = NULL;
145     } else;                     /* must have got dequeued in a race */
146
147     return;
148 }                               /* afs_DequeueCallback */
149
150 /* afs_CheckCallbacks
151  * called periodically to determine which callbacks are likely to
152  * expire in the next n second interval.  Preemptively marks them as
153  * expired.  Rehashes items which are now in the wrong hash bucket.
154  * Preemptively renew recently-accessed items.  Only removes things
155  * from the first and second bucket (as long as secs < 128), and
156  * inserts things into other, later buckets.  either need to advance
157  * to the second bucket if secs spans two intervals, or else be
158  * certain to call afs_CheckCallbacks immediately after calling
159  * BumpBase (allows a little more slop but it's ok because file server
160  * keeps 3 minutes of slop time)
161  *
162  * There is a little race between CheckCallbacks and any code which
163  * updates cbExpires, always just prior to calling QueueCallback. We
164  * don't lock the vcache struct here (can't, or we'd risk deadlock),
165  * so GetVCache (for example) may update cbExpires before or after #1
166  * below.  If before, CheckCallbacks moves this entry to its proper
167  * slot.  If after, GetVCache blocks in the call to QueueCallbacks,
168  * this code dequeues the vcache, and then QueueCallbacks re-enqueues it. 
169  *
170  * XXX to avoid the race, make QueueCallback take the "real" time
171  * and update cbExpires under the xcbhash lock. 
172  *
173  * NB #1: There's a little optimization here: if I go to invalidate a
174  * RO vcache or volume, first check to see if the server is down.  If
175  * it _is_, don't invalidate it, cuz we might just as well keep using
176  * it.  Possibly, we could do the same thing for items in RW volumes,
177  * but that bears some drinking about.
178  *
179  * Don't really need to invalidate the hints, we could just wait to see if
180  * the dv has changed after a subsequent FetchStatus, but this is safer.
181  */
182
183 /* Sanity check on the callback queue. Allow for slop in the computation. */
184 #ifdef AFS_OSF_ENV
185 #define CBQ_LIMIT (afs_maxvcount + 10)
186 #else
187 #define CBQ_LIMIT (afs_cacheStats + afs_stats_cmperf.vcacheXAllocs + 10)
188 #endif
189
190 void
191 afs_CheckCallbacks(unsigned int secs)
192 {
193     struct vcache *tvc;
194     register struct afs_q *tq;
195     struct afs_q *uq;
196     afs_uint32 now;
197     struct volume *tvp;
198     register int safety;
199
200     ObtainWriteLock(&afs_xcbhash, 85);  /* pretty likely I'm going to remove something */
201     now = osi_Time();
202     for (safety = 0, tq = cbHashT[base].head.prev;
203          (safety <= CBQ_LIMIT) && (tq != &(cbHashT[base].head));
204          tq = uq, safety++) {
205
206         uq = QPrev(tq);
207         tvc = CBQTOV(tq);
208         if (tvc->cbExpires < now + secs) {      /* race #1 here */
209             /* Get the volume, and if its callback expiration time is more than secs
210              * seconds into the future, update this vcache entry and requeue it below
211              */
212             if ((tvc->states & CRO)
213                 && (tvp = afs_FindVolume(&(tvc->fid), READ_LOCK))) {
214                 if (tvp->expireTime > now + secs) {
215                     tvc->cbExpires = tvp->expireTime;   /* XXX race here */
216                 } else {
217                     int i;
218                     for (i = 0; i < MAXHOSTS && tvp->serverHost[i]; i++) {
219                         if (!(tvp->serverHost[i]->flags & SRVR_ISDOWN)) {
220                             /* What about locking xvcache or vrefcount++ or
221                              * write locking tvc? */
222                             QRemove(tq);
223                             tq->prev = tq->next = NULL;
224                             tvc->states &= ~(CStatd | CMValid | CUnique);
225                             if ((tvc->fid.Fid.Vnode & 1)
226                                 || (vType(tvc) == VDIR))
227                                 osi_dnlc_purgedp(tvc);
228                             tvc->dchint = NULL; /*invalidate em */
229                             afs_ResetVolumeInfo(tvp);
230                             break;
231                         }
232                     }
233                 }
234                 afs_PutVolume(tvp, READ_LOCK);
235             } else {
236                 /* Do I need to worry about things like execsorwriters?
237                  * What about locking xvcache or vrefcount++ or write locking tvc?
238                  */
239                 QRemove(tq);
240                 tq->prev = tq->next = NULL;
241                 tvc->states &= ~(CStatd | CMValid | CUnique);
242                 if ((tvc->fid.Fid.Vnode & 1) || (vType(tvc) == VDIR))
243                     osi_dnlc_purgedp(tvc);
244             }
245         }
246
247         if ((tvc->cbExpires > basetime) && CBHash(tvc->cbExpires - basetime)) {
248             /* it's been renewed on us.  Have to be careful not to put it back
249              * into this slot, or we may never get out of here.
250              */
251             int slot;
252             slot = (CBHash(tvc->cbExpires - basetime) + base) % CBHTSIZE;
253             if (slot != base) {
254                 if (QPrev(tq))
255                     QRemove(&(tvc->callsort));
256                 QAdd(&(cbHashT[slot].head), &(tvc->callsort));
257                 /* XXX remember to update volume expiration time */
258                 /* -- not needed for correctness, though */
259             }
260         }
261     }
262
263     if (safety > CBQ_LIMIT) {
264         afs_stats_cmperf.cbloops++;
265         if (afs_paniconwarn)
266             osi_Panic("CheckCallbacks");
267
268         afs_warn
269             ("AFS Internal Error (minor): please contact AFS Product Support.\n");
270         ReleaseWriteLock(&afs_xcbhash);
271         afs_FlushCBs();
272         return;
273     } else
274         ReleaseWriteLock(&afs_xcbhash);
275
276
277 /* XXX future optimization:
278    if this item has been recently accessed, queue up a stat for it.
279    {
280    struct dcache * adc;
281
282    ObtainReadLock(&afs_xdcache);
283    if ((adc = tvc->quick.dc) && (adc->stamp == tvc->quick.stamp)
284    && (afs_indexTimes[adc->index] > afs_indexCounter - 20)) {
285    queue up the stat request
286    }
287    ReleaseReadLock(&afs_xdcache);
288    }
289    */
290
291     return;
292 }                               /* afs_CheckCallback */
293
294 /* afs_FlushCBs 
295  * to be used only in dire circumstances, this drops all callbacks on
296  * the floor, without giving them back to the server.  It's ok, the server can 
297  * deal with it, but it is a little bit rude.
298  */
299 void
300 afs_FlushCBs(void)
301 {
302     register int i;
303     register struct vcache *tvc;
304
305     ObtainWriteLock(&afs_xcbhash, 86);  /* pretty likely I'm going to remove something */
306
307     for (i = 0; i < VCSIZE; i++)        /* reset all the vnodes */
308         for (tvc = afs_vhashT[i]; tvc; tvc = tvc->hnext) {
309             tvc->callback = 0;
310             tvc->dchint = NULL; /* invalidate hints */
311             tvc->states &= ~(CStatd);
312             if ((tvc->fid.Fid.Vnode & 1) || (vType(tvc) == VDIR))
313                 osi_dnlc_purgedp(tvc);
314             tvc->callsort.prev = tvc->callsort.next = NULL;
315         }
316
317     afs_InitCBQueue(0);
318
319     ReleaseWriteLock(&afs_xcbhash);
320 }
321
322 /* afs_FlushServerCBs
323  * to be used only in dire circumstances, this drops all callbacks on
324  * the floor for a specific server, without giving them back to the server.
325  * It's ok, the server can deal with it, but it is a little bit rude.
326  */
327 void
328 afs_FlushServerCBs(struct server *srvp)
329 {
330     register int i;
331     register struct vcache *tvc;
332
333     ObtainWriteLock(&afs_xcbhash, 86);  /* pretty likely I'm going to remove something */
334
335     for (i = 0; i < VCSIZE; i++) {      /* reset all the vnodes */
336         for (tvc = afs_vhashT[i]; tvc; tvc = tvc->hnext) {
337             if (tvc->callback == srvp) {
338                 tvc->callback = 0;
339                 tvc->dchint = NULL;     /* invalidate hints */
340                 tvc->states &= ~(CStatd);
341                 if ((tvc->fid.Fid.Vnode & 1) || (vType(tvc) == VDIR)) {
342                     osi_dnlc_purgedp(tvc);
343                 }
344                 afs_DequeueCallback(tvc);
345             }
346         }
347     }
348
349     ReleaseWriteLock(&afs_xcbhash);
350 }
351
352 /* afs_InitCBQueue
353  *  called to initialize static and global variables associated with
354  *  the Callback expiration management mechanism.
355  */
356 void
357 afs_InitCBQueue(int doLockInit)
358 {
359     register int i;
360
361     memset((char *)cbHashT, 0, CBHTSIZE * sizeof(struct bucket));
362     for (i = 0; i < CBHTSIZE; i++) {
363         QInit(&(cbHashT[i].head));
364         /* Lock_Init(&(cbHashT[i].lock)); only if you want lots of locks, which 
365          * don't seem too useful at present.  */
366     }
367     base = 0;
368     basetime = osi_Time();
369     if (doLockInit)
370         Lock_Init(&afs_xcbhash);
371 }
372
373 /* Because there are no real-time guarantees, and especially because a
374  * thread may wait on a lock indefinitely, this routine has to be
375  * careful that it doesn't get permanently out-of-date.  Important
376  * assumption: this routine is only called from afs_Daemon, so there
377  * can't be more than one instance of this running at any one time.
378  * Presumes that basetime is never 0, and is always sane. 
379  *
380  * Before calling this routine, be sure that the first slot is pretty
381  * empty.  This -20 is because the granularity of the checks in
382  * afs_Daemon is pretty large, so I'd rather err on the side of safety
383  * sometimes.  The fact that I only bump basetime by CBHTSLOTLEN-1
384  * instead of the whole CBHTSLOTLEN is also for "safety".
385  * Conceptually, it makes this clock run just a little faster than the
386  * clock governing which slot a callback gets hashed into.  Both of these 
387  * things make CheckCallbacks work a little harder than it would have to 
388  * if I wanted to cut things finer.
389  * Everything from the old first slot is carried over into the new first
390  * slot.  Thus, if there were some things that ought to have been invalidated,
391  * but weren't (say, if the server was down), they will be examined at every
392  * opportunity thereafter.
393  */
394 int
395 afs_BumpBase(void)
396 {
397     afs_uint32 now;
398     int didbump;
399     u_int oldbase;
400
401     ObtainWriteLock(&afs_xcbhash, 87);
402     didbump = 0;
403     now = osi_Time();
404     while (basetime + (CBHTSLOTLEN - 20) <= now) {
405         oldbase = base;
406         basetime += CBHTSLOTLEN - 1;
407         base = (base + 1) % CBHTSIZE;
408         didbump++;
409         if (!QEmpty(&(cbHashT[oldbase].head))) {
410             QCat(&(cbHashT[oldbase].head), &(cbHashT[base].head));
411         }
412     }
413     ReleaseWriteLock(&afs_xcbhash);
414
415     return didbump;
416 }