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