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