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