comment assumptions in lih0_r
[openafs.git] / src / viced / callback.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  * Portions Copyright (c) 2006 Sine Nomine Associates
10  */
11
12 /*
13  * NEW callback package callback.c (replaces vicecb.c)
14  * Updated call back routines, NOW with:
15  * 
16  *     Faster DeleteVenus (Now called DeleteAllCallBacks)
17  *     Call back breaking for volumes
18  *     Adaptive timeouts on call backs
19  *     Architected for Multi RPC
20  *     No locks (currently implicit vnode locks--these will go, to)
21  *     Delayed call back when rpc connection down.
22  *     Bulk break of delayed call backs when rpc connection
23  *         reestablished
24  *     Strict limit on number of call backs.
25  *
26  * InitCallBack(nblocks)
27  *     Initialize: nblocks is max number # of file entries + # of callback entries
28  *     nblocks must be < 65536
29  *     Space used is nblocks*16 bytes
30  *     Note that space will be reclaimed by breaking callbacks of old hosts
31  * 
32  * time = AddCallBack(host, fid)
33  *     Add a call back.
34  *     Returns the expiration time at the workstation.
35  * 
36  * BreakCallBack(host, fid)
37  *     Break all call backs for fid, except for the specified host.
38  *     Delete all of them.
39  * 
40  * BreakVolumeCallBacks(volume)
41  *     Break all call backs on volume, using single call to each host
42  *     Delete all the call backs.
43  * 
44  * DeleteCallBack(host,fid)
45  *     Delete (do not break) single call back for fid.
46  * 
47  * DeleteFileCallBacks(fid)
48  *     Delete (do not break) all call backs for fid.
49  *
50  * DeleteAllCallBacks(host)
51  *     Delete (do not break) all call backs for host.
52  * 
53  * CleanupTimedOutCallBacks()
54  *     Delete all timed out call back entries
55  *     Must be called periodically by file server.
56  * 
57  * BreakDelayedCallBacks(host)
58  *     Break all delayed call backs for host.
59  *     Returns 1: one or more failed, 0: success.
60  * 
61  * PrintCallBackStats()
62  *     Print statistics about call backs to stdout.
63  * 
64  * DumpCallBacks() ---wishful thinking---
65  *     Dump call back state to /tmp/callback.state.
66  *     This is separately interpretable by the program pcb.
67  *
68  * Notes:  In general, if a call back to a host doesn't get through,
69  * then HostDown, supplied elsewhere, is called.  BreakDelayedCallBacks,
70  * however, does not call HostDown, but instead returns an indication of
71  * success if all delayed call backs were finally broken.
72  *
73  * BreakDelayedCallBacks MUST be called at the first sign of activity
74  * from the host after HostDown has been called (or a previous
75  * BreakDelayedCallBacks failed). The BreakDelayedCallBacks must be
76  * allowed to complete before any requests from that host are handled.
77  * If BreakDelayedCallBacks fails, then the host should remain
78  * down (and the request should be failed).
79
80  * CleanupCallBacks MUST be called periodically by the file server for
81  * this package to work correctly.  Every 5 minutes is suggested.
82  */
83
84 #include <afsconfig.h>
85 #include <afs/param.h>
86
87
88 #include <stdio.h>
89 #include <stdlib.h>             /* for malloc() */
90 #include <time.h>               /* ANSI standard location for time stuff */
91 #include <string.h>
92 #ifdef AFS_NT40_ENV
93 #include <fcntl.h>
94 #include <io.h>
95 #else
96 #include <sys/time.h>
97 #include <sys/file.h>
98 #include <unistd.h>
99 #endif
100 #include <afs/assert.h>
101
102 #include <afs/stds.h>
103
104 #include <afs/nfs.h>            /* yuck.  This is an abomination. */
105 #include <lwp.h>
106 #include <rx/rx.h>
107 #include <afs/afscbint.h>
108 #include <afs/afsutil.h>
109 #include <lock.h>
110 #include <afs/ihandle.h>
111 #include <afs/vnode.h>
112 #include <afs/volume.h>
113 #include "viced_prototypes.h"
114 #include "viced.h"
115
116 #include <afs/ptclient.h>       /* need definition of prlist for host.h */
117 #include "host.h"
118 #include "callback.h"
119 #ifdef AFS_DEMAND_ATTACH_FS
120 #include "../tviced/serialize_state.h"
121 #endif /* AFS_DEMAND_ATTACH_FS */
122
123
124 extern afsUUID FS_HostUUID;
125 extern int hostCount;
126
127 #ifndef INTERPRET_DUMP
128 static int ShowProblems = 1;
129 #endif
130
131 struct cbcounters cbstuff;
132
133 static struct FileEntry * FE = NULL;    /* don't use FE[0] */
134 static struct CallBack * CB = NULL;     /* don't use CB[0] */
135
136 static struct CallBack * CBfree = NULL;
137 static struct FileEntry * FEfree = NULL;
138
139
140 /* Time to live for call backs depends upon number of users of the file.
141  * TimeOuts is indexed by this number/8 (using TimeOut macro).  Times
142  * in this table are for the workstation; server timeouts, add
143  * ServerBias */
144
145 static int TimeOuts[] = {
146 /* Note: don't make the first entry larger than 4 hours (see above) */
147     4 * 60 * 60,                /* 0-7 users */
148     1 * 60 * 60,                /* 8-15 users */
149     30 * 60,                    /* 16-23 users */
150     15 * 60,                    /* 24-31 users */
151     15 * 60,                    /* 32-39 users */
152     10 * 60,                    /* 40-47 users */
153     10 * 60,                    /* 48-55 users */
154     10 * 60,                    /* 56-63 users */
155 };                              /* Anything more: MinTimeOut */
156
157 /* minimum time given for a call back */
158 #ifndef INTERPRET_DUMP
159 static int MinTimeOut = (7 * 60);
160 #endif
161
162 /* Heads of CB queues; a timeout index is 1+index into this array */
163 static afs_uint32 timeout[CB_NUM_TIMEOUT_QUEUES];
164
165 static afs_int32 tfirst;        /* cbtime of oldest unexpired call back time queue */
166
167
168 /* 16 byte object get/free routines */
169 struct object {
170     struct object *next;
171 };
172
173 /* Prototypes for static routines */
174 static struct FileEntry *FindFE(register AFSFid * fid);
175
176 #ifndef INTERPRET_DUMP
177 static struct CallBack *iGetCB(register int *nused);
178 static int iFreeCB(register struct CallBack *cb, register int *nused);
179 static struct FileEntry *iGetFE(register int *nused);
180 static int iFreeFE(register struct FileEntry *fe, register int *nused);
181 static int TAdd(register struct CallBack *cb, register afs_uint32 * thead);
182 static int TDel(register struct CallBack *cb);
183 static int HAdd(register struct CallBack *cb, register struct host *host);
184 static int HDel(register struct CallBack *cb);
185 static int CDel(struct CallBack *cb, int deletefe);
186 static int CDelPtr(register struct FileEntry *fe, register afs_uint32 * cbp,
187                    int deletefe);
188 static afs_uint32 *FindCBPtr(struct FileEntry *fe, struct host *host);
189 static int FDel(register struct FileEntry *fe);
190 static int AddCallBack1_r(struct host *host, AFSFid * fid, afs_uint32 * thead,
191                           int type, int locked);
192 static void MultiBreakCallBack_r(struct cbstruct cba[], int ncbas,
193                                  struct AFSCBFids *afidp, struct host *xhost);
194 static int MultiBreakVolumeCallBack_r(struct host *host, int isheld,
195                                       struct VCBParams *parms, int deletefe);
196 static int MultiBreakVolumeCallBack(struct host *host, int isheld,
197                                     void *rock);
198 static int MultiBreakVolumeLaterCallBack(struct host *host, int isheld,
199                                          void *rock);
200 static int GetSomeSpace_r(struct host *hostp, int locked);
201 static int ClearHostCallbacks_r(struct host *hp, int locked);
202 #endif
203
204 #define GetCB() ((struct CallBack *)iGetCB(&cbstuff.nCBs))
205 #define GetFE() ((struct FileEntry *)iGetFE(&cbstuff.nFEs))
206 #define FreeCB(cb) iFreeCB((struct CallBack *)cb, &cbstuff.nCBs)
207 #define FreeFE(fe) iFreeFE((struct FileEntry *)fe, &cbstuff.nFEs)
208
209
210 /* Other protos - move out sometime */
211 void PrintCB(register struct CallBack *cb, afs_uint32 now);
212
213 static afs_uint32 HashTable[FEHASH_SIZE];       /* File entry hash table */
214
215 static struct FileEntry *
216 FindFE(register AFSFid * fid)
217 {
218     int hash;
219     register int fei;
220     register struct FileEntry *fe;
221
222     hash = FEHash(fid->Volume, fid->Unique);
223     for (fei = HashTable[hash]; fei; fei = fe->fnext) {
224         fe = itofe(fei);
225         if (fe->volid == fid->Volume && fe->unique == fid->Unique
226             && fe->vnode == fid->Vnode && (fe->status & FE_LATER) != FE_LATER)
227             return fe;
228     }
229     return 0;
230 }
231
232 #ifndef INTERPRET_DUMP
233
234 static struct CallBack *
235 iGetCB(register int *nused)
236 {
237     register struct CallBack *ret;
238
239     if ((ret = CBfree)) {
240         CBfree = (struct CallBack *)(((struct object *)ret)->next);
241         (*nused)++;
242     }
243     return ret;
244 }
245
246 static int
247 iFreeCB(register struct CallBack *cb, register int *nused)
248 {
249     ((struct object *)cb)->next = (struct object *)CBfree;
250     CBfree = cb;
251     (*nused)--;
252     return 0;
253 }
254
255 static struct FileEntry *
256 iGetFE(register int *nused)
257 {
258     register struct FileEntry *ret;
259
260     if ((ret = FEfree)) {
261         FEfree = (struct FileEntry *)(((struct object *)ret)->next);
262         (*nused)++;
263     }
264     return ret;
265 }
266
267 static int
268 iFreeFE(register struct FileEntry *fe, register int *nused)
269 {
270     ((struct object *)fe)->next = (struct object *)FEfree;
271     FEfree = fe;
272     (*nused)--;
273     return 0;
274 }
275
276 /* Add cb to end of specified timeout list */
277 static int
278 TAdd(register struct CallBack *cb, register afs_uint32 * thead)
279 {
280     if (!*thead) {
281         (*thead) = cb->tnext = cb->tprev = cbtoi(cb);
282     } else {
283         register struct CallBack *thp = itocb(*thead);
284
285         cb->tprev = thp->tprev;
286         cb->tnext = *thead;
287         if (thp) {
288             if (thp->tprev)
289                 thp->tprev = (itocb(thp->tprev)->tnext = cbtoi(cb));
290             else
291                 thp->tprev = cbtoi(cb);
292         }
293     }
294     cb->thead = ttoi(thead);
295     return 0;
296 }
297
298 /* Delete call back entry from timeout list */
299 static int
300 TDel(register struct CallBack *cb)
301 {
302     register afs_uint32 *thead = itot(cb->thead);
303
304     if (*thead == cbtoi(cb))
305         *thead = (*thead == cb->tnext ? 0 : cb->tnext);
306     if (itocb(cb->tprev))
307         itocb(cb->tprev)->tnext = cb->tnext;
308     if (itocb(cb->tnext))
309         itocb(cb->tnext)->tprev = cb->tprev;
310     return 0;
311 }
312
313 /* Add cb to end of specified host list */
314 static int
315 HAdd(register struct CallBack *cb, register struct host *host)
316 {
317     cb->hhead = h_htoi(host);
318     if (!host->cblist) {
319         host->cblist = cb->hnext = cb->hprev = cbtoi(cb);
320     } else {
321         register struct CallBack *fcb = itocb(host->cblist);
322
323         cb->hprev = fcb->hprev;
324         cb->hnext = cbtoi(fcb);
325         fcb->hprev = (itocb(fcb->hprev)->hnext = cbtoi(cb));
326     }
327     return 0;
328 }
329
330 /* Delete call back entry from host list */
331 static int
332 HDel(register struct CallBack *cb)
333 {
334     register afs_uint32 *hhead = &h_itoh(cb->hhead)->cblist;
335
336     if (*hhead == cbtoi(cb))
337         *hhead = (*hhead == cb->hnext ? 0 : cb->hnext);
338     itocb(cb->hprev)->hnext = cb->hnext;
339     itocb(cb->hnext)->hprev = cb->hprev;
340     return 0;
341 }
342
343 /* Delete call back entry from fid's chain of cb's */
344 /* N.B.  This one also deletes the CB, and also possibly parent FE, so
345  * make sure that it is not on any other list before calling this
346  * routine */
347 static int
348 CDel(struct CallBack *cb, int deletefe)
349 {
350     int cbi = cbtoi(cb);
351     struct FileEntry *fe = itofe(cb->fhead);
352     register afs_uint32 *cbp;
353     register int safety;
354
355     for (safety = 0, cbp = &fe->firstcb; *cbp && *cbp != cbi;
356          cbp = &itocb(*cbp)->cnext, safety++) {
357         if (safety > cbstuff.nblks + 10) {
358             assert(0);
359             ViceLog(0,
360                     ("CDel: Internal Error -- shutting down: wanted %d from %d, now at %d\n",
361                      cbi, fe->firstcb, *cbp));
362             DumpCallBackState();
363             ShutDownAndCore(PANIC);
364         }
365     }
366     CDelPtr(fe, cbp, deletefe);
367     return 0;
368 }
369
370 /* Same as CDel, but pointer to parent pointer to CB entry is passed,
371  * as well as file entry */
372 /* N.B.  This one also deletes the CB, and also possibly parent FE, so
373  * make sure that it is not on any other list before calling this
374  * routine */
375 static int Ccdelpt = 0, CcdelB = 0;
376
377 static int
378 CDelPtr(register struct FileEntry *fe, register afs_uint32 * cbp,
379         int deletefe)
380 {
381     register struct CallBack *cb;
382
383     if (!*cbp)
384         return 0;
385     Ccdelpt++;
386     cb = itocb(*cbp);
387     if (cb != &CB[*cbp])
388         CcdelB++;
389     *cbp = cb->cnext;
390     FreeCB(cb);
391     if ((--fe->ncbs == 0) && deletefe)
392         FDel(fe);
393     return 0;
394 }
395
396 static afs_uint32 *
397 FindCBPtr(struct FileEntry *fe, struct host *host)
398 {
399     register afs_uint32 hostindex = h_htoi(host);
400     register struct CallBack *cb;
401     register afs_uint32 *cbp;
402     register int safety;
403
404     for (safety = 0, cbp = &fe->firstcb; *cbp; cbp = &cb->cnext, safety++) {
405         if (safety > cbstuff.nblks) {
406             ViceLog(0, ("FindCBPtr: Internal Error -- shutting down.\n"));
407             DumpCallBackState();
408             ShutDownAndCore(PANIC);
409         }
410         cb = itocb(*cbp);
411         if (cb->hhead == hostindex)
412             break;
413     }
414     return cbp;
415 }
416
417 /* Delete file entry from hash table */
418 static int
419 FDel(register struct FileEntry *fe)
420 {
421     register int fei = fetoi(fe);
422     register afs_uint32 *p = &HashTable[FEHash(fe->volid, fe->unique)];
423
424     while (*p && *p != fei)
425         p = &itofe(*p)->fnext;
426     assert(*p);
427     *p = fe->fnext;
428     FreeFE(fe);
429     return 0;
430 }
431
432 /* initialize the callback package */
433 int
434 InitCallBack(int nblks)
435 {
436     H_LOCK;
437     tfirst = CBtime(FT_ApproxTime());
438     /* N.B. The "-1", below, is because
439      * FE[0] and CB[0] are not used--and not allocated */
440     FE = ((struct FileEntry *)(calloc(nblks, sizeof(struct FileEntry))));
441     if (!FE) {
442         ViceLog(0, ("Failed malloc in InitCallBack\n"));
443         assert(0);
444     }
445     FE--;  /* FE[0] is supposed to point to junk */
446     cbstuff.nFEs = nblks;
447     while (cbstuff.nFEs)
448         FreeFE(&FE[cbstuff.nFEs]);      /* This is correct */
449     CB = ((struct CallBack *)(calloc(nblks, sizeof(struct CallBack))));
450     if (!CB) {
451         ViceLog(0, ("Failed malloc in InitCallBack\n"));
452         assert(0);
453     }
454     CB--;  /* CB[0] is supposed to point to junk */
455     cbstuff.nCBs = nblks;
456     while (cbstuff.nCBs)
457         FreeCB(&CB[cbstuff.nCBs]);      /* This is correct */
458     cbstuff.nblks = nblks;
459     cbstuff.nbreakers = 0;
460     H_UNLOCK;
461     return 0;
462 }
463
464 afs_int32
465 XCallBackBulk_r(struct host * ahost, struct AFSFid * fids, afs_int32 nfids)
466 {
467     struct AFSCallBack tcbs[AFSCBMAX];
468     register int i;
469     struct AFSCBFids tf;
470     struct AFSCBs tc;
471     int code;
472     int j;
473     struct rx_connection *cb_conn = NULL;
474
475 #ifdef  ADAPT_MTU
476     rx_SetConnDeadTime(ahost->callback_rxcon, 4);
477     rx_SetConnHardDeadTime(ahost->callback_rxcon, AFS_HARDDEADTIME);
478 #endif
479
480     code = 0;
481     j = 0;
482     while (nfids > 0) {
483
484         for (i = 0; i < nfids && i < AFSCBMAX; i++) {
485             tcbs[i].CallBackVersion = CALLBACK_VERSION;
486             tcbs[i].ExpirationTime = 0;
487             tcbs[i].CallBackType = CB_DROPPED;
488         }
489         tf.AFSCBFids_len = i;
490         tf.AFSCBFids_val = &(fids[j]);
491         nfids -= i;
492         j += i;
493         tc.AFSCBs_len = i;
494         tc.AFSCBs_val = tcbs;
495
496         cb_conn = ahost->callback_rxcon;
497         rx_GetConnection(cb_conn);
498         H_UNLOCK;
499         code |= RXAFSCB_CallBack(cb_conn, &tf, &tc);
500         rx_PutConnection(cb_conn);
501         cb_conn = NULL;
502         H_LOCK;
503     }
504
505     return code;
506 }
507
508 /* the locked flag tells us if the host entry has already been locked 
509  * by our parent.  I don't think anybody actually calls us with the
510  * host locked, but here's how to make that work:  GetSomeSpace has to
511  * change so that it doesn't attempt to lock any hosts < "host".  That
512  * means that it might be unable to free any objects, so it has to
513  * return an exit status.  If it fails, then AddCallBack1 might fail,
514  * as well. If so, the host->ResetDone should probably be set to 0,
515  * and we probably don't want to return a callback promise to the
516  * cache manager, either. */
517 int
518 AddCallBack1(struct host *host, AFSFid * fid, afs_uint32 * thead, int type,
519              int locked)
520 {
521     int retVal = 0;
522     H_LOCK;
523     if (!locked) {
524         h_Lock_r(host);
525     }
526     if (!(host->hostFlags & HOSTDELETED))
527         retVal = AddCallBack1_r(host, fid, thead, type, 1);
528
529     if (!locked) {
530         h_Unlock_r(host);
531     }
532     H_UNLOCK;
533     return retVal;
534 }
535
536 static int
537 AddCallBack1_r(struct host *host, AFSFid * fid, afs_uint32 * thead, int type,
538                int locked)
539 {
540     struct FileEntry *fe;
541     struct CallBack *cb = 0, *lastcb = 0;
542     struct FileEntry *newfe = 0;
543     afs_uint32 time_out = 0;
544     afs_uint32 *Thead = thead;
545     struct CallBack *newcb = 0;
546     int safety;
547
548     cbstuff.AddCallBacks++;
549
550     host->Console |= 2;
551
552     /* allocate these guys first, since we can't call the allocator with
553      * the host structure locked -- or we might deadlock. However, we have 
554      * to avoid races with FindFE... */
555     while (!(newcb = GetCB())) {
556         GetSomeSpace_r(host, locked);
557     }
558     while (!(newfe = GetFE())) {        /* Get it now, so we don't have to call */
559         /* GetSomeSpace with the host locked, later.  This might turn out to */
560         /* have been unneccessary, but that's actually kind of unlikely, since */
561         /* most files are not shared. */
562         GetSomeSpace_r(host, locked);
563     }
564
565     if (!locked) {
566         h_Lock_r(host);         /* this can yield, so do it before we get any */
567         /* fragile info */
568         if (host->hostFlags & HOSTDELETED) {
569             host->Console &= ~2;
570             h_Unlock_r(host);
571             return 0;
572         }
573     }
574
575     fe = FindFE(fid);
576     if (type == CB_NORMAL) {
577         time_out =
578             TimeCeiling(FT_ApproxTime() + TimeOut(fe ? fe->ncbs : 0) +
579                         ServerBias);
580         Thead = THead(CBtime(time_out));
581     } else if (type == CB_VOLUME) {
582         time_out = TimeCeiling((60 * 120 + FT_ApproxTime()) + ServerBias);
583         Thead = THead(CBtime(time_out));
584     } else if (type == CB_BULK) {
585         /* bulk status can get so many callbacks all at once, and most of them
586          * are probably not for things that will be used for long.
587          */
588         time_out =
589             TimeCeiling(FT_ApproxTime() + ServerBias +
590                         TimeOut(22 + (fe ? fe->ncbs : 0)));
591         Thead = THead(CBtime(time_out));
592     }
593
594     host->Console &= ~2;
595
596     if (!fe) {
597         register afs_uint32 hash;
598
599         fe = newfe;
600         newfe = NULL;
601         fe->firstcb = 0;
602         fe->volid = fid->Volume;
603         fe->vnode = fid->Vnode;
604         fe->unique = fid->Unique;
605         fe->ncbs = 0;
606         fe->status = 0;
607         hash = FEHash(fid->Volume, fid->Unique);
608         fe->fnext = HashTable[hash];
609         HashTable[hash] = fetoi(fe);
610     }
611     for (safety = 0, lastcb = cb = itocb(fe->firstcb); cb;
612          lastcb = cb, cb = itocb(cb->cnext), safety++) {
613         if (safety > cbstuff.nblks) {
614             ViceLog(0, ("AddCallBack1: Internal Error -- shutting down.\n"));
615             DumpCallBackState();
616             ShutDownAndCore(PANIC);
617         }
618         if (cb->hhead == h_htoi(host))
619             break;
620     }
621     if (cb) {                   /* Already have call back:  move to new timeout list */
622         /* don't change delayed callbacks back to normal ones */
623         if (cb->status != CB_DELAYED)
624             cb->status = type;
625         /* Only move if new timeout is longer */
626         if (TNorm(ttoi(Thead)) > TNorm(cb->thead)) {
627             TDel(cb);
628             TAdd(cb, Thead);
629         }
630         if (newfe == NULL) {    /* we are using the new FE */
631             fe->firstcb = cbtoi(cb);
632             fe->ncbs++;
633             cb->fhead = fetoi(fe);
634         }
635     } else {
636         cb = newcb;
637         newcb = NULL;
638         *(lastcb ? &lastcb->cnext : &fe->firstcb) = cbtoi(cb);
639         fe->ncbs++;
640         cb->cnext = 0;
641         cb->fhead = fetoi(fe);
642         cb->status = type;
643         HAdd(cb, host);
644         TAdd(cb, Thead);
645     }
646
647     /* now free any still-unused callback or host entries */
648     if (newcb)
649         FreeCB(newcb);
650     if (newfe)
651         FreeFE(newfe);
652
653     if (!locked)                /* freecb and freefe might(?) yield */
654         h_Unlock_r(host);
655
656     if (type == CB_NORMAL || type == CB_VOLUME || type == CB_BULK)
657         return time_out - ServerBias;   /* Expires sooner at workstation */
658
659     return 0;
660 }
661
662 static int
663 CompareCBA(const void *e1, const void *e2)
664 {
665     const struct cbstruct *cba1 = (const struct cbstruct *)e1;
666     const struct cbstruct *cba2 = (const struct cbstruct *)e2;
667     return ((cba1->hp)->index - (cba2->hp)->index);
668 }
669
670 /* Take an array full of hosts, all held.  Break callbacks to them, and 
671  * release the holds once you're done, except don't release xhost.  xhost 
672  * may be NULL.  Currently only works for a single Fid in afidp array.
673  * If you want to make this work with multiple fids, you need to fix
674  * the error handling.  One approach would be to force a reset if a
675  * multi-fid call fails, or you could add delayed callbacks for each
676  * fid.   You probably also need to sort and remove duplicate hosts.
677  * When this is called from the BreakVolumeCallBacks path, it does NOT 
678  * force a reset if the RPC fails, it just marks the host down and tries 
679  * to create a delayed callback. */
680 /* N.B.  be sure that code works when ncbas == 0 */
681 /* N.B.  requires all the cba[*].hp pointers to be valid... */
682 /* This routine does not hold a lock on the host for the duration of 
683  * the BreakCallBack RPC, which is a significant deviation from tradition.
684  * It _does_ get a lock on the host before setting VenusDown = 1,
685  * which is sufficient only if VenusDown = 0 only happens when the
686  * lock is held over the RPC and the subsequent VenusDown == 0
687  * wherever that is done. */
688 static void
689 MultiBreakCallBack_r(struct cbstruct cba[], int ncbas,
690                      struct AFSCBFids *afidp, struct host *xhost)
691 {
692     int i, j;
693     struct rx_connection *conns[MAX_CB_HOSTS];
694     static struct AFSCBs tc = { 0, 0 };
695     int multi_to_cba_map[MAX_CB_HOSTS];
696
697     assert(ncbas <= MAX_CB_HOSTS);
698
699     /* sort cba list to avoid makecall issues */
700     qsort(cba, ncbas, sizeof(struct cbstruct), CompareCBA);
701
702     /* set up conns for multi-call */
703     for (i = 0, j = 0; i < ncbas; i++) {
704         struct host *thishost = cba[i].hp;
705         if (!thishost || (thishost->hostFlags & HOSTDELETED)) {
706             continue;
707         }
708         rx_GetConnection(thishost->callback_rxcon);
709         multi_to_cba_map[j] = i;
710         conns[j++] = thishost->callback_rxcon;
711
712 #ifdef  ADAPT_MTU
713         rx_SetConnDeadTime(thishost->callback_rxcon, 4);
714         rx_SetConnHardDeadTime(thishost->callback_rxcon, AFS_HARDDEADTIME);
715 #endif
716     }
717
718     if (j) {                    /* who knows what multi would do with 0 conns? */
719         cbstuff.nbreakers++;
720         H_UNLOCK;
721         multi_Rx(conns, j) {
722             multi_RXAFSCB_CallBack(afidp, &tc);
723             if (multi_error) {
724                 afs_uint32 idx;
725                 struct host *hp;
726                 char hoststr[16];
727
728                 i = multi_to_cba_map[multi_i];
729                 hp = cba[i].hp;
730                 idx = cba[i].thead;
731
732                 if (!hp || !idx) {
733                     ViceLog(0,
734                             ("BCB: INTERNAL ERROR: hp=%p, cba=%p, thead=%u\n",
735                              hp, cba, idx));
736                 } else {
737                     /* 
738                      ** try breaking callbacks on alternate interface addresses
739                      */
740                     if (MultiBreakCallBackAlternateAddress(hp, afidp)) {
741                         if (ShowProblems) {
742                             ViceLog(7,
743                                     ("BCB: Failed on file %u.%u.%u, "
744                                      "Host %p (%s:%d) is down\n",
745                                      afidp->AFSCBFids_val->Volume,
746                                      afidp->AFSCBFids_val->Vnode,
747                                      afidp->AFSCBFids_val->Unique,
748                                      hp,
749                                      afs_inet_ntoa_r(hp->host, hoststr),
750                                      ntohs(hp->port)));
751                         }
752
753                         H_LOCK;
754                         h_Lock_r(hp); 
755                         if (!(hp->hostFlags & HOSTDELETED)) {
756                             hp->hostFlags |= VENUSDOWN;
757                             /**
758                              * We always go into AddCallBack1_r with the host locked
759                              */
760                             AddCallBack1_r(hp, afidp->AFSCBFids_val, itot(idx),
761                                            CB_DELAYED, 1);
762                         }
763                         h_Unlock_r(hp); 
764                         H_UNLOCK;
765                     }
766                 }
767             }
768         }
769         multi_End;
770         H_LOCK;
771         cbstuff.nbreakers--;
772     }
773
774     for (i = 0; i < ncbas; i++) {
775         struct host *hp;
776         hp = cba[i].hp;
777         if (hp && xhost != hp) {
778             h_Release_r(hp);
779         }
780     }
781
782     /* H_UNLOCK around this so h_FreeConnection does not deadlock.
783        h_FreeConnection should *never* be called on a callback connection,
784        but on 10/27/04 a deadlock occurred where it was, when we know why,
785        this should be reverted. -- shadow */
786     H_UNLOCK;
787     for (i = 0; i < j; i++) {
788         rx_PutConnection(conns[i]);
789     }
790     H_LOCK;
791
792     return;
793 }
794
795 /*
796  * Break all call backs for fid, except for the specified host (unless flag
797  * is true, in which case all get a callback message. Assumption: the specified
798  * host is h_Held, by the caller; the others aren't.
799  * Specified host may be bogus, that's ok.  This used to check to see if the 
800  * host was down in two places, once right after the host was h_held, and 
801  * again after it was locked.  That race condition is incredibly rare and
802  * relatively harmless even when it does occur, so we don't check for it now. 
803  */
804 /* if flag is true, send a break callback msg to "host", too */
805 int
806 BreakCallBack(struct host *xhost, AFSFid * fid, int flag)
807 {
808     struct FileEntry *fe;
809     struct CallBack *cb, *nextcb;
810     struct cbstruct cba[MAX_CB_HOSTS];
811     int ncbas;
812     struct AFSCBFids tf;
813     int hostindex;
814     char hoststr[16];
815
816     ViceLog(7,
817             ("BCB: BreakCallBack(Host %p all but %s:%d, (%u,%u,%u))\n",
818              xhost, afs_inet_ntoa_r(xhost->host, hoststr), ntohs(xhost->port),
819              fid->Volume, fid->Vnode, fid->Unique));
820
821     H_LOCK;
822     cbstuff.BreakCallBacks++;
823     fe = FindFE(fid);
824     if (!fe) {
825         goto done;
826     }
827     hostindex = h_htoi(xhost);
828     cb = itocb(fe->firstcb);
829     if (!cb || ((fe->ncbs == 1) && (cb->hhead == hostindex) && !flag)) {
830         /* the most common case is what follows the || */
831         goto done;
832     }
833     tf.AFSCBFids_len = 1;
834     tf.AFSCBFids_val = fid;
835
836     for (; cb;) {
837         for (ncbas = 0; cb && ncbas < MAX_CB_HOSTS; cb = nextcb) {
838             nextcb = itocb(cb->cnext);
839             if ((cb->hhead != hostindex || flag)
840                 && (cb->status == CB_BULK || cb->status == CB_NORMAL
841                     || cb->status == CB_VOLUME)) {
842                 struct host *thishost = h_itoh(cb->hhead);
843                 if (!thishost) {
844                     ViceLog(0, ("BCB: BOGUS! cb->hhead is NULL!\n"));
845                 } else if (thishost->hostFlags & VENUSDOWN) {
846                     ViceLog(7,
847                             ("BCB: %p (%s:%d) is down; delaying break call back\n",
848                              thishost, afs_inet_ntoa_r(thishost->host, hoststr),
849                              ntohs(thishost->port)));
850                     cb->status = CB_DELAYED;
851                 } else {
852                     if (!(thishost->hostFlags & HOSTDELETED)) {
853                         h_Hold_r(thishost);
854                         cba[ncbas].hp = thishost;
855                         cba[ncbas].thead = cb->thead;
856                         ncbas++;
857                     }
858                     TDel(cb);
859                     HDel(cb);
860                     CDel(cb, 1);        /* Usually first; so this delete 
861                                          * is reasonably inexpensive */
862                 }
863             }
864         }
865
866         if (ncbas) {
867             MultiBreakCallBack_r(cba, ncbas, &tf, xhost);
868
869             /* we need to to all these initializations again because MultiBreakCallBack may block */
870             fe = FindFE(fid);
871             if (!fe) {
872                 goto done;
873             }
874             cb = itocb(fe->firstcb);
875             if (!cb || ((fe->ncbs == 1) && (cb->hhead == hostindex) && !flag)) {
876                 /* the most common case is what follows the || */
877                 goto done;
878             }
879         }
880     }
881
882   done:
883     H_UNLOCK;
884     return 0;
885 }
886
887 /* Delete (do not break) single call back for fid */
888 int
889 DeleteCallBack(struct host *host, AFSFid * fid)
890 {
891     register struct FileEntry *fe;
892     register afs_uint32 *pcb;
893     char hoststr[16];
894
895     H_LOCK;
896     cbstuff.DeleteCallBacks++;
897
898     h_Lock_r(host);
899     /* do not care if the host has been HOSTDELETED */
900     fe = FindFE(fid);
901     if (!fe) {
902         h_Unlock_r(host);
903         H_UNLOCK;
904         ViceLog(8,
905                 ("DCB: No call backs for fid (%u, %u, %u)\n", fid->Volume,
906                  fid->Vnode, fid->Unique));
907         return 0;
908     }
909     pcb = FindCBPtr(fe, host);
910     if (!*pcb) {
911         ViceLog(8,
912                 ("DCB: No call back for host %p (%s:%d), (%u, %u, %u)\n",
913                  host, afs_inet_ntoa_r(host->host, hoststr), ntohs(host->port),
914                  fid->Volume, fid->Vnode, fid->Unique));
915         h_Unlock_r(host);
916         H_UNLOCK;
917         return 0;
918     }
919     HDel(itocb(*pcb));
920     TDel(itocb(*pcb));
921     CDelPtr(fe, pcb, 1);
922     h_Unlock_r(host);
923     H_UNLOCK;
924     return 0;
925 }
926
927 /*
928  * Delete (do not break) all call backs for fid.  This call doesn't
929  * set all of the various host locks, but it shouldn't really matter
930  * since we're not adding callbacks, but deleting them.  I'm not sure
931  * why it doesn't set the lock, however; perhaps it should.
932  */
933 int
934 DeleteFileCallBacks(AFSFid * fid)
935 {
936     register struct FileEntry *fe;
937     register struct CallBack *cb;
938     register afs_uint32 cbi;
939     register int n;
940
941     H_LOCK;
942     cbstuff.DeleteFiles++;
943     fe = FindFE(fid);
944     if (!fe) {
945         H_UNLOCK;
946         ViceLog(8,
947                 ("DF: No fid (%u,%u,%u) to delete\n", fid->Volume, fid->Vnode,
948                  fid->Unique));
949         return 0;
950     }
951     for (n = 0, cbi = fe->firstcb; cbi; n++) {
952         cb = itocb(cbi);
953         cbi = cb->cnext;
954         TDel(cb);
955         HDel(cb);
956         FreeCB(cb);
957         fe->ncbs--;
958     }
959     FDel(fe);
960     H_UNLOCK;
961     return 0;
962 }
963
964 /* Delete (do not break) all call backs for host.  The host should be
965  * locked. */
966 int
967 DeleteAllCallBacks_r(struct host *host, int deletefe)
968 {
969     register struct CallBack *cb;
970     register int cbi, first;
971
972     cbstuff.DeleteAllCallBacks++;
973     cbi = first = host->cblist;
974     if (!cbi) {
975         ViceLog(8, ("DV: no call backs\n"));
976         return 0;
977     }
978     do {
979         cb = itocb(cbi);
980         cbi = cb->hnext;
981         TDel(cb);
982         CDel(cb, deletefe);
983     } while (cbi != first);
984     host->cblist = 0;
985     return 0;
986 }
987
988 /*
989  * Break all delayed call backs for host.  Returns 1 if all call backs
990  * successfully broken; 0 otherwise.  Assumes host is h_Held and h_Locked.
991  * Must be called with VenusDown set for this host
992  */
993 int
994 BreakDelayedCallBacks(struct host *host)
995 {
996     int retVal;
997     H_LOCK;
998     retVal = BreakDelayedCallBacks_r(host);
999     H_UNLOCK;
1000     return retVal;
1001 }
1002
1003 int
1004 BreakDelayedCallBacks_r(struct host *host)
1005 {
1006     struct AFSFid fids[AFSCBMAX];
1007     u_byte thead[AFSCBMAX];     /* This should match thead in struct Callback */
1008     int cbi, first, nfids;
1009     struct CallBack *cb;
1010     int code;
1011     char hoststr[16];
1012     struct rx_connection *cb_conn;
1013
1014     cbstuff.nbreakers++;
1015     if (!(host->hostFlags & RESETDONE) && !(host->hostFlags & HOSTDELETED)) {
1016         host->hostFlags &= ~ALTADDR;    /* alternate addresses are invalid */
1017         cb_conn = host->callback_rxcon;
1018         rx_GetConnection(cb_conn);
1019         if (host->interface) {
1020             H_UNLOCK;
1021             code =
1022                 RXAFSCB_InitCallBackState3(cb_conn, &FS_HostUUID);
1023         } else {
1024             H_UNLOCK;
1025             code = RXAFSCB_InitCallBackState(cb_conn);
1026         }
1027         rx_PutConnection(cb_conn);
1028         cb_conn = NULL;
1029         H_LOCK;
1030         host->hostFlags |= ALTADDR;     /* alternate addresses are valid */
1031         if (code) {
1032             if (ShowProblems) {
1033                 ViceLog(0,
1034                         ("CB: Call back connect back failed (in break delayed) "
1035                          "for Host %p (%s:%d)\n",
1036                          host, afs_inet_ntoa_r(host->host, hoststr),
1037                          ntohs(host->port)));
1038             }
1039             host->hostFlags |= VENUSDOWN;
1040         } else {
1041             ViceLog(25,
1042                     ("InitCallBackState success on %p (%s:%d)\n",
1043                      host, afs_inet_ntoa_r(host->host, hoststr),
1044                      ntohs(host->port)));
1045             /* reset was done successfully */
1046             host->hostFlags |= RESETDONE;
1047             host->hostFlags &= ~VENUSDOWN;
1048         }
1049     } else
1050         while (!(host->hostFlags & HOSTDELETED)) {
1051             nfids = 0;
1052             host->hostFlags &= ~VENUSDOWN;      /* presume up */
1053             cbi = first = host->cblist;
1054             if (!cbi)
1055                 break;
1056             do {
1057                 first = host->cblist;
1058                 cb = itocb(cbi);
1059                 cbi = cb->hnext;
1060                 if (cb->status == CB_DELAYED) {
1061                     register struct FileEntry *fe = itofe(cb->fhead);
1062                     thead[nfids] = cb->thead;
1063                     fids[nfids].Volume = fe->volid;
1064                     fids[nfids].Vnode = fe->vnode;
1065                     fids[nfids].Unique = fe->unique;
1066                     nfids++;
1067                     HDel(cb);
1068                     TDel(cb);
1069                     CDel(cb, 1);
1070                 }
1071             } while (cbi && cbi != first && nfids < AFSCBMAX);
1072
1073             if (nfids == 0) {
1074                 break;
1075             }
1076
1077             if (XCallBackBulk_r(host, fids, nfids)) {
1078                 /* Failed, again:  put them back, probably with old
1079                  * timeout values */
1080                 int i;
1081                 if (ShowProblems) {
1082                     ViceLog(0,
1083                             ("CB: XCallBackBulk failed, Host %p (%s:%d); "
1084                              "callback list follows:\n",
1085                              host, afs_inet_ntoa_r(host->host, hoststr),
1086                              ntohs(host->port)));
1087                 }
1088                 for (i = 0; i < nfids; i++) {
1089                     if (ShowProblems) {
1090                         ViceLog(0,
1091                                 ("CB: Host %p (%s:%d), file %u.%u.%u "
1092                                  "(part of bulk callback)\n",
1093                                  host, afs_inet_ntoa_r(host->host, hoststr),
1094                                  ntohs(host->port), fids[i].Volume,
1095                                  fids[i].Vnode, fids[i].Unique));
1096                     }
1097                     /* used to do this:
1098                      * AddCallBack1_r(host, &fids[i], itot(thead[i]), CB_DELAYED, 1);
1099                      * * but it turns out to cause too many tricky locking problems.
1100                      * * now, if break delayed fails, screw it. */
1101                 }
1102                 host->hostFlags |= VENUSDOWN;   /* Failed */
1103                 ClearHostCallbacks_r(host, 1 /* locked */ );
1104                 nfids = 0;
1105                 break;
1106             }
1107             if (nfids < AFSCBMAX)
1108                 break;
1109         }
1110
1111     cbstuff.nbreakers--;
1112     /* If we succeeded it's always ok to unset HFE_LATER */
1113     if (!(host->hostFlags & VENUSDOWN))
1114         host->hostFlags &= ~HFE_LATER;
1115     return (host->hostFlags & VENUSDOWN);
1116 }
1117
1118 /*
1119 ** isheld is 0 if the host is held in h_Enumerate
1120 ** isheld is 1 if the host is held in BreakVolumeCallBacks
1121 */
1122 static int
1123 MultiBreakVolumeCallBack_r(struct host *host, int isheld,
1124                            struct VCBParams *parms, int deletefe)
1125 {
1126     char hoststr[16];
1127
1128     if (!isheld)
1129         return isheld;          /* host is held only by h_Enumerate, do nothing */
1130     if (host->hostFlags & HOSTDELETED)
1131         return 0;               /* host is deleted, release hold */
1132
1133     if (host->hostFlags & VENUSDOWN) {
1134         h_Lock_r(host);
1135         /* Do not care if the host is now HOSTDELETED */
1136         if (ShowProblems) {
1137             ViceLog(0,
1138                     ("BVCB: volume callback for Host %p (%s:%d) failed\n",
1139                      host, afs_inet_ntoa_r(host->host, hoststr),
1140                      ntohs(host->port)));
1141         }
1142         DeleteAllCallBacks_r(host, deletefe);   /* Delete all callback state 
1143                                                  * rather than attempting to 
1144                                                  * selectively remember to
1145                                                  * delete the volume callbacks
1146                                                  * later */
1147         host->hostFlags &= ~RESETDONE;  /* Do InitCallBackState when host returns */
1148         h_Unlock_r(host);
1149         return 0;               /* release hold */
1150     }
1151     assert(parms->ncbas <= MAX_CB_HOSTS);
1152
1153     /* Do not call MultiBreakCallBack on the current host structure
1154      ** because it would prematurely release the hold on the host
1155      */
1156     if (parms->ncbas == MAX_CB_HOSTS) {
1157         struct AFSCBFids tf;
1158
1159         tf.AFSCBFids_len = 1;
1160         tf.AFSCBFids_val = parms->fid;
1161
1162         /* this releases all the hosts */
1163         MultiBreakCallBack_r(parms->cba, parms->ncbas, &tf, 0 /* xhost */ );
1164
1165         parms->ncbas = 0;
1166     }
1167     parms->cba[parms->ncbas].hp = host;
1168     parms->cba[(parms->ncbas)++].thead = parms->thead;
1169     return 1;                   /* DON'T release hold, because we still need it. */
1170 }
1171
1172 /*
1173 ** isheld is 0 if the host is held in h_Enumerate
1174 ** isheld is 1 if the host is held in BreakVolumeCallBacks
1175 */
1176 static int
1177 MultiBreakVolumeCallBack(struct host *host, int isheld, void *rock)
1178 {
1179     struct VCBParams *parms = (struct VCBParams *) rock;
1180     
1181     int retval;
1182     H_LOCK;
1183     retval = MultiBreakVolumeCallBack_r(host, isheld, parms, 1);
1184     H_UNLOCK;
1185     return retval;
1186 }
1187
1188 /*
1189 ** isheld is 0 if the host is held in h_Enumerate
1190 ** isheld is 1 if the host is held in BreakVolumeCallBacks
1191 */
1192 static int
1193 MultiBreakVolumeLaterCallBack(struct host *host, int isheld, void *rock)
1194 {
1195     struct VCBParams *parms = (struct VCBParams *)rock;
1196     int retval;
1197     H_LOCK;
1198     retval = MultiBreakVolumeCallBack_r(host, isheld, parms, 0);
1199     H_UNLOCK;
1200     return retval;
1201 }
1202
1203 /*
1204  * Break all call backs on a single volume.  Don't call this with any
1205  * hosts h_held.  Note that this routine clears the callbacks before
1206  * actually breaking them, and that the vnode isn't locked during this
1207  * operation, so that people might see temporary callback loss while
1208  * this function is executing.  It is just a temporary state, however,
1209  * since the callback will be broken later by this same function.
1210  *
1211  * Now uses multi-RX for CallBack RPC.  Note that the
1212  * multiBreakCallBacks routine does not force a reset if the RPC
1213  * fails, unlike the previous version of this routine, but does create
1214  * a delayed callback.  Resets will be forced if the host is
1215  * determined to be down before the RPC is executed.
1216  */
1217 int
1218 BreakVolumeCallBacks(afs_uint32 volume)
1219 {
1220     struct AFSFid fid;
1221     int hash;
1222     afs_uint32 *feip;
1223     struct CallBack *cb;
1224     struct FileEntry *fe;
1225     struct host *host;
1226     struct VCBParams henumParms;
1227     afs_uint32 tthead = 0;      /* zero is illegal value */
1228
1229     H_LOCK;
1230     fid.Volume = volume, fid.Vnode = fid.Unique = 0;
1231     for (hash = 0; hash < FEHASH_SIZE; hash++) {
1232         for (feip = &HashTable[hash]; (fe = itofe(*feip));) {
1233             if (fe->volid == volume) {
1234                 register struct CallBack *cbnext;
1235                 for (cb = itocb(fe->firstcb); cb; cb = cbnext) {
1236                     host = h_itoh(cb->hhead);
1237
1238                     if (!(host->hostFlags & HOSTDELETED)) {
1239                         h_Hold_r(host);
1240                         if (!tthead || (TNorm(tthead) < TNorm(cb->thead))) {
1241                             tthead = cb->thead;
1242                         }
1243                     }
1244                     cbnext = itocb(cb->cnext);
1245                     TDel(cb);
1246                     HDel(cb);
1247                     FreeCB(cb);
1248                     /* leave hold for MultiBreakVolumeCallBack to clear */
1249                 }
1250                 *feip = fe->fnext;
1251                 FreeFE(fe);
1252             } else {
1253                 feip = &fe->fnext;
1254             }
1255         }
1256     }
1257
1258     if (!tthead) {
1259         /* didn't find any callbacks, so return right away. */
1260         H_UNLOCK;
1261         return 0;
1262     }
1263     henumParms.ncbas = 0;
1264     henumParms.fid = &fid;
1265     henumParms.thead = tthead;
1266     H_UNLOCK;
1267     h_Enumerate(MultiBreakVolumeCallBack, &henumParms);
1268     H_LOCK;
1269     if (henumParms.ncbas) {     /* do left-overs */
1270         struct AFSCBFids tf;
1271         tf.AFSCBFids_len = 1;
1272         tf.AFSCBFids_val = &fid;
1273
1274         MultiBreakCallBack_r(henumParms.cba, henumParms.ncbas, &tf, 0);
1275
1276         henumParms.ncbas = 0;
1277     }
1278     H_UNLOCK;
1279     return 0;
1280 }
1281
1282 #ifdef AFS_PTHREAD_ENV
1283 extern pthread_cond_t fsync_cond;
1284 #else
1285 extern char fsync_wait[];
1286 #endif
1287
1288 int
1289 BreakVolumeCallBacksLater(afs_uint32 volume)
1290 {
1291     int hash;
1292     afs_uint32 *feip;
1293     struct FileEntry *fe;
1294     struct CallBack *cb;
1295     struct host *host;
1296     int found = 0;
1297
1298     ViceLog(25, ("Setting later on volume %u\n", volume));
1299     H_LOCK;
1300     for (hash = 0; hash < FEHASH_SIZE; hash++) {
1301         for (feip = &HashTable[hash]; (fe = itofe(*feip)) != NULL; ) {
1302             if (fe->volid == volume) {
1303                 register struct CallBack *cbnext;
1304                 for (cb = itocb(fe->firstcb); cb; cb = cbnext) {
1305                     host = h_itoh(cb->hhead);
1306                     host->hostFlags |= HFE_LATER;
1307                     cb->status = CB_DELAYED;
1308                     cbnext = itocb(cb->cnext);
1309                 }
1310                 FSYNC_LOCK;
1311                 fe->status |= FE_LATER;
1312                 FSYNC_UNLOCK;
1313                 found = 1;
1314             }
1315             feip = &fe->fnext;
1316         }
1317     }
1318     H_UNLOCK;
1319     if (!found) {
1320         /* didn't find any callbacks, so return right away. */
1321         return 0;
1322     }
1323
1324     ViceLog(25, ("Fsync thread wakeup\n"));
1325 #ifdef AFS_PTHREAD_ENV
1326     FSYNC_LOCK;
1327     assert(pthread_cond_broadcast(&fsync_cond) == 0);
1328     FSYNC_UNLOCK;
1329 #else
1330     LWP_NoYieldSignal(fsync_wait);
1331 #endif
1332     return 0;
1333 }
1334
1335 int
1336 BreakLaterCallBacks(void)
1337 {
1338     struct AFSFid fid;
1339     int hash;
1340     afs_uint32 *feip;
1341     struct CallBack *cb;
1342     struct FileEntry *fe = NULL;
1343     struct FileEntry *myfe = NULL;
1344     struct host *host;
1345     struct VCBParams henumParms;
1346     unsigned short tthead = 0;  /* zero is illegal value */
1347     char hoststr[16];
1348
1349     /* Unchain first */
1350     ViceLog(25, ("Looking for FileEntries to unchain\n"));
1351     H_LOCK;
1352     FSYNC_LOCK;
1353     /* Pick the first volume we see to clean up */
1354     fid.Volume = fid.Vnode = fid.Unique = 0;
1355
1356     for (hash = 0; hash < FEHASH_SIZE; hash++) {
1357         for (feip = &HashTable[hash]; (fe = itofe(*feip)) != NULL; ) {
1358             if (fe && (fe->status & FE_LATER)
1359                 && (fid.Volume == 0 || fid.Volume == fe->volid)) {
1360                 /* Ugly, but used to avoid left side casting */
1361                 struct object *tmpfe;
1362                 ViceLog(125,
1363                         ("Unchaining for %u:%u:%u\n", fe->vnode, fe->unique,
1364                          fe->volid));
1365                 fid.Volume = fe->volid;
1366                 *feip = fe->fnext;
1367                 fe->status &= ~FE_LATER; /* not strictly needed */
1368                 /* Works since volid is deeper than the largest pointer */
1369                 tmpfe = (struct object *)fe;
1370                 tmpfe->next = (struct object *)myfe;
1371                 myfe = fe;
1372             } else
1373                 feip = &fe->fnext;
1374         }
1375     }
1376     FSYNC_UNLOCK;
1377
1378     if (!myfe) {
1379         H_UNLOCK;
1380         return 0;
1381     }
1382
1383     /* loop over FEs from myfe and free/break */
1384     tthead = 0;
1385     for (fe = myfe; fe;) {
1386         register struct CallBack *cbnext;
1387         for (cb = itocb(fe->firstcb); cb; cb = cbnext) {
1388             cbnext = itocb(cb->cnext);
1389             host = h_itoh(cb->hhead);
1390             if (cb->status == CB_DELAYED) {
1391                 if (!(host->hostFlags & HOSTDELETED)) {
1392                     h_Hold_r(host);
1393                     if (!tthead || (TNorm(tthead) < TNorm(cb->thead))) {
1394                         tthead = cb->thead;
1395                     }
1396                 }
1397                 TDel(cb);
1398                 HDel(cb);
1399                 CDel(cb, 0);    /* Don't let CDel clean up the fe */
1400                 /* leave hold for MultiBreakVolumeCallBack to clear */
1401             } else {
1402                 ViceLog(125,
1403                         ("Found host %p (%s:%d) non-DELAYED cb for %u:%u:%u\n",
1404                          host, afs_inet_ntoa_r(host->host, hoststr),
1405                          ntohs(host->port), fe->vnode, fe->unique, fe->volid));
1406             }
1407         }
1408         myfe = fe;
1409         fe = (struct FileEntry *)((struct object *)fe)->next;
1410         FreeFE(myfe);
1411     }
1412
1413     if (tthead) {
1414         ViceLog(125, ("Breaking volume %u\n", fid.Volume));
1415         henumParms.ncbas = 0;
1416         henumParms.fid = &fid;
1417         henumParms.thead = tthead;
1418         H_UNLOCK;
1419         h_Enumerate(MultiBreakVolumeLaterCallBack, (char *)&henumParms);
1420         H_LOCK;
1421         if (henumParms.ncbas) { /* do left-overs */
1422             struct AFSCBFids tf;
1423             tf.AFSCBFids_len = 1;
1424             tf.AFSCBFids_val = &fid;
1425
1426             MultiBreakCallBack_r(henumParms.cba, henumParms.ncbas, &tf, 0);
1427             henumParms.ncbas = 0;
1428         }
1429     }
1430     H_UNLOCK;
1431
1432     /* Arrange to be called again */
1433     return 1;
1434 }
1435
1436 /*
1437  * Delete all timed-out call back entries (to be called periodically by file
1438  * server)
1439  */
1440 int
1441 CleanupTimedOutCallBacks(void)
1442 {
1443     H_LOCK;
1444     CleanupTimedOutCallBacks_r();
1445     H_UNLOCK;
1446     return 0;
1447 }
1448
1449 int
1450 CleanupTimedOutCallBacks_r(void)
1451 {
1452     afs_uint32 now = CBtime(FT_ApproxTime());
1453     register afs_uint32 *thead;
1454     register struct CallBack *cb;
1455     register int ntimedout = 0;
1456     char hoststr[16];
1457
1458     while (tfirst <= now) {
1459         register int cbi;
1460         cbi = *(thead = THead(tfirst));
1461         if (cbi) {
1462             do {
1463                 cb = itocb(cbi);
1464                 cbi = cb->tnext;
1465                 ViceLog(8,
1466                         ("CCB: deleting timed out call back %x (%s:%d), (%u,%u,%u)\n",
1467                          h_itoh(cb->hhead)->host,
1468                          afs_inet_ntoa_r(h_itoh(cb->hhead)->host, hoststr),
1469                          h_itoh(cb->hhead)->port, itofe(cb->fhead)->volid,
1470                          itofe(cb->fhead)->vnode, itofe(cb->fhead)->unique));
1471                 HDel(cb);
1472                 CDel(cb, 1);
1473                 ntimedout++;
1474                 if (ntimedout > cbstuff.nblks) {
1475                     ViceLog(0, ("CCB: Internal Error -- shutting down...\n"));
1476                     DumpCallBackState();
1477                     ShutDownAndCore(PANIC);
1478                 }
1479             } while (cbi != *thead);
1480             *thead = 0;
1481         }
1482         tfirst++;
1483     }
1484     cbstuff.CBsTimedOut += ntimedout;
1485     ViceLog(7, ("CCB: deleted %d timed out callbacks\n", ntimedout));
1486     return (ntimedout > 0);
1487 }
1488
1489 /**
1490  * parameters to pass to lih*_r from h_Enumerate_r when trying to find a host
1491  * from which to clear callbacks.
1492  */
1493 struct lih_params {
1494     /**
1495      * Points to the least interesting host found; try to clear callbacks on
1496      * this host after h_Enumerate_r(lih*_r)'ing.
1497      */
1498     struct host *lih;
1499
1500     /**
1501      * The last host we got from lih*_r, but we couldn't clear its callbacks
1502      * for some reason. Choose the next-best host after this one (with the
1503      * current lih*_r, this means to only select hosts that have an ActiveCall
1504      * newer than lastlih).
1505      */
1506     struct host *lastlih;
1507 };
1508
1509 /* Value of host->refCount that allows us to reliably infer that
1510  * host may be held by some other thread */
1511 #define OTHER_MUSTHOLD_LIH 2
1512
1513 /* This version does not allow 'host' to be selected unless its ActiveCall 
1514  * is newer than 'params->lastlih' which is the host with the oldest
1515  * ActiveCall from the last pass (if it is provided).  We filter out any hosts
1516  * that are are held by other threads.
1517  *
1518  * There is a small problem here, but it may not be easily fixable. Say we
1519  * select some host A, and give it back to GetSomeSpace_r. GSS_r for some
1520  * reason cannot clear the callbacks on A, and so calls us again with
1521  * lastlih = A. Suppose there is another host B that has the same ActiveCall
1522  * time as A. We will now skip over host B, since
1523  * 'hostB->ActiveCall > hostA->ActiveCall' is not true. This could result in
1524  * us prematurely going to the GSS_r 2nd or 3rd pass, and making us a little
1525  * inefficient. This should be pretty rare, though, except perhaps in cases
1526  * with very small numbers of hosts.
1527  *
1528  * Also filter out any hosts with HOSTDELETED set. h_Enumerate_r should in
1529  * theory not give these to us anyway, but be paranoid.
1530  */
1531 static int
1532 lih0_r(register struct host *host, register int flags, void *rock)
1533 {
1534     struct lih_params *params = (struct lih_params *)rock;
1535
1536     /* OTHER_MUSTHOLD_LIH is because the h_Enum loop holds us once */
1537     if (host->cblist
1538         && (!(host->hostFlags & HOSTDELETED))
1539         && (host->refCount < OTHER_MUSTHOLD_LIH)
1540         && (!params->lih || host->ActiveCall < params->lih->ActiveCall)
1541         && (!params->lastlih || host->ActiveCall > params->lastlih->ActiveCall)) {
1542
1543         if (params->lih) {
1544             h_Release_r(params->lih); /* release prev host */
1545         }
1546
1547         h_Hold_r(host);
1548         params->lih = host;
1549     }
1550     return flags;
1551 }
1552
1553 /* same as lih0_r, except we do not prevent held hosts from being selected. */
1554 static int
1555 lih1_r(register struct host *host, register int flags, void *rock)
1556 {
1557     struct lih_params *params = (struct lih_params *)rock;
1558
1559     if (host->cblist
1560         && (!(host->hostFlags & HOSTDELETED))
1561         && (!params->lih || host->ActiveCall < params->lih->ActiveCall)
1562         && (!params->lastlih || host->ActiveCall > params->lastlih->ActiveCall)) {
1563
1564         if (params->lih) {
1565             h_Release_r(params->lih); /* release prev host */
1566         }
1567
1568         h_Hold_r(host);
1569         params->lih = host;
1570     }
1571     return flags;
1572 }
1573
1574 /* This could be upgraded to get more space each time */
1575 /* first pass: sequentially find the oldest host which isn't held by
1576                anyone for which we can clear callbacks;
1577                skipping 'hostp' */
1578 /* second pass: sequentially find the oldest host regardless of 
1579                whether or not the host is held; skipping 'hostp' */
1580 /* third pass: attempt to clear callbacks from 'hostp' */
1581 /* always called with hostp unlocked */
1582
1583 /* Note: hostlist is ordered most recently created host first and 
1584  * its order has no relationship to the most recently used. */
1585 extern struct host *hostList;
1586 static int
1587 GetSomeSpace_r(struct host *hostp, int locked)
1588 {
1589     struct host *hp;
1590     struct lih_params params;
1591     int i = 0;
1592
1593     cbstuff.GotSomeSpaces++;
1594     ViceLog(5,
1595             ("GSS: First looking for timed out call backs via CleanupCallBacks\n"));
1596     if (CleanupTimedOutCallBacks_r()) {
1597         cbstuff.GSS3++;
1598         return 0;
1599     }
1600
1601     i = 0;
1602     params.lastlih = NULL;
1603
1604     do {
1605         params.lih = NULL;
1606
1607         h_Enumerate_r(i == 0 ? lih0_r : lih1_r, hostList, &params);
1608
1609         hp = params.lih;
1610         if (params.lastlih) {
1611             h_Release_r(params.lastlih);
1612             params.lastlih = NULL;
1613         }
1614
1615         if (hp) {
1616             /* note that 'hp' was held by lih*_r; we will need to release it */
1617             cbstuff.GSS4++;
1618             if ((hp != hostp) && !ClearHostCallbacks_r(hp, 0 /* not locked or held */ )) {
1619                 h_Release_r(hp);
1620                 return 0;
1621             }
1622
1623             params.lastlih = hp;
1624             /* params.lastlih will be released on the next iteration, after
1625              * h_Enumerate_r */
1626
1627         } else {
1628             /*
1629              * Next time try getting callbacks from any host even if
1630              * it's held, since the only other option is starvation for
1631              * the file server (i.e. until the callback timeout arrives).
1632              */
1633             i++;
1634             params.lastlih = NULL;
1635             cbstuff.GSS1++;
1636             ViceLog(5,
1637                     ("GSS: Try harder for longest inactive host cnt= %d\n",
1638                      i));
1639         }
1640     } while (i < 2);
1641
1642     /* Could not obtain space from other hosts, clear hostp's callback state */
1643     cbstuff.GSS2++;
1644     if (!locked) {
1645         h_Lock_r(hostp);
1646     }
1647     ClearHostCallbacks_r(hostp, 1 /*already locked */ );
1648     if (!locked) {
1649         h_Unlock_r(hostp);
1650     }
1651     return 0;
1652 }
1653
1654 /* locked - set if caller has already locked the host */
1655 static int
1656 ClearHostCallbacks_r(struct host *hp, int locked)
1657 {
1658     int code;
1659     char hoststr[16];
1660     struct rx_connection *cb_conn = NULL;
1661
1662     ViceLog(5,
1663             ("GSS: Delete longest inactive host %p (%s:%d)\n",
1664              hp, afs_inet_ntoa_r(hp->host, hoststr), ntohs(hp->port)));
1665
1666     if ((hp->hostFlags & HOSTDELETED)) {
1667         /* hp could go away after reacquiring H_LOCK in h_NBLock_r, so we can't
1668          * really use it; its callbacks will get cleared anyway when
1669          * h_TossStuff_r gets its hands on it */
1670         return 1;
1671     }
1672
1673     h_Hold_r(hp);
1674
1675     /** Try a non-blocking lock. If the lock is already held return
1676       * after releasing hold on hp
1677       */
1678     if (!locked) {
1679         if (h_NBLock_r(hp)) {
1680             h_Release_r(hp);
1681             return 1;
1682         }
1683     }
1684     if (hp->Console & 2) {
1685         /*
1686          * If the special console field is set it means that a thread
1687          * is waiting in AddCallBack1 after it set pointers to the
1688          * file entry and/or callback entry. Because of the bogus
1689          * usage of h_hold it won't prevent from another thread, this
1690          * one, to remove all the callbacks so just to be safe we keep
1691          * a reference. NOTE, on the last phase we'll free the calling
1692          * host's callbacks but that's ok...
1693          */
1694         cbstuff.GSS5++;
1695     }
1696     DeleteAllCallBacks_r(hp, 1);
1697     if (hp->hostFlags & VENUSDOWN) {
1698         hp->hostFlags &= ~RESETDONE;    /* remember that we must do a reset */
1699     } else if (!(hp->hostFlags & HOSTDELETED)) {
1700         /* host is up, try a call */
1701         hp->hostFlags &= ~ALTADDR;      /* alternate addresses are invalid */
1702         cb_conn = hp->callback_rxcon;
1703         rx_GetConnection(hp->callback_rxcon);
1704         if (hp->interface) {
1705             H_UNLOCK;
1706             code =
1707                 RXAFSCB_InitCallBackState3(cb_conn, &FS_HostUUID);
1708         } else {
1709             H_UNLOCK;
1710             code = RXAFSCB_InitCallBackState(cb_conn);
1711         }
1712         rx_PutConnection(cb_conn);
1713         cb_conn = NULL;
1714         H_LOCK;
1715         hp->hostFlags |= ALTADDR;       /* alternate addresses are valid */
1716         if (code) {
1717             /* failed, mark host down and need reset */
1718             hp->hostFlags |= VENUSDOWN;
1719             hp->hostFlags &= ~RESETDONE;
1720         } else {
1721             /* reset succeeded, we're done */
1722             hp->hostFlags |= RESETDONE;
1723         }
1724     }
1725     if (!locked)
1726         h_Unlock_r(hp);
1727     h_Release_r(hp);
1728
1729     return 0;
1730 }
1731 #endif /* INTERPRET_DUMP */
1732
1733
1734 int
1735 PrintCallBackStats(void)
1736 {
1737     fprintf(stderr,
1738             "%d add CB, %d break CB, %d del CB, %d del FE, %d CB's timed out, %d space reclaim, %d del host\n",
1739             cbstuff.AddCallBacks, cbstuff.BreakCallBacks,
1740             cbstuff.DeleteCallBacks, cbstuff.DeleteFiles, cbstuff.CBsTimedOut,
1741             cbstuff.GotSomeSpaces, cbstuff.DeleteAllCallBacks);
1742     fprintf(stderr, "%d CBs, %d FEs, (%d of total of %d 16-byte blocks)\n",
1743             cbstuff.nCBs, cbstuff.nFEs, cbstuff.nCBs + cbstuff.nFEs,
1744             cbstuff.nblks);
1745
1746     return 0;
1747 }
1748
1749 #define MAGIC 0x12345678        /* To check byte ordering of dump when it is read in */
1750 #define MAGICV2 0x12345679      /* To check byte ordering & version of dump when it is read in */
1751
1752
1753 #ifndef INTERPRET_DUMP
1754
1755 #ifdef AFS_DEMAND_ATTACH_FS
1756 /*
1757  * demand attach fs
1758  * callback state serialization
1759  */
1760 static int cb_stateSaveTimeouts(struct fs_dump_state * state);
1761 static int cb_stateSaveFEHash(struct fs_dump_state * state);
1762 static int cb_stateSaveFEs(struct fs_dump_state * state);
1763 static int cb_stateSaveFE(struct fs_dump_state * state, struct FileEntry * fe);
1764 static int cb_stateRestoreTimeouts(struct fs_dump_state * state);
1765 static int cb_stateRestoreFEHash(struct fs_dump_state * state);
1766 static int cb_stateRestoreFEs(struct fs_dump_state * state);
1767 static int cb_stateRestoreFE(struct fs_dump_state * state);
1768 static int cb_stateRestoreCBs(struct fs_dump_state * state, struct FileEntry * fe, 
1769                               struct iovec * iov, int niovecs);
1770
1771 static int cb_stateVerifyFEHash(struct fs_dump_state * state);
1772 static int cb_stateVerifyFE(struct fs_dump_state * state, struct FileEntry * fe);
1773 static int cb_stateVerifyFCBList(struct fs_dump_state * state, struct FileEntry * fe);
1774 static int cb_stateVerifyTimeoutQueues(struct fs_dump_state * state);
1775
1776 static int cb_stateFEToDiskEntry(struct FileEntry *, struct FEDiskEntry *);
1777 static int cb_stateDiskEntryToFE(struct fs_dump_state * state,
1778                                  struct FEDiskEntry *, struct FileEntry *);
1779
1780 static int cb_stateCBToDiskEntry(struct CallBack *, struct CBDiskEntry *);
1781 static int cb_stateDiskEntryToCB(struct fs_dump_state * state,
1782                                  struct CBDiskEntry *, struct CallBack *);
1783
1784 static int cb_stateFillHeader(struct callback_state_header * hdr);
1785 static int cb_stateCheckHeader(struct callback_state_header * hdr);
1786
1787 static int cb_stateAllocMap(struct fs_dump_state * state);
1788
1789 int
1790 cb_stateSave(struct fs_dump_state * state)
1791 {
1792     int ret = 0;
1793
1794     AssignInt64(state->eof_offset, &state->hdr->cb_offset);
1795
1796     /* invalidate callback state header */
1797     memset(state->cb_hdr, 0, sizeof(struct callback_state_header));
1798     if (fs_stateWriteHeader(state, &state->hdr->cb_offset, state->cb_hdr,
1799                             sizeof(struct callback_state_header))) {
1800         ret = 1;
1801         goto done;
1802     }
1803
1804     fs_stateIncEOF(state, sizeof(struct callback_state_header));
1805
1806     /* dump timeout state */
1807     if (cb_stateSaveTimeouts(state)) {
1808         ret = 1;
1809         goto done;
1810     }
1811
1812     /* dump fe hashtable state */
1813     if (cb_stateSaveFEHash(state)) {
1814         ret = 1;
1815         goto done;
1816     }
1817
1818     /* dump callback state */
1819     if (cb_stateSaveFEs(state)) {
1820         ret = 1;
1821         goto done;
1822     }
1823
1824     /* write the callback state header to disk */
1825     cb_stateFillHeader(state->cb_hdr);
1826     if (fs_stateWriteHeader(state, &state->hdr->cb_offset, state->cb_hdr,
1827                             sizeof(struct callback_state_header))) {
1828         ret = 1;
1829         goto done;
1830     }
1831     
1832  done:
1833     return ret;
1834 }
1835
1836 int
1837 cb_stateRestore(struct fs_dump_state * state)
1838 {
1839     int ret = 0;
1840
1841     if (fs_stateReadHeader(state, &state->hdr->cb_offset, state->cb_hdr,
1842                            sizeof(struct callback_state_header))) {
1843         ret = 1;
1844         goto done;
1845     }
1846
1847     if (cb_stateCheckHeader(state->cb_hdr)) {
1848         ret = 1;
1849         goto done;
1850     }
1851
1852     if (cb_stateAllocMap(state)) {
1853         ret = 1;
1854         goto done;
1855     }
1856
1857     if (cb_stateRestoreTimeouts(state)) {
1858         ret = 1;
1859         goto done;
1860     }
1861
1862     if (cb_stateRestoreFEHash(state)) {
1863         ret = 1;
1864         goto done;
1865     }
1866
1867     /* restore FEs and CBs from disk */
1868     if (cb_stateRestoreFEs(state)) {
1869         ret = 1;
1870         goto done;
1871     }
1872
1873     /* restore the timeout queue heads */
1874     tfirst = state->cb_hdr->tfirst;
1875
1876  done:
1877     return ret;
1878 }
1879
1880 int
1881 cb_stateRestoreIndices(struct fs_dump_state * state)
1882 {
1883     int i, ret = 0;
1884     struct FileEntry * fe;
1885     struct CallBack * cb;
1886
1887     /* restore indices in the FileEntry structures */
1888     for (i = 1; i < state->fe_map.len; i++) {
1889         if (state->fe_map.entries[i].new_idx) {
1890             fe = itofe(state->fe_map.entries[i].new_idx);
1891
1892             /* restore the fe->fnext entry */
1893             if (fe_OldToNew(state, fe->fnext, &fe->fnext)) {
1894                 ret = 1;
1895                 goto done;
1896             }
1897
1898             /* restore the fe->firstcb entry */
1899             if (cb_OldToNew(state, fe->firstcb, &fe->firstcb)) {
1900                 ret = 1;
1901                 goto done;
1902             }
1903         }
1904     }
1905     
1906     /* restore indices in the CallBack structures */
1907     for (i = 1; i < state->cb_map.len; i++) {
1908         if (state->cb_map.entries[i].new_idx) {
1909             cb = itocb(state->cb_map.entries[i].new_idx);
1910
1911             /* restore the cb->cnext entry */
1912             if (cb_OldToNew(state, cb->cnext, &cb->cnext)) {
1913                 ret = 1;
1914                 goto done;
1915             }
1916             
1917             /* restore the cb->fhead entry */
1918             if (fe_OldToNew(state, cb->fhead, &cb->fhead)) {
1919                 ret = 1;
1920                 goto done;
1921             }
1922
1923             /* restore the cb->hhead entry */
1924             if (h_OldToNew(state, cb->hhead, &cb->hhead)) {
1925                 ret = 1;
1926                 goto done;
1927             }
1928
1929             /* restore the cb->tprev entry */
1930             if (cb_OldToNew(state, cb->tprev, &cb->tprev)) {
1931                 ret = 1;
1932                 goto done;
1933             }
1934
1935             /* restore the cb->tnext entry */
1936             if (cb_OldToNew(state, cb->tnext, &cb->tnext)) {
1937                 ret = 1;
1938                 goto done;
1939             }
1940
1941             /* restore the cb->hprev entry */
1942             if (cb_OldToNew(state, cb->hprev, &cb->hprev)) {
1943                 ret = 1;
1944                 goto done;
1945             }
1946
1947             /* restore the cb->hnext entry */
1948             if (cb_OldToNew(state, cb->hnext, &cb->hnext)) {
1949                 ret = 1;
1950                 goto done;
1951             }
1952         }
1953     }
1954
1955     /* restore the timeout queue head indices */
1956     for (i = 0; i < state->cb_timeout_hdr->records; i++) {
1957         if (cb_OldToNew(state, timeout[i], &timeout[i])) {
1958             ret = 1;
1959             goto done;
1960         }
1961     }
1962
1963     /* restore the FE hash table queue heads */
1964     for (i = 0; i < state->cb_fehash_hdr->records; i++) {
1965         if (fe_OldToNew(state, HashTable[i], &HashTable[i])) {
1966             ret = 1;
1967             goto done;
1968         }
1969     }
1970
1971  done:
1972     return ret;
1973 }
1974
1975 int
1976 cb_stateVerify(struct fs_dump_state * state)
1977 {
1978     int ret = 0;
1979
1980     if (cb_stateVerifyFEHash(state)) {
1981         ret = 1;
1982     }
1983
1984     if (cb_stateVerifyTimeoutQueues(state)) {
1985         ret = 1;
1986     }
1987
1988     return ret;
1989 }
1990
1991 static int
1992 cb_stateVerifyFEHash(struct fs_dump_state * state)
1993 {
1994     int ret = 0, i;
1995     struct FileEntry * fe;
1996     afs_uint32 fei, chain_len;
1997
1998     for (i = 0; i < FEHASH_SIZE; i++) {
1999         chain_len = 0;
2000         for (fei = HashTable[i], fe = itofe(fei);
2001              fe;
2002              fei = fe->fnext, fe = itofe(fei)) {
2003             if (fei > cbstuff.nblks) {
2004                 ViceLog(0, ("cb_stateVerifyFEHash: error: index out of range (fei=%d)\n", fei));
2005                 ret = 1;
2006                 break;
2007             }
2008             if (cb_stateVerifyFE(state, fe)) {
2009                 ret = 1;
2010             }
2011             if (chain_len > FS_STATE_FE_MAX_HASH_CHAIN_LEN) {
2012                 ViceLog(0, ("cb_stateVerifyFEHash: error: hash chain %d length exceeds %d; assuming there's a loop\n",
2013                             i, FS_STATE_FE_MAX_HASH_CHAIN_LEN));
2014                 ret = 1;
2015                 break;
2016             }
2017             chain_len++;
2018         }
2019     }
2020
2021     return ret;
2022 }
2023
2024 static int
2025 cb_stateVerifyFE(struct fs_dump_state * state, struct FileEntry * fe)
2026 {
2027     int ret = 0;
2028
2029     if ((fe->firstcb && !fe->ncbs) ||
2030         (!fe->firstcb && fe->ncbs)) {
2031         ViceLog(0, ("cb_stateVerifyFE: error: fe->firstcb does not agree with fe->ncbs (fei=%lu, fe->firstcb=%lu, fe->ncbs=%lu)\n",
2032                     afs_printable_uint32_lu(fetoi(fe)),
2033                     afs_printable_uint32_lu(fe->firstcb),
2034                     afs_printable_uint32_lu(fe->ncbs)));
2035         ret = 1;
2036     }
2037     if (cb_stateVerifyFCBList(state, fe)) {
2038         ViceLog(0, ("cb_stateVerifyFE: error: FCBList failed verification (fei=%lu)\n",
2039                     afs_printable_uint32_lu(fetoi(fe))));
2040         ret = 1;
2041     }
2042
2043     return ret;
2044 }
2045
2046 static int
2047 cb_stateVerifyFCBList(struct fs_dump_state * state, struct FileEntry * fe)
2048 {
2049     int ret = 0;
2050     afs_uint32 cbi, fei, chain_len = 0;
2051     struct CallBack * cb;
2052
2053     fei = fetoi(fe);
2054
2055     for (cbi = fe->firstcb, cb = itocb(cbi);
2056          cb;
2057          cbi = cb->cnext, cb = itocb(cbi)) {
2058         if (cbi > cbstuff.nblks) {
2059             ViceLog(0, ("cb_stateVerifyFCBList: error: list index out of range (cbi=%d, ncbs=%d)\n",
2060                         cbi, cbstuff.nblks));
2061             ret = 1;
2062             goto done;
2063         }
2064         if (cb->fhead != fei) {
2065             ViceLog(0, ("cb_stateVerifyFCBList: error: cb->fhead != fei (fei=%d, cb->fhead=%d)\n",
2066                         fei, cb->fhead));
2067             ret = 1;
2068         }
2069         if (chain_len > FS_STATE_FCB_MAX_LIST_LEN) {
2070             ViceLog(0, ("cb_stateVerifyFCBList: error: list length exceeds %d (fei=%d); assuming there's a loop\n",
2071                         FS_STATE_FCB_MAX_LIST_LEN, fei));
2072             ret = 1;
2073             goto done;
2074         }
2075         chain_len++;
2076     }
2077
2078     if (fe->ncbs != chain_len) {
2079         ViceLog(0, ("cb_stateVerifyFCBList: error: list length mismatch (len=%d, fe->ncbs=%d)\n",
2080                     chain_len, fe->ncbs));
2081         ret = 1;
2082     }
2083
2084  done:
2085     return ret;
2086 }
2087
2088 int
2089 cb_stateVerifyHCBList(struct fs_dump_state * state, struct host * host)
2090 {
2091     int ret = 0;
2092     afs_uint32 hi, chain_len, cbi;
2093     struct CallBack *cb, *ncb;
2094
2095     hi = h_htoi(host);
2096     chain_len = 0;
2097
2098     for (cbi = host->cblist, cb = itocb(cbi);
2099          cb;
2100          cbi = cb->hnext, cb = ncb) {
2101         if (chain_len && (host->cblist == cbi)) {
2102             /* we've wrapped around the circular list, and everything looks ok */
2103             break;
2104         }
2105         if (cb->hhead != hi) {
2106             ViceLog(0, ("cb_stateVerifyHCBList: error: incorrect cb->hhead (cbi=%d, h->index=%d, cb->hhead=%d)\n",
2107                         cbi, hi, cb->hhead));
2108             ret = 1;
2109         }
2110         if (!cb->hprev || !cb->hnext) {
2111             ViceLog(0, ("cb_stateVerifyHCBList: error: null index in circular list (cbi=%d, h->index=%d)\n",
2112                         cbi, hi));
2113             ret = 1;
2114             goto done;
2115         }
2116         if ((cb->hprev > cbstuff.nblks) ||
2117             (cb->hnext > cbstuff.nblks)) {
2118             ViceLog(0, ("cb_stateVerifyHCBList: error: list index out of range (cbi=%d, h->index=%d, cb->hprev=%d, cb->hnext=%d, nCBs=%d)\n",
2119                         cbi, hi, cb->hprev, cb->hnext, cbstuff.nblks));
2120             ret = 1;
2121             goto done;
2122         }
2123         ncb = itocb(cb->hnext);
2124         if (cbi != ncb->hprev) {
2125             ViceLog(0, ("cb_stateVerifyHCBList: error: corrupt linked list (cbi=%d, h->index=%d)\n",
2126                         cbi, hi));
2127             ret = 1;
2128             goto done;
2129         }
2130         if (chain_len > FS_STATE_HCB_MAX_LIST_LEN) {
2131             ViceLog(0, ("cb_stateVerifyFCBList: error: list length exceeds %d (h->index=%d); assuming there's a loop\n",
2132                         FS_STATE_HCB_MAX_LIST_LEN, hi));
2133             ret = 1;
2134             goto done;
2135         }
2136         chain_len++;
2137     }
2138
2139  done:
2140     return ret;
2141 }
2142
2143 static int
2144 cb_stateVerifyTimeoutQueues(struct fs_dump_state * state)
2145 {
2146     int ret = 0, i;
2147     afs_uint32 cbi, chain_len;
2148     struct CallBack *cb, *ncb;
2149
2150     for (i = 0; i < CB_NUM_TIMEOUT_QUEUES; i++) {
2151         chain_len = 0;
2152         for (cbi = timeout[i], cb = itocb(cbi);
2153              cb;
2154              cbi = cb->tnext, cb = ncb) {
2155             if (chain_len && (cbi == timeout[i])) {
2156                 /* we've wrapped around the circular list, and everything looks ok */
2157                 break;
2158             }
2159             if (cbi > cbstuff.nblks) {
2160                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: error: list index out of range (cbi=%d, tindex=%d)\n",
2161                             cbi, i));
2162                 ret = 1;
2163                 break;
2164             }
2165             if (itot(cb->thead) != &timeout[i]) {
2166                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: error: cb->thead points to wrong timeout queue (tindex=%d, cbi=%d, cb->thead=%d)\n",
2167                             i, cbi, cb->thead));
2168                 ret = 1;
2169             }
2170             if (!cb->tprev || !cb->tnext) {
2171                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: null index in circular list (cbi=%d, tindex=%d)\n",
2172                             cbi, i));
2173                 ret = 1;
2174                 break;
2175             }
2176             if ((cb->tprev > cbstuff.nblks) ||
2177                 (cb->tnext > cbstuff.nblks)) {
2178                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: list index out of range (cbi=%d, tindex=%d, cb->tprev=%d, cb->tnext=%d, nCBs=%d)\n",
2179                             cbi, i, cb->tprev, cb->tnext, cbstuff.nblks));
2180                 ret = 1;
2181                 break;
2182             }
2183             ncb = itocb(cb->tnext);
2184             if (cbi != ncb->tprev) {
2185                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: corrupt linked list (cbi=%d, tindex=%d)\n",
2186                             cbi, i));
2187                 ret = 1;
2188                 break;
2189             }
2190             if (chain_len > FS_STATE_TCB_MAX_LIST_LEN) {
2191                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: list length exceeds %d (tindex=%d); assuming there's a loop\n",
2192                             FS_STATE_TCB_MAX_LIST_LEN, i));
2193                 ret = 1;
2194                 break;
2195             }
2196             chain_len++;
2197         }
2198     }
2199
2200     return ret;
2201 }
2202
2203 static int
2204 cb_stateSaveTimeouts(struct fs_dump_state * state)
2205 {
2206     int ret = 0;
2207     struct iovec iov[2];
2208
2209     AssignInt64(state->eof_offset, &state->cb_hdr->timeout_offset);
2210
2211     memset(state->cb_timeout_hdr, 0, sizeof(struct callback_state_fehash_header));
2212     state->cb_timeout_hdr->magic = CALLBACK_STATE_TIMEOUT_MAGIC;
2213     state->cb_timeout_hdr->records = CB_NUM_TIMEOUT_QUEUES;
2214     state->cb_timeout_hdr->len = sizeof(struct callback_state_timeout_header) +
2215         (state->cb_timeout_hdr->records * sizeof(afs_uint32));
2216
2217     iov[0].iov_base = (char *)state->cb_timeout_hdr;
2218     iov[0].iov_len = sizeof(struct callback_state_timeout_header);
2219     iov[1].iov_base = (char *)timeout;
2220     iov[1].iov_len = sizeof(timeout);
2221
2222     if (fs_stateSeek(state, &state->cb_hdr->timeout_offset)) {
2223         ret = 1;
2224         goto done;
2225     }
2226
2227     if (fs_stateWriteV(state, iov, 2)) {
2228         ret = 1;
2229         goto done;
2230     }
2231
2232     fs_stateIncEOF(state, state->cb_timeout_hdr->len);
2233
2234  done:
2235     return ret;
2236 }
2237
2238 static int
2239 cb_stateRestoreTimeouts(struct fs_dump_state * state)
2240 {
2241     int ret = 0, len;
2242
2243     if (fs_stateReadHeader(state, &state->cb_hdr->timeout_offset,
2244                            state->cb_timeout_hdr, 
2245                            sizeof(struct callback_state_timeout_header))) {
2246         ret = 1;
2247         goto done;
2248     }
2249
2250     if (state->cb_timeout_hdr->magic != CALLBACK_STATE_TIMEOUT_MAGIC) {
2251         ret = 1;
2252         goto done;
2253     }
2254     if (state->cb_timeout_hdr->records != CB_NUM_TIMEOUT_QUEUES) {
2255         ret = 1;
2256         goto done;
2257     }
2258
2259     len = state->cb_timeout_hdr->records * sizeof(afs_uint32);
2260
2261     if (state->cb_timeout_hdr->len !=
2262         (sizeof(struct callback_state_timeout_header) + len)) {
2263         ret = 1;
2264         goto done;
2265     }
2266
2267     if (fs_stateRead(state, timeout, len)) {
2268         ret = 1;
2269         goto done;
2270     }
2271
2272  done:
2273     return ret;
2274 }
2275
2276 static int
2277 cb_stateSaveFEHash(struct fs_dump_state * state)
2278 {
2279     int ret = 0;
2280     struct iovec iov[2];
2281
2282     AssignInt64(state->eof_offset, &state->cb_hdr->fehash_offset);
2283
2284     memset(state->cb_fehash_hdr, 0, sizeof(struct callback_state_fehash_header));
2285     state->cb_fehash_hdr->magic = CALLBACK_STATE_FEHASH_MAGIC;
2286     state->cb_fehash_hdr->records = FEHASH_SIZE;
2287     state->cb_fehash_hdr->len = sizeof(struct callback_state_fehash_header) +
2288         (state->cb_fehash_hdr->records * sizeof(afs_uint32));
2289
2290     iov[0].iov_base = (char *)state->cb_fehash_hdr;
2291     iov[0].iov_len = sizeof(struct callback_state_fehash_header);
2292     iov[1].iov_base = (char *)HashTable;
2293     iov[1].iov_len = sizeof(HashTable);
2294
2295     if (fs_stateSeek(state, &state->cb_hdr->fehash_offset)) {
2296         ret = 1;
2297         goto done;
2298     }
2299
2300     if (fs_stateWriteV(state, iov, 2)) {
2301         ret = 1;
2302         goto done;
2303     }
2304
2305     fs_stateIncEOF(state, state->cb_fehash_hdr->len);
2306
2307  done:
2308     return ret;
2309 }
2310
2311 static int
2312 cb_stateRestoreFEHash(struct fs_dump_state * state)
2313 {
2314     int ret = 0, len;
2315
2316     if (fs_stateReadHeader(state, &state->cb_hdr->fehash_offset,
2317                            state->cb_fehash_hdr, 
2318                            sizeof(struct callback_state_fehash_header))) {
2319         ret = 1;
2320         goto done;
2321     }
2322
2323     if (state->cb_fehash_hdr->magic != CALLBACK_STATE_FEHASH_MAGIC) {
2324         ret = 1;
2325         goto done;
2326     }
2327     if (state->cb_fehash_hdr->records != FEHASH_SIZE) {
2328         ret = 1;
2329         goto done;
2330     }
2331
2332     len = state->cb_fehash_hdr->records * sizeof(afs_uint32);
2333
2334     if (state->cb_fehash_hdr->len !=
2335         (sizeof(struct callback_state_fehash_header) + len)) {
2336         ret = 1;
2337         goto done;
2338     }
2339
2340     if (fs_stateRead(state, HashTable, len)) {
2341         ret = 1;
2342         goto done;
2343     }
2344
2345  done:
2346     return ret;
2347 }
2348
2349 static int
2350 cb_stateSaveFEs(struct fs_dump_state * state)
2351 {
2352     int ret = 0;
2353     register int fei, hash;
2354     register struct FileEntry *fe;
2355
2356     AssignInt64(state->eof_offset, &state->cb_hdr->fe_offset);
2357
2358     for (hash = 0; hash < FEHASH_SIZE ; hash++) {
2359         for (fei = HashTable[hash]; fei; fei = fe->fnext) {
2360             fe = itofe(fei);
2361             if (cb_stateSaveFE(state, fe)) {
2362                 ret = 1;
2363                 goto done;
2364             }
2365         }
2366     }
2367
2368  done:
2369     return ret;
2370 }
2371
2372 static int
2373 cb_stateRestoreFEs(struct fs_dump_state * state)
2374 {
2375     int count, nFEs, ret = 0;
2376
2377     nFEs = state->cb_hdr->nFEs;
2378
2379     for (count = 0; count < nFEs; count++) {
2380         if (cb_stateRestoreFE(state)) {
2381             ret = 1;
2382             goto done;
2383         }
2384     }
2385
2386  done:
2387     return ret;
2388 }
2389
2390 static int
2391 cb_stateSaveFE(struct fs_dump_state * state, struct FileEntry * fe)
2392 {
2393     int ret = 0, iovcnt, cbi, written = 0;
2394     afs_uint32 fei;
2395     struct callback_state_entry_header hdr;
2396     struct FEDiskEntry fedsk;
2397     struct CBDiskEntry cbdsk[16];
2398     struct iovec iov[16];
2399     struct CallBack *cb;
2400
2401     fei = fetoi(fe);
2402     if (fei > state->cb_hdr->fe_max) {
2403         state->cb_hdr->fe_max = fei;
2404     }
2405
2406     memset(&hdr, 0, sizeof(struct callback_state_entry_header));
2407
2408     if (cb_stateFEToDiskEntry(fe, &fedsk)) {
2409         ret = 1;
2410         goto done;
2411     }
2412
2413     iov[0].iov_base = (char *)&hdr;
2414     iov[0].iov_len = sizeof(hdr);
2415     iov[1].iov_base = (char *)&fedsk;
2416     iov[1].iov_len = sizeof(struct FEDiskEntry);
2417     iovcnt = 2;
2418
2419     for (cbi = fe->firstcb, cb = itocb(cbi); 
2420          cb != NULL; 
2421          cbi = cb->cnext, cb = itocb(cbi), hdr.nCBs++) {
2422         if (cbi > state->cb_hdr->cb_max) {
2423             state->cb_hdr->cb_max = cbi;
2424         }
2425         if (cb_stateCBToDiskEntry(cb, &cbdsk[iovcnt])) {
2426             ret = 1;
2427             goto done;
2428         }
2429         cbdsk[iovcnt].index = cbi;
2430         iov[iovcnt].iov_base = (char *)&cbdsk[iovcnt];
2431         iov[iovcnt].iov_len = sizeof(struct CBDiskEntry);
2432         iovcnt++;
2433         if ((iovcnt == 16) || (!cb->cnext)) {
2434             if (fs_stateWriteV(state, iov, iovcnt)) {
2435                 ret = 1;
2436                 goto done;
2437             }
2438             written = 1;
2439             iovcnt = 0;
2440         }
2441     }
2442
2443     hdr.magic = CALLBACK_STATE_ENTRY_MAGIC;
2444     hdr.len = sizeof(hdr) + sizeof(struct FEDiskEntry) + 
2445         (hdr.nCBs * sizeof(struct CBDiskEntry));
2446
2447     if (!written) {
2448         if (fs_stateWriteV(state, iov, iovcnt)) {
2449             ret = 1;
2450             goto done;
2451         }
2452     } else {
2453         if (fs_stateWriteHeader(state, &state->eof_offset, &hdr, sizeof(hdr))) {
2454             ret = 1;
2455             goto done;
2456         }
2457     }
2458
2459     fs_stateIncEOF(state, hdr.len);
2460
2461     if (written) {
2462         if (fs_stateSeek(state, &state->eof_offset)) {
2463             ret = 1;
2464             goto done;
2465         }
2466     }
2467
2468     state->cb_hdr->nFEs++;
2469     state->cb_hdr->nCBs += hdr.nCBs;
2470
2471  done:
2472     return ret;
2473 }
2474
2475 static int
2476 cb_stateRestoreFE(struct fs_dump_state * state)
2477 {
2478     int ret = 0, iovcnt, nCBs;
2479     struct callback_state_entry_header hdr;
2480     struct FEDiskEntry fedsk;
2481     struct CBDiskEntry cbdsk[16];
2482     struct iovec iov[16];
2483     struct FileEntry * fe;
2484
2485     iov[0].iov_base = (char *)&hdr;
2486     iov[0].iov_len = sizeof(hdr);
2487     iov[1].iov_base = (char *)&fedsk;
2488     iov[1].iov_len = sizeof(fedsk);
2489     iovcnt = 2;
2490
2491     if (fs_stateReadV(state, iov, iovcnt)) {
2492         ret = 1;
2493         goto done;
2494     }
2495
2496     if (hdr.magic != CALLBACK_STATE_ENTRY_MAGIC) {
2497         ret = 1;
2498         goto done;
2499     }
2500
2501     fe = GetFE();
2502     if (fe == NULL) {
2503         ViceLog(0, ("cb_stateRestoreFE: ran out of free FileEntry structures\n"));
2504         ret = 1;
2505         goto done;
2506     }
2507
2508     if (cb_stateDiskEntryToFE(state, &fedsk, fe)) {
2509         ret = 1;
2510         goto done;
2511     }
2512
2513     if (hdr.nCBs) {
2514         for (iovcnt = 0, nCBs = 0;
2515              nCBs < hdr.nCBs;
2516              nCBs++) {
2517             iov[iovcnt].iov_base = (char *)&cbdsk[iovcnt];
2518             iov[iovcnt].iov_len = sizeof(struct CBDiskEntry);
2519             iovcnt++;
2520             if ((iovcnt == 16) || (nCBs == hdr.nCBs - 1)) {
2521                 if (fs_stateReadV(state, iov, iovcnt)) {
2522                     ret = 1;
2523                     goto done;
2524                 }
2525                 if (cb_stateRestoreCBs(state, fe, iov, iovcnt)) {
2526                     ret = 1;
2527                     goto done;
2528                 }
2529                 iovcnt = 0;
2530             }
2531         }
2532     }
2533     
2534  done:
2535     return ret;
2536 }
2537
2538 static int
2539 cb_stateRestoreCBs(struct fs_dump_state * state, struct FileEntry * fe, 
2540                    struct iovec * iov, int niovecs)
2541 {
2542     int ret = 0, idx;
2543     register struct CallBack * cb;
2544     struct CBDiskEntry * cbdsk;
2545     afs_uint32 fei;
2546
2547     fei = fetoi(fe);
2548
2549     for (idx = 0; idx < niovecs; idx++) {
2550         cbdsk = (struct CBDiskEntry *) iov[idx].iov_base;
2551         if ((cb = GetCB()) == NULL) {
2552             ViceLog(0, ("cb_stateRestoreCBs: ran out of free CallBack structures\n"));
2553             ret = 1;
2554             goto done;
2555         }
2556         if (cb_stateDiskEntryToCB(state, cbdsk, cb)) {
2557             ViceLog(0, ("cb_stateRestoreCBs: corrupt CallBack disk entry\n"));
2558             ret = 1;
2559             goto done;
2560         }
2561     }
2562
2563  done:
2564     return ret;
2565 }
2566
2567
2568 static int
2569 cb_stateFillHeader(struct callback_state_header * hdr)
2570 {
2571     hdr->stamp.magic = CALLBACK_STATE_MAGIC;
2572     hdr->stamp.version = CALLBACK_STATE_VERSION;
2573     hdr->tfirst = tfirst;
2574     return 0;
2575 }
2576
2577 static int
2578 cb_stateCheckHeader(struct callback_state_header * hdr)
2579 {
2580     int ret = 0;
2581
2582     if (hdr->stamp.magic != CALLBACK_STATE_MAGIC) {
2583         ret = 1;
2584     } else if (hdr->stamp.version != CALLBACK_STATE_VERSION) {
2585         ret = 1;
2586     } else if ((hdr->nFEs > cbstuff.nblks) || (hdr->nCBs > cbstuff.nblks)) {
2587         ViceLog(0, ("cb_stateCheckHeader: saved callback state larger than callback memory allocation\n"));
2588         ret = 1;
2589     }
2590     return ret;
2591 }
2592
2593 /* disk entry conversion routines */
2594 static int
2595 cb_stateFEToDiskEntry(struct FileEntry * in, struct FEDiskEntry * out)
2596 {
2597     memcpy(&out->fe, in, sizeof(struct FileEntry));
2598     out->index = fetoi(in);
2599     return 0;
2600 }
2601
2602 static int
2603 cb_stateDiskEntryToFE(struct fs_dump_state * state, 
2604                       struct FEDiskEntry * in, struct FileEntry * out)
2605 {
2606     int ret = 0;
2607
2608     memcpy(out, &in->fe, sizeof(struct FileEntry));
2609
2610     /* setup FE map entry */
2611     if (!in->index || (in->index >= state->fe_map.len)) {
2612         ViceLog(0, ("cb_stateDiskEntryToFE: index (%d) out of range",
2613                     in->index));
2614         ret = 1;
2615         goto done;
2616     }
2617     state->fe_map.entries[in->index].old_idx = in->index;
2618     state->fe_map.entries[in->index].new_idx = fetoi(out);
2619
2620  done:
2621     return ret;
2622 }
2623
2624 static int
2625 cb_stateCBToDiskEntry(struct CallBack * in, struct CBDiskEntry * out)
2626 {
2627     memcpy(&out->cb, in, sizeof(struct CallBack));
2628     out->index = cbtoi(in);
2629     return 0;
2630 }
2631
2632 static int
2633 cb_stateDiskEntryToCB(struct fs_dump_state * state,
2634                       struct CBDiskEntry * in, struct CallBack * out)
2635 {
2636     int ret = 0;
2637
2638     memcpy(out, &in->cb, sizeof(struct CallBack));
2639
2640     /* setup CB map entry */
2641     if (!in->index || (in->index >= state->cb_map.len)) {
2642         ViceLog(0, ("cb_stateDiskEntryToCB: index (%d) out of range\n",
2643                     in->index));
2644         ret = 1;
2645         goto done;
2646     }
2647     state->cb_map.entries[in->index].old_idx = in->index;
2648     state->cb_map.entries[in->index].new_idx = cbtoi(out);
2649
2650  done:
2651     return ret;
2652 }
2653
2654 /* index map routines */
2655 static int
2656 cb_stateAllocMap(struct fs_dump_state * state)
2657 {
2658     state->fe_map.len = state->cb_hdr->fe_max + 1;
2659     state->cb_map.len = state->cb_hdr->cb_max + 1;
2660     state->fe_map.entries = (struct idx_map_entry_t *)
2661         calloc(state->fe_map.len, sizeof(struct idx_map_entry_t));
2662     state->cb_map.entries = (struct idx_map_entry_t *)
2663         calloc(state->cb_map.len, sizeof(struct idx_map_entry_t));
2664     return ((state->fe_map.entries != NULL) && (state->cb_map.entries != NULL)) ? 0 : 1;
2665 }
2666
2667 int
2668 fe_OldToNew(struct fs_dump_state * state, afs_uint32 old, afs_uint32 * new)
2669 {
2670     int ret = 0;
2671
2672     /* FEs use a one-based indexing system, so old==0 implies no mapping */
2673     if (!old) {
2674         *new = 0;
2675         goto done;
2676     }
2677
2678     if (old >= state->fe_map.len) {
2679         ViceLog(0, ("fe_OldToNew: index %d is out of range\n", old));
2680         ret = 1;
2681     } else if (state->fe_map.entries[old].old_idx != old) { /* sanity check */
2682         ViceLog(0, ("fe_OldToNew: index %d points to an invalid FileEntry record\n", old));
2683         ret = 1;
2684     } else {
2685         *new = state->fe_map.entries[old].new_idx;
2686     }
2687
2688  done:
2689     return ret;
2690 }
2691
2692 int
2693 cb_OldToNew(struct fs_dump_state * state, afs_uint32 old, afs_uint32 * new)
2694 {
2695     int ret = 0;
2696
2697     /* CBs use a one-based indexing system, so old==0 implies no mapping */
2698     if (!old) {
2699         *new = 0;
2700         goto done;
2701     }
2702
2703     if (old >= state->cb_map.len) {
2704         ViceLog(0, ("cb_OldToNew: index %d is out of range\n", old));
2705         ret = 1;
2706     } else if (state->cb_map.entries[old].old_idx != old) { /* sanity check */
2707         ViceLog(0, ("cb_OldToNew: index %d points to an invalid CallBack record\n", old));
2708         ret = 1;
2709     } else {
2710         *new = state->cb_map.entries[old].new_idx;
2711     }
2712
2713  done:
2714     return ret;
2715 }
2716 #endif /* AFS_DEMAND_ATTACH_FS */
2717
2718 int
2719 DumpCallBackState(void)
2720 {
2721     int fd, oflag;
2722     afs_uint32 magic = MAGICV2, now = (afs_int32) FT_ApproxTime(), freelisthead;
2723
2724     oflag = O_WRONLY | O_CREAT | O_TRUNC;
2725 #ifdef AFS_NT40_ENV
2726     oflag |= O_BINARY;
2727 #endif
2728     fd = open(AFSDIR_SERVER_CBKDUMP_FILEPATH, oflag, 0666);
2729     if (fd < 0) {
2730         ViceLog(0,
2731                 ("Couldn't create callback dump file %s\n",
2732                  AFSDIR_SERVER_CBKDUMP_FILEPATH));
2733         return 0;
2734     }
2735     (void)write(fd, &magic, sizeof(magic));
2736     (void)write(fd, &now, sizeof(now));
2737     (void)write(fd, &cbstuff, sizeof(cbstuff));
2738     (void)write(fd, TimeOuts, sizeof(TimeOuts));
2739     (void)write(fd, timeout, sizeof(timeout));
2740     (void)write(fd, &tfirst, sizeof(tfirst));
2741     freelisthead = cbtoi((struct CallBack *)CBfree);
2742     (void)write(fd, &freelisthead, sizeof(freelisthead));       /* This is a pointer */
2743     freelisthead = fetoi((struct FileEntry *)FEfree);
2744     (void)write(fd, &freelisthead, sizeof(freelisthead));       /* This is a pointer */
2745     (void)write(fd, HashTable, sizeof(HashTable));
2746     (void)write(fd, &CB[1], sizeof(CB[1]) * cbstuff.nblks);     /* CB stuff */
2747     (void)write(fd, &FE[1], sizeof(FE[1]) * cbstuff.nblks);     /* FE stuff */
2748     close(fd);
2749
2750     return 0;
2751 }
2752
2753 #endif /* !INTERPRET_DUMP */
2754
2755 #ifdef INTERPRET_DUMP
2756
2757 /* This is only compiled in for the callback analyzer program */
2758 /* Returns the time of the dump */
2759 time_t
2760 ReadDump(char *file, int timebits)
2761 {
2762     int fd, oflag;
2763     afs_uint32 magic, freelisthead;
2764     afs_uint32 now;
2765 #ifdef AFS_64BIT_ENV
2766     afs_int64 now64;
2767 #endif
2768
2769     oflag = O_RDONLY;
2770 #ifdef AFS_NT40_ENV
2771     oflag |= O_BINARY;
2772 #endif
2773     fd = open(file, oflag);
2774     if (fd < 0) {
2775         fprintf(stderr, "Couldn't read dump file %s\n", file);
2776         exit(1);
2777     }
2778     read(fd, &magic, sizeof(magic));
2779     if (magic == MAGICV2) {
2780         timebits = 32;
2781     } else {
2782         if (magic != MAGIC) {
2783             fprintf(stderr,
2784                     "Magic number of %s is invalid.  You might be trying to\n",
2785                     file);
2786             fprintf(stderr,
2787                     "run this program on a machine type with a different byte ordering.\n");
2788             exit(1);
2789         }
2790     }
2791 #ifdef AFS_64BIT_ENV
2792     if (timebits == 64) {
2793         read(fd, &now64, sizeof(afs_int64));
2794         now = (afs_int32) now64;
2795     } else
2796 #endif
2797         read(fd, &now, sizeof(afs_int32));
2798     read(fd, &cbstuff, sizeof(cbstuff));
2799     read(fd, TimeOuts, sizeof(TimeOuts));
2800     read(fd, timeout, sizeof(timeout));
2801     read(fd, &tfirst, sizeof(tfirst));
2802     read(fd, &freelisthead, sizeof(freelisthead));
2803     CB = ((struct CallBack
2804            *)(calloc(cbstuff.nblks, sizeof(struct CallBack)))) - 1;
2805     FE = ((struct FileEntry
2806            *)(calloc(cbstuff.nblks, sizeof(struct FileEntry)))) - 1;
2807     CBfree = (struct CallBack *)itocb(freelisthead);
2808     read(fd, &freelisthead, sizeof(freelisthead));
2809     FEfree = (struct FileEntry *)itofe(freelisthead);
2810     read(fd, HashTable, sizeof(HashTable));
2811     read(fd, &CB[1], sizeof(CB[1]) * cbstuff.nblks);    /* CB stuff */
2812     read(fd, &FE[1], sizeof(FE[1]) * cbstuff.nblks);    /* FE stuff */
2813     if (close(fd)) {
2814         perror("Error reading dumpfile");
2815         exit(1);
2816     }
2817     return now;
2818 }
2819
2820 #ifdef AFS_NT40_ENV
2821 #include "AFS_component_version_number.h"
2822 #else
2823 #include "AFS_component_version_number.c"
2824 #endif
2825
2826 int
2827 main(int argc, char **argv)
2828 {
2829     int err = 0, cbi = 0, stats = 0, noptions = 0, all = 0, vol = 0, raw = 0;
2830     static AFSFid fid;
2831     register struct FileEntry *fe;
2832     register struct CallBack *cb;
2833     afs_int32 now;
2834     int timebits = 32;
2835     
2836     memset(&fid, 0, sizeof(fid));
2837     argc--;
2838     argv++;
2839     while (argc && **argv == '-') {
2840         noptions++;
2841         argc--;
2842         if (!strcmp(*argv, "-host")) {
2843             if (argc < 1) {
2844                 err++;
2845                 break;
2846             }
2847             argc--;
2848             cbi = atoi(*++argv);
2849         } else if (!strcmp(*argv, "-fid")) {
2850             if (argc < 2) {
2851                 err++;
2852                 break;
2853             }
2854             argc -= 3;
2855             fid.Volume = atoi(*++argv);
2856             fid.Vnode = atoi(*++argv);
2857             fid.Unique = atoi(*++argv);
2858         } else if (!strcmp(*argv, "-time")) {
2859             fprintf(stderr, "-time not supported\n");
2860             exit(1);
2861         } else if (!strcmp(*argv, "-stats")) {
2862             stats = 1;
2863         } else if (!strcmp(*argv, "-all")) {
2864             all = 1;
2865         } else if (!strcmp(*argv, "-raw")) {
2866             raw = 1;
2867         } else if (!strcmp(*argv, "-timebits")) {
2868             if (argc < 1) {
2869                 err++;
2870                 break;
2871             }
2872             argc--;
2873             timebits = atoi(*++argv);
2874             if ((timebits != 32)
2875 #ifdef AFS_64BIT_ENV
2876                 && (timebits != 64)
2877 #endif
2878                 ) 
2879                 err++;
2880         } else if (!strcmp(*argv, "-volume")) {
2881             if (argc < 1) {
2882                 err++;
2883                 break;
2884             }
2885             argc--;
2886             vol = atoi(*++argv);
2887         } else
2888             err++;
2889         argv++;
2890     }
2891     if (err || argc != 1) {
2892         fprintf(stderr,
2893                 "Usage: cbd [-host cbid] [-fid volume vnode] [-stats] [-all] [-timebits 32"
2894 #ifdef AFS_64BIT_ENV
2895                 "|64"
2896 #endif
2897                 "] callbackdumpfile\n");
2898         fprintf(stderr,
2899                 "[cbid is shown for each host in the hosts.dump file]\n");
2900         exit(1);
2901     }
2902     now = ReadDump(*argv, timebits);
2903     if (stats || noptions == 0) {
2904         time_t uxtfirst = UXtime(tfirst), tnow = now;
2905         printf("The time of the dump was %u %s", (unsigned int) now, ctime(&tnow));
2906         printf("The last time cleanup ran was %u %s", (unsigned int) uxtfirst,
2907                ctime(&uxtfirst));
2908         PrintCallBackStats();
2909     }
2910     if (all || vol) {
2911         int hash;
2912         afs_uint32 *feip;
2913         struct CallBack *cb;
2914         struct FileEntry *fe;
2915
2916         for (hash = 0; hash < FEHASH_SIZE; hash++) {
2917             for (feip = &HashTable[hash]; (fe = itofe(*feip));) {
2918                 if (!vol || (fe->volid == vol)) {
2919                     register struct CallBack *cbnext;
2920                     for (cb = itocb(fe->firstcb); cb; cb = cbnext) {
2921                         PrintCB(cb, now);
2922                         cbnext = itocb(cb->cnext);
2923                     }
2924                     *feip = fe->fnext;
2925                 } else {
2926                     feip = &fe->fnext;
2927                 }
2928             }
2929         }
2930     }
2931     if (cbi) {
2932         afs_uint32 cfirst = cbi;
2933         do {
2934             cb = itocb(cbi);
2935             PrintCB(cb, now);
2936             cbi = cb->hnext;
2937         } while (cbi != cfirst);
2938     }
2939     if (fid.Volume) {
2940         fe = FindFE(&fid);
2941         if (!fe) {
2942             printf("No callback entries for %u.%u\n", fid.Volume, fid.Vnode);
2943             exit(1);
2944         }
2945         cb = itocb(fe->firstcb);
2946         while (cb) {
2947             PrintCB(cb, now);
2948             cb = itocb(cb->cnext);
2949         }
2950     }
2951     if (raw) {
2952         afs_int32 *p, i;
2953         for (i = 1; i < cbstuff.nblks; i++) {
2954             p = (afs_int32 *) & FE[i];
2955             printf("%d:%12x%12x%12x%12x\n", i, p[0], p[1], p[2], p[3]);
2956         }
2957     }
2958     exit(0);
2959 }
2960
2961 void
2962 PrintCB(register struct CallBack *cb, afs_uint32 now)
2963 {
2964     struct FileEntry *fe = itofe(cb->fhead);
2965     time_t expires = TIndexToTime(cb->thead);
2966
2967     if (fe == NULL)
2968         return;
2969
2970     printf("vol=%u vn=%u cbs=%d hi=%d st=%d fest=%d, exp in %lu secs at %s",
2971            fe->volid, fe->vnode, fe->ncbs, cb->hhead, cb->status, fe->status,
2972            expires - now, ctime(&expires));
2973 }
2974
2975 #endif
2976
2977 #if     !defined(INTERPRET_DUMP)
2978 /*
2979 ** try breaking calbacks on afidp from host. Use multi_rx.
2980 ** return 0 on success, non-zero on failure
2981 */
2982 int
2983 MultiBreakCallBackAlternateAddress(struct host *host, struct AFSCBFids *afidp)
2984 {
2985     int retVal;
2986     H_LOCK;
2987     retVal = MultiBreakCallBackAlternateAddress_r(host, afidp);
2988     H_UNLOCK;
2989     return retVal;
2990 }
2991
2992 int
2993 MultiBreakCallBackAlternateAddress_r(struct host *host,
2994                                      struct AFSCBFids *afidp)
2995 {
2996     int i, j;
2997     struct rx_connection **conns;
2998     struct rx_connection *connSuccess = 0;
2999     struct AddrPort *interfaces;
3000     static struct rx_securityClass *sc = 0;
3001     static struct AFSCBs tc = { 0, 0 };
3002     char hoststr[16];
3003
3004     /* nothing more can be done */
3005     if (!host->interface)
3006         return 1;               /* failure */
3007
3008     /* the only address is the primary interface */
3009     if (host->interface->numberOfInterfaces <= 1)
3010         return 1;               /* failure */
3011
3012     /* initialise a security object only once */
3013     if (!sc)
3014         sc = rxnull_NewClientSecurityObject();
3015
3016     i = host->interface->numberOfInterfaces;
3017     interfaces = calloc(i, sizeof(struct AddrPort));
3018     conns = calloc(i, sizeof(struct rx_connection *));
3019     if (!interfaces || !conns) {
3020         ViceLog(0,
3021                 ("Failed malloc in MultiBreakCallBackAlternateAddress_r\n"));
3022         assert(0);
3023     }
3024
3025     /* initialize alternate rx connections */
3026     for (i = 0, j = 0; i < host->interface->numberOfInterfaces; i++) {
3027         /* this is the current primary address */
3028         if (host->host == host->interface->interface[i].addr &&
3029             host->port == host->interface->interface[i].port)
3030             continue;
3031
3032         interfaces[j] = host->interface->interface[i];
3033         conns[j] =
3034             rx_NewConnection(interfaces[j].addr, 
3035                              interfaces[j].port, 1, sc, 0);
3036         rx_SetConnDeadTime(conns[j], 2);
3037         rx_SetConnHardDeadTime(conns[j], AFS_HARDDEADTIME);
3038         j++;
3039     }
3040
3041     assert(j);                  /* at least one alternate address */
3042     ViceLog(125,
3043             ("Starting multibreakcall back on all addr for host %p (%s:%d)\n",
3044              host, afs_inet_ntoa_r(host->host, hoststr), ntohs(host->port)));
3045     H_UNLOCK;
3046     multi_Rx(conns, j) {
3047         multi_RXAFSCB_CallBack(afidp, &tc);
3048         if (!multi_error) {
3049             /* first success */
3050             H_LOCK;
3051             if (host->callback_rxcon)
3052                 rx_DestroyConnection(host->callback_rxcon);
3053             host->callback_rxcon = conns[multi_i];
3054             h_DeleteHostFromAddrHashTable_r(host->host, host->port, host);
3055             host->host = interfaces[multi_i].addr;
3056             host->port = interfaces[multi_i].port;
3057             h_AddHostToAddrHashTable_r(host->host, host->port, host);
3058             connSuccess = conns[multi_i];
3059             rx_SetConnDeadTime(host->callback_rxcon, 50);
3060             rx_SetConnHardDeadTime(host->callback_rxcon, AFS_HARDDEADTIME);
3061             ViceLog(125,
3062                     ("multibreakcall success with addr %s:%d\n",
3063                      afs_inet_ntoa_r(interfaces[multi_i].addr, hoststr),
3064                      ntohs(interfaces[multi_i].port)));
3065             H_UNLOCK;
3066             multi_Abort;
3067         }
3068     }
3069     multi_End_Ignore;
3070     H_LOCK;
3071     /* Destroy all connections except the one on which we succeeded */
3072     for (i = 0; i < j; i++)
3073         if (conns[i] != connSuccess)
3074             rx_DestroyConnection(conns[i]);
3075
3076     free(interfaces);
3077     free(conns);
3078
3079     if (connSuccess)
3080         return 0;               /* success */
3081     else
3082         return 1;               /* failure */
3083 }
3084
3085
3086 /*
3087 ** try multi_RX probes to host. 
3088 ** return 0 on success, non-0 on failure
3089 */
3090 int
3091 MultiProbeAlternateAddress_r(struct host *host)
3092 {
3093     int i, j;
3094     struct rx_connection **conns;
3095     struct rx_connection *connSuccess = 0;
3096     struct AddrPort *interfaces;
3097     static struct rx_securityClass *sc = 0;
3098     char hoststr[16];
3099
3100     /* nothing more can be done */
3101     if (!host->interface)
3102         return 1;               /* failure */
3103
3104     /* the only address is the primary interface */
3105     if (host->interface->numberOfInterfaces <= 1)
3106         return 1;               /* failure */
3107
3108     /* initialise a security object only once */
3109     if (!sc)
3110         sc = rxnull_NewClientSecurityObject();
3111
3112     i = host->interface->numberOfInterfaces;
3113     interfaces = calloc(i, sizeof(struct AddrPort));
3114     conns = calloc(i, sizeof(struct rx_connection *));
3115     if (!interfaces || !conns) {
3116         ViceLog(0, ("Failed malloc in MultiProbeAlternateAddress_r\n"));
3117         assert(0);
3118     }
3119
3120     /* initialize alternate rx connections */
3121     for (i = 0, j = 0; i < host->interface->numberOfInterfaces; i++) {
3122         /* this is the current primary address */
3123         if (host->host == host->interface->interface[i].addr &&
3124             host->port == host->interface->interface[i].port)
3125             continue;
3126
3127         interfaces[j] = host->interface->interface[i];
3128         conns[j] =
3129             rx_NewConnection(interfaces[j].addr, 
3130                              interfaces[j].port, 1, sc, 0);
3131         rx_SetConnDeadTime(conns[j], 2);
3132         rx_SetConnHardDeadTime(conns[j], AFS_HARDDEADTIME);
3133         j++;
3134     }
3135
3136     assert(j);                  /* at least one alternate address */
3137     ViceLog(125,
3138             ("Starting multiprobe on all addr for host %p (%s:%d)\n",
3139              host, afs_inet_ntoa_r(host->host, hoststr),
3140              ntohs(host->port)));
3141     H_UNLOCK;
3142     multi_Rx(conns, j) {
3143         multi_RXAFSCB_ProbeUuid(&host->interface->uuid);
3144         if (!multi_error) {
3145             /* first success */
3146             H_LOCK;
3147             if (host->callback_rxcon)
3148                 rx_DestroyConnection(host->callback_rxcon);
3149             host->callback_rxcon = conns[multi_i];
3150             h_DeleteHostFromAddrHashTable_r(host->host, host->port, host);
3151             host->host = interfaces[multi_i].addr;
3152             host->port = interfaces[multi_i].port;
3153             h_AddHostToAddrHashTable_r(host->host, host->port, host);
3154             connSuccess = conns[multi_i];
3155             rx_SetConnDeadTime(host->callback_rxcon, 50);
3156             rx_SetConnHardDeadTime(host->callback_rxcon, AFS_HARDDEADTIME);
3157             ViceLog(125,
3158                     ("multiprobe success with addr %s:%d\n",
3159                      afs_inet_ntoa_r(interfaces[multi_i].addr, hoststr),
3160                      ntohs(interfaces[multi_i].port)));
3161             H_UNLOCK;
3162             multi_Abort;
3163         } else {
3164             ViceLog(125,
3165                     ("multiprobe failure with addr %s:%d\n",
3166                      afs_inet_ntoa_r(interfaces[multi_i].addr, hoststr),
3167                      ntohs(interfaces[multi_i].port)));
3168             
3169             /* This is less than desirable but its the best we can do.
3170              * The AFS Cache Manager will return either 0 for a Uuid  
3171              * match and a 1 for a non-match.   If the error is 1 we 
3172              * therefore know that our mapping of IP address to Uuid 
3173              * is wrong.   We should attempt to find the correct
3174              * Uuid and fix the host tables.
3175              */
3176             if (multi_error == 1) {
3177                 /* remove the current alternate address from this host */
3178                 H_LOCK;
3179                 removeInterfaceAddr_r(host, interfaces[multi_i].addr, interfaces[multi_i].port);
3180                 H_UNLOCK;
3181             }
3182         }
3183 #ifdef AFS_DEMAND_ATTACH_FS
3184         /* try to bail ASAP if the fileserver is shutting down */
3185         FS_STATE_RDLOCK;
3186         if (fs_state.mode == FS_MODE_SHUTDOWN) {
3187             FS_STATE_UNLOCK;
3188             multi_Abort;
3189         }
3190         FS_STATE_UNLOCK;
3191 #endif
3192     }
3193     multi_End_Ignore;
3194     H_LOCK;
3195     /* Destroy all connections except the one on which we succeeded */
3196     for (i = 0; i < j; i++)
3197         if (conns[i] != connSuccess)
3198             rx_DestroyConnection(conns[i]);
3199
3200     free(interfaces);
3201     free(conns);
3202
3203     if (connSuccess)
3204         return 0;               /* success */
3205     else
3206         return 1;               /* failure */
3207 }
3208
3209 #endif /* !defined(INTERPRET_DUMP) */