afsd: correct printf format mismatch in debugging printf
[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->cblist) {
309         host->cblist = cb->hnext = cb->hprev = cbtoi(cb);
310     } else {
311         struct CallBack *fcb = itocb(host->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)->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->callback_rxcon, 4);
465     rx_SetConnHardDeadTime(ahost->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->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->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->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->hostFlags & HOSTDELETED) {
556             host->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->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->hostFlags & HOSTDELETED)) {
707             continue;
708         }
709         rx_GetConnection(thishost->callback_rxcon);
710         multi_to_cba_map[j] = i;
711         conns[j++] = thishost->callback_rxcon;
712
713         rx_SetConnDeadTime(thishost->callback_rxcon, 4);
714         rx_SetConnHardDeadTime(thishost->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->host, hoststr),
749                                      ntohs(hp->port)));
750                         }
751
752                         H_LOCK;
753                         h_Lock_r(hp);
754                         if (!(hp->hostFlags & HOSTDELETED)) {
755                             hp->hostFlags |= VENUSDOWN;
756                             /**
757                              * We always go into AddCallBack1_r with the host locked
758                              */
759                             AddCallBack1_r(hp, afidp->AFSCBFids_val, itot(idx),
760                                            CB_DELAYED, 1);
761                         }
762                         h_Unlock_r(hp);
763                         H_UNLOCK;
764                     }
765                 }
766             }
767         }
768         multi_End;
769         H_LOCK;
770         cbstuff.nbreakers--;
771     }
772
773     for (i = 0; i < ncbas; i++) {
774         struct host *hp;
775         hp = cba[i].hp;
776         if (hp) {
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->host, hoststr), ntohs(xhost->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->hostFlags & VENUSDOWN) {
868                     ViceLog(7,
869                             ("BCB: %p (%s:%d) is down; delaying break call back\n",
870                              thishost, afs_inet_ntoa_r(thishost->host, hoststr),
871                              ntohs(thishost->port)));
872                     cb->status = CB_DELAYED;
873                 } else {
874                     if (!(thishost->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->host, hoststr), ntohs(host->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->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->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->hostFlags & RESETDONE) && !(host->hostFlags & HOSTDELETED)) {
1037         host->hostFlags &= ~ALTADDR;    /* alternate addresses are invalid */
1038         cb_conn = host->callback_rxcon;
1039         rx_GetConnection(cb_conn);
1040         if (host->interface) {
1041             H_UNLOCK;
1042             code =
1043                 RXAFSCB_InitCallBackState3(cb_conn, &FS_HostUUID);
1044         } else {
1045             H_UNLOCK;
1046             code = RXAFSCB_InitCallBackState(cb_conn);
1047         }
1048         rx_PutConnection(cb_conn);
1049         cb_conn = NULL;
1050         H_LOCK;
1051         host->hostFlags |= ALTADDR;     /* alternate addresses are valid */
1052         if (code) {
1053             if (ShowProblems) {
1054                 ViceLog(0,
1055                         ("CB: Call back connect back failed (in break delayed) "
1056                          "for Host %p (%s:%d)\n",
1057                          host, afs_inet_ntoa_r(host->host, hoststr),
1058                          ntohs(host->port)));
1059             }
1060             host->hostFlags |= VENUSDOWN;
1061         } else {
1062             ViceLog(25,
1063                     ("InitCallBackState success on %p (%s:%d)\n",
1064                      host, afs_inet_ntoa_r(host->host, hoststr),
1065                      ntohs(host->port)));
1066             /* reset was done successfully */
1067             host->hostFlags |= RESETDONE;
1068             host->hostFlags &= ~VENUSDOWN;
1069         }
1070     } else
1071         while (!(host->hostFlags & HOSTDELETED)) {
1072             nfids = 0;
1073             host->hostFlags &= ~VENUSDOWN;      /* presume up */
1074             cbi = first = host->cblist;
1075             if (!cbi)
1076                 break;
1077             do {
1078                 first = host->cblist;
1079                 cb = itocb(cbi);
1080                 cbi = cb->hnext;
1081                 if (cb->status == CB_DELAYED) {
1082                     struct FileEntry *fe = itofe(cb->fhead);
1083                     fids[nfids].Volume = fe->volid;
1084                     fids[nfids].Vnode = fe->vnode;
1085                     fids[nfids].Unique = fe->unique;
1086                     nfids++;
1087                     HDel(cb);
1088                     TDel(cb);
1089                     CDel(cb, 1);
1090                 }
1091             } while (cbi && cbi != first && nfids < AFSCBMAX);
1092
1093             if (nfids == 0) {
1094                 break;
1095             }
1096
1097             if (XCallBackBulk_r(host, fids, nfids)) {
1098                 /* Failed, again:  put them back, probably with old
1099                  * timeout values */
1100                 int i;
1101                 if (ShowProblems) {
1102                     ViceLog(0,
1103                             ("CB: XCallBackBulk failed, Host %p (%s:%d); "
1104                              "callback list follows:\n",
1105                              host, afs_inet_ntoa_r(host->host, hoststr),
1106                              ntohs(host->port)));
1107                 }
1108                 for (i = 0; i < nfids; i++) {
1109                     if (ShowProblems) {
1110                         ViceLog(0,
1111                                 ("CB: Host %p (%s:%d), file %u.%u.%u "
1112                                  "(part of bulk callback)\n",
1113                                  host, afs_inet_ntoa_r(host->host, hoststr),
1114                                  ntohs(host->port), fids[i].Volume,
1115                                  fids[i].Vnode, fids[i].Unique));
1116                     }
1117                     /* used to do this:
1118                      * AddCallBack1_r(host, &fids[i], itot(thead[i]), CB_DELAYED, 1);
1119                      * * but it turns out to cause too many tricky locking problems.
1120                      * * now, if break delayed fails, screw it. */
1121                 }
1122                 host->hostFlags |= VENUSDOWN;   /* Failed */
1123                 ClearHostCallbacks_r(host, 1 /* locked */ );
1124                 nfids = 0;
1125                 break;
1126             }
1127             if (nfids < AFSCBMAX)
1128                 break;
1129         }
1130
1131     cbstuff.nbreakers--;
1132     /* If we succeeded it's always ok to unset HFE_LATER */
1133     if (!(host->hostFlags & VENUSDOWN))
1134         host->hostFlags &= ~HFE_LATER;
1135     return (host->hostFlags & VENUSDOWN);
1136 }
1137
1138 static int
1139 MultiBreakVolumeCallBack_r(struct host *host,
1140                            struct VCBParams *parms, int deletefe)
1141 {
1142     char hoststr[16];
1143
1144     if (host->hostFlags & HOSTDELETED)
1145         return 0;
1146
1147     if (!(host->hostFlags & HCBREAK))
1148         return 0;               /* host is not flagged to notify */
1149
1150     if (host->hostFlags & VENUSDOWN) {
1151         h_Lock_r(host);
1152         /* Do not care if the host is now HOSTDELETED */
1153         if (ShowProblems) {
1154             ViceLog(0,
1155                     ("BVCB: volume callback for Host %p (%s:%d) failed\n",
1156                      host, afs_inet_ntoa_r(host->host, hoststr),
1157                      ntohs(host->port)));
1158         }
1159         DeleteAllCallBacks_r(host, deletefe);   /* Delete all callback state
1160                                                  * rather than attempting to
1161                                                  * selectively remember to
1162                                                  * delete the volume callbacks
1163                                                  * later */
1164         host->hostFlags &= ~(RESETDONE|HCBREAK);        /* Do InitCallBackState when host returns */
1165         h_Unlock_r(host);
1166         return 0;
1167     }
1168     opr_Assert(parms->ncbas <= MAX_CB_HOSTS);
1169
1170     /* Do not call MultiBreakCallBack on the current host structure
1171      ** because it would prematurely release the hold on the host
1172      */
1173     if (parms->ncbas == MAX_CB_HOSTS) {
1174         struct AFSCBFids tf;
1175
1176         tf.AFSCBFids_len = 1;
1177         tf.AFSCBFids_val = parms->fid;
1178
1179         /* this releases all the hosts */
1180         MultiBreakCallBack_r(parms->cba, parms->ncbas, &tf);
1181
1182         parms->ncbas = 0;
1183     }
1184     parms->cba[parms->ncbas].hp = host;
1185     parms->cba[(parms->ncbas)++].thead = parms->thead;
1186     host->hostFlags &= ~HCBREAK;
1187
1188     /* we have more work to do on this host, so make sure we keep a reference
1189      * to it */
1190     h_Hold_r(host);
1191
1192     return 0;
1193 }
1194
1195 static int
1196 MultiBreakVolumeLaterCallBack(struct host *host, void *rock)
1197 {
1198     struct VCBParams *parms = (struct VCBParams *)rock;
1199     int retval;
1200     H_LOCK;
1201     retval = MultiBreakVolumeCallBack_r(host, parms, 0);
1202     H_UNLOCK;
1203     return retval;
1204 }
1205
1206 /*
1207  * Break all call backs on a single volume.  Don't call this with any
1208  * hosts h_held.  Note that this routine clears the callbacks before
1209  * actually breaking them, and that the vnode isn't locked during this
1210  * operation, so that people might see temporary callback loss while
1211  * this function is executing.  It is just a temporary state, however,
1212  * since the callback will be broken later by this same function.
1213  *
1214  * Now uses multi-RX for CallBack RPC in a different thread,
1215  * only marking them here.
1216  */
1217 extern pthread_cond_t fsync_cond;
1218
1219 int
1220 BreakVolumeCallBacksLater(VolumeId volume)
1221 {
1222     int hash;
1223     afs_uint32 *feip;
1224     struct FileEntry *fe;
1225     struct CallBack *cb;
1226     struct host *host;
1227     int found = 0;
1228
1229     ViceLog(25, ("Setting later on volume %" AFS_VOLID_FMT "\n",
1230                  afs_printable_VolumeId_lu(volume)));
1231     H_LOCK;
1232     for (hash = 0; hash < FEHASH_SIZE; hash++) {
1233         for (feip = &HashTable[hash]; (fe = itofe(*feip)) != NULL; ) {
1234             if (fe->volid == volume) {
1235                 struct CallBack *cbnext;
1236                 for (cb = itocb(fe->firstcb); cb; cb = cbnext) {
1237                     host = h_itoh(cb->hhead);
1238                     host->hostFlags |= HFE_LATER;
1239                     cb->status = CB_DELAYED;
1240                     cbnext = itocb(cb->cnext);
1241                 }
1242                 FSYNC_LOCK;
1243                 fe->status |= FE_LATER;
1244                 FSYNC_UNLOCK;
1245                 found = 1;
1246             }
1247             feip = &fe->fnext;
1248         }
1249     }
1250     H_UNLOCK;
1251     if (!found) {
1252         /* didn't find any callbacks, so return right away. */
1253         return 0;
1254     }
1255
1256     ViceLog(25, ("Fsync thread wakeup\n"));
1257     FSYNC_LOCK;
1258     opr_cv_broadcast(&fsync_cond);
1259     FSYNC_UNLOCK;
1260     return 0;
1261 }
1262
1263 int
1264 BreakLaterCallBacks(void)
1265 {
1266     struct AFSFid fid;
1267     int hash;
1268     afs_uint32 *feip;
1269     struct CallBack *cb;
1270     struct FileEntry *fe = NULL;
1271     struct FileEntry *myfe = NULL;
1272     struct host *host;
1273     struct VCBParams henumParms;
1274     unsigned short tthead = 0;  /* zero is illegal value */
1275     char hoststr[16];
1276
1277     /* Unchain first */
1278     ViceLog(25, ("Looking for FileEntries to unchain\n"));
1279     H_LOCK;
1280     FSYNC_LOCK;
1281     /* Pick the first volume we see to clean up */
1282     fid.Volume = fid.Vnode = fid.Unique = 0;
1283
1284     for (hash = 0; hash < FEHASH_SIZE; hash++) {
1285         for (feip = &HashTable[hash]; (fe = itofe(*feip)) != NULL; ) {
1286             if (fe && (fe->status & FE_LATER)
1287                 && (fid.Volume == 0 || fid.Volume == fe->volid)) {
1288                 /* Ugly, but used to avoid left side casting */
1289                 struct object *tmpfe;
1290                 ViceLog(125,
1291                         ("Unchaining for %u:%u:%" AFS_VOLID_FMT "\n", fe->vnode,
1292                          fe->unique, afs_printable_VolumeId_lu(fe->volid)));
1293                 fid.Volume = fe->volid;
1294                 *feip = fe->fnext;
1295                 fe->status &= ~FE_LATER; /* not strictly needed */
1296                 /* Works since volid is deeper than the largest pointer */
1297                 tmpfe = (struct object *)fe;
1298                 tmpfe->next = (struct object *)myfe;
1299                 myfe = fe;
1300             } else
1301                 feip = &fe->fnext;
1302         }
1303     }
1304     FSYNC_UNLOCK;
1305
1306     if (!myfe) {
1307         H_UNLOCK;
1308         return 0;
1309     }
1310
1311     /* loop over FEs from myfe and free/break */
1312     tthead = 0;
1313     for (fe = myfe; fe;) {
1314         struct CallBack *cbnext;
1315         for (cb = itocb(fe->firstcb); cb; cb = cbnext) {
1316             cbnext = itocb(cb->cnext);
1317             host = h_itoh(cb->hhead);
1318             if (cb->status == CB_DELAYED) {
1319                 if (!(host->hostFlags & HOSTDELETED)) {
1320                     /* mark this host for notification */
1321                     host->hostFlags |= HCBREAK;
1322                     if (!tthead || (TNorm(tthead) < TNorm(cb->thead))) {
1323                         tthead = cb->thead;
1324                     }
1325                 }
1326                 TDel(cb);
1327                 HDel(cb);
1328                 CDel(cb, 0);    /* Don't let CDel clean up the fe */
1329                 /* leave flag for MultiBreakVolumeCallBack to clear */
1330             } else {
1331                 ViceLog(125,
1332                         ("Found host %p (%s:%d) non-DELAYED cb for %u:%u:%" AFS_VOLID_FMT "\n",
1333                          host, afs_inet_ntoa_r(host->host, hoststr),
1334                          ntohs(host->port), fe->vnode, fe->unique,
1335                          afs_printable_VolumeId_lu(fe->volid)));
1336             }
1337         }
1338         myfe = fe;
1339         fe = (struct FileEntry *)((struct object *)fe)->next;
1340         FreeFE(myfe);
1341     }
1342
1343     if (tthead) {
1344         ViceLog(125, ("Breaking volume %u\n", fid.Volume));
1345         henumParms.ncbas = 0;
1346         henumParms.fid = &fid;
1347         henumParms.thead = tthead;
1348         H_UNLOCK;
1349         h_Enumerate(MultiBreakVolumeLaterCallBack, (char *)&henumParms);
1350         H_LOCK;
1351         if (henumParms.ncbas) { /* do left-overs */
1352             struct AFSCBFids tf;
1353             tf.AFSCBFids_len = 1;
1354             tf.AFSCBFids_val = &fid;
1355
1356             MultiBreakCallBack_r(henumParms.cba, henumParms.ncbas, &tf);
1357             henumParms.ncbas = 0;
1358         }
1359     }
1360     H_UNLOCK;
1361
1362     /* Arrange to be called again */
1363     return 1;
1364 }
1365
1366 /*
1367  * Delete all timed-out call back entries (to be called periodically by file
1368  * server)
1369  */
1370 int
1371 CleanupTimedOutCallBacks(void)
1372 {
1373     H_LOCK;
1374     CleanupTimedOutCallBacks_r();
1375     H_UNLOCK;
1376     return 0;
1377 }
1378
1379 int
1380 CleanupTimedOutCallBacks_r(void)
1381 {
1382     afs_uint32 now = CBtime(time(NULL));
1383     afs_uint32 *thead;
1384     struct CallBack *cb;
1385     int ntimedout = 0;
1386     char hoststr[16];
1387
1388     while (tfirst <= now) {
1389         int cbi;
1390         cbi = *(thead = THead(tfirst));
1391         if (cbi) {
1392             do {
1393                 cb = itocb(cbi);
1394                 cbi = cb->tnext;
1395                 ViceLog(8,
1396                         ("CCB: deleting timed out call back %x (%s:%d), (%" AFS_VOLID_FMT ",%u,%u)\n",
1397                          h_itoh(cb->hhead)->host,
1398                          afs_inet_ntoa_r(h_itoh(cb->hhead)->host, hoststr),
1399                          h_itoh(cb->hhead)->port,
1400                          afs_printable_VolumeId_lu(itofe(cb->fhead)->volid),
1401                          itofe(cb->fhead)->vnode, itofe(cb->fhead)->unique));
1402                 HDel(cb);
1403                 CDel(cb, 1);
1404                 ntimedout++;
1405                 if (ntimedout > cbstuff.nblks) {
1406                     ViceLog(0, ("CCB: Internal Error -- shutting down...\n"));
1407                     DumpCallBackState_r();
1408                     ShutDownAndCore(PANIC);
1409                 }
1410             } while (cbi != *thead);
1411             *thead = 0;
1412         }
1413         tfirst++;
1414     }
1415     cbstuff.CBsTimedOut += ntimedout;
1416     ViceLog(7, ("CCB: deleted %d timed out callbacks\n", ntimedout));
1417     return (ntimedout > 0);
1418 }
1419
1420 /**
1421  * parameters to pass to lih*_r from h_Enumerate_r when trying to find a host
1422  * from which to clear callbacks.
1423  */
1424 struct lih_params {
1425     /**
1426      * Points to the least interesting host found; try to clear callbacks on
1427      * this host after h_Enumerate_r(lih*_r)'ing.
1428      */
1429     struct host *lih;
1430
1431     /**
1432      * The last host we got from lih*_r, but we couldn't clear its callbacks
1433      * for some reason. Choose the next-best host after this one (with the
1434      * current lih*_r, this means to only select hosts that have an ActiveCall
1435      * newer than lastlih).
1436      */
1437     struct host *lastlih;
1438 };
1439
1440 /* Value of host->refCount that allows us to reliably infer that
1441  * host may be held by some other thread */
1442 #define OTHER_MUSTHOLD_LIH 2
1443
1444 /* This version does not allow 'host' to be selected unless its ActiveCall
1445  * is newer than 'params->lastlih' which is the host with the oldest
1446  * ActiveCall from the last pass (if it is provided).  We filter out any hosts
1447  * that are are held by other threads.
1448  *
1449  * There is a small problem here, but it may not be easily fixable. Say we
1450  * select some host A, and give it back to GetSomeSpace_r. GSS_r for some
1451  * reason cannot clear the callbacks on A, and so calls us again with
1452  * lastlih = A. Suppose there is another host B that has the same ActiveCall
1453  * time as A. We will now skip over host B, since
1454  * 'hostB->ActiveCall > hostA->ActiveCall' is not true. This could result in
1455  * us prematurely going to the GSS_r 2nd or 3rd pass, and making us a little
1456  * inefficient. This should be pretty rare, though, except perhaps in cases
1457  * with very small numbers of hosts.
1458  *
1459  * Also filter out any hosts with HOSTDELETED set. h_Enumerate_r should in
1460  * theory not give these to us anyway, but be paranoid.
1461  */
1462 static int
1463 lih0_r(struct host *host, void *rock)
1464 {
1465     struct lih_params *params = (struct lih_params *)rock;
1466
1467     /* OTHER_MUSTHOLD_LIH is because the h_Enum loop holds us once */
1468     if (host->cblist
1469         && (!(host->hostFlags & HOSTDELETED))
1470         && (host->refCount < OTHER_MUSTHOLD_LIH)
1471         && (!params->lih || host->ActiveCall < params->lih->ActiveCall)
1472         && (!params->lastlih || host->ActiveCall > params->lastlih->ActiveCall)) {
1473
1474         if (params->lih) {
1475             h_Release_r(params->lih); /* release prev host */
1476         }
1477
1478         h_Hold_r(host);
1479         params->lih = host;
1480     }
1481     return 0;
1482 }
1483
1484 /* same as lih0_r, except we do not prevent held hosts from being selected. */
1485 static int
1486 lih1_r(struct host *host, void *rock)
1487 {
1488     struct lih_params *params = (struct lih_params *)rock;
1489
1490     if (host->cblist
1491         && (!(host->hostFlags & HOSTDELETED))
1492         && (!params->lih || host->ActiveCall < params->lih->ActiveCall)
1493         && (!params->lastlih || host->ActiveCall > params->lastlih->ActiveCall)) {
1494
1495         if (params->lih) {
1496             h_Release_r(params->lih); /* release prev host */
1497         }
1498
1499         h_Hold_r(host);
1500         params->lih = host;
1501     }
1502     return 0;
1503 }
1504
1505 /* This could be upgraded to get more space each time */
1506 /* first pass: sequentially find the oldest host which isn't held by
1507                anyone for which we can clear callbacks;
1508                skipping 'hostp' */
1509 /* second pass: sequentially find the oldest host regardless of
1510                whether or not the host is held; skipping 'hostp' */
1511 /* third pass: attempt to clear callbacks from 'hostp' */
1512 /* always called with hostp unlocked */
1513
1514 /* Note: hostlist is ordered most recently created host first and
1515  * its order has no relationship to the most recently used. */
1516 extern struct host *hostList;
1517 static int
1518 GetSomeSpace_r(struct host *hostp, int locked)
1519 {
1520     struct host *hp;
1521     struct lih_params params;
1522     int i = 0;
1523
1524     if (cbstuff.GotSomeSpaces == 0) {
1525         /* only log this once; if GSS is getting called constantly, that's not
1526          * good but don't make things worse by spamming the log. */
1527         ViceLog(0, ("We have run out of callback space; forcing callback revocation. "
1528                     "This suggests the fileserver is configured with insufficient "
1529                     "callbacks; you probably want to increase the -cb fileserver "
1530                     "parameter (current setting: %u). The fileserver will continue "
1531                     "to operate, but this may indicate a severe performance problem\n",
1532                     cbstuff.nblks));
1533         ViceLog(0, ("This message is logged at most once; for more information "
1534                     "see the OpenAFS documentation and fileserver xstat collection 3\n"));
1535     }
1536
1537     cbstuff.GotSomeSpaces++;
1538     ViceLog(5,
1539             ("GSS: First looking for timed out call backs via CleanupCallBacks\n"));
1540     if (CleanupTimedOutCallBacks_r()) {
1541         cbstuff.GSS3++;
1542         return 0;
1543     }
1544
1545     i = 0;
1546     params.lastlih = NULL;
1547
1548     do {
1549         params.lih = NULL;
1550
1551         h_Enumerate_r(i == 0 ? lih0_r : lih1_r, hostList, &params);
1552
1553         hp = params.lih;
1554         if (params.lastlih) {
1555             h_Release_r(params.lastlih);
1556             params.lastlih = NULL;
1557         }
1558
1559         if (hp) {
1560             /* note that 'hp' was held by lih*_r; we will need to release it */
1561             cbstuff.GSS4++;
1562             if ((hp != hostp) && !ClearHostCallbacks_r(hp, 0 /* not locked or held */ )) {
1563                 h_Release_r(hp);
1564                 return 0;
1565             }
1566
1567             params.lastlih = hp;
1568             /* params.lastlih will be released on the next iteration, after
1569              * h_Enumerate_r */
1570
1571         } else {
1572             /*
1573              * Next time try getting callbacks from any host even if
1574              * it's held, since the only other option is starvation for
1575              * the file server (i.e. until the callback timeout arrives).
1576              */
1577             i++;
1578             params.lastlih = NULL;
1579             cbstuff.GSS1++;
1580             ViceLog(5,
1581                     ("GSS: Try harder for longest inactive host cnt= %d\n",
1582                      i));
1583         }
1584     } while (i < 2);
1585
1586     /* Could not obtain space from other hosts, clear hostp's callback state */
1587     cbstuff.GSS2++;
1588     if (!locked) {
1589         h_Lock_r(hostp);
1590     }
1591     ClearHostCallbacks_r(hostp, 1 /*already locked */ );
1592     if (!locked) {
1593         h_Unlock_r(hostp);
1594     }
1595     return 0;
1596 }
1597
1598 /* locked - set if caller has already locked the host */
1599 static int
1600 ClearHostCallbacks_r(struct host *hp, int locked)
1601 {
1602     int code;
1603     char hoststr[16];
1604     struct rx_connection *cb_conn = NULL;
1605
1606     ViceLog(5,
1607             ("GSS: Delete longest inactive host %p (%s:%d)\n",
1608              hp, afs_inet_ntoa_r(hp->host, hoststr), ntohs(hp->port)));
1609
1610     if ((hp->hostFlags & HOSTDELETED)) {
1611         /* hp could go away after reacquiring H_LOCK in h_NBLock_r, so we can't
1612          * really use it; its callbacks will get cleared anyway when
1613          * h_TossStuff_r gets its hands on it */
1614         return 1;
1615     }
1616
1617     h_Hold_r(hp);
1618
1619     /** Try a non-blocking lock. If the lock is already held return
1620       * after releasing hold on hp
1621       */
1622     if (!locked) {
1623         if (h_NBLock_r(hp)) {
1624             h_Release_r(hp);
1625             return 1;
1626         }
1627     }
1628     if (hp->Console & 2) {
1629         /*
1630          * If the special console field is set it means that a thread
1631          * is waiting in AddCallBack1 after it set pointers to the
1632          * file entry and/or callback entry. Because of the bogus
1633          * usage of h_hold it won't prevent from another thread, this
1634          * one, to remove all the callbacks so just to be safe we keep
1635          * a reference. NOTE, on the last phase we'll free the calling
1636          * host's callbacks but that's ok...
1637          */
1638         cbstuff.GSS5++;
1639     }
1640     DeleteAllCallBacks_r(hp, 1);
1641     if (hp->hostFlags & VENUSDOWN) {
1642         hp->hostFlags &= ~RESETDONE;    /* remember that we must do a reset */
1643     } else if (!(hp->hostFlags & HOSTDELETED)) {
1644         /* host is up, try a call */
1645         hp->hostFlags &= ~ALTADDR;      /* alternate addresses are invalid */
1646         cb_conn = hp->callback_rxcon;
1647         rx_GetConnection(hp->callback_rxcon);
1648         if (hp->interface) {
1649             H_UNLOCK;
1650             code =
1651                 RXAFSCB_InitCallBackState3(cb_conn, &FS_HostUUID);
1652         } else {
1653             H_UNLOCK;
1654             code = RXAFSCB_InitCallBackState(cb_conn);
1655         }
1656         rx_PutConnection(cb_conn);
1657         cb_conn = NULL;
1658         H_LOCK;
1659         hp->hostFlags |= ALTADDR;       /* alternate addresses are valid */
1660         if (code) {
1661             /* failed, mark host down and need reset */
1662             hp->hostFlags |= VENUSDOWN;
1663             hp->hostFlags &= ~RESETDONE;
1664         } else {
1665             /* reset succeeded, we're done */
1666             hp->hostFlags |= RESETDONE;
1667         }
1668     }
1669     if (!locked)
1670         h_Unlock_r(hp);
1671     h_Release_r(hp);
1672
1673     return 0;
1674 }
1675 #endif /* INTERPRET_DUMP */
1676
1677
1678 int
1679 PrintCallBackStats(void)
1680 {
1681     fprintf(stderr,
1682             "%d add CB, %d break CB, %d del CB, %d del FE, %d CB's timed out, %d space reclaim, %d del host\n",
1683             cbstuff.AddCallBacks, cbstuff.BreakCallBacks,
1684             cbstuff.DeleteCallBacks, cbstuff.DeleteFiles, cbstuff.CBsTimedOut,
1685             cbstuff.GotSomeSpaces, cbstuff.DeleteAllCallBacks);
1686     fprintf(stderr, "%d CBs, %d FEs, (%d of total of %d 16-byte blocks)\n",
1687             cbstuff.nCBs, cbstuff.nFEs, cbstuff.nCBs + cbstuff.nFEs,
1688             cbstuff.nblks);
1689     fprintf(stderr, "%d GSS1, %d GSS2, %d GSS3, %d GSS4, %d GSS5 (internal counters)\n",
1690             cbstuff.GSS1, cbstuff.GSS2, cbstuff.GSS3, cbstuff.GSS4, cbstuff.GSS5);
1691
1692     return 0;
1693 }
1694
1695 #define MAGIC 0x12345678        /* To check byte ordering of dump when it is read in */
1696 #define MAGICV2 0x12345679      /* To check byte ordering & version of dump when it is read in */
1697
1698
1699 #ifndef INTERPRET_DUMP
1700
1701 #ifdef AFS_DEMAND_ATTACH_FS
1702 /*
1703  * demand attach fs
1704  * callback state serialization
1705  */
1706 static int cb_stateSaveTimeouts(struct fs_dump_state * state);
1707 static int cb_stateSaveFEHash(struct fs_dump_state * state);
1708 static int cb_stateSaveFEs(struct fs_dump_state * state);
1709 static int cb_stateSaveFE(struct fs_dump_state * state, struct FileEntry * fe);
1710 static int cb_stateRestoreTimeouts(struct fs_dump_state * state);
1711 static int cb_stateRestoreFEHash(struct fs_dump_state * state);
1712 static int cb_stateRestoreFEs(struct fs_dump_state * state);
1713 static int cb_stateRestoreFE(struct fs_dump_state * state);
1714 static int cb_stateRestoreCBs(struct fs_dump_state * state, struct FileEntry * fe,
1715                               struct iovec * iov, int niovecs);
1716
1717 static int cb_stateVerifyFEHash(struct fs_dump_state * state);
1718 static int cb_stateVerifyFE(struct fs_dump_state * state, struct FileEntry * fe);
1719 static int cb_stateVerifyFCBList(struct fs_dump_state * state, struct FileEntry * fe);
1720 static int cb_stateVerifyTimeoutQueues(struct fs_dump_state * state);
1721
1722 static int cb_stateFEToDiskEntry(struct FileEntry *, struct FEDiskEntry *);
1723 static int cb_stateDiskEntryToFE(struct fs_dump_state * state,
1724                                  struct FEDiskEntry *, struct FileEntry *);
1725
1726 static int cb_stateCBToDiskEntry(struct CallBack *, struct CBDiskEntry *);
1727 static int cb_stateDiskEntryToCB(struct fs_dump_state * state,
1728                                  struct CBDiskEntry *, struct CallBack *);
1729
1730 static int cb_stateFillHeader(struct callback_state_header * hdr);
1731 static int cb_stateCheckHeader(struct callback_state_header * hdr);
1732
1733 static int cb_stateAllocMap(struct fs_dump_state * state);
1734
1735 int
1736 cb_stateSave(struct fs_dump_state * state)
1737 {
1738     int ret = 0;
1739
1740     AssignInt64(state->eof_offset, &state->hdr->cb_offset);
1741
1742     /* invalidate callback state header */
1743     memset(state->cb_hdr, 0, sizeof(struct callback_state_header));
1744     if (fs_stateWriteHeader(state, &state->hdr->cb_offset, state->cb_hdr,
1745                             sizeof(struct callback_state_header))) {
1746         ret = 1;
1747         goto done;
1748     }
1749
1750     fs_stateIncEOF(state, sizeof(struct callback_state_header));
1751
1752     /* dump timeout state */
1753     if (cb_stateSaveTimeouts(state)) {
1754         ret = 1;
1755         goto done;
1756     }
1757
1758     /* dump fe hashtable state */
1759     if (cb_stateSaveFEHash(state)) {
1760         ret = 1;
1761         goto done;
1762     }
1763
1764     /* dump callback state */
1765     if (cb_stateSaveFEs(state)) {
1766         ret = 1;
1767         goto done;
1768     }
1769
1770     /* write the callback state header to disk */
1771     cb_stateFillHeader(state->cb_hdr);
1772     if (fs_stateWriteHeader(state, &state->hdr->cb_offset, state->cb_hdr,
1773                             sizeof(struct callback_state_header))) {
1774         ret = 1;
1775         goto done;
1776     }
1777
1778  done:
1779     return ret;
1780 }
1781
1782 int
1783 cb_stateRestore(struct fs_dump_state * state)
1784 {
1785     int ret = 0;
1786
1787     if (fs_stateReadHeader(state, &state->hdr->cb_offset, state->cb_hdr,
1788                            sizeof(struct callback_state_header))) {
1789         ret = 1;
1790         goto done;
1791     }
1792
1793     if (cb_stateCheckHeader(state->cb_hdr)) {
1794         ret = 1;
1795         goto done;
1796     }
1797
1798     if (cb_stateAllocMap(state)) {
1799         ret = 1;
1800         goto done;
1801     }
1802
1803     if (cb_stateRestoreTimeouts(state)) {
1804         ret = 1;
1805         goto done;
1806     }
1807
1808     if (cb_stateRestoreFEHash(state)) {
1809         ret = 1;
1810         goto done;
1811     }
1812
1813     /* restore FEs and CBs from disk */
1814     if (cb_stateRestoreFEs(state)) {
1815         ret = 1;
1816         goto done;
1817     }
1818
1819     /* restore the timeout queue heads */
1820     tfirst = state->cb_hdr->tfirst;
1821
1822  done:
1823     return ret;
1824 }
1825
1826 int
1827 cb_stateRestoreIndices(struct fs_dump_state * state)
1828 {
1829     int i, ret = 0;
1830     struct FileEntry * fe;
1831     struct CallBack * cb;
1832
1833     /* restore indices in the FileEntry structures */
1834     for (i = 1; i < state->fe_map.len; i++) {
1835         if (state->fe_map.entries[i].new_idx) {
1836             fe = itofe(state->fe_map.entries[i].new_idx);
1837
1838             /* restore the fe->fnext entry */
1839             if (fe_OldToNew(state, fe->fnext, &fe->fnext)) {
1840                 ret = 1;
1841                 goto done;
1842             }
1843
1844             /* restore the fe->firstcb entry */
1845             if (cb_OldToNew(state, fe->firstcb, &fe->firstcb)) {
1846                 ret = 1;
1847                 goto done;
1848             }
1849         }
1850     }
1851
1852     /* restore indices in the CallBack structures */
1853     for (i = 1; i < state->cb_map.len; i++) {
1854         if (state->cb_map.entries[i].new_idx) {
1855             cb = itocb(state->cb_map.entries[i].new_idx);
1856
1857             /* restore the cb->cnext entry */
1858             if (cb_OldToNew(state, cb->cnext, &cb->cnext)) {
1859                 ret = 1;
1860                 goto done;
1861             }
1862
1863             /* restore the cb->fhead entry */
1864             if (fe_OldToNew(state, cb->fhead, &cb->fhead)) {
1865                 ret = 1;
1866                 goto done;
1867             }
1868
1869             /* restore the cb->hhead entry */
1870             if (h_OldToNew(state, cb->hhead, &cb->hhead)) {
1871                 ret = 1;
1872                 goto done;
1873             }
1874
1875             /* restore the cb->tprev entry */
1876             if (cb_OldToNew(state, cb->tprev, &cb->tprev)) {
1877                 ret = 1;
1878                 goto done;
1879             }
1880
1881             /* restore the cb->tnext entry */
1882             if (cb_OldToNew(state, cb->tnext, &cb->tnext)) {
1883                 ret = 1;
1884                 goto done;
1885             }
1886
1887             /* restore the cb->hprev entry */
1888             if (cb_OldToNew(state, cb->hprev, &cb->hprev)) {
1889                 ret = 1;
1890                 goto done;
1891             }
1892
1893             /* restore the cb->hnext entry */
1894             if (cb_OldToNew(state, cb->hnext, &cb->hnext)) {
1895                 ret = 1;
1896                 goto done;
1897             }
1898         }
1899     }
1900
1901     /* restore the timeout queue head indices */
1902     for (i = 0; i < state->cb_timeout_hdr->records; i++) {
1903         if (cb_OldToNew(state, timeout[i], &timeout[i])) {
1904             ret = 1;
1905             goto done;
1906         }
1907     }
1908
1909     /* restore the FE hash table queue heads */
1910     for (i = 0; i < state->cb_fehash_hdr->records; i++) {
1911         if (fe_OldToNew(state, HashTable[i], &HashTable[i])) {
1912             ret = 1;
1913             goto done;
1914         }
1915     }
1916
1917  done:
1918     return ret;
1919 }
1920
1921 int
1922 cb_stateVerify(struct fs_dump_state * state)
1923 {
1924     int ret = 0;
1925
1926     if (cb_stateVerifyFEHash(state)) {
1927         ret = 1;
1928     }
1929
1930     if (cb_stateVerifyTimeoutQueues(state)) {
1931         ret = 1;
1932     }
1933
1934     return ret;
1935 }
1936
1937 static int
1938 cb_stateVerifyFEHash(struct fs_dump_state * state)
1939 {
1940     int ret = 0, i;
1941     struct FileEntry * fe;
1942     afs_uint32 fei, chain_len;
1943
1944     for (i = 0; i < FEHASH_SIZE; i++) {
1945         chain_len = 0;
1946         for (fei = HashTable[i], fe = itofe(fei);
1947              fe;
1948              fei = fe->fnext, fe = itofe(fei)) {
1949             if (fei > cbstuff.nblks) {
1950                 ViceLog(0, ("cb_stateVerifyFEHash: error: index out of range (fei=%d)\n", fei));
1951                 ret = 1;
1952                 break;
1953             }
1954             if (cb_stateVerifyFE(state, fe)) {
1955                 ret = 1;
1956             }
1957             if (chain_len > FS_STATE_FE_MAX_HASH_CHAIN_LEN) {
1958                 ViceLog(0, ("cb_stateVerifyFEHash: error: hash chain %d length exceeds %d; assuming there's a loop\n",
1959                             i, FS_STATE_FE_MAX_HASH_CHAIN_LEN));
1960                 ret = 1;
1961                 break;
1962             }
1963             chain_len++;
1964         }
1965     }
1966
1967     return ret;
1968 }
1969
1970 static int
1971 cb_stateVerifyFE(struct fs_dump_state * state, struct FileEntry * fe)
1972 {
1973     int ret = 0;
1974
1975     if ((fe->firstcb && !fe->ncbs) ||
1976         (!fe->firstcb && fe->ncbs)) {
1977         ViceLog(0, ("cb_stateVerifyFE: error: fe->firstcb does not agree with fe->ncbs (fei=%lu, fe->firstcb=%lu, fe->ncbs=%lu)\n",
1978                     afs_printable_uint32_lu(fetoi(fe)),
1979                     afs_printable_uint32_lu(fe->firstcb),
1980                     afs_printable_uint32_lu(fe->ncbs)));
1981         ret = 1;
1982     }
1983     if (cb_stateVerifyFCBList(state, fe)) {
1984         ViceLog(0, ("cb_stateVerifyFE: error: FCBList failed verification (fei=%lu)\n",
1985                     afs_printable_uint32_lu(fetoi(fe))));
1986         ret = 1;
1987     }
1988
1989     return ret;
1990 }
1991
1992 static int
1993 cb_stateVerifyFCBList(struct fs_dump_state * state, struct FileEntry * fe)
1994 {
1995     int ret = 0;
1996     afs_uint32 cbi, fei, chain_len = 0;
1997     struct CallBack * cb;
1998
1999     fei = fetoi(fe);
2000
2001     for (cbi = fe->firstcb, cb = itocb(cbi);
2002          cb;
2003          cbi = cb->cnext, cb = itocb(cbi)) {
2004         if (cbi > cbstuff.nblks) {
2005             ViceLog(0, ("cb_stateVerifyFCBList: error: list index out of range (cbi=%d, ncbs=%d)\n",
2006                         cbi, cbstuff.nblks));
2007             ret = 1;
2008             goto done;
2009         }
2010         if (cb->fhead != fei) {
2011             ViceLog(0, ("cb_stateVerifyFCBList: error: cb->fhead != fei (fei=%d, cb->fhead=%d)\n",
2012                         fei, cb->fhead));
2013             ret = 1;
2014         }
2015         if (chain_len > FS_STATE_FCB_MAX_LIST_LEN) {
2016             ViceLog(0, ("cb_stateVerifyFCBList: error: list length exceeds %d (fei=%d); assuming there's a loop\n",
2017                         FS_STATE_FCB_MAX_LIST_LEN, fei));
2018             ret = 1;
2019             goto done;
2020         }
2021         chain_len++;
2022     }
2023
2024     if (fe->ncbs != chain_len) {
2025         ViceLog(0, ("cb_stateVerifyFCBList: error: list length mismatch (len=%d, fe->ncbs=%d)\n",
2026                     chain_len, fe->ncbs));
2027         ret = 1;
2028     }
2029
2030  done:
2031     return ret;
2032 }
2033
2034 int
2035 cb_stateVerifyHCBList(struct fs_dump_state * state, struct host * host)
2036 {
2037     int ret = 0;
2038     afs_uint32 hi, chain_len, cbi;
2039     struct CallBack *cb, *ncb;
2040
2041     hi = h_htoi(host);
2042     chain_len = 0;
2043
2044     for (cbi = host->cblist, cb = itocb(cbi);
2045          cb;
2046          cbi = cb->hnext, cb = ncb) {
2047         if (chain_len && (host->cblist == cbi)) {
2048             /* we've wrapped around the circular list, and everything looks ok */
2049             break;
2050         }
2051         if (cb->hhead != hi) {
2052             ViceLog(0, ("cb_stateVerifyHCBList: error: incorrect cb->hhead (cbi=%d, h->index=%d, cb->hhead=%d)\n",
2053                         cbi, hi, cb->hhead));
2054             ret = 1;
2055         }
2056         if (!cb->hprev || !cb->hnext) {
2057             ViceLog(0, ("cb_stateVerifyHCBList: error: null index in circular list (cbi=%d, h->index=%d)\n",
2058                         cbi, hi));
2059             ret = 1;
2060             goto done;
2061         }
2062         if ((cb->hprev > cbstuff.nblks) ||
2063             (cb->hnext > cbstuff.nblks)) {
2064             ViceLog(0, ("cb_stateVerifyHCBList: error: list index out of range (cbi=%d, h->index=%d, cb->hprev=%d, cb->hnext=%d, nCBs=%d)\n",
2065                         cbi, hi, cb->hprev, cb->hnext, cbstuff.nblks));
2066             ret = 1;
2067             goto done;
2068         }
2069         ncb = itocb(cb->hnext);
2070         if (cbi != ncb->hprev) {
2071             ViceLog(0, ("cb_stateVerifyHCBList: error: corrupt linked list (cbi=%d, h->index=%d)\n",
2072                         cbi, hi));
2073             ret = 1;
2074             goto done;
2075         }
2076         if (chain_len > FS_STATE_HCB_MAX_LIST_LEN) {
2077             ViceLog(0, ("cb_stateVerifyFCBList: error: list length exceeds %d (h->index=%d); assuming there's a loop\n",
2078                         FS_STATE_HCB_MAX_LIST_LEN, hi));
2079             ret = 1;
2080             goto done;
2081         }
2082         chain_len++;
2083     }
2084
2085  done:
2086     return ret;
2087 }
2088
2089 static int
2090 cb_stateVerifyTimeoutQueues(struct fs_dump_state * state)
2091 {
2092     int ret = 0, i;
2093     afs_uint32 cbi, chain_len;
2094     struct CallBack *cb, *ncb;
2095
2096     for (i = 0; i < CB_NUM_TIMEOUT_QUEUES; i++) {
2097         chain_len = 0;
2098         for (cbi = timeout[i], cb = itocb(cbi);
2099              cb;
2100              cbi = cb->tnext, cb = ncb) {
2101             if (chain_len && (cbi == timeout[i])) {
2102                 /* we've wrapped around the circular list, and everything looks ok */
2103                 break;
2104             }
2105             if (cbi > cbstuff.nblks) {
2106                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: error: list index out of range (cbi=%d, tindex=%d)\n",
2107                             cbi, i));
2108                 ret = 1;
2109                 break;
2110             }
2111             if (itot(cb->thead) != &timeout[i]) {
2112                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: error: cb->thead points to wrong timeout queue (tindex=%d, cbi=%d, cb->thead=%d)\n",
2113                             i, cbi, cb->thead));
2114                 ret = 1;
2115             }
2116             if (!cb->tprev || !cb->tnext) {
2117                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: null index in circular list (cbi=%d, tindex=%d)\n",
2118                             cbi, i));
2119                 ret = 1;
2120                 break;
2121             }
2122             if ((cb->tprev > cbstuff.nblks) ||
2123                 (cb->tnext > cbstuff.nblks)) {
2124                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: list index out of range (cbi=%d, tindex=%d, cb->tprev=%d, cb->tnext=%d, nCBs=%d)\n",
2125                             cbi, i, cb->tprev, cb->tnext, cbstuff.nblks));
2126                 ret = 1;
2127                 break;
2128             }
2129             ncb = itocb(cb->tnext);
2130             if (cbi != ncb->tprev) {
2131                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: corrupt linked list (cbi=%d, tindex=%d)\n",
2132                             cbi, i));
2133                 ret = 1;
2134                 break;
2135             }
2136             if (chain_len > FS_STATE_TCB_MAX_LIST_LEN) {
2137                 ViceLog(0, ("cb_stateVerifyTimeoutQueues: list length exceeds %d (tindex=%d); assuming there's a loop\n",
2138                             FS_STATE_TCB_MAX_LIST_LEN, i));
2139                 ret = 1;
2140                 break;
2141             }
2142             chain_len++;
2143         }
2144     }
2145
2146     return ret;
2147 }
2148
2149 static int
2150 cb_stateSaveTimeouts(struct fs_dump_state * state)
2151 {
2152     int ret = 0;
2153     struct iovec iov[2];
2154
2155     AssignInt64(state->eof_offset, &state->cb_hdr->timeout_offset);
2156
2157     memset(state->cb_timeout_hdr, 0, sizeof(struct callback_state_fehash_header));
2158     state->cb_timeout_hdr->magic = CALLBACK_STATE_TIMEOUT_MAGIC;
2159     state->cb_timeout_hdr->records = CB_NUM_TIMEOUT_QUEUES;
2160     state->cb_timeout_hdr->len = sizeof(struct callback_state_timeout_header) +
2161         (state->cb_timeout_hdr->records * sizeof(afs_uint32));
2162
2163     iov[0].iov_base = (char *)state->cb_timeout_hdr;
2164     iov[0].iov_len = sizeof(struct callback_state_timeout_header);
2165     iov[1].iov_base = (char *)timeout;
2166     iov[1].iov_len = sizeof(timeout);
2167
2168     if (fs_stateSeek(state, &state->cb_hdr->timeout_offset)) {
2169         ret = 1;
2170         goto done;
2171     }
2172
2173     if (fs_stateWriteV(state, iov, 2)) {
2174         ret = 1;
2175         goto done;
2176     }
2177
2178     fs_stateIncEOF(state, state->cb_timeout_hdr->len);
2179
2180  done:
2181     return ret;
2182 }
2183
2184 static int
2185 cb_stateRestoreTimeouts(struct fs_dump_state * state)
2186 {
2187     int ret = 0, len;
2188
2189     if (fs_stateReadHeader(state, &state->cb_hdr->timeout_offset,
2190                            state->cb_timeout_hdr,
2191                            sizeof(struct callback_state_timeout_header))) {
2192         ret = 1;
2193         goto done;
2194     }
2195
2196     if (state->cb_timeout_hdr->magic != CALLBACK_STATE_TIMEOUT_MAGIC) {
2197         ret = 1;
2198         goto done;
2199     }
2200     if (state->cb_timeout_hdr->records != CB_NUM_TIMEOUT_QUEUES) {
2201         ret = 1;
2202         goto done;
2203     }
2204
2205     len = state->cb_timeout_hdr->records * sizeof(afs_uint32);
2206
2207     if (state->cb_timeout_hdr->len !=
2208         (sizeof(struct callback_state_timeout_header) + len)) {
2209         ret = 1;
2210         goto done;
2211     }
2212
2213     if (fs_stateRead(state, timeout, len)) {
2214         ret = 1;
2215         goto done;
2216     }
2217
2218  done:
2219     return ret;
2220 }
2221
2222 static int
2223 cb_stateSaveFEHash(struct fs_dump_state * state)
2224 {
2225     int ret = 0;
2226     struct iovec iov[2];
2227
2228     AssignInt64(state->eof_offset, &state->cb_hdr->fehash_offset);
2229
2230     memset(state->cb_fehash_hdr, 0, sizeof(struct callback_state_fehash_header));
2231     state->cb_fehash_hdr->magic = CALLBACK_STATE_FEHASH_MAGIC;
2232     state->cb_fehash_hdr->records = FEHASH_SIZE;
2233     state->cb_fehash_hdr->len = sizeof(struct callback_state_fehash_header) +
2234         (state->cb_fehash_hdr->records * sizeof(afs_uint32));
2235
2236     iov[0].iov_base = (char *)state->cb_fehash_hdr;
2237     iov[0].iov_len = sizeof(struct callback_state_fehash_header);
2238     iov[1].iov_base = (char *)HashTable;
2239     iov[1].iov_len = sizeof(HashTable);
2240
2241     if (fs_stateSeek(state, &state->cb_hdr->fehash_offset)) {
2242         ret = 1;
2243         goto done;
2244     }
2245
2246     if (fs_stateWriteV(state, iov, 2)) {
2247         ret = 1;
2248         goto done;
2249     }
2250
2251     fs_stateIncEOF(state, state->cb_fehash_hdr->len);
2252
2253  done:
2254     return ret;
2255 }
2256
2257 static int
2258 cb_stateRestoreFEHash(struct fs_dump_state * state)
2259 {
2260     int ret = 0, len;
2261
2262     if (fs_stateReadHeader(state, &state->cb_hdr->fehash_offset,
2263                            state->cb_fehash_hdr,
2264                            sizeof(struct callback_state_fehash_header))) {
2265         ret = 1;
2266         goto done;
2267     }
2268
2269     if (state->cb_fehash_hdr->magic != CALLBACK_STATE_FEHASH_MAGIC) {
2270         ret = 1;
2271         goto done;
2272     }
2273     if (state->cb_fehash_hdr->records != FEHASH_SIZE) {
2274         ret = 1;
2275         goto done;
2276     }
2277
2278     len = state->cb_fehash_hdr->records * sizeof(afs_uint32);
2279
2280     if (state->cb_fehash_hdr->len !=
2281         (sizeof(struct callback_state_fehash_header) + len)) {
2282         ret = 1;
2283         goto done;
2284     }
2285
2286     if (fs_stateRead(state, HashTable, len)) {
2287         ret = 1;
2288         goto done;
2289     }
2290
2291  done:
2292     return ret;
2293 }
2294
2295 static int
2296 cb_stateSaveFEs(struct fs_dump_state * state)
2297 {
2298     int ret = 0;
2299     int fei, hash;
2300     struct FileEntry *fe;
2301
2302     AssignInt64(state->eof_offset, &state->cb_hdr->fe_offset);
2303
2304     for (hash = 0; hash < FEHASH_SIZE ; hash++) {
2305         for (fei = HashTable[hash]; fei; fei = fe->fnext) {
2306             fe = itofe(fei);
2307             if (cb_stateSaveFE(state, fe)) {
2308                 ret = 1;
2309                 goto done;
2310             }
2311         }
2312     }
2313
2314  done:
2315     return ret;
2316 }
2317
2318 static int
2319 cb_stateRestoreFEs(struct fs_dump_state * state)
2320 {
2321     int count, nFEs, ret = 0;
2322
2323     nFEs = state->cb_hdr->nFEs;
2324
2325     for (count = 0; count < nFEs; count++) {
2326         if (cb_stateRestoreFE(state)) {
2327             ret = 1;
2328             goto done;
2329         }
2330     }
2331
2332  done:
2333     return ret;
2334 }
2335
2336 static int
2337 cb_stateSaveFE(struct fs_dump_state * state, struct FileEntry * fe)
2338 {
2339     int ret = 0, iovcnt, cbi, written = 0;
2340     afs_uint32 fei;
2341     struct callback_state_entry_header hdr;
2342     struct FEDiskEntry fedsk;
2343     struct CBDiskEntry cbdsk[16];
2344     struct iovec iov[16];
2345     struct CallBack *cb;
2346
2347     fei = fetoi(fe);
2348     if (fei > state->cb_hdr->fe_max) {
2349         state->cb_hdr->fe_max = fei;
2350     }
2351
2352     memset(&hdr, 0, sizeof(struct callback_state_entry_header));
2353
2354     if (cb_stateFEToDiskEntry(fe, &fedsk)) {
2355         ret = 1;
2356         goto done;
2357     }
2358
2359     iov[0].iov_base = (char *)&hdr;
2360     iov[0].iov_len = sizeof(hdr);
2361     iov[1].iov_base = (char *)&fedsk;
2362     iov[1].iov_len = sizeof(struct FEDiskEntry);
2363     iovcnt = 2;
2364
2365     for (cbi = fe->firstcb, cb = itocb(cbi);
2366          cb != NULL;
2367          cbi = cb->cnext, cb = itocb(cbi), hdr.nCBs++) {
2368         if (cbi > state->cb_hdr->cb_max) {
2369             state->cb_hdr->cb_max = cbi;
2370         }
2371         if (cb_stateCBToDiskEntry(cb, &cbdsk[iovcnt])) {
2372             ret = 1;
2373             goto done;
2374         }
2375         cbdsk[iovcnt].index = cbi;
2376         iov[iovcnt].iov_base = (char *)&cbdsk[iovcnt];
2377         iov[iovcnt].iov_len = sizeof(struct CBDiskEntry);
2378         iovcnt++;
2379         if ((iovcnt == 16) || (!cb->cnext)) {
2380             if (fs_stateWriteV(state, iov, iovcnt)) {
2381                 ret = 1;
2382                 goto done;
2383             }
2384             written = 1;
2385             iovcnt = 0;
2386         }
2387     }
2388
2389     hdr.magic = CALLBACK_STATE_ENTRY_MAGIC;
2390     hdr.len = sizeof(hdr) + sizeof(struct FEDiskEntry) +
2391         (hdr.nCBs * sizeof(struct CBDiskEntry));
2392
2393     if (!written) {
2394         if (fs_stateWriteV(state, iov, iovcnt)) {
2395             ret = 1;
2396             goto done;
2397         }
2398     } else {
2399         if (fs_stateWriteHeader(state, &state->eof_offset, &hdr, sizeof(hdr))) {
2400             ret = 1;
2401             goto done;
2402         }
2403     }
2404
2405     fs_stateIncEOF(state, hdr.len);
2406
2407     if (written) {
2408         if (fs_stateSeek(state, &state->eof_offset)) {
2409             ret = 1;
2410             goto done;
2411         }
2412     }
2413
2414     state->cb_hdr->nFEs++;
2415     state->cb_hdr->nCBs += hdr.nCBs;
2416
2417  done:
2418     return ret;
2419 }
2420
2421 static int
2422 cb_stateRestoreFE(struct fs_dump_state * state)
2423 {
2424     int ret = 0, iovcnt, nCBs;
2425     struct callback_state_entry_header hdr;
2426     struct FEDiskEntry fedsk;
2427     struct CBDiskEntry cbdsk[16];
2428     struct iovec iov[16];
2429     struct FileEntry * fe;
2430
2431     iov[0].iov_base = (char *)&hdr;
2432     iov[0].iov_len = sizeof(hdr);
2433     iov[1].iov_base = (char *)&fedsk;
2434     iov[1].iov_len = sizeof(fedsk);
2435     iovcnt = 2;
2436
2437     if (fs_stateReadV(state, iov, iovcnt)) {
2438         ret = 1;
2439         goto done;
2440     }
2441
2442     if (hdr.magic != CALLBACK_STATE_ENTRY_MAGIC) {
2443         ret = 1;
2444         goto done;
2445     }
2446
2447     fe = GetFE();
2448     if (fe == NULL) {
2449         ViceLog(0, ("cb_stateRestoreFE: ran out of free FileEntry structures\n"));
2450         ret = 1;
2451         goto done;
2452     }
2453
2454     if (cb_stateDiskEntryToFE(state, &fedsk, fe)) {
2455         ret = 1;
2456         goto done;
2457     }
2458
2459     if (hdr.nCBs) {
2460         for (iovcnt = 0, nCBs = 0;
2461              nCBs < hdr.nCBs;
2462              nCBs++) {
2463             iov[iovcnt].iov_base = (char *)&cbdsk[iovcnt];
2464             iov[iovcnt].iov_len = sizeof(struct CBDiskEntry);
2465             iovcnt++;
2466             if ((iovcnt == 16) || (nCBs == hdr.nCBs - 1)) {
2467                 if (fs_stateReadV(state, iov, iovcnt)) {
2468                     ret = 1;
2469                     goto done;
2470                 }
2471                 if (cb_stateRestoreCBs(state, fe, iov, iovcnt)) {
2472                     ret = 1;
2473                     goto done;
2474                 }
2475                 iovcnt = 0;
2476             }
2477         }
2478     }
2479
2480  done:
2481     return ret;
2482 }
2483
2484 static int
2485 cb_stateRestoreCBs(struct fs_dump_state * state, struct FileEntry * fe,
2486                    struct iovec * iov, int niovecs)
2487 {
2488     int ret = 0, idx;
2489     struct CallBack * cb;
2490     struct CBDiskEntry * cbdsk;
2491
2492     for (idx = 0; idx < niovecs; idx++) {
2493         cbdsk = (struct CBDiskEntry *) iov[idx].iov_base;
2494
2495         if (cbdsk->cb.hhead < state->h_map.len &&
2496             state->h_map.entries[cbdsk->cb.hhead].valid == FS_STATE_IDX_SKIPPED) {
2497             continue;
2498         }
2499
2500         if ((cb = GetCB()) == NULL) {
2501             ViceLog(0, ("cb_stateRestoreCBs: ran out of free CallBack structures\n"));
2502             ret = 1;
2503             goto done;
2504         }
2505         if (cb_stateDiskEntryToCB(state, cbdsk, cb)) {
2506             ViceLog(0, ("cb_stateRestoreCBs: corrupt CallBack disk entry\n"));
2507             ret = 1;
2508             goto done;
2509         }
2510     }
2511
2512  done:
2513     return ret;
2514 }
2515
2516
2517 static int
2518 cb_stateFillHeader(struct callback_state_header * hdr)
2519 {
2520     hdr->stamp.magic = CALLBACK_STATE_MAGIC;
2521     hdr->stamp.version = CALLBACK_STATE_VERSION;
2522     hdr->tfirst = tfirst;
2523     return 0;
2524 }
2525
2526 static int
2527 cb_stateCheckHeader(struct callback_state_header * hdr)
2528 {
2529     int ret = 0;
2530
2531     if (hdr->stamp.magic != CALLBACK_STATE_MAGIC) {
2532         ret = 1;
2533     } else if (hdr->stamp.version != CALLBACK_STATE_VERSION) {
2534         ret = 1;
2535     } else if ((hdr->nFEs > cbstuff.nblks) || (hdr->nCBs > cbstuff.nblks)) {
2536         ViceLog(0, ("cb_stateCheckHeader: saved callback state larger than callback memory allocation\n"));
2537         ret = 1;
2538     }
2539     return ret;
2540 }
2541
2542 /* disk entry conversion routines */
2543 static int
2544 cb_stateFEToDiskEntry(struct FileEntry * in, struct FEDiskEntry * out)
2545 {
2546     memcpy(&out->fe, in, sizeof(struct FileEntry));
2547     out->index = fetoi(in);
2548     return 0;
2549 }
2550
2551 static int
2552 cb_stateDiskEntryToFE(struct fs_dump_state * state,
2553                       struct FEDiskEntry * in, struct FileEntry * out)
2554 {
2555     int ret = 0;
2556
2557     memcpy(out, &in->fe, sizeof(struct FileEntry));
2558
2559     /* setup FE map entry */
2560     if (!in->index || (in->index >= state->fe_map.len)) {
2561         ViceLog(0, ("cb_stateDiskEntryToFE: index (%d) out of range",
2562                     in->index));
2563         ret = 1;
2564         goto done;
2565     }
2566     state->fe_map.entries[in->index].valid = FS_STATE_IDX_VALID;
2567     state->fe_map.entries[in->index].old_idx = in->index;
2568     state->fe_map.entries[in->index].new_idx = fetoi(out);
2569
2570  done:
2571     return ret;
2572 }
2573
2574 static int
2575 cb_stateCBToDiskEntry(struct CallBack * in, struct CBDiskEntry * out)
2576 {
2577     memcpy(&out->cb, in, sizeof(struct CallBack));
2578     out->index = cbtoi(in);
2579     return 0;
2580 }
2581
2582 static int
2583 cb_stateDiskEntryToCB(struct fs_dump_state * state,
2584                       struct CBDiskEntry * in, struct CallBack * out)
2585 {
2586     int ret = 0;
2587
2588     memcpy(out, &in->cb, sizeof(struct CallBack));
2589
2590     /* setup CB map entry */
2591     if (!in->index || (in->index >= state->cb_map.len)) {
2592         ViceLog(0, ("cb_stateDiskEntryToCB: index (%d) out of range\n",
2593                     in->index));
2594         ret = 1;
2595         goto done;
2596     }
2597     state->cb_map.entries[in->index].valid = FS_STATE_IDX_VALID;
2598     state->cb_map.entries[in->index].old_idx = in->index;
2599     state->cb_map.entries[in->index].new_idx = cbtoi(out);
2600
2601  done:
2602     return ret;
2603 }
2604
2605 /* index map routines */
2606 static int
2607 cb_stateAllocMap(struct fs_dump_state * state)
2608 {
2609     state->fe_map.len = state->cb_hdr->fe_max + 1;
2610     state->cb_map.len = state->cb_hdr->cb_max + 1;
2611     state->fe_map.entries = (struct idx_map_entry_t *)
2612         calloc(state->fe_map.len, sizeof(struct idx_map_entry_t));
2613     state->cb_map.entries = (struct idx_map_entry_t *)
2614         calloc(state->cb_map.len, sizeof(struct idx_map_entry_t));
2615     return ((state->fe_map.entries != NULL) && (state->cb_map.entries != NULL)) ? 0 : 1;
2616 }
2617
2618 int
2619 fe_OldToNew(struct fs_dump_state * state, afs_uint32 old, afs_uint32 * new)
2620 {
2621     int ret = 0;
2622
2623     /* FEs use a one-based indexing system, so old==0 implies no mapping */
2624     if (!old) {
2625         *new = 0;
2626         goto done;
2627     }
2628
2629     if (old >= state->fe_map.len) {
2630         ViceLog(0, ("fe_OldToNew: index %d is out of range\n", old));
2631         ret = 1;
2632     } else if (state->fe_map.entries[old].valid != FS_STATE_IDX_VALID ||
2633                state->fe_map.entries[old].old_idx != old) { /* sanity check */
2634         ViceLog(0, ("fe_OldToNew: index %d points to an invalid FileEntry record\n", old));
2635         ret = 1;
2636     } else {
2637         *new = state->fe_map.entries[old].new_idx;
2638     }
2639
2640  done:
2641     return ret;
2642 }
2643
2644 int
2645 cb_OldToNew(struct fs_dump_state * state, afs_uint32 old, afs_uint32 * new)
2646 {
2647     int ret = 0;
2648
2649     /* CBs use a one-based indexing system, so old==0 implies no mapping */
2650     if (!old) {
2651         *new = 0;
2652         goto done;
2653     }
2654
2655     if (old >= state->cb_map.len) {
2656         ViceLog(0, ("cb_OldToNew: index %d is out of range\n", old));
2657         ret = 1;
2658     } else if (state->cb_map.entries[old].valid != FS_STATE_IDX_VALID ||
2659                state->cb_map.entries[old].old_idx != old) { /* sanity check */
2660         ViceLog(0, ("cb_OldToNew: index %d points to an invalid CallBack record\n", old));
2661         ret = 1;
2662     } else {
2663         *new = state->cb_map.entries[old].new_idx;
2664     }
2665
2666  done:
2667     return ret;
2668 }
2669 #endif /* AFS_DEMAND_ATTACH_FS */
2670
2671 #define DumpBytes(fd,buf,req) if (write(fd, buf, req) < 0) {} /* don't care */
2672
2673 static int
2674 DumpCallBackState_r(void)
2675 {
2676     int fd, oflag;
2677     afs_uint32 magic = MAGICV2, now = (afs_int32) time(NULL), freelisthead;
2678
2679     oflag = O_WRONLY | O_CREAT | O_TRUNC;
2680 #ifdef AFS_NT40_ENV
2681     oflag |= O_BINARY;
2682 #endif
2683     fd = open(AFSDIR_SERVER_CBKDUMP_FILEPATH, oflag, 0666);
2684     if (fd < 0) {
2685         ViceLog(0,
2686                 ("Couldn't create callback dump file %s\n",
2687                  AFSDIR_SERVER_CBKDUMP_FILEPATH));
2688         return 0;
2689     }
2690     /*
2691      * Collect but ignoring the return value of write(2) here,
2692      * to avoid compiler warnings on some platforms.
2693      */
2694     DumpBytes(fd, &magic, sizeof(magic));
2695     DumpBytes(fd, &now, sizeof(now));
2696     DumpBytes(fd, &cbstuff, sizeof(cbstuff));
2697     DumpBytes(fd, TimeOuts, sizeof(TimeOuts));
2698     DumpBytes(fd, timeout, sizeof(timeout));
2699     DumpBytes(fd, &tfirst, sizeof(tfirst));
2700     freelisthead = cbtoi((struct CallBack *)CBfree);
2701     DumpBytes(fd, &freelisthead, sizeof(freelisthead)); /* This is a pointer */
2702     freelisthead = fetoi((struct FileEntry *)FEfree);
2703     DumpBytes(fd, &freelisthead, sizeof(freelisthead)); /* This is a pointer */
2704     DumpBytes(fd, HashTable, sizeof(HashTable));
2705     DumpBytes(fd, &CB[1], sizeof(CB[1]) * cbstuff.nblks);       /* CB stuff */
2706     DumpBytes(fd, &FE[1], sizeof(FE[1]) * cbstuff.nblks);       /* FE stuff */
2707     close(fd);
2708
2709     return 0;
2710 }
2711
2712 int
2713 DumpCallBackState(void) {
2714     int rc;
2715
2716     H_LOCK;
2717     rc = DumpCallBackState_r();
2718     H_UNLOCK;
2719
2720     return(rc);
2721 }
2722
2723 #endif /* !INTERPRET_DUMP */
2724
2725 #ifdef INTERPRET_DUMP
2726
2727 static void
2728 ReadBytes(int fd, void *buf, size_t req)
2729 {
2730     ssize_t count;
2731
2732     count = read(fd, buf, req);
2733     if (count < 0) {
2734         perror("read");
2735         exit(-1);
2736     } else if (count != req) {
2737         fprintf(stderr, "read: premature EOF (expected %lu, got %lu)\n",
2738                 (unsigned long)req, (unsigned long)count);
2739         exit(-1);
2740     }
2741 }
2742
2743 /* This is only compiled in for the callback analyzer program */
2744 /* Returns the time of the dump */
2745 time_t
2746 ReadDump(char *file, int timebits)
2747 {
2748     int fd, oflag;
2749     afs_uint32 magic, freelisthead;
2750     afs_uint32 now;
2751     afs_int64 now64;
2752
2753     oflag = O_RDONLY;
2754 #ifdef AFS_NT40_ENV
2755     oflag |= O_BINARY;
2756 #endif
2757     fd = open(file, oflag);
2758     if (fd < 0) {
2759         fprintf(stderr, "Couldn't read dump file %s\n", file);
2760         exit(1);
2761     }
2762     ReadBytes(fd, &magic, sizeof(magic));
2763     if (magic == MAGICV2) {
2764         timebits = 32;
2765     } else {
2766         if (magic != MAGIC) {
2767             fprintf(stderr,
2768                     "Magic number of %s is invalid.  You might be trying to\n",
2769                     file);
2770             fprintf(stderr,
2771                     "run this program on a machine type with a different byte ordering.\n");
2772             exit(1);
2773         }
2774     }
2775     if (timebits == 64) {
2776         ReadBytes(fd, &now64, sizeof(afs_int64));
2777         now = (afs_int32) now64;
2778     } else
2779         ReadBytes(fd, &now, sizeof(afs_int32));
2780
2781     ReadBytes(fd, &cbstuff, sizeof(cbstuff));
2782     ReadBytes(fd, TimeOuts, sizeof(TimeOuts));
2783     ReadBytes(fd, timeout, sizeof(timeout));
2784     ReadBytes(fd, &tfirst, sizeof(tfirst));
2785     ReadBytes(fd, &freelisthead, sizeof(freelisthead));
2786     CB = ((struct CallBack
2787            *)(calloc(cbstuff.nblks, sizeof(struct CallBack)))) - 1;
2788     FE = ((struct FileEntry
2789            *)(calloc(cbstuff.nblks, sizeof(struct FileEntry)))) - 1;
2790     CBfree = (struct CallBack *)itocb(freelisthead);
2791     ReadBytes(fd, &freelisthead, sizeof(freelisthead));
2792     FEfree = (struct FileEntry *)itofe(freelisthead);
2793     ReadBytes(fd, HashTable, sizeof(HashTable));
2794     ReadBytes(fd, &CB[1], sizeof(CB[1]) * cbstuff.nblks);       /* CB stuff */
2795     ReadBytes(fd, &FE[1], sizeof(FE[1]) * cbstuff.nblks);       /* FE stuff */
2796     if (close(fd)) {
2797         perror("Error reading dumpfile");
2798         exit(1);
2799     }
2800     return now;
2801 }
2802
2803 #ifdef AFS_NT40_ENV
2804 #include "AFS_component_version_number.h"
2805 #else
2806 #include "AFS_component_version_number.c"
2807 #endif
2808
2809 static afs_uint32 *cbTrack;
2810
2811 int
2812 main(int argc, char **argv)
2813 {
2814     int err = 0, cbi = 0, stats = 0, noptions = 0, all = 0, vol = 0, raw = 0;
2815     static AFSFid fid;
2816     struct FileEntry *fe;
2817     struct CallBack *cb;
2818     time_t now;
2819     int timebits = 32;
2820
2821     memset(&fid, 0, sizeof(fid));
2822     argc--;
2823     argv++;
2824     while (argc && **argv == '-') {
2825         noptions++;
2826         argc--;
2827         if (!strcmp(*argv, "-host")) {
2828             if (argc < 1) {
2829                 err++;
2830                 break;
2831             }
2832             argc--;
2833             cbi = atoi(*++argv);
2834         } else if (!strcmp(*argv, "-fid")) {
2835             if (argc < 2) {
2836                 err++;
2837                 break;
2838             }
2839             argc -= 3;
2840             fid.Volume = atoi(*++argv);
2841             fid.Vnode = atoi(*++argv);
2842             fid.Unique = atoi(*++argv);
2843         } else if (!strcmp(*argv, "-time")) {
2844             fprintf(stderr, "-time not supported\n");
2845             exit(1);
2846         } else if (!strcmp(*argv, "-stats")) {
2847             stats = 1;
2848         } else if (!strcmp(*argv, "-all")) {
2849             all = 1;
2850         } else if (!strcmp(*argv, "-raw")) {
2851             raw = 1;
2852         } else if (!strcmp(*argv, "-timebits")) {
2853             if (argc < 1) {
2854                 err++;
2855                 break;
2856             }
2857             argc--;
2858             timebits = atoi(*++argv);
2859             if ((timebits != 32)
2860                 && (timebits != 64)
2861                 )
2862                 err++;
2863         } else if (!strcmp(*argv, "-volume")) {
2864             if (argc < 1) {
2865                 err++;
2866                 break;
2867             }
2868             argc--;
2869             vol = atoi(*++argv);
2870         } else
2871             err++;
2872         argv++;
2873     }
2874     if (err || argc != 1) {
2875         fprintf(stderr,
2876                 "Usage: cbd [-host cbid] [-fid volume vnode] [-stats] [-all] [-timebits 32"
2877                 "|64"
2878                 "] callbackdumpfile\n");
2879         fprintf(stderr,
2880                 "[cbid is shown for each host in the hosts.dump file]\n");
2881         exit(1);
2882     }
2883     now = ReadDump(*argv, timebits);
2884     if (stats || noptions == 0) {
2885         time_t uxtfirst = UXtime(tfirst), tnow = now;
2886         printf("The time of the dump was %u %s", (unsigned int) now, ctime(&tnow));
2887         printf("The last time cleanup ran was %u %s", (unsigned int) uxtfirst,
2888                ctime(&uxtfirst));
2889         PrintCallBackStats();
2890     }
2891
2892     cbTrack = calloc(cbstuff.nblks, sizeof(cbTrack[0]));
2893
2894     if (all || vol) {
2895         int hash;
2896         afs_uint32 *feip;
2897         struct CallBack *cb;
2898         struct FileEntry *fe;
2899
2900         for (hash = 0; hash < FEHASH_SIZE; hash++) {
2901             for (feip = &HashTable[hash]; (fe = itofe(*feip));) {
2902                 if (!vol || (fe->volid == vol)) {
2903                     afs_uint32 fe_i = fetoi(fe);
2904
2905                     for (cb = itocb(fe->firstcb); cb; cb = itocb(cb->cnext)) {
2906                         afs_uint32 cb_i = cbtoi(cb);
2907
2908                         if (cb_i > cbstuff.nblks) {
2909                             printf("CB index out of range (%u > %d), stopped for this FE\n",
2910                                 cb_i, cbstuff.nblks);
2911                             break;
2912                         }
2913
2914                         if (cbTrack[cb_i]) {
2915                             printf("CB entry already claimed for FE[%u] (this is FE[%u]), stopped\n",
2916                                 cbTrack[cb_i], fe_i);
2917                             break;
2918                         }
2919                         cbTrack[cb_i] = fe_i;
2920
2921                         PrintCB(cb, now);
2922                     }
2923                     *feip = fe->fnext;
2924                 } else {
2925                     feip = &fe->fnext;
2926                 }
2927             }
2928         }
2929     }
2930     if (cbi) {
2931         afs_uint32 cfirst = cbi;
2932         do {
2933             cb = itocb(cbi);
2934             PrintCB(cb, now);
2935             cbi = cb->hnext;
2936         } while (cbi != cfirst);
2937     }
2938     if (fid.Volume) {
2939         fe = FindFE(&fid);
2940         if (!fe) {
2941             printf("No callback entries for %u.%u\n", fid.Volume, fid.Vnode);
2942             exit(1);
2943         }
2944         cb = itocb(fe->firstcb);
2945         while (cb) {
2946             PrintCB(cb, now);
2947             cb = itocb(cb->cnext);
2948         }
2949     }
2950     if (raw) {
2951         afs_int32 *p, i;
2952         for (i = 1; i < cbstuff.nblks; i++) {
2953             p = (afs_int32 *) & FE[i];
2954             printf("%d:%12x%12x%12x%12x\n", i, p[0], p[1], p[2], p[3]);
2955         }
2956     }
2957
2958     free(cbTrack);
2959     exit(0);
2960 }
2961
2962 void
2963 PrintCB(struct CallBack *cb, afs_uint32 now)
2964 {
2965     struct FileEntry *fe = itofe(cb->fhead);
2966     time_t expires = TIndexToTime(cb->thead);
2967
2968     if (fe == NULL)
2969         return;
2970
2971     printf("vol=%" AFS_VOLID_FMT " vn=%u cbs=%d hi=%d st=%d fest=%d, exp in %lu secs at %s",
2972            afs_printable_VolumeId_lu(fe->volid), fe->vnode, fe->ncbs,
2973            cb->hhead, cb->status, fe->status, expires - now, ctime(&expires));
2974 }
2975
2976 #endif
2977
2978 #if     !defined(INTERPRET_DUMP)
2979 /*
2980 ** try breaking calbacks on afidp from host. Use multi_rx.
2981 ** return 0 on success, non-zero on failure
2982 */
2983 int
2984 MultiBreakCallBackAlternateAddress(struct host *host, struct AFSCBFids *afidp)
2985 {
2986     int retVal;
2987     H_LOCK;
2988     retVal = MultiBreakCallBackAlternateAddress_r(host, afidp);
2989     H_UNLOCK;
2990     return retVal;
2991 }
2992
2993 int
2994 MultiBreakCallBackAlternateAddress_r(struct host *host,
2995                                      struct AFSCBFids *afidp)
2996 {
2997     int i, j;
2998     struct rx_connection **conns;
2999     struct rx_connection *connSuccess = 0;
3000     struct AddrPort *interfaces;
3001     static struct rx_securityClass *sc = 0;
3002     static struct AFSCBs tc = { 0, 0 };
3003     char hoststr[16];
3004
3005     /* nothing more can be done */
3006     if (!host->interface)
3007         return 1;               /* failure */
3008
3009     /* the only address is the primary interface */
3010     if (host->interface->numberOfInterfaces <= 1)
3011         return 1;               /* failure */
3012
3013     /* initialise a security object only once */
3014     if (!sc)
3015         sc = rxnull_NewClientSecurityObject();
3016
3017     i = host->interface->numberOfInterfaces;
3018     interfaces = calloc(i, sizeof(struct AddrPort));
3019     conns = calloc(i, sizeof(struct rx_connection *));
3020     if (!interfaces || !conns) {
3021         ViceLogThenPanic(0, ("Failed malloc in "
3022                              "MultiBreakCallBackAlternateAddress_r\n"));
3023     }
3024
3025     /* initialize alternate rx connections */
3026     for (i = 0, j = 0; i < host->interface->numberOfInterfaces; i++) {
3027         /* this is the current primary address */
3028         if (host->host == host->interface->interface[i].addr &&
3029             host->port == host->interface->interface[i].port)
3030             continue;
3031
3032         interfaces[j] = host->interface->interface[i];
3033         conns[j] =
3034             rx_NewConnection(interfaces[j].addr,
3035                              interfaces[j].port, 1, sc, 0);
3036         rx_SetConnDeadTime(conns[j], 2);
3037         rx_SetConnHardDeadTime(conns[j], AFS_HARDDEADTIME);
3038         j++;
3039     }
3040
3041     opr_Assert(j);                      /* at least one alternate address */
3042     ViceLog(125,
3043             ("Starting multibreakcall back on all addr for host %p (%s:%d)\n",
3044              host, afs_inet_ntoa_r(host->host, hoststr), ntohs(host->port)));
3045     H_UNLOCK;
3046     multi_Rx(conns, j) {
3047         multi_RXAFSCB_CallBack(afidp, &tc);
3048         if (!multi_error) {
3049             /* first success */
3050             H_LOCK;
3051             if (host->callback_rxcon)
3052                 rx_DestroyConnection(host->callback_rxcon);
3053             host->callback_rxcon = conns[multi_i];
3054             /* add then remove */
3055             addInterfaceAddr_r(host, interfaces[multi_i].addr,
3056                                      interfaces[multi_i].port);
3057             removeInterfaceAddr_r(host, host->host, host->port);
3058             host->host = interfaces[multi_i].addr;
3059             host->port = interfaces[multi_i].port;
3060             connSuccess = conns[multi_i];
3061             rx_SetConnDeadTime(host->callback_rxcon, 50);
3062             rx_SetConnHardDeadTime(host->callback_rxcon, AFS_HARDDEADTIME);
3063             ViceLog(125,
3064                     ("multibreakcall success with addr %s:%d\n",
3065                      afs_inet_ntoa_r(interfaces[multi_i].addr, hoststr),
3066                      ntohs(interfaces[multi_i].port)));
3067             H_UNLOCK;
3068             multi_Abort;
3069         }
3070     }
3071     multi_End_Ignore;
3072     H_LOCK;
3073     /* Destroy all connections except the one on which we succeeded */
3074     for (i = 0; i < j; i++)
3075         if (conns[i] != connSuccess)
3076             rx_DestroyConnection(conns[i]);
3077
3078     free(interfaces);
3079     free(conns);
3080
3081     if (connSuccess)
3082         return 0;               /* success */
3083     else
3084         return 1;               /* failure */
3085 }
3086
3087
3088 /*
3089 ** try multi_RX probes to host.
3090 ** return 0 on success, non-0 on failure
3091 */
3092 int
3093 MultiProbeAlternateAddress_r(struct host *host)
3094 {
3095     int i, j;
3096     struct rx_connection **conns;
3097     struct rx_connection *connSuccess = 0;
3098     struct AddrPort *interfaces;
3099     static struct rx_securityClass *sc = 0;
3100     char hoststr[16];
3101
3102     /* nothing more can be done */
3103     if (!host->interface)
3104         return 1;               /* failure */
3105
3106     /* the only address is the primary interface */
3107     if (host->interface->numberOfInterfaces <= 1)
3108         return 1;               /* failure */
3109
3110     /* initialise a security object only once */
3111     if (!sc)
3112         sc = rxnull_NewClientSecurityObject();
3113
3114     i = host->interface->numberOfInterfaces;
3115     interfaces = calloc(i, sizeof(struct AddrPort));
3116     conns = calloc(i, sizeof(struct rx_connection *));
3117     if (!interfaces || !conns) {
3118         ViceLogThenPanic(0, ("Failed malloc in "
3119                              "MultiProbeAlternateAddress_r\n"));
3120     }
3121
3122     /* initialize alternate rx connections */
3123     for (i = 0, j = 0; i < host->interface->numberOfInterfaces; i++) {
3124         /* this is the current primary address */
3125         if (host->host == host->interface->interface[i].addr &&
3126             host->port == host->interface->interface[i].port)
3127             continue;
3128
3129         interfaces[j] = host->interface->interface[i];
3130         conns[j] =
3131             rx_NewConnection(interfaces[j].addr,
3132                              interfaces[j].port, 1, sc, 0);
3133         rx_SetConnDeadTime(conns[j], 2);
3134         rx_SetConnHardDeadTime(conns[j], AFS_HARDDEADTIME);
3135         j++;
3136     }
3137
3138     opr_Assert(j);                      /* at least one alternate address */
3139     ViceLog(125,
3140             ("Starting multiprobe on all addr for host %p (%s:%d)\n",
3141              host, afs_inet_ntoa_r(host->host, hoststr),
3142              ntohs(host->port)));
3143     H_UNLOCK;
3144     multi_Rx(conns, j) {
3145         multi_RXAFSCB_ProbeUuid(&host->interface->uuid);
3146         if (!multi_error) {
3147             /* first success */
3148             H_LOCK;
3149             if (host->callback_rxcon)
3150                 rx_DestroyConnection(host->callback_rxcon);
3151             host->callback_rxcon = conns[multi_i];
3152             /* add then remove */
3153             addInterfaceAddr_r(host, interfaces[multi_i].addr,
3154                                      interfaces[multi_i].port);
3155             removeInterfaceAddr_r(host, host->host, host->port);
3156             host->host = interfaces[multi_i].addr;
3157             host->port = interfaces[multi_i].port;
3158             connSuccess = conns[multi_i];
3159             rx_SetConnDeadTime(host->callback_rxcon, 50);
3160             rx_SetConnHardDeadTime(host->callback_rxcon, AFS_HARDDEADTIME);
3161             ViceLog(125,
3162                     ("multiprobe success with addr %s:%d\n",
3163                      afs_inet_ntoa_r(interfaces[multi_i].addr, hoststr),
3164                      ntohs(interfaces[multi_i].port)));
3165             H_UNLOCK;
3166             multi_Abort;
3167         } else {
3168             ViceLog(125,
3169                     ("multiprobe failure with addr %s:%d\n",
3170                      afs_inet_ntoa_r(interfaces[multi_i].addr, hoststr),
3171                      ntohs(interfaces[multi_i].port)));
3172
3173             /* This is less than desirable but its the best we can do.
3174              * The AFS Cache Manager will return either 0 for a Uuid
3175              * match and a 1 for a non-match.   If the error is 1 we
3176              * therefore know that our mapping of IP address to Uuid
3177              * is wrong.   We should attempt to find the correct
3178              * Uuid and fix the host tables.
3179              */
3180             if (multi_error == 1) {
3181                 /* remove the current alternate address from this host */
3182                 H_LOCK;
3183                 removeInterfaceAddr_r(host, interfaces[multi_i].addr, interfaces[multi_i].port);
3184                 H_UNLOCK;
3185             }
3186         }
3187 #ifdef AFS_DEMAND_ATTACH_FS
3188         /* try to bail ASAP if the fileserver is shutting down */
3189         FS_STATE_RDLOCK;
3190         if (fs_state.mode == FS_MODE_SHUTDOWN) {
3191             FS_STATE_UNLOCK;
3192             multi_Abort;
3193         }
3194         FS_STATE_UNLOCK;
3195 #endif
3196     }
3197     multi_End_Ignore;
3198     H_LOCK;
3199     /* Destroy all connections except the one on which we succeeded */
3200     for (i = 0; i < j; i++)
3201         if (conns[i] != connSuccess)
3202             rx_DestroyConnection(conns[i]);
3203
3204     free(interfaces);
3205     free(conns);
3206
3207     if (connSuccess)
3208         return 0;               /* success */
3209     else
3210         return 1;               /* failure */
3211 }
3212
3213 #endif /* !defined(INTERPRET_DUMP) */