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