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