Revert "Windows: Readonly Volume Versioning for Windows Cache Manager"
[openafs.git] / src / WINNT / afsd / cm_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
10 #include <afs/param.h>
11 #include <afs/afs_args.h>
12 #include <afs/stds.h>
13
14 #include <windows.h>
15 #include <winsock2.h>
16 #include <malloc.h>
17 #include <string.h>
18 #include <stdlib.h>
19
20 #include "afsd.h"
21 #include "smb.h"
22 #include <osi.h>
23 #include <rx_pthread.h>
24
25 #include <WINNT/syscfg.h>
26 #include <WINNT/afsreg.h>
27
28 int
29 SRXAFSCB_InitCallBackState3(struct rx_call *callp, afsUUID* serverUuid);
30
31 /* read/write lock for all global storage in this module */
32 osi_rwlock_t cm_callbackLock;
33
34 afs_int32 cm_OfflineROIsValid = 0;
35
36 afs_int32 cm_giveUpAllCBs = 0;
37
38 afs_int32 cm_shutdown = 0;
39
40 #ifdef AFS_FREELANCE_CLIENT
41 extern osi_mutex_t cm_Freelance_Lock;
42 #endif
43
44 /* count of # of callback breaking messages received by this CM so far.  We use
45  * this count in determining whether there have been any callback breaks that
46  * apply to a call that returned a new callback.  If the counter doesn't
47  * increase during a call, then we know that no callbacks were broken during
48  * that call, and thus that the callback that was just returned is still valid.
49  */
50 long cm_callbackCount;
51
52 /* count of number of RPCs potentially returning a callback executing now.
53  * When this counter hits zero, we can clear out the racing revokes list, since
54  * at that time, we know that none of the just-executed callback revokes will
55  * apply to any future call that returns a callback (since the latter hasn't
56  * even started execution yet).
57  */
58 long cm_activeCallbackGrantingCalls;
59
60 /* list of callbacks that have been broken recently.  If a call returning a
61  * callback is executing and a callback revoke runs immediately after it at the
62  * server, the revoke may end up being processed before the response to the
63  * original callback granting call.  We detect this by keeping a list of
64  * callback revokes that have been received since we *started* the callback
65  * granting call, and discarding any callbacks received for the same file ID,
66  * even if the callback revoke was received before the callback grant.
67  */
68 cm_racingRevokes_t *cm_racingRevokesp;
69
70 /* record a (potentially) racing revoke for this file ID; null means for all
71  * file IDs, and is used by InitCallBackState.
72  *
73  * The cancelFlags describe whether we're just discarding callbacks for the same
74  * file ID, the same volume, or all from the same server.
75  *
76  * Called with no locks held.
77  */
78 void cm_RecordRacingRevoke(cm_fid_t *fidp, long cancelFlags)
79 {
80     cm_racingRevokes_t *rp;
81
82     lock_ObtainWrite(&cm_callbackLock);
83
84     osi_Log3(afsd_logp, "RecordRacingRevoke Volume %d Flags %lX activeCalls %d",
85                 fidp ? fidp->volume : 0, cancelFlags, cm_activeCallbackGrantingCalls);
86
87     if (cm_activeCallbackGrantingCalls > 0) {
88         rp = malloc(sizeof(*rp));
89         memset(rp, 0, sizeof(*rp));
90         osi_QAdd((osi_queue_t **) &cm_racingRevokesp, &rp->q);
91         rp->flags |= (cancelFlags & CM_RACINGFLAG_ALL);
92         if (fidp) rp->fid = *fidp;
93         rp->callbackCount = ++cm_callbackCount;
94     }
95     lock_ReleaseWrite(&cm_callbackLock);
96 }
97
98 /*
99  * When we lose a callback, may have to send change notification replies.
100  * Do not call with a lock on the scp.
101  */
102 void cm_CallbackNotifyChange(cm_scache_t *scp)
103 {
104     DWORD dwDelay = 0;
105     HKEY  hKey;
106     DWORD dummyLen;
107
108     /* why does this have to query the registry each time? */
109         if (RegOpenKeyEx( HKEY_LOCAL_MACHINE, 
110                       AFSREG_CLT_OPENAFS_SUBKEY,
111                       0,
112                       KEY_READ|KEY_QUERY_VALUE,
113                       &hKey) == ERROR_SUCCESS) {
114
115         dummyLen = sizeof(DWORD);
116         RegQueryValueEx(hKey, "CallBack Notify Change Delay", NULL, NULL,
117                         (BYTE *) &dwDelay, &dummyLen);
118         RegCloseKey(hKey);
119     }
120
121     if (dwDelay > 5000)    /* do not allow a delay of more then 5 seconds */
122         dwDelay = 5000;   
123
124     osi_Log3(afsd_logp, "CallbackNotifyChange FileType %d Flags %lX Delay %dms",
125               scp->fileType, scp->flags, dwDelay);
126
127     if (dwDelay)
128         Sleep(dwDelay);
129
130     /* for directories, this sends a change notification on the dir itself */
131     if (scp->fileType == CM_SCACHETYPE_DIRECTORY) {
132         if (scp->flags & CM_SCACHEFLAG_ANYWATCH)
133             smb_NotifyChange(0,
134                              FILE_NOTIFY_GENERIC_DIRECTORY_FILTER,
135                              scp, NULL, NULL, TRUE);
136     } else {
137         /* and for files, this sends a change notification on the file's parent dir */
138         cm_fid_t tfid;
139         cm_scache_t *dscp;
140
141         cm_SetFid(&tfid, scp->fid.cell, scp->fid.volume, scp->parentVnode, scp->parentUnique);
142         dscp = cm_FindSCache(&tfid);
143         if ( dscp &&
144              dscp->flags & CM_SCACHEFLAG_ANYWATCH )
145             smb_NotifyChange( 0,
146                               FILE_NOTIFY_GENERIC_FILE_FILTER,
147                               dscp, NULL, NULL, TRUE);
148         if (dscp) 
149             cm_ReleaseSCache(dscp);
150     }
151 }
152
153 /* called with no locks held for every file ID that is revoked directly by
154  * a callback revoke call.  Does not have to handle volume callback breaks,
155  * since those have already been split out.
156  *
157  * The callp parameter is currently unused.
158  */
159 void cm_RevokeCallback(struct rx_call *callp, cm_cell_t * cellp, AFSFid *fidp)
160 {
161     cm_fid_t tfid;
162     cm_scache_t *scp;
163     long hash;
164         
165     tfid.cell = cellp ? cellp->cellID : 0;
166     tfid.volume = fidp->Volume;
167     tfid.vnode = fidp->Vnode;
168     tfid.unique = fidp->Unique;
169     hash = CM_SCACHE_HASH(&tfid);
170
171     osi_Log3(afsd_logp, "RevokeCallback vol %u vn %u uniq %u",
172              fidp->Volume, fidp->Vnode, fidp->Unique);
173         
174     /* do this first, so that if we're executing a callback granting call
175      * at this moment, we kill it before it can be merged in.  Otherwise,
176      * it could complete while we're doing the scan below, and get missed
177      * by both the scan and by this code.
178      */
179     cm_RecordRacingRevoke(&tfid, 0);
180
181     lock_ObtainWrite(&cm_scacheLock);
182     /* do all in the hash bucket, since we don't know how many we'll find with
183      * varying cells.
184      */
185     for (scp = cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
186         if (scp->fid.volume == tfid.volume &&
187              scp->fid.vnode == tfid.vnode &&
188              scp->fid.unique == tfid.unique &&
189              (cellp == NULL || scp->fid.cell == cellp->cellID) &&
190              cm_HaveCallback(scp))
191         {
192             cm_HoldSCacheNoLock(scp);
193             lock_ReleaseWrite(&cm_scacheLock);
194             osi_Log4(afsd_logp, "RevokeCallback Discarding SCache scp 0x%p vol %u vn %u uniq %u", 
195                      scp, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
196
197             lock_ObtainWrite(&scp->rw);
198             cm_DiscardSCache(scp);
199             lock_ReleaseWrite(&scp->rw);
200
201             cm_CallbackNotifyChange(scp);
202             
203             lock_ObtainWrite(&cm_scacheLock);
204             cm_ReleaseSCacheNoLock(scp);
205         }
206     }
207     lock_ReleaseWrite(&cm_scacheLock);
208
209     osi_Log3(afsd_logp, "RevokeCallback Complete vol %u vn %u uniq %u",
210              fidp->Volume, fidp->Vnode, fidp->Unique);
211 }
212
213 /* called to revoke a volume callback, which is typically issued when a volume
214  * is moved from one server to another.
215  *
216  * Called with no locks held.
217  */
218 void cm_RevokeVolumeCallback(struct rx_call *callp, cm_cell_t *cellp, AFSFid *fidp)
219 {
220     unsigned long hash;
221     cm_scache_t *scp;
222     cm_fid_t tfid;
223
224     osi_Log1(afsd_logp, "RevokeVolumeCallback vol %d", fidp->Volume);
225
226     /* do this first, so that if we're executing a callback granting call
227      * at this moment, we kill it before it can be merged in.  Otherwise,
228      * it could complete while we're doing the scan below, and get missed
229      * by both the scan and by this code.
230      */
231     tfid.cell = cellp ? cellp->cellID : 0;
232     tfid.volume = fidp->Volume;
233     tfid.vnode = tfid.unique = 0;
234
235     cm_RecordRacingRevoke(&tfid, CM_RACINGFLAG_CANCELVOL);
236
237     lock_ObtainWrite(&cm_scacheLock);
238     for (hash = 0; hash < cm_data.scacheHashTableSize; hash++) {
239         for(scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
240             if (scp->fid.volume == fidp->Volume &&
241                 (cellp == NULL || scp->fid.cell == cellp->cellID) &&
242                  scp->cbExpires > 0 &&
243                  scp->cbServerp != NULL) {
244                 cm_HoldSCacheNoLock(scp);
245                 lock_ReleaseWrite(&cm_scacheLock);
246
247                 lock_ObtainWrite(&scp->rw);
248                 osi_Log4(afsd_logp, "RevokeVolumeCallback Discarding SCache scp 0x%p vol %u vn %u uniq %u", 
249                           scp, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
250                 cm_DiscardSCache(scp);
251                 lock_ReleaseWrite(&scp->rw);
252
253                 cm_CallbackNotifyChange(scp);
254                 lock_ObtainWrite(&cm_scacheLock);
255                 cm_ReleaseSCacheNoLock(scp);
256                 if (scp->flags & CM_SCACHEFLAG_PURERO) {
257                     cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
258                     if (volp) {
259                         volp->cbExpiresRO = 0;
260                         cm_PutVolume(volp);
261                     }
262                 }
263             }
264         }       /* search one hash bucket */
265     }   /* search all hash buckets */
266
267     lock_ReleaseWrite(&cm_scacheLock);
268
269     osi_Log1(afsd_logp, "RevokeVolumeCallback Complete vol %d", fidp->Volume);
270 }
271
272 /*
273  * afs_data_pointer_to_int32() - returns least significant afs_int32 of the
274  * given data pointer, without triggering "cast truncates pointer"
275  * warnings.  We use this where we explicitly don't care whether a
276  * pointer is truncated -- it loses information where a pointer is
277  * larger than an afs_int32.
278  */
279
280 static afs_int32
281 afs_data_pointer_to_int32(const void *p)
282 {
283     union {
284         afs_int32 i32[sizeof(void *) / sizeof(afs_int32)];
285         const void *p;
286     } ip;
287
288     int i32_sub;                /* subscript of least significant afs_int32 in ip.i32[] */
289
290     /* set i32_sub */
291
292     {
293         /* used to determine the byte order of the system */
294
295         union {
296             char c[sizeof(int) / sizeof(char)];
297             int i;
298         } ci;
299
300         ci.i = 1;
301         if (ci.c[0] == 1) {
302             /* little-endian system */
303             i32_sub = 0;
304         } else {
305             /* big-endian system */
306             i32_sub = (sizeof ip.i32 / sizeof ip.i32[0]) - 1;
307         }
308     }
309
310     ip.p = p;
311     return ip.i32[i32_sub];
312 }
313 /*------------------------------------------------------------------------
314  * EXPORTED SRXAFSCB_CallBack
315  *
316  * Description:
317  *      Routine called by the server-side callback RPC interface to
318  *      implement passing in callback information.
319  *      table.
320  *
321  * Arguments:
322  *      rx_call    : Ptr to Rx call on which this request came in.
323  *      fidsArrayp : Ptr to array of fids involved.
324  *      cbsArrayp  : Ptr to matching callback info for the fids.
325  *
326  * Returns:
327  *      0 (always).
328  *
329  * Environment:
330  *      Nothing interesting.
331  *
332  * Side Effects:
333  *      As advertised.
334  *------------------------------------------------------------------------*/
335 /* handle incoming RPC callback breaking message.
336  * Called with no locks held.
337  */
338 int
339 SRXAFSCB_CallBack(struct rx_call *callp, AFSCBFids *fidsArrayp, AFSCBs *cbsArrayp)
340 {
341     int i;
342     AFSFid *tfidp;
343     struct rx_connection *connp;
344     struct rx_peer *peerp;
345     unsigned long host = 0;
346     unsigned short port = 0;
347     cm_server_t *tsp = NULL;
348     cm_cell_t* cellp = NULL;
349
350     if (cm_shutdown)
351         return 1;
352
353     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
354         host = rx_HostOf(peerp);
355         port = rx_PortOf(peerp);
356
357         tsp = cm_FindServerByIP(host, port, CM_SERVER_FILE);
358         if (tsp) {
359             cellp = tsp->cellp;
360             cm_PutServer(tsp);
361         }
362
363         if (!cellp)
364             osi_Log2(afsd_logp, "SRXAFSCB_CallBack from host 0x%x port %d",
365                      ntohl(host),
366                      ntohs(port));
367         else 
368             osi_Log3(afsd_logp, "SRXAFSCB_CallBack from host 0x%x port %d for cell %s",
369                      ntohl(host),
370                      ntohs(port),
371                      cellp->name /* does not need to be saved, doesn't change */);
372     } else {
373         osi_Log0(afsd_logp, "SRXAFSCB_CallBack from unknown host");
374     }
375
376
377     for (i=0; i < (long) fidsArrayp->AFSCBFids_len; i++) {
378         tfidp = &fidsArrayp->AFSCBFids_val[i];
379                 
380         if (tfidp->Volume == 0)
381             continue;   /* means don't do anything */
382         else if (tfidp->Vnode == 0)
383             cm_RevokeVolumeCallback(callp, cellp, tfidp);
384         else
385             cm_RevokeCallback(callp, cellp, tfidp);
386     }
387     return 0;
388 }
389
390 /*------------------------------------------------------------------------
391  * EXPORTED SRXAFSCB_InitCallBackState
392  *
393  * Description:
394  *      Routine called by the server-side callback RPC interface to
395  *      implement clearing all callbacks from this host.
396  *
397  * Arguments:
398  *      rx_call : Ptr to Rx call on which this request came in.
399  *
400  * Returns:
401  *      0 (always).
402  *
403  * Environment:
404  *      Nothing interesting.
405  *
406  * Side Effects:
407  *      As advertised.
408  *------------------------------------------------------------------------*/
409 /* called with no locks by RPC system when a server indicates that it has never
410  * heard from us, or for other reasons has had to discard callbacks from us
411  * without telling us, e.g. a network partition.
412  */
413 int
414 SRXAFSCB_InitCallBackState(struct rx_call *callp)
415 {
416     if (cm_shutdown)
417         return 1;
418
419     osi_Log0(afsd_logp, "SRXAFSCB_InitCallBackState ->");
420
421     return SRXAFSCB_InitCallBackState3(callp, NULL);
422 }
423
424 /*------------------------------------------------------------------------
425  * EXPORTED SRXAFSCB_Probe
426  *
427  * Description:
428  *      Routine called by the server-side callback RPC interface to
429  *      implement ``probing'' the Cache Manager, just making sure it's
430  *      still there.
431  *
432  * Arguments:
433  *      rx_call : Ptr to Rx call on which this request came in.
434  *
435  * Returns:
436  *      0 (always).
437  *
438  * Environment:
439  *      Nothing interesting.
440  *
441  * Side Effects:
442  *      As advertised.
443  *------------------------------------------------------------------------*/
444 int
445 SRXAFSCB_Probe(struct rx_call *callp)
446 {
447     struct rx_connection *connp;
448     struct rx_peer *peerp;
449     unsigned long host = 0;
450     unsigned short port = 0;
451
452     if (cm_shutdown)
453         return 1;
454
455     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
456         host = rx_HostOf(peerp);
457         port = rx_PortOf(peerp);
458     }
459
460     osi_Log2(afsd_logp, "SRXAFSCB_Probe from host 0x%x port %d",
461               ntohl(host),
462               ntohs(port));
463
464     return 0;
465 }
466
467 /*------------------------------------------------------------------------
468  * EXPORTED SRXAFSCB_GetLock
469  *
470  * Description:
471  *      Routine called by the server-side callback RPC interface to
472  *      implement pulling out the contents of a lock in the lock
473  *      table.
474  *
475  * Arguments:
476  *      a_call   : Ptr to Rx call on which this request came in.
477  *      a_index  : Index of desired lock.
478  *      a_result : Ptr to a buffer for the given lock.
479  *
480  * Returns:
481  *      0 if everything went fine,
482  *      1 if we were given a bad index.
483  *
484  * Environment:
485  *      Nothing interesting.
486  *
487  * Side Effects:
488  *      As advertised.
489  *------------------------------------------------------------------------*/
490 /* debug interface */
491
492 extern osi_rwlock_t cm_aclLock;
493 extern osi_rwlock_t buf_globalLock;
494 extern osi_rwlock_t cm_cellLock;
495 extern osi_rwlock_t cm_connLock;
496 extern osi_rwlock_t cm_daemonLock;
497 extern osi_rwlock_t cm_dnlcLock;
498 extern osi_rwlock_t cm_scacheLock;
499 extern osi_rwlock_t cm_serverLock;
500 extern osi_rwlock_t cm_syscfgLock;
501 extern osi_rwlock_t cm_userLock;
502 extern osi_rwlock_t cm_utilsLock;
503 extern osi_rwlock_t cm_volumeLock;
504 extern osi_rwlock_t smb_globalLock;
505 extern osi_rwlock_t smb_rctLock;
506
507 extern osi_mutex_t cm_Freelance_Lock;
508 extern osi_mutex_t cm_Afsdsbmt_Lock;
509 extern osi_mutex_t tokenEventLock;
510 extern osi_mutex_t  smb_ListenerLock;
511 extern osi_mutex_t smb_RawBufLock;
512 extern osi_mutex_t smb_Dir_Watch_Lock;
513
514 #define LOCKTYPE_RW     1
515 #define LOCKTYPE_MUTEX  2
516 static struct _ltable {
517     char *name;
518     char *addr;
519     int  type;
520 } ltable[] = {
521     {"cm_scacheLock",    (char*)&cm_scacheLock,         LOCKTYPE_RW},
522     {"buf_globalLock",   (char*)&buf_globalLock,        LOCKTYPE_RW},
523     {"cm_serverLock",    (char*)&cm_serverLock,         LOCKTYPE_RW},
524     {"cm_callbackLock",  (char*)&cm_callbackLock,       LOCKTYPE_RW},
525     {"cm_syscfgLock",    (char*)&cm_syscfgLock,         LOCKTYPE_RW},
526     {"cm_aclLock",       (char*)&cm_aclLock,            LOCKTYPE_RW},
527     {"cm_cellLock",      (char*)&cm_cellLock,           LOCKTYPE_RW},
528     {"cm_connLock",      (char*)&cm_connLock,           LOCKTYPE_RW},
529     {"cm_userLock",      (char*)&cm_userLock,           LOCKTYPE_RW},
530     {"cm_volumeLock",    (char*)&cm_volumeLock,         LOCKTYPE_RW},
531     {"cm_daemonLock",    (char*)&cm_daemonLock,         LOCKTYPE_RW},
532     {"cm_dnlcLock",      (char*)&cm_dnlcLock,           LOCKTYPE_RW},
533     {"cm_utilsLock",     (char*)&cm_utilsLock,          LOCKTYPE_RW},
534     {"smb_globalLock",   (char*)&smb_globalLock,        LOCKTYPE_RW},
535     {"smb_rctLock",      (char*)&smb_rctLock,           LOCKTYPE_RW},
536     {"cm_Freelance_Lock",(char*)&cm_Freelance_Lock,     LOCKTYPE_MUTEX},
537     {"cm_Afsdsbmt_Lock", (char*)&cm_Afsdsbmt_Lock,      LOCKTYPE_MUTEX},
538     {"tokenEventLock",   (char*)&tokenEventLock,        LOCKTYPE_MUTEX},
539     {"smb_ListenerLock", (char*)&smb_ListenerLock,      LOCKTYPE_MUTEX},
540     {"smb_RawBufLock",   (char*)&smb_RawBufLock,        LOCKTYPE_MUTEX},
541     {"smb_Dir_Watch_Lock",(char*)&smb_Dir_Watch_Lock,   LOCKTYPE_MUTEX}
542 };
543
544 int
545 SRXAFSCB_GetLock(struct rx_call *callp, long index, AFSDBLock *lockp)
546 {
547     struct _ltable *tl;          /*Ptr to lock table entry */
548     osi_rwlock_t  *rwp;
549     osi_mutex_t   *mtxp;
550     int nentries;               /*Num entries in table */
551     int code;                   /*Return code */
552     struct rx_connection *connp;
553     struct rx_peer *peerp;
554     unsigned long host = 0;
555     unsigned short port = 0;
556
557     if (cm_shutdown)
558         return 1;
559
560     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
561         host = rx_HostOf(peerp);
562         port = rx_PortOf(peerp);
563     }
564
565     osi_Log3(afsd_logp, "SRXAFSCB_GetLock(%d) from host 0x%x port %d", 
566              index, ntohl(host), ntohs(port));
567
568     nentries = sizeof(ltable) / sizeof(struct _ltable);
569     if (index < 0 || index >= nentries) {
570         /*
571          * Past EOF
572          */
573         code = 1;
574     } else {
575         /*
576          * Found it - copy out its contents.
577          */
578         tl = &ltable[index];
579         strncpy(lockp->name, tl->name, sizeof(lockp->name));
580         lockp->name[sizeof(lockp->name)-1] = '\0';
581         lockp->lock.waitStates = 0;
582         switch ( tl->type ) {
583         case LOCKTYPE_RW:
584             rwp = (osi_rwlock_t *)tl->addr;
585             lockp->lock.exclLocked = rwp->flags;
586             lockp->lock.readersReading = rwp->readers;
587             lockp->lock.numWaiting = rwp->waiters;
588             break;
589         case LOCKTYPE_MUTEX:
590             mtxp = (osi_mutex_t *)tl->addr;
591             lockp->lock.exclLocked = mtxp->flags;
592             lockp->lock.readersReading = 0;
593             lockp->lock.numWaiting = mtxp->waiters;
594             break;
595         }
596         lockp->lock.pid_last_reader = 0;
597         lockp->lock.pid_writer = 0;
598         lockp->lock.src_indicator = 0;
599         code = 0;
600     }
601
602     return code;
603 }
604
605 /* debug interface */
606 int
607 SRXAFSCB_GetCE(struct rx_call *callp, long index, AFSDBCacheEntry *cep)
608 {
609     afs_uint32 i;
610     cm_scache_t * scp;
611     int code;
612     struct rx_connection *connp;
613     struct rx_peer *peerp;
614     unsigned long host = 0;
615     unsigned short port = 0;
616
617     if (cm_shutdown)
618         return 1;
619
620     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
621         host = rx_HostOf(peerp);
622         port = rx_PortOf(peerp);
623     }
624
625     osi_Log2(afsd_logp, "SRXAFSCB_GetCE from host 0x%x port %d",
626              ntohl(host), ntohs(port));
627
628     lock_ObtainRead(&cm_scacheLock);
629     for (i = 0; i < cm_data.scacheHashTableSize; i++) {
630         for (scp = cm_data.scacheHashTablep[i]; scp; scp = scp->nextp) {
631             if (index == 0)
632                 goto searchDone;
633             index--;
634         }                       /*Zip through current hash chain */
635     }                           /*Zip through hash chains */
636
637   searchDone:
638     if (scp == NULL) {
639         /*Past EOF */
640         code = 1;
641         goto fcnDone;
642     }
643
644     /*
645      * Copy out the located entry.
646      */
647     memset(cep, 0, sizeof(AFSDBCacheEntry));
648     cep->addr = afs_data_pointer_to_int32(scp);
649     cep->cell = scp->fid.cell;
650     cep->netFid.Volume = scp->fid.volume;
651     cep->netFid.Vnode = scp->fid.vnode;
652     cep->netFid.Unique = scp->fid.unique;
653     cep->lock.waitStates = 0;
654     cep->lock.exclLocked = scp->rw.flags;
655     cep->lock.readersReading = 0;
656     cep->lock.numWaiting = scp->rw.waiters;
657     cep->lock.pid_last_reader = 0;
658     cep->lock.pid_writer = 0;
659     cep->lock.src_indicator = 0;
660     cep->Length = scp->length.LowPart;
661     cep->DataVersion = (afs_uint32)(scp->dataVersion & 0xFFFFFFFF);
662     cep->callback = afs_data_pointer_to_int32(scp->cbServerp);
663     if (scp->flags & CM_SCACHEFLAG_PURERO) {
664         cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
665         if (volp) {
666             cep->cbExpires = volp->cbExpiresRO;
667             cm_PutVolume(volp);
668         }
669     } else {
670         /* TODO: deal with time_t below */
671         cep->cbExpires = (afs_int32) scp->cbExpires;
672     }
673     cep->refCount = scp->refCount;
674     cep->opens = scp->openReads;
675     cep->writers = scp->openWrites;
676     switch (scp->fileType) {
677     case CM_SCACHETYPE_FILE:
678         cep->mvstat = 0;
679         break;
680     case CM_SCACHETYPE_MOUNTPOINT:
681         cep->mvstat = 1;
682         break;
683     case CM_SCACHETYPE_DIRECTORY:
684         if (scp->fid.vnode == 1 && scp->fid.unique == 1)
685             cep->mvstat = 2;
686         else
687             cep->mvstat = 3;
688         break;
689     case CM_SCACHETYPE_SYMLINK:
690         cep->mvstat = 4;
691         break;
692     case CM_SCACHETYPE_DFSLINK:
693         cep->mvstat = 5;
694         break;
695     case CM_SCACHETYPE_INVALID:
696         cep->mvstat = 6;
697         break;
698     }
699     cep->states = 0;
700     if (scp->flags & CM_SCACHEFLAG_STATD)
701         cep->states |= 1;
702     if (scp->flags & CM_SCACHEFLAG_RO || scp->flags & CM_SCACHEFLAG_PURERO)
703         cep->states |= 4;
704     if (scp->fileType == CM_SCACHETYPE_MOUNTPOINT &&
705         scp->mountPointStringp[0])
706         cep->states |= 8;
707     if (scp->flags & CM_SCACHEFLAG_WAITING)
708         cep->states |= 0x40;
709     code = 0;
710
711     /*
712      * Return our results.
713      */
714   fcnDone:
715     lock_ReleaseRead(&cm_scacheLock);
716
717     return (code);
718 }
719
720 /* debug interface */
721 int
722 SRXAFSCB_GetCE64(struct rx_call *callp, long index, AFSDBCacheEntry64 *cep)
723 {
724     afs_uint32 i;
725     cm_scache_t * scp;
726     int code;
727     struct rx_connection *connp;
728     struct rx_peer *peerp;
729     unsigned long host = 0;
730     unsigned short port = 0;
731
732     if (cm_shutdown)
733         return 1;
734
735     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
736         host = rx_HostOf(peerp);
737         port = rx_PortOf(peerp);
738     }
739
740     osi_Log2(afsd_logp, "SRXAFSCB_GetCE64 from host 0x%x port %d",
741              ntohl(host), ntohs(port));
742
743     lock_ObtainRead(&cm_scacheLock);
744     for (i = 0; i < cm_data.scacheHashTableSize; i++) {
745         for (scp = cm_data.scacheHashTablep[i]; scp; scp = scp->nextp) {
746             if (index == 0)
747                 goto searchDone;
748             index--;
749         }                       /*Zip through current hash chain */
750     }                           /*Zip through hash chains */
751
752   searchDone:
753     if (scp == NULL) {
754         /*Past EOF */
755         code = 1;
756         goto fcnDone;
757     }
758
759     /*
760      * Copy out the located entry.
761      */
762     memset(cep, 0, sizeof(AFSDBCacheEntry64));
763     cep->addr = afs_data_pointer_to_int32(scp);
764     cep->cell = scp->fid.cell;
765     cep->netFid.Volume = scp->fid.volume;
766     cep->netFid.Vnode = scp->fid.vnode;
767     cep->netFid.Unique = scp->fid.unique;
768     cep->lock.waitStates = 0;
769     cep->lock.exclLocked = scp->rw.flags;
770     cep->lock.readersReading = 0;
771     cep->lock.numWaiting = scp->rw.waiters;
772     cep->lock.pid_last_reader = 0;
773     cep->lock.pid_writer = 0;
774     cep->lock.src_indicator = 0;
775 #if !defined(AFS_64BIT_ENV)
776     cep->Length.high = scp->length.HighPart;
777     cep->Length.low = scp->length.LowPart;
778 #else
779     cep->Length = (afs_int64) scp->length.QuadPart;
780 #endif
781     cep->DataVersion = (afs_uint32)(scp->dataVersion & 0xFFFFFFFF);
782     cep->callback = afs_data_pointer_to_int32(scp->cbServerp);
783     if (scp->flags & CM_SCACHEFLAG_PURERO) {
784         cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
785         if (volp) {
786             cep->cbExpires = volp->cbExpiresRO;
787             cm_PutVolume(volp);
788         }
789     } else {
790         /* TODO: handle time_t */
791         cep->cbExpires = (afs_int32) scp->cbExpires;
792     }
793     cep->refCount = scp->refCount;
794     cep->opens = scp->openReads;
795     cep->writers = scp->openWrites;
796     switch (scp->fileType) {
797     case CM_SCACHETYPE_FILE:
798         cep->mvstat = 0;
799         break;
800     case CM_SCACHETYPE_MOUNTPOINT:
801         cep->mvstat = 1;
802         break;
803     case CM_SCACHETYPE_DIRECTORY:
804         if (scp->fid.vnode == 1 && scp->fid.unique == 1)
805             cep->mvstat = 2;
806         else
807             cep->mvstat = 3;
808         break;
809     case CM_SCACHETYPE_SYMLINK:
810         cep->mvstat = 4;
811         break;
812     case CM_SCACHETYPE_DFSLINK:
813         cep->mvstat = 5;
814         break;
815     case CM_SCACHETYPE_INVALID:
816         cep->mvstat = 6;
817         break;
818     }
819     cep->states = 0;
820     if (scp->flags & CM_SCACHEFLAG_STATD)
821         cep->states |= 1;
822     if (scp->flags & CM_SCACHEFLAG_RO || scp->flags & CM_SCACHEFLAG_PURERO)
823         cep->states |= 4;
824     if (scp->fileType == CM_SCACHETYPE_MOUNTPOINT &&
825         scp->mountPointStringp[0])
826         cep->states |= 8;
827     if (scp->flags & CM_SCACHEFLAG_WAITING)
828         cep->states |= 0x40;
829     code = 0;
830
831     /*
832      * Return our results.
833      */
834   fcnDone:
835     lock_ReleaseRead(&cm_scacheLock);
836
837     return (code);
838 }
839
840 /* debug interface: not implemented */
841 int
842 SRXAFSCB_XStatsVersion(struct rx_call *callp, long *vp)
843 {
844     struct rx_connection *connp;
845     struct rx_peer *peerp;
846     unsigned long host = 0;
847     unsigned short port = 0;
848
849     if (cm_shutdown)
850         return 1;
851
852     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
853         host = rx_HostOf(peerp);
854         port = rx_PortOf(peerp);
855     }
856
857     osi_Log2(afsd_logp, "SRXAFSCB_XStatsVersion from host 0x%x port %d - not implemented",
858              ntohl(host), ntohs(port));
859     *vp = -1;
860
861     return RXGEN_OPCODE;
862 }
863
864 /* debug interface: not implemented */
865 int
866 SRXAFSCB_GetXStats(struct rx_call *callp, long cvn, long coln, long *srvp, long *timep,
867                    AFSCB_CollData *datap)
868 {
869     struct rx_connection *connp;
870     struct rx_peer *peerp;
871     unsigned long host = 0;
872     unsigned short port = 0;
873
874     if (cm_shutdown)
875         return 1;
876
877     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
878         host = rx_HostOf(peerp);
879         port = rx_PortOf(peerp);
880     }
881
882     osi_Log2(afsd_logp, "SRXAFSCB_GetXStats from host 0x%x port %d - not implemented",
883              ntohl(host), ntohs(port));
884
885     return RXGEN_OPCODE;
886 }
887
888 int
889 SRXAFSCB_InitCallBackState2(struct rx_call *callp, struct interfaceAddr* addr)
890 {
891     if (cm_shutdown)
892         return 1;
893
894     osi_Log0(afsd_logp, "SRXAFSCB_InitCallBackState2 ->");
895
896     return SRXAFSCB_InitCallBackState3(callp, NULL);
897 }
898
899 /* debug interface */
900 int
901 SRXAFSCB_WhoAreYou(struct rx_call *callp, struct interfaceAddr* addr)
902 {
903     int i;
904     long code;
905     struct rx_connection *connp;
906     struct rx_peer *peerp;
907     unsigned long host = 0;
908     unsigned short port = 0;
909
910     if (cm_shutdown)
911         return 1;
912
913     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
914         host = rx_HostOf(peerp);
915         port = rx_PortOf(peerp);
916     }
917
918     osi_Log2(afsd_logp, "SRXAFSCB_WhoAreYou from host 0x%x port %d",
919               ntohl(host),
920               ntohs(port));
921
922     lock_ObtainRead(&cm_syscfgLock);
923     if (cm_LanAdapterChangeDetected) {
924         lock_ConvertRToW(&cm_syscfgLock);
925         if (cm_LanAdapterChangeDetected) {
926             /* get network related info */
927             cm_noIPAddr = CM_MAXINTERFACE_ADDR;
928             code = syscfg_GetIFInfo(&cm_noIPAddr,
929                                      cm_IPAddr, cm_SubnetMask,
930                                      cm_NetMtu, cm_NetFlags);
931             cm_LanAdapterChangeDetected = 0;
932         }
933         lock_ConvertWToR(&cm_syscfgLock);
934     }
935
936     /* return all network interface addresses */
937     addr->numberOfInterfaces = cm_noIPAddr;
938     addr->uuid = cm_data.Uuid;
939     for ( i=0; i < cm_noIPAddr; i++ ) {
940         addr->addr_in[i] = cm_IPAddr[i];
941         addr->subnetmask[i] = cm_SubnetMask[i];
942         addr->mtu[i] = (rx_mtu == -1 || (rx_mtu != -1 && cm_NetMtu[i] < rx_mtu)) ? 
943             cm_NetMtu[i] : rx_mtu;
944     }
945
946     lock_ReleaseRead(&cm_syscfgLock);
947
948     return 0;
949 }
950
951 int
952 SRXAFSCB_InitCallBackState3(struct rx_call *callp, afsUUID* serverUuid)
953 {
954     char *p = NULL;
955
956     struct sockaddr_in taddr;
957     cm_server_t *tsp = NULL;
958     cm_scache_t *scp = NULL;
959     cm_cell_t* cellp = NULL;
960     afs_uint32 hash;
961     int discarded;
962     struct rx_connection *connp;
963     struct rx_peer *peerp;
964     unsigned long host = 0;
965     unsigned short port = 0;
966
967     if (cm_shutdown)
968         return 1;
969
970     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
971         host = rx_HostOf(peerp);
972         port = rx_PortOf(peerp);
973
974         if (serverUuid) {
975             if (UuidToString((UUID *)serverUuid, &p) == RPC_S_OK) {
976                 osi_Log1(afsd_logp, "SRXAFSCB_InitCallBackState3 Uuid%s ->",osi_LogSaveString(afsd_logp,p));
977                 RpcStringFree(&p);
978             } 
979
980             tsp = cm_FindServerByUuid(serverUuid, CM_SERVER_FILE);
981         }
982         if (!tsp)
983             tsp = cm_FindServerByIP(host, port, CM_SERVER_FILE);
984         if (tsp) {
985             cellp = tsp->cellp;
986             cm_PutServer(tsp);
987         }
988
989         if (!cellp)
990             osi_Log2(afsd_logp, "SRXAFSCB_InitCallBackState3 from host 0x%x port %d",
991                      ntohl(host),
992                      ntohs(port));
993         else 
994             osi_Log3(afsd_logp, "SRXAFSCB_InitCallBackState3 from host 0x%x port %d for cell %s",
995                      ntohl(host),
996                      ntohs(port),
997                      cellp->name /* does not need to be saved, doesn't change */);
998     } else {
999         osi_Log0(afsd_logp, "SRXAFSCB_InitCallBackState3 from unknown host");
1000     }
1001
1002     if (connp && peerp) {
1003         taddr.sin_family = AF_INET;
1004         taddr.sin_addr.s_addr = rx_HostOf(rx_PeerOf(rx_ConnectionOf(callp)));
1005         taddr.sin_port = rx_PortOf(rx_PeerOf(rx_ConnectionOf(callp)));
1006
1007         tsp = cm_FindServer(&taddr, CM_SERVER_FILE);
1008
1009         osi_Log1(afsd_logp, "InitCallbackState3 server %x", tsp);
1010         
1011         /* record the callback in the racing revokes structure.  This
1012          * shouldn't be necessary, since we shouldn't be making callback
1013          * granting calls while we're going to get an initstate call,
1014          * but there probably are some obscure races, so better safe
1015          * than sorry.
1016          *
1017          * We do this first since we don't hold the cm_scacheLock and vnode
1018          * locks over the entire callback scan operation below.  The
1019          * big loop below is guaranteed to hit any callback already
1020          * processed.  The call to RecordRacingRevoke is guaranteed
1021          * to kill any callback that is currently being returned.
1022          * Anything that sneaks past both must start
1023          * after the call to RecordRacingRevoke.
1024          */
1025         if (cellp) {
1026             cm_fid_t fid;
1027
1028             fid.cell = cellp->cellID;
1029             fid.volume = fid.vnode = fid.unique = 0;
1030
1031             cm_RecordRacingRevoke(&fid, CM_RACINGFLAG_CANCELALL);
1032         } else {
1033             cm_RecordRacingRevoke(NULL, CM_RACINGFLAG_CANCELALL);
1034         }
1035
1036         /* now search all vnodes looking for guys with this callback, if we
1037          * found it, or guys with any callbacks, if we didn't find the server
1038          * (that's how multihomed machines will appear and how we'll handle
1039          * them, albeit a little inefficiently).  That is, we're discarding all
1040          * callbacks from all hosts if we get an initstate call from an unknown
1041          * host.  Since these calls are rare, and multihomed servers
1042          * are "rare," hopefully this won't be a problem.
1043          */
1044         lock_ObtainWrite(&cm_scacheLock);
1045         for (hash = 0; hash < cm_data.scacheHashTableSize; hash++) {
1046             for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
1047                 cm_HoldSCacheNoLock(scp);
1048                 lock_ReleaseWrite(&cm_scacheLock);
1049                 lock_ObtainWrite(&scp->rw);
1050                 discarded = 0;
1051                 if (scp->cbExpires > 0 && scp->cbServerp != NULL) {
1052                     /* we have a callback, now decide if we should clear it */
1053                     if (cm_ServerEqual(scp->cbServerp, tsp)) {
1054                         osi_Log4(afsd_logp, "InitCallbackState3 Discarding SCache scp 0x%p vol %u vn %u uniq %u", 
1055                                   scp, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
1056                         cm_DiscardSCache(scp);
1057                         discarded = 1;
1058                     }
1059                 }
1060                 lock_ReleaseWrite(&scp->rw);
1061                 if (discarded)
1062                     cm_CallbackNotifyChange(scp);
1063                 lock_ObtainWrite(&cm_scacheLock);
1064                 cm_ReleaseSCacheNoLock(scp);
1065
1066                 if (discarded && (scp->flags & CM_SCACHEFLAG_PURERO)) {
1067                     cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
1068                     if (volp) {
1069                         if (volp->cbExpiresRO != 0)
1070                             volp->cbExpiresRO = 0;
1071                         cm_PutVolume(volp);
1072                     }
1073                 }
1074
1075             }   /* search one hash bucket */
1076         }       /* search all hash buckets */
1077         
1078         lock_ReleaseWrite(&cm_scacheLock);
1079         
1080         if (tsp) {
1081             /* reset the No flags on the server */
1082             cm_SetServerNo64Bit(tsp, 0);
1083             cm_SetServerNoInlineBulk(tsp, 0);
1084
1085             /* we're done with the server structure */
1086             cm_PutServer(tsp);
1087         } 
1088     }
1089     return 0;
1090 }
1091
1092 /* debug interface */
1093 int
1094 SRXAFSCB_ProbeUuid(struct rx_call *callp, afsUUID* clientUuid)
1095 {
1096     struct rx_connection *connp;
1097     struct rx_peer *peerp;
1098     unsigned long host = 0;
1099     unsigned short port = 0;
1100     char *p,*q;
1101     int code = 0;
1102
1103     if (cm_shutdown)
1104         return 1;
1105
1106     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
1107         host = rx_HostOf(peerp);
1108         port = rx_PortOf(peerp);
1109     }
1110
1111     if ( !afs_uuid_equal(&cm_data.Uuid, clientUuid) ) {
1112         UuidToString((UUID *)&cm_data.Uuid, &p);
1113         UuidToString((UUID *)clientUuid, &q);
1114         osi_Log4(afsd_logp, "SRXAFSCB_ProbeUuid %s != %s from host 0x%x port %d", 
1115                   osi_LogSaveString(afsd_logp,p), 
1116                   osi_LogSaveString(afsd_logp,q),
1117                   ntohl(host),
1118                   ntohs(port));
1119         RpcStringFree(&p);
1120         RpcStringFree(&q);
1121
1122         code = 1;       /* failure */
1123     } else
1124         osi_Log2(afsd_logp, "SRXAFSCB_ProbeUuid (success) from host 0x%x port %d",
1125                   ntohl(host),
1126                   ntohs(port));
1127
1128     return code;
1129 }
1130
1131 /* debug interface */
1132 static int 
1133 GetCellCommon(afs_int32 a_cellnum, char **a_name, serverList *a_hosts)
1134 {
1135     afs_int32 sn;
1136     cm_cell_t * cellp;
1137     cm_serverRef_t * serverRefp; 
1138
1139     cellp = cm_FindCellByID(a_cellnum, CM_FLAG_NOPROBE);
1140     if (!cellp) {
1141         *a_name = strdup("");
1142         return 0;
1143     }
1144
1145     lock_ObtainRead(&cm_serverLock);
1146     *a_name = strdup(cellp->name);
1147
1148     for ( sn = 0, serverRefp = cellp->vlServersp; 
1149           sn < AFSMAXCELLHOSTS && serverRefp;
1150           sn++, serverRefp = serverRefp->next);
1151
1152     a_hosts->serverList_len = sn;
1153     a_hosts->serverList_val = (afs_int32 *)xdr_alloc(sn * sizeof(afs_int32));
1154
1155     for ( sn = 0, serverRefp = cellp->vlServersp; 
1156           sn < AFSMAXCELLHOSTS && serverRefp;
1157           sn++, serverRefp = serverRefp->next)
1158     {
1159         a_hosts->serverList_val[sn] = ntohl(serverRefp->server->addr.sin_addr.s_addr);
1160     }
1161
1162     lock_ReleaseRead(&cm_serverLock);
1163     return 0;
1164 }
1165
1166 /* debug interface */
1167 int 
1168 SRXAFSCB_GetCellByNum(struct rx_call *callp, afs_int32 a_cellnum,
1169                       char **a_name, serverList *a_hosts)
1170 {
1171     struct rx_connection *connp;
1172     struct rx_peer *peerp;
1173     unsigned long host = 0;
1174     unsigned short port = 0;
1175     int rc;
1176
1177     if (cm_shutdown)
1178         return 1;
1179
1180     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
1181         host = rx_HostOf(peerp);
1182         port = rx_PortOf(peerp);
1183     }
1184
1185     osi_Log3(afsd_logp, "SRXAFSCB_GetCellByNum(%d) from host 0x%x port %d",
1186              a_cellnum, ntohl(host), ntohs(port));
1187
1188     a_hosts->serverList_val = 0;
1189     a_hosts->serverList_len = 0;
1190
1191
1192     rc = GetCellCommon(a_cellnum, a_name, a_hosts);
1193
1194     return rc;
1195 }
1196
1197 /* debug interface */
1198 int 
1199 SRXAFSCB_TellMeAboutYourself( struct rx_call *callp, 
1200                               struct interfaceAddr *addr,
1201                               Capabilities * capabilities)
1202 {
1203     int i;
1204     afs_uint32 *dataBuffP;
1205     afs_int32 dataBytes;
1206     long code;
1207     struct rx_connection *connp;
1208     struct rx_peer *peerp;
1209     unsigned long host = 0;
1210     unsigned short port = 0;
1211
1212     if (cm_shutdown)
1213         return 1;
1214
1215     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
1216         host = rx_HostOf(peerp);
1217         port = rx_PortOf(peerp);
1218     }
1219
1220     osi_Log2(afsd_logp, "SRXAFSCB_TellMeAboutYourself from host 0x%x port %d",
1221               ntohl(host),
1222               ntohs(port));
1223
1224     lock_ObtainRead(&cm_syscfgLock);
1225     if (cm_LanAdapterChangeDetected) {
1226         lock_ConvertRToW(&cm_syscfgLock);
1227         if (cm_LanAdapterChangeDetected) {
1228             /* get network related info */
1229             cm_noIPAddr = CM_MAXINTERFACE_ADDR;
1230             code = syscfg_GetIFInfo(&cm_noIPAddr,
1231                                      cm_IPAddr, cm_SubnetMask,
1232                                      cm_NetMtu, cm_NetFlags);
1233             cm_LanAdapterChangeDetected = 0;
1234         }
1235         lock_ConvertWToR(&cm_syscfgLock);
1236     }
1237
1238     /* return all network interface addresses */
1239     addr->numberOfInterfaces = cm_noIPAddr;
1240     addr->uuid = cm_data.Uuid;
1241     for ( i=0; i < cm_noIPAddr; i++ ) {
1242         addr->addr_in[i] = cm_IPAddr[i];
1243         addr->subnetmask[i] = cm_SubnetMask[i];
1244         addr->mtu[i] = (rx_mtu == -1 || (rx_mtu != -1 && cm_NetMtu[i] < rx_mtu)) ? 
1245             cm_NetMtu[i] : rx_mtu;
1246     }
1247     lock_ReleaseRead(&cm_syscfgLock);
1248
1249     dataBytes = 1 * sizeof(afs_uint32);
1250     dataBuffP = (afs_uint32 *) xdr_alloc(dataBytes);
1251     dataBuffP[0] = CLIENT_CAPABILITY_ERRORTRANS;
1252     capabilities->Capabilities_len = dataBytes / sizeof(afs_uint32);
1253     capabilities->Capabilities_val = dataBuffP;
1254
1255     return 0;
1256 }
1257
1258 /*------------------------------------------------------------------------
1259  * EXPORTED SRXAFSCB_GetServerPrefs
1260  *
1261  * Description:
1262  *      Routine to list server preferences used by this client.
1263  *
1264  * Arguments:
1265  *      a_call  : Ptr to Rx call on which this request came in.
1266  *      a_index : Input server index
1267  *      a_srvr_addr  : Output server address (0xffffffff on last server)
1268  *      a_srvr_rank  : Output server rank
1269  *
1270  * Returns:
1271  *      0 on success
1272  *
1273  * Environment:
1274  *      Nothing interesting.
1275  *
1276  * Side Effects:
1277  *      As advertised.
1278  *------------------------------------------------------------------------*/
1279
1280 int SRXAFSCB_GetServerPrefs(
1281     struct rx_call *callp,
1282     afs_int32 a_index,
1283     afs_int32 *a_srvr_addr,
1284     afs_int32 *a_srvr_rank)
1285 {
1286     struct rx_connection *connp;
1287     struct rx_peer *peerp;
1288     unsigned long host = 0;
1289     unsigned short port = 0;
1290
1291     if (cm_shutdown)
1292         return 1;
1293
1294     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
1295         host = rx_HostOf(peerp);
1296         port = rx_PortOf(peerp);
1297     }
1298
1299     osi_Log2(afsd_logp, "SRXAFSCB_GetServerPrefs from host 0x%x port %d - not implemented",
1300               ntohl(host),
1301               ntohs(port));
1302
1303     *a_srvr_addr = 0xffffffff;
1304     *a_srvr_rank = 0xffffffff;
1305
1306     return 0;
1307 }
1308
1309 /*------------------------------------------------------------------------
1310  * EXPORTED SRXAFSCB_GetCellServDB
1311  *
1312  * Description:
1313  *      Routine to list cells configured for this client
1314  *
1315  * Arguments:
1316  *      a_call  : Ptr to Rx call on which this request came in.
1317  *      a_index : Input cell index
1318  *      a_name  : Output cell name ("" on last cell)
1319  *      a_hosts : Output cell database servers
1320  *
1321  * Returns:
1322  *      0 on success
1323  *
1324  * Environment:
1325  *      Nothing interesting.
1326  *
1327  * Side Effects:
1328  *      As advertised.
1329  *------------------------------------------------------------------------*/
1330
1331 int SRXAFSCB_GetCellServDB(struct rx_call *callp, afs_int32 index, char **a_name, 
1332                            serverList *a_hosts)
1333 {
1334     struct rx_connection *connp;
1335     struct rx_peer *peerp;
1336     unsigned long host = 0;
1337     unsigned short port = 0;
1338     int rc;
1339
1340     if (cm_shutdown)
1341         return 1;
1342
1343     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
1344         host = rx_HostOf(peerp);
1345         port = rx_PortOf(peerp);
1346     }
1347
1348     osi_Log2(afsd_logp, "SRXAFSCB_GetCellServDB from host 0x%x port %d - not implemented",
1349              ntohl(host), ntohs(port));
1350
1351 #ifdef AFS_FREELANCE_CLIENT
1352     if (cm_freelanceEnabled && index == 0) {
1353         rc = GetCellCommon(AFS_FAKE_ROOT_CELL_ID, a_name, a_hosts);
1354     } else
1355 #endif
1356     {
1357         rc = GetCellCommon(index+1, a_name, a_hosts);
1358     }
1359     return 0;
1360 }
1361
1362 /*------------------------------------------------------------------------
1363  * EXPORTED SRXAFSCB_GetLocalCell
1364  *
1365  * Description:
1366  *      Routine to return name of client's local cell
1367  *
1368  * Arguments:
1369  *      a_call  : Ptr to Rx call on which this request came in.
1370  *      a_name  : Output cell name
1371  *
1372  * Returns:
1373  *      0 on success
1374  *
1375  * Environment:
1376  *      Nothing interesting.
1377  *
1378  * Side Effects:
1379  *      As advertised.
1380  *------------------------------------------------------------------------*/
1381
1382 int SRXAFSCB_GetLocalCell(struct rx_call *callp, char **a_name)
1383 {
1384     char *t_name;
1385     struct rx_connection *connp;
1386     struct rx_peer *peerp;
1387     unsigned long host = 0;
1388     unsigned short port = 0;
1389
1390     if (cm_shutdown)
1391         return 1;
1392
1393     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
1394         host = rx_HostOf(peerp);
1395         port = rx_PortOf(peerp);
1396     }
1397
1398     osi_Log2(afsd_logp, "SRXAFSCB_GetLocalCell from host 0x%x port %d",
1399              ntohl(host), ntohs(port));
1400
1401     if (cm_data.rootCellp) {
1402         t_name = strdup(cm_data.rootCellp->name);
1403     } else {
1404         t_name = (char *)xdr_alloc(1);
1405         t_name[0] = '\0';
1406     }
1407     *a_name = t_name;
1408
1409     return 0;
1410 }
1411
1412
1413 /*
1414  * afs_MarshallCacheConfig - marshall client cache configuration
1415  *
1416  * PARAMETERS
1417  *
1418  * IN callerVersion - the rpc stat version of the caller.
1419  *
1420  * IN config - client cache configuration.
1421  *
1422  * OUT ptr - buffer where configuration is marshalled.
1423  *
1424  * RETURN CODES
1425  *
1426  * Returns void.
1427  */
1428 static void afs_MarshallCacheConfig(
1429     afs_uint32 callerVersion,
1430     cm_initparams_v1 *config,
1431     afs_uint32 *ptr)
1432 {
1433     /*
1434      * We currently only support version 1.
1435      */
1436     *(ptr++) = config->nChunkFiles;
1437     *(ptr++) = config->nStatCaches;
1438     *(ptr++) = config->nDataCaches;
1439     *(ptr++) = config->nVolumeCaches;
1440     *(ptr++) = config->firstChunkSize;
1441     *(ptr++) = config->otherChunkSize;
1442     *(ptr++) = config->cacheSize;
1443     *(ptr++) = config->setTime;
1444     *(ptr++) = config->memCache;
1445
1446 }
1447  
1448
1449 /*------------------------------------------------------------------------
1450  * EXPORTED SRXAFSCB_GetCacheConfig
1451  *
1452  * Description:
1453  *      Routine to return parameters used to initialize client cache.
1454  *      Client may request any format version. Server may not return
1455  *      format version greater than version requested by client.
1456  *
1457  * Arguments:
1458  *      a_call:        Ptr to Rx call on which this request came in.
1459  *      callerVersion: Data format version desired by the client.
1460  *      serverVersion: Data format version of output data.
1461  *      configCount:   Number bytes allocated for output data.
1462  *      config:        Client cache configuration.
1463  *
1464  * Returns:
1465  *      0 on success
1466  *
1467  * Environment:
1468  *      Nothing interesting.
1469  *
1470  * Side Effects:
1471  *      As advertised.
1472  *------------------------------------------------------------------------*/
1473
1474 int SRXAFSCB_GetCacheConfig(struct rx_call *callp,
1475                             afs_uint32 callerVersion,
1476                             afs_uint32 *serverVersion,
1477                             afs_uint32 *configCount,
1478                             cacheConfig *config)
1479 {
1480     afs_uint32 *t_config;
1481     size_t allocsize;
1482     extern cm_initparams_v1 cm_initParams;
1483     struct rx_connection *connp;
1484     struct rx_peer *peerp;
1485     unsigned long host = 0;
1486     unsigned short port = 0;
1487
1488     if (cm_shutdown)
1489         return 1;
1490
1491     if ((connp = rx_ConnectionOf(callp)) && (peerp = rx_PeerOf(connp))) {
1492         host = rx_HostOf(peerp);
1493         port = rx_PortOf(peerp);
1494     }
1495
1496     osi_Log2(afsd_logp, "SRXAFSCB_GetCacheConfig from host 0x%x port %d - version 1 only",
1497              ntohl(host), ntohs(port));
1498
1499     /*
1500      * Currently only support version 1
1501      */
1502     allocsize = sizeof(cm_initparams_v1);
1503     t_config = (afs_uint32 *)xdr_alloc(allocsize);
1504
1505     afs_MarshallCacheConfig(callerVersion, &cm_initParams, t_config);
1506
1507     *serverVersion = AFS_CLIENT_RETRIEVAL_FIRST_EDITION;
1508 #ifdef DEBUG
1509 #ifndef SIZE_MAX
1510 #define SIZE_MAX UINT_MAX
1511 #endif
1512     osi_assertx(allocsize < SIZE_MAX, "allocsize >= SIZE_MAX");
1513 #endif
1514     *configCount = (afs_uint32)allocsize;
1515     config->cacheConfig_val = t_config;
1516     config->cacheConfig_len = (*configCount)/sizeof(afs_uint32);
1517
1518     return 0;
1519 }
1520
1521 /* called by afsd without any locks to initialize this module */
1522 void cm_InitCallback(void)
1523 {
1524     lock_InitializeRWLock(&cm_callbackLock, "cm_callbackLock", LOCK_HIERARCHY_CALLBACK_GLOBAL);
1525     cm_activeCallbackGrantingCalls = 0;
1526 }
1527
1528 /* called with locked scp; tells us whether we've got a callback.
1529  * Expirations are checked by a background daemon so as to make
1530  * this function as inexpensive as possible
1531  */
1532 int cm_HaveCallback(cm_scache_t *scp)
1533 {
1534 #ifdef AFS_FREELANCE_CLIENT
1535     // yj: we handle callbacks specially for callbacks on the root directory
1536     // Since it's local, we almost always say that we have callback on it
1537     // The only time we send back a 0 is if we're need to initialize or
1538     // reinitialize the fake directory
1539
1540     // There are 2 state variables cm_fakeGettingCallback and cm_fakeDirCallback
1541     // cm_fakeGettingCallback is 1 if we're in the process of initialization and
1542     // hence should return false. it's 0 otherwise
1543     // cm_fakeDirCallback is 0 if we haven't loaded the fake directory, it's 1
1544     // if the fake directory is loaded and this is the first time cm_HaveCallback
1545     // is called since then. We return false in this case to allow cm_GetCallback
1546     // to be called because cm_GetCallback has some initialization work to do.
1547     // If cm_fakeDirCallback is 2, then it means that the fake directory is in
1548     // good shape and we simply return true, provided no change is detected.
1549     int fdc, fgc;
1550
1551     if (cm_freelanceEnabled && 
1552          scp->fid.cell==AFS_FAKE_ROOT_CELL_ID && scp->fid.volume==AFS_FAKE_ROOT_VOL_ID) {
1553         lock_ObtainMutex(&cm_Freelance_Lock);
1554         fdc = cm_fakeDirCallback;
1555         fgc = cm_fakeGettingCallback;
1556         lock_ReleaseMutex(&cm_Freelance_Lock);
1557             
1558         if (fdc==1) {   // first call since init
1559             return 0;
1560         } else if (fdc==2 && !fgc) {    // we're in good shape
1561             if (cm_getLocalMountPointChange()) {        // check for changes
1562                 cm_clearLocalMountPointChange(); // clear the changefile
1563                 lock_ReleaseWrite(&scp->rw);      // this is re-locked in reInitLocalMountPoints
1564                 cm_reInitLocalMountPoints();    // start reinit
1565                 lock_ObtainWrite(&scp->rw);      // now get the lock back 
1566                 return 0;
1567             }
1568             return (cm_data.fakeDirVersion == scp->dataVersion);
1569         }
1570         return 0;
1571     }
1572 #endif
1573
1574     if (scp->cbServerp != NULL) {
1575         return 1;
1576     } else if (cm_OfflineROIsValid) {
1577         cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
1578         if (volp) {
1579             switch (cm_GetVolumeStatus(volp, scp->fid.volume)) {
1580             case vl_offline:
1581             case vl_alldown:
1582             case vl_unknown:
1583                 cm_PutVolume(volp);
1584                 return 1;
1585             default:
1586                 cm_PutVolume(volp);
1587                 return 0;
1588             }
1589         }
1590         return 1;
1591     }
1592     return 0;
1593 }
1594
1595 /* need to detect a broken callback that races with our obtaining a callback.
1596  * Need to be able to do this even if we don't know the file ID of the file
1597  * we're breaking the callback on at the time we start the acquisition of the
1598  * callback (as in the case where we are creating a file).
1599  *
1600  * So, we start by writing down the count of the # of callbacks we've received
1601  * so far, and bumping a global counter of the # of callback granting calls
1602  * outstanding (all done under cm_callbackLock).
1603  *
1604  * When we're back from the call, we look at all of the callback revokes with
1605  * counter numbers greater than the one we recorded in our caller's structure,
1606  * and replay those that are higher than when we started the call.
1607  * 
1608  * We free all the structures in the queue when the count of the # of outstanding
1609  * callback-granting calls drops to zero.
1610  *
1611  * We call this function with the scp locked, too, but in its current implementation,
1612  * this knowledge is not used.
1613  */
1614 void cm_StartCallbackGrantingCall(cm_scache_t *scp, cm_callbackRequest_t *cbrp)
1615 {
1616     lock_ObtainWrite(&cm_callbackLock);
1617     cbrp->callbackCount = cm_callbackCount;
1618     cm_activeCallbackGrantingCalls++;
1619     cbrp->startTime = time(NULL);
1620     cbrp->serverp = NULL;
1621     lock_ReleaseWrite(&cm_callbackLock);
1622 }
1623
1624 /* Called at the end of a callback-granting call, to remove the callback
1625  * info from the scache entry, if necessary.
1626  *
1627  * Called with scp write locked, so we can discard the callbacks easily with
1628  * this locking hierarchy.
1629  */
1630 void cm_EndCallbackGrantingCall(cm_scache_t *scp, cm_callbackRequest_t *cbrp,
1631                                 AFSCallBack *cbp, long flags)
1632 {
1633     cm_racingRevokes_t *revp;           /* where we are */
1634     cm_racingRevokes_t *nrevp;          /* where we'll be next */
1635     int freeFlag;
1636     cm_server_t * serverp = NULL;
1637     int discardScp = 0, discardVolCB = 0;
1638
1639     lock_ObtainWrite(&cm_callbackLock);
1640     if (flags & CM_CALLBACK_MAINTAINCOUNT) {
1641         osi_assertx(cm_activeCallbackGrantingCalls > 0, 
1642                     "CM_CALLBACK_MAINTAINCOUNT && cm_activeCallbackGrantingCalls == 0");
1643     }
1644     else {
1645         osi_assertx(cm_activeCallbackGrantingCalls-- > 0,
1646                     "!CM_CALLBACK_MAINTAINCOUNT && cm_activeCallbackGrantingCalls == 0");
1647     }
1648     if (cm_activeCallbackGrantingCalls == 0) 
1649         freeFlag = 1;
1650     else 
1651         freeFlag = 0;
1652
1653     /* record the callback; we'll clear it below if we really lose it */
1654     if (cbrp) {
1655         if (scp) {
1656             if (!cm_ServerEqual(scp->cbServerp, cbrp->serverp)) {
1657                 serverp = scp->cbServerp;
1658                 if (!freeFlag)
1659                     cm_GetServer(cbrp->serverp);
1660                 scp->cbServerp = cbrp->serverp;
1661             } else {
1662                 if (freeFlag)
1663                     serverp = cbrp->serverp;
1664             }
1665             scp->cbExpires = cbrp->startTime + cbp->ExpirationTime;
1666         } else {
1667             if (freeFlag)
1668                 serverp = cbrp->serverp;
1669         }
1670         if (freeFlag)
1671             cbrp->serverp = NULL;
1672     }
1673
1674     /* a callback was actually revoked during our granting call, so
1675      * run down the list of revoked fids, looking for ours.
1676      * If activeCallbackGrantingCalls is zero, free the elements, too.
1677      *
1678      * May need to go through entire list just to do the freeing.
1679      */
1680     for (revp = cm_racingRevokesp; revp; revp = nrevp) {
1681         nrevp = (cm_racingRevokes_t *) osi_QNext(&revp->q);
1682         /* if this callback came in later than when we started the
1683          * callback-granting call, and if this fid is the right fid,
1684          * then clear the callback.
1685          */
1686         if (scp && cbrp && cbrp->callbackCount != cm_callbackCount
1687              && revp->callbackCount > cbrp->callbackCount
1688              && (( scp->fid.volume == revp->fid.volume &&
1689                    scp->fid.vnode == revp->fid.vnode &&
1690                    scp->fid.unique == revp->fid.unique)
1691                   ||
1692                   ((revp->flags & CM_RACINGFLAG_CANCELVOL) &&
1693                     scp->fid.volume == revp->fid.volume)
1694                   ||
1695                   ((revp->flags & CM_RACINGFLAG_CANCELALL) && 
1696                    (revp->fid.cell == 0 || scp->fid.cell == revp->fid.cell)))) {
1697             /* this one matches */
1698             osi_Log4(afsd_logp,
1699                       "Racing revoke scp 0x%p old cbc %d rev cbc %d cur cbc %d",
1700                       scp,
1701                       cbrp->callbackCount, revp->callbackCount,
1702                       cm_callbackCount);
1703             discardScp = 1;
1704             if ((scp->flags & CM_SCACHEFLAG_PURERO) && 
1705                  (revp->flags & CM_RACINGFLAG_ALL)) {
1706                 cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
1707                 if (volp) {
1708                     volp->cbExpiresRO = 0;
1709                     cm_PutVolume(volp);
1710                 }
1711             }
1712         }
1713         if (freeFlag) 
1714             free(revp);
1715     }
1716
1717     /* if we freed the list, zap the pointer to it */
1718     if (freeFlag) 
1719         cm_racingRevokesp = NULL;
1720
1721     lock_ReleaseWrite(&cm_callbackLock);
1722
1723     if ( discardScp ) {
1724         cm_DiscardSCache(scp);
1725         lock_ReleaseWrite(&scp->rw);
1726         cm_CallbackNotifyChange(scp);
1727         lock_ObtainWrite(&scp->rw);
1728     } else {
1729         if (scp && scp->flags & CM_SCACHEFLAG_PURERO) {
1730             cm_volume_t * volp = cm_GetVolumeByFID(&scp->fid);
1731             if (volp) {
1732                 volp->cbExpiresRO = scp->cbExpires;
1733                 if (volp->cbServerpRO != scp->cbServerp) {
1734                     if (volp->cbServerpRO)
1735                         cm_PutServer(volp->cbServerpRO);
1736                     cm_GetServer(scp->cbServerp);
1737                     volp->cbServerpRO = scp->cbServerp;
1738                 }
1739                 cm_PutVolume(volp);
1740             }
1741         }
1742     }
1743
1744     if ( serverp ) {
1745         lock_ObtainWrite(&cm_serverLock);
1746         cm_FreeServer(serverp);
1747         lock_ReleaseWrite(&cm_serverLock);
1748     }
1749 }
1750
1751 /* if flags is 1, we want to force the code to make one call, anyway.
1752  * called with locked scp; returns with same.
1753  */
1754 long cm_GetCallback(cm_scache_t *scp, struct cm_user *userp,
1755                     struct cm_req *reqp, long flags)
1756 {
1757     long code = 0;
1758     cm_conn_t *connp = NULL;
1759     AFSFetchStatus afsStatus;
1760     AFSVolSync volSync;
1761     AFSCallBack callback;
1762     AFSFid tfid;
1763     cm_callbackRequest_t cbr;
1764     int mustCall;
1765     cm_fid_t sfid;
1766     struct rx_connection * rxconnp = NULL;
1767     int syncop_done = 0;
1768
1769     osi_Log4(afsd_logp, "GetCallback scp 0x%p cell %d vol %d flags %lX", 
1770              scp, scp->fid.cell, scp->fid.volume, flags);
1771
1772 #ifdef AFS_FREELANCE_CLIENT
1773     // The case where a callback is needed on /afs is handled
1774     // specially. We need to fetch the status by calling
1775     // cm_MergeStatus and mark that cm_fakeDirCallback is 2
1776     if (cm_freelanceEnabled &&
1777         (scp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
1778          scp->fid.volume==AFS_FAKE_ROOT_VOL_ID)) {
1779
1780         code = cm_SyncOp(scp, NULL, userp, reqp, 0,
1781                           CM_SCACHESYNC_FETCHSTATUS | CM_SCACHESYNC_GETCALLBACK);
1782         if (code)
1783             goto done;
1784         syncop_done = 1;
1785
1786         if (cm_fakeDirCallback != 2) {
1787             // Start by indicating that we're in the process
1788             // of fetching the callback
1789             lock_ObtainMutex(&cm_Freelance_Lock);
1790             osi_Log0(afsd_logp,"GetCallback Freelance fakeGettingCallback=1");
1791             cm_fakeGettingCallback = 1;
1792             lock_ReleaseMutex(&cm_Freelance_Lock);
1793
1794             memset(&afsStatus, 0, sizeof(afsStatus));
1795             memset(&volSync, 0, sizeof(volSync));
1796
1797             // Fetch the status info 
1798             cm_MergeStatus(NULL, scp, &afsStatus, &volSync, userp, reqp, 0);
1799
1800             // Indicate that the callback is not done
1801             lock_ObtainMutex(&cm_Freelance_Lock);
1802             osi_Log0(afsd_logp,"GetCallback Freelance fakeDirCallback=2");
1803             cm_fakeDirCallback = 2;
1804
1805             // Indicate that we're no longer fetching the callback
1806             osi_Log0(afsd_logp,"GetCallback Freelance fakeGettingCallback=0");
1807             cm_fakeGettingCallback = 0;
1808             lock_ReleaseMutex(&cm_Freelance_Lock);
1809         }
1810         goto done;
1811     }
1812 #endif /* AFS_FREELANCE_CLIENT */
1813         
1814     mustCall = (flags & 1);
1815     cm_AFSFidFromFid(&tfid, &scp->fid);
1816     while (1) {
1817         if (!mustCall && cm_HaveCallback(scp))
1818             break;
1819
1820         /* turn off mustCall, since it has now forced us past the check above */
1821         mustCall = 0;
1822
1823         /* otherwise, we have to make an RPC to get the status */
1824         if (!syncop_done) {
1825             code = cm_SyncOp(scp, NULL, userp, reqp, 0, 
1826                              CM_SCACHESYNC_FETCHSTATUS | CM_SCACHESYNC_GETCALLBACK);
1827             if (code)
1828                 break;
1829             syncop_done = 1;
1830         }
1831         cm_StartCallbackGrantingCall(scp, &cbr);
1832         sfid = scp->fid;
1833         lock_ReleaseWrite(&scp->rw);
1834                 
1835         /* now make the RPC */
1836         osi_Log4(afsd_logp, "CALL FetchStatus scp 0x%p vol %u vn %u uniq %u", 
1837                  scp, sfid.volume, sfid.vnode, sfid.unique);
1838         do {
1839             code = cm_ConnFromFID(&sfid, userp, reqp, &connp);
1840             if (code) 
1841                 continue;
1842
1843             rxconnp = cm_GetRxConn(connp);
1844             code = RXAFS_FetchStatus(rxconnp, &tfid,
1845                                      &afsStatus, &callback, &volSync);
1846             rx_PutConnection(rxconnp);
1847
1848         } while (cm_Analyze(connp, userp, reqp, &sfid, &volSync, NULL,
1849                             &cbr, code));
1850         code = cm_MapRPCError(code, reqp);
1851         if (code)
1852             osi_Log4(afsd_logp, "CALL FetchStatus FAILURE code 0x%x scp 0x%p vol %u vn %u", 
1853                      code, scp, scp->fid.volume, scp->fid.vnode);
1854         else
1855             osi_Log4(afsd_logp, "CALL FetchStatus SUCCESS scp 0x%p vol %u vn %u uniq %u", 
1856                      scp, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
1857
1858         lock_ObtainWrite(&scp->rw);
1859         if (code == 0) {
1860             cm_EndCallbackGrantingCall(scp, &cbr, &callback, 0);
1861             cm_MergeStatus(NULL, scp, &afsStatus, &volSync, userp, reqp, 0);
1862         } else {
1863             cm_EndCallbackGrantingCall(NULL, &cbr, NULL, 0);
1864         }
1865
1866         /* if we got an error, return to caller */
1867         if (code)
1868             break;
1869     }
1870
1871   done:
1872     if (syncop_done)
1873         cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_FETCHSTATUS | CM_SCACHESYNC_GETCALLBACK);
1874     
1875     if (code) {
1876         osi_Log2(afsd_logp, "GetCallback Failed code 0x%x scp 0x%p -->",code, scp);
1877         osi_Log4(afsd_logp, "            cell %u vol %u vn %u uniq %u",
1878                  scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
1879     } else {
1880         osi_Log3(afsd_logp, "GetCallback Complete scp 0x%p cell %d vol %d", 
1881                   scp, scp->fid.cell, scp->fid.volume);
1882     }
1883
1884     return code;
1885 }
1886
1887
1888 /* called with cm_scacheLock held */
1889 long cm_CBServersUp(cm_scache_t *scp, time_t * downTime)
1890 {
1891     cm_vol_state_t *statep;
1892     cm_volume_t * volp;
1893     afs_uint32 volID = scp->fid.volume;
1894     cm_serverRef_t *tsrp;
1895     int found;
1896
1897     *downTime = 0;
1898
1899     if (scp->cbServerp == NULL)
1900         return 1;
1901
1902     volp = cm_GetVolumeByFID(&scp->fid);
1903     if (!volp)
1904         return 1;
1905
1906     statep = cm_VolumeStateByID(volp, volID);
1907     cm_PutVolume(volp);
1908     if (statep->state == vl_online)
1909         return 1;
1910
1911     for (found = 0,tsrp = statep->serversp; tsrp; tsrp=tsrp->next) {
1912         if (tsrp->status == srv_deleted)
1913             continue;
1914         if (cm_ServerEqual(tsrp->server, scp->cbServerp))
1915             found = 1;
1916         if (tsrp->server->downTime > *downTime)
1917             *downTime = tsrp->server->downTime;
1918     }
1919
1920     /* if the cbServerp does not match the current volume server list
1921      * we report the callback server as up so the callback can be 
1922      * expired.
1923      */
1924     return(found ? 0 : 1);
1925 }
1926
1927 /* called periodically by cm_daemon to shut down use of expired callbacks */
1928 void cm_CheckCBExpiration(void)
1929 {
1930     afs_uint32 i;
1931     cm_scache_t *scp;
1932     time_t now, downTime;
1933         
1934     osi_Log0(afsd_logp, "CheckCBExpiration");
1935
1936     now = time(NULL);
1937     lock_ObtainWrite(&cm_scacheLock);
1938     for (i=0; i<cm_data.scacheHashTableSize; i++) {
1939         for (scp = cm_data.scacheHashTablep[i]; scp; scp=scp->nextp) {
1940             downTime = 0;
1941             if (scp->flags & CM_SCACHEFLAG_PURERO) {
1942                 cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
1943                 if (volp) {
1944                     if (volp->cbExpiresRO > scp->cbExpires &&
1945                         scp->cbExpires > 0) 
1946                     {
1947                         scp->cbExpires = volp->cbExpiresRO;
1948                         if (volp->cbServerpRO != scp->cbServerp) {
1949                             if (scp->cbServerp)
1950                                 cm_PutServer(scp->cbServerp);
1951                             cm_GetServer(volp->cbServerpRO);
1952                             scp->cbServerp = volp->cbServerpRO;
1953                         }
1954                     }        
1955                     cm_PutVolume(volp);
1956                 }
1957             }
1958             if (scp->cbServerp && scp->cbExpires > 0 && now > scp->cbExpires && 
1959                  (cm_CBServersUp(scp, &downTime) || downTime == 0 || downTime >= scp->cbExpires)) 
1960             {
1961                 cm_HoldSCacheNoLock(scp);
1962                 lock_ReleaseWrite(&cm_scacheLock);
1963                 
1964                 osi_Log4(afsd_logp, "Callback Expiration Discarding SCache scp 0x%p vol %u vn %u uniq %u",
1965                           scp, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
1966                 lock_ObtainWrite(&scp->rw);
1967                 cm_DiscardSCache(scp);
1968                 lock_ReleaseWrite(&scp->rw);
1969                 cm_CallbackNotifyChange(scp);
1970
1971                 lock_ObtainWrite(&cm_scacheLock);
1972                 cm_ReleaseSCacheNoLock(scp);
1973             }
1974         }
1975     }
1976     lock_ReleaseWrite(&cm_scacheLock);
1977
1978     osi_Log0(afsd_logp, "CheckCBExpiration Complete");
1979 }
1980
1981
1982 void 
1983 cm_GiveUpAllCallbacks(cm_server_t *tsp, afs_int32 markDown)
1984 {
1985     long code;
1986     cm_conn_t *connp;
1987     struct rx_connection * rxconnp;
1988
1989     if ((tsp->type == CM_SERVER_FILE) && !(tsp->flags & CM_SERVERFLAG_DOWN)) 
1990     {
1991         code = cm_ConnByServer(tsp, cm_rootUserp, &connp);
1992         if (code == 0) {
1993             rxconnp = cm_GetRxConn(connp);
1994             rx_SetConnDeadTime(rxconnp, 10);
1995             code = RXAFS_GiveUpAllCallBacks(rxconnp);
1996             rx_SetConnDeadTime(rxconnp, ConnDeadtimeout);
1997             rx_PutConnection(rxconnp);
1998         }
1999
2000         if (markDown) {
2001             cm_server_vols_t * tsrvp;
2002             cm_volume_t * volp;
2003             int i;
2004
2005             cm_ForceNewConnections(tsp);
2006
2007             lock_ObtainMutex(&tsp->mx);
2008             if (!(tsp->flags & CM_SERVERFLAG_DOWN)) {
2009                 tsp->flags |= CM_SERVERFLAG_DOWN;
2010                 tsp->downTime = time(NULL);
2011             }
2012             /* Now update the volume status */
2013             for (tsrvp = tsp->vols; tsrvp; tsrvp = tsrvp->nextp) {
2014                 for (i=0; i<NUM_SERVER_VOLS; i++) {
2015                     if (tsrvp->ids[i] != 0) {
2016                         cm_req_t req;
2017
2018                         cm_InitReq(&req);
2019                         lock_ReleaseMutex(&tsp->mx);
2020                         code = cm_FindVolumeByID(tsp->cellp, tsrvp->ids[i], cm_rootUserp,
2021                                                  &req, CM_GETVOL_FLAG_NO_LRU_UPDATE | CM_GETVOL_FLAG_NO_RESET, &volp);
2022                         lock_ObtainMutex(&tsp->mx);
2023                         if (code == 0) {    
2024                             cm_UpdateVolumeStatus(volp, tsrvp->ids[i]);
2025                             cm_PutVolume(volp);
2026                         }       
2027                     }
2028                 }
2029             }
2030             lock_ReleaseMutex(&tsp->mx);
2031         }
2032     }
2033 }
2034
2035 void
2036 cm_GiveUpAllCallbacksAllServers(afs_int32 markDown)
2037 {
2038     cm_server_t *tsp;
2039
2040     if (!cm_giveUpAllCBs)
2041         return;
2042
2043     lock_ObtainWrite(&cm_serverLock);
2044     for (tsp = cm_allServersp; tsp; tsp = tsp->allNextp) {
2045         cm_GetServerNoLock(tsp);
2046         lock_ReleaseWrite(&cm_serverLock);
2047         cm_GiveUpAllCallbacks(tsp, markDown);
2048         lock_ObtainWrite(&cm_serverLock);
2049         cm_PutServerNoLock(tsp);
2050     }
2051     lock_ReleaseWrite(&cm_serverLock);
2052 }
2053
2054