d3595d72d059f983a6fc8ab00f713302fbf6905e
[openafs.git] / src / WINNT / afsd / cm_scache.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/stds.h>
12
13 #include <windows.h>
14 #include <winsock2.h>
15 #include <nb30.h>
16 #include <malloc.h>
17 #include <string.h>
18 #include <stdlib.h>
19 #include <osi.h>
20
21 #include "afsd.h"
22
23 /*extern void afsi_log(char *pattern, ...);*/
24
25 extern osi_hyper_t hzero;
26
27 /* File locks */
28 osi_queue_t *cm_allFileLocks;
29 osi_queue_t *cm_freeFileLocks;
30 unsigned long cm_lockRefreshCycle;
31
32 /* lock for globals */
33 osi_rwlock_t cm_scacheLock;
34
35 /* Dummy scache entry for use with pioctl fids */
36 cm_scache_t cm_fakeSCache;
37
38 #ifdef AFS_FREELANCE_CLIENT
39 extern osi_mutex_t cm_Freelance_Lock;
40 #endif
41
42 /* must be called with cm_scacheLock write-locked! */
43 void cm_AdjustLRU(cm_scache_t *scp)
44 {
45     if (scp == cm_data.scacheLRULastp)
46         cm_data.scacheLRULastp = (cm_scache_t *) osi_QPrev(&scp->q);
47     osi_QRemoveHT((osi_queue_t **) &cm_data.scacheLRUFirstp, (osi_queue_t **) &cm_data.scacheLRULastp, &scp->q);
48     osi_QAdd((osi_queue_t **) &cm_data.scacheLRUFirstp, &scp->q);
49     if (!cm_data.scacheLRULastp) 
50         cm_data.scacheLRULastp = scp;
51 }
52
53 /* call with scache write-locked and mutex held */
54 void cm_RemoveSCacheFromHashTable(cm_scache_t *scp)
55 {
56     cm_scache_t **lscpp;
57     cm_scache_t *tscp;
58     int i;
59         
60     if (scp->flags & CM_SCACHEFLAG_INHASH) {
61         /* hash it out first */
62         i = CM_SCACHE_HASH(&scp->fid);
63         for (lscpp = &cm_data.hashTablep[i], tscp = cm_data.hashTablep[i];
64              tscp;
65              lscpp = &tscp->nextp, tscp = tscp->nextp) {
66             if (tscp == scp) {
67                 *lscpp = scp->nextp;
68                 scp->flags &= ~CM_SCACHEFLAG_INHASH;
69                 break;
70             }
71         }
72     }
73 }
74
75 /* called with cm_scacheLock write-locked; recycles an existing scp. 
76  *
77  * this function ignores all of the locking hierarchy.  
78  */
79 long cm_RecycleSCache(cm_scache_t *scp, afs_int32 flags)
80 {
81     if (scp->refCount != 0) {
82         return -1;
83     }
84
85     if (scp->flags & CM_SCACHEFLAG_SMB_FID) {
86         osi_Log1(afsd_logp,"cm_RecycleSCache CM_SCACHEFLAG_SMB_FID detected scp 0x%p", scp);
87 #ifdef DEBUG
88         osi_panic("cm_RecycleSCache CM_SCACHEFLAG_SMB_FID detected",__FILE__,__LINE__);
89 #endif
90         return -1;
91     }
92
93     cm_RemoveSCacheFromHashTable(scp);
94
95 #if 0
96     if (flags & CM_SCACHE_RECYCLEFLAG_DESTROY_BUFFERS) {
97         osi_queueData_t *qdp;
98         cm_buf_t *bufp;
99
100         while(qdp = scp->bufWritesp) {
101             bufp = osi_GetQData(qdp);
102             osi_QRemove((osi_queue_t **) &scp->bufWritesp, &qdp->q);
103             osi_QDFree(qdp);
104             if (bufp) {
105                 lock_ObtainMutex(&bufp->mx);
106                 bufp->cmFlags &= ~CM_BUF_CMSTORING;
107                 bufp->flags &= ~CM_BUF_DIRTY;
108                 bufp->flags |= CM_BUF_ERROR;
109                 bufp->error = VNOVNODE;
110                 bufp->dataVersion = -1; /* bad */
111                 bufp->dirtyCounter++;
112                 if (bufp->flags & CM_BUF_WAITING) {
113                     osi_Log2(afsd_logp, "CM RecycleSCache Waking [scp 0x%x] bufp 0x%x", scp, bufp);
114                     osi_Wakeup((long) &bufp);
115                 }
116                 lock_ReleaseMutex(&bufp->mx);
117                 buf_Release(bufp);
118             }
119         }
120         while(qdp = scp->bufReadsp) {
121             bufp = osi_GetQData(qdp);
122             osi_QRemove((osi_queue_t **) &scp->bufReadsp, &qdp->q);
123             osi_QDFree(qdp);
124             if (bufp) {
125                 lock_ObtainMutex(&bufp->mx);
126                 bufp->cmFlags &= ~CM_BUF_CMFETCHING;
127                 bufp->flags &= ~CM_BUF_DIRTY;
128                 bufp->flags |= CM_BUF_ERROR;
129                 bufp->error = VNOVNODE;
130                 bufp->dataVersion = -1; /* bad */
131                 bufp->dirtyCounter++;
132                 if (bufp->flags & CM_BUF_WAITING) {
133                     osi_Log2(afsd_logp, "CM RecycleSCache Waking [scp 0x%x] bufp 0x%x", scp, bufp);
134                     osi_Wakeup((long) &bufp);
135                 }
136                 lock_ReleaseMutex(&bufp->mx);
137                 buf_Release(bufp);
138             }
139         }
140         buf_CleanDirtyBuffers(scp); 
141     } else {
142         /* look for things that shouldn't still be set */
143         osi_assert(scp->bufWritesp == NULL);
144         osi_assert(scp->bufReadsp == NULL);
145     }
146 #endif
147
148     /* invalidate so next merge works fine;
149      * also initialize some flags */
150     scp->flags &= ~(CM_SCACHEFLAG_STATD
151                      | CM_SCACHEFLAG_DELETED
152                      | CM_SCACHEFLAG_RO
153                      | CM_SCACHEFLAG_PURERO
154                      | CM_SCACHEFLAG_OVERQUOTA
155                      | CM_SCACHEFLAG_OUTOFSPACE
156                      | CM_SCACHEFLAG_EACCESS);
157     scp->serverModTime = 0;
158     scp->dataVersion = 0;
159     scp->bulkStatProgress = hzero;
160     scp->waitCount = 0;
161
162     scp->fid.vnode = 0;
163     scp->fid.volume = 0;
164     scp->fid.unique = 0;
165     scp->fid.cell = 0;
166
167     /* discard callback */
168     if (scp->cbServerp) {
169         cm_PutServer(scp->cbServerp);
170         scp->cbServerp = NULL;
171     }
172     scp->cbExpires = 0;
173
174     /* remove from dnlc */
175     cm_dnlcPurgedp(scp);
176     cm_dnlcPurgevp(scp);
177
178     /* discard cached status; if non-zero, Close
179      * tried to store this to server but failed */
180     scp->mask = 0;
181
182     /* drop held volume ref */
183     if (scp->volp) {
184         cm_PutVolume(scp->volp);
185         scp->volp = NULL;
186     }
187
188     /* discard symlink info */
189     scp->mountPointStringp[0] = 0;
190     memset(&scp->mountRootFid, 0, sizeof(cm_fid_t));
191     memset(&scp->dotdotFid, 0, sizeof(cm_fid_t));
192
193     /* reset locking info */
194     scp->fileLocksH = NULL;
195     scp->fileLocksT = NULL;
196     scp->serverLock = (-1);
197     scp->exclusiveLocks = 0;
198     scp->sharedLocks = 0;
199
200     /* not locked, but there can be no references to this guy
201      * while we hold the global refcount lock.
202      */
203     cm_FreeAllACLEnts(scp);
204     return 0;
205 }
206
207
208 /* called with cm_scacheLock write-locked; find a vnode to recycle.
209  * Can allocate a new one if desperate, or if below quota (cm_data.maxSCaches).
210  */
211 cm_scache_t *cm_GetNewSCache(void)
212 {
213     cm_scache_t *scp;
214     int retry = 0;
215
216 #if 0
217     /* first pass - look for deleted objects */
218     for ( scp = cm_data.scacheLRULastp;
219           scp;
220           scp = (cm_scache_t *) osi_QPrev(&scp->q)) 
221     {
222         osi_assert(scp >= cm_data.scacheBaseAddress && scp < (cm_scache_t *)cm_data.hashTablep);
223
224         if (scp->refCount == 0) {
225             if (scp->flags & CM_SCACHEFLAG_DELETED) {
226                 osi_Log1(afsd_logp, "GetNewSCache attempting to recycle deleted scp 0x%x", scp);
227                 if (!cm_RecycleSCache(scp, CM_SCACHE_RECYCLEFLAG_DESTROY_BUFFERS)) {
228
229                     /* we found an entry, so return it */
230                     /* now remove from the LRU queue and put it back at the
231                      * head of the LRU queue.
232                      */
233                     cm_AdjustLRU(scp);
234
235                     /* and we're done */
236                     return scp;
237                 } 
238                 osi_Log1(afsd_logp, "GetNewSCache recycled failed scp 0x%x", scp);
239             } else if (!(scp->flags & CM_SCACHEFLAG_INHASH)) {
240                 /* we found an entry, so return it */
241                 /* now remove from the LRU queue and put it back at the
242                 * head of the LRU queue.
243                 */
244                 cm_AdjustLRU(scp);
245
246                 /* and we're done */
247                 return scp;
248             }
249         }       
250     }   
251     osi_Log0(afsd_logp, "GetNewSCache no deleted or recycled entries available for reuse");
252 #endif 
253
254     if (cm_data.currentSCaches >= cm_data.maxSCaches) {
255         /* There were no deleted scache objects that we could use.  Try to find
256          * one that simply hasn't been used in a while.
257          */
258             for ( scp = cm_data.scacheLRULastp;
259                   scp;
260                   scp = (cm_scache_t *) osi_QPrev(&scp->q)) 
261             {
262                 /* It is possible for the refCount to be zero and for there still
263                  * to be outstanding dirty buffers.  If there are dirty buffers,
264                  * we must not recycle the scp. */
265                 if (scp->refCount == 0 && scp->bufReadsp == NULL && scp->bufWritesp == NULL) {
266                     if (!buf_DirtyBuffersExist(&scp->fid)) {
267                         if (!cm_RecycleSCache(scp, 0)) {
268                             /* we found an entry, so return it */
269                             /* now remove from the LRU queue and put it back at the
270                              * head of the LRU queue.
271                              */
272                             cm_AdjustLRU(scp);
273
274                             /* and we're done */
275                             return scp;
276                         }
277                     } else {
278                         osi_Log1(afsd_logp,"GetNewSCache dirty buffers exist scp 0x%x", scp);
279                     }
280                 }       
281             }
282             osi_Log1(afsd_logp, "GetNewSCache all scache entries in use (retry = %d)", retry);
283             
284                 return NULL;
285     }
286         
287     /* if we get here, we should allocate a new scache entry.  We either are below
288      * quota or we have a leak and need to allocate a new one to avoid panicing.
289      */
290     scp = cm_data.scacheBaseAddress + cm_data.currentSCaches;
291     osi_assert(scp >= cm_data.scacheBaseAddress && scp < (cm_scache_t *)cm_data.hashTablep);
292     memset(scp, 0, sizeof(cm_scache_t));
293     scp->magic = CM_SCACHE_MAGIC;
294     lock_InitializeMutex(&scp->mx, "cm_scache_t mutex");
295     lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock");
296     scp->serverLock = -1;
297
298     /* and put it in the LRU queue */
299     osi_QAdd((osi_queue_t **) &cm_data.scacheLRUFirstp, &scp->q);
300     if (!cm_data.scacheLRULastp) 
301         cm_data.scacheLRULastp = scp;
302     cm_data.currentSCaches++;
303     cm_dnlcPurgedp(scp); /* make doubly sure that this is not in dnlc */
304     cm_dnlcPurgevp(scp); 
305     return scp;
306 }       
307
308 /* like strcmp, only for fids */
309 int cm_FidCmp(cm_fid_t *ap, cm_fid_t *bp)
310 {
311     if (ap->vnode != bp->vnode) 
312         return 1;
313     if (ap->volume != bp->volume) 
314         return 1;
315     if (ap->unique != bp->unique) 
316         return 1;
317     if (ap->cell != bp->cell) 
318         return 1;
319     return 0;
320 }
321
322 void cm_fakeSCacheInit(int newFile)
323 {
324     if ( newFile ) {
325         memset(&cm_data.fakeSCache, 0, sizeof(cm_scache_t));
326         cm_data.fakeSCache.cbServerp = (struct cm_server *)(-1);
327         /* can leave clientModTime at 0 */
328         cm_data.fakeSCache.fileType = CM_SCACHETYPE_FILE;
329         cm_data.fakeSCache.unixModeBits = 0777;
330         cm_data.fakeSCache.length.LowPart = 1000;
331         cm_data.fakeSCache.linkCount = 1;
332         cm_data.fakeSCache.refCount = 1;
333     }
334     lock_InitializeMutex(&cm_data.fakeSCache.mx, "cm_scache_t mutex");
335 }
336
337 long
338 cm_ValidateSCache(void)
339 {
340     cm_scache_t * scp, *lscp;
341     long i;
342
343     if ( cm_data.scacheLRUFirstp == NULL && cm_data.scacheLRULastp != NULL ||
344          cm_data.scacheLRUFirstp != NULL && cm_data.scacheLRULastp == NULL) {
345         afsi_log("cm_ValidateSCache failure: inconsistent LRU pointers");
346         fprintf(stderr, "cm_ValidateSCache failure: inconsistent LRU pointers\n");
347         return -17;
348     }
349
350     for ( scp = cm_data.scacheLRUFirstp, lscp = NULL, i = 0; 
351           scp;
352           lscp = scp, scp = (cm_scache_t *) osi_QNext(&scp->q), i++ ) {
353         if (scp->magic != CM_SCACHE_MAGIC) {
354             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
355             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
356             return -1;
357         }
358         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
359             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
360             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
361             return -2;
362         }
363         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
364             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
365             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
366             return -3;
367         }
368         if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
369             afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
370             fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
371             return -4;
372         }
373         if (i > cm_data.currentSCaches ) {
374             afsi_log("cm_ValidateSCache failure: LRU First queue loops");
375             fprintf(stderr, "cm_ValidateSCache failure: LUR First queue loops\n");
376             return -13;
377         }
378         if (lscp != (cm_scache_t *) osi_QPrev(&scp->q)) {
379             afsi_log("cm_ValidateSCache failure: QPrev(scp) != previous");
380             fprintf(stderr, "cm_ValidateSCache failure: QPrev(scp) != previous\n");
381             return -15;
382         }
383     }
384
385     for ( scp = cm_data.scacheLRULastp, lscp = NULL, i = 0; scp;
386           lscp = scp, scp = (cm_scache_t *) osi_QPrev(&scp->q), i++ ) {
387         if (scp->magic != CM_SCACHE_MAGIC) {
388             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
389             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
390             return -5;
391         }
392         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
393             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
394             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
395             return -6;
396         }
397         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
398             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
399             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
400             return -7;
401         }
402         if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
403             afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
404             fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
405             return -8;
406         }
407         if (i > cm_data.currentSCaches ) {
408             afsi_log("cm_ValidateSCache failure: LRU Last queue loops");
409             fprintf(stderr, "cm_ValidateSCache failure: LUR Last queue loops\n");
410             return -14;
411         }
412         if (lscp != (cm_scache_t *) osi_QNext(&scp->q)) {
413             afsi_log("cm_ValidateSCache failure: QNext(scp) != next");
414             fprintf(stderr, "cm_ValidateSCache failure: QNext(scp) != next\n");
415             return -16;
416         }
417     }
418
419     for ( i=0; i < cm_data.hashTableSize; i++ ) {
420         for ( scp = cm_data.hashTablep[i]; scp; scp = scp->nextp ) {
421             if (scp->magic != CM_SCACHE_MAGIC) {
422                 afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
423                 fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
424                 return -9;
425             }
426             if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
427                 afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
428                 fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
429                 return -10;
430             }
431             if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
432                 afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
433                 fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
434                 return -11;
435             }
436             if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
437                 afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
438                 fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
439                 return -12;
440             }
441         }
442     }
443
444     return cm_dnlcValidate();
445 }
446
447 long
448 cm_ShutdownSCache(void)
449 {
450     cm_scache_t * scp;
451
452     for ( scp = cm_data.scacheLRULastp; scp;
453           scp = (cm_scache_t *) osi_QPrev(&scp->q) ) {
454         if (scp->randomACLp) {
455             lock_ObtainMutex(&scp->mx);
456             cm_FreeAllACLEnts(scp);
457             lock_ReleaseMutex(&scp->mx);
458         }
459         lock_FinalizeMutex(&scp->mx);
460         lock_FinalizeRWLock(&scp->bufCreateLock);
461     }
462
463     return cm_dnlcShutdown();
464 }
465
466 void cm_InitSCache(int newFile, long maxSCaches)
467 {
468     static osi_once_t once;
469         
470     if (osi_Once(&once)) {
471         lock_InitializeRWLock(&cm_scacheLock, "cm_scacheLock");
472         if ( newFile ) {
473             memset(cm_data.hashTablep, 0, sizeof(cm_scache_t *) * cm_data.hashTableSize);
474             cm_data.currentSCaches = 0;
475             cm_data.maxSCaches = maxSCaches;
476             cm_data.scacheLRUFirstp = cm_data.scacheLRULastp = NULL;
477         } else {
478             cm_scache_t * scp;
479
480             for ( scp = cm_data.scacheLRULastp; scp;
481                   scp = (cm_scache_t *) osi_QPrev(&scp->q) ) {
482                 lock_InitializeMutex(&scp->mx, "cm_scache_t mutex");
483                 lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock");
484
485                 scp->cbServerp = NULL;
486                 scp->cbExpires = 0;
487                 scp->fileLocksH = NULL;
488                 scp->fileLocksT = NULL;
489                 scp->serverLock = (-1);
490                 scp->lastRefreshCycle = 0;
491                 scp->exclusiveLocks = 0;
492                 scp->sharedLocks = 0;
493                 scp->openReads = 0;
494                 scp->openWrites = 0;
495                 scp->openShares = 0;
496                 scp->openExcls = 0;
497                 scp->waitCount = 0;
498                 scp->flags &= ~CM_SCACHEFLAG_WAITING;
499             }
500         }
501         cm_allFileLocks = NULL;
502         cm_freeFileLocks = NULL;
503         cm_lockRefreshCycle = 0;
504         cm_fakeSCacheInit(newFile);
505         cm_dnlcInit(newFile);
506         osi_EndOnce(&once);
507     }
508 }
509
510 /* version that doesn't bother creating the entry if we don't find it */
511 cm_scache_t *cm_FindSCache(cm_fid_t *fidp)
512 {
513     long hash;
514     cm_scache_t *scp;
515
516     hash = CM_SCACHE_HASH(fidp);
517
518     if (fidp->cell == 0) {
519         return NULL;
520     }
521
522     lock_ObtainWrite(&cm_scacheLock);
523     for (scp=cm_data.hashTablep[hash]; scp; scp=scp->nextp) {
524         if (cm_FidCmp(fidp, &scp->fid) == 0) {
525             cm_HoldSCacheNoLock(scp);
526             cm_AdjustLRU(scp);
527             lock_ReleaseWrite(&cm_scacheLock);
528             return scp;
529         }
530     }
531     lock_ReleaseWrite(&cm_scacheLock);
532     return NULL;
533 }
534
535 #ifdef DEBUG_REFCOUNT
536 long cm_GetSCacheDbg(cm_fid_t *fidp, cm_scache_t **outScpp, cm_user_t *userp,
537                   cm_req_t *reqp, char * file, long line)
538 #else
539 long cm_GetSCache(cm_fid_t *fidp, cm_scache_t **outScpp, cm_user_t *userp,
540                   cm_req_t *reqp)
541 #endif
542 {
543     long hash;
544     cm_scache_t *scp;
545     long code;
546     cm_volume_t *volp = 0;
547     cm_cell_t *cellp;
548     char* mp = 0;
549     int special; // yj: boolean variable to test if file is on root.afs
550     int isRoot;
551     extern cm_fid_t cm_rootFid;
552         
553     hash = CM_SCACHE_HASH(fidp);
554         
555     osi_assert(fidp->cell != 0);
556
557     if (fidp->cell== cm_data.rootFid.cell && 
558          fidp->volume==cm_data.rootFid.volume &&
559          fidp->vnode==0x0 && fidp->unique==0x0)
560     {
561         osi_Log0(afsd_logp,"cm_GetSCache called with root cell/volume and vnode=0 and unique=0");
562     }
563
564     // yj: check if we have the scp, if so, we don't need
565     // to do anything else
566     lock_ObtainWrite(&cm_scacheLock);
567     for (scp=cm_data.hashTablep[hash]; scp; scp=scp->nextp) {
568         if (cm_FidCmp(fidp, &scp->fid) == 0) {
569 #ifdef DEBUG_REFCOUNT
570             afsi_log("%s:%d cm_GetSCache (1) outScpp 0x%p ref %d", file, line, scp, scp->refCount);
571             osi_Log1(afsd_logp,"cm_GetSCache (1) outScpp 0x%p", scp);
572 #endif
573             cm_HoldSCacheNoLock(scp);
574             *outScpp = scp;
575             cm_AdjustLRU(scp);
576             lock_ReleaseWrite(&cm_scacheLock);
577             return 0;
578         }
579     }
580         
581     // yj: when we get here, it means we don't have an scp
582     // so we need to either load it or fake it, depending
583     // on whether the file is "special", see below.
584
585     // yj: if we're trying to get an scp for a file that's
586     // on root.afs of homecell, we want to handle it specially
587     // because we have to fill in the status stuff 'coz we
588     // don't want trybulkstat to fill it in for us
589 #ifdef AFS_FREELANCE_CLIENT
590     special = (fidp->cell==AFS_FAKE_ROOT_CELL_ID && 
591                fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
592                !(fidp->vnode==0x1 && fidp->unique==0x1));
593     isRoot = (fidp->cell==AFS_FAKE_ROOT_CELL_ID && 
594               fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
595               fidp->vnode==0x1 && fidp->unique==0x1);
596     if (cm_freelanceEnabled && isRoot) {
597         osi_Log0(afsd_logp,"cm_GetSCache Freelance and isRoot");
598         /* freelance: if we are trying to get the root scp for the first
599          * time, we will just put in a place holder entry. 
600          */
601         volp = NULL;
602     }
603           
604     if (cm_freelanceEnabled && special) {
605         osi_Log0(afsd_logp,"cm_GetSCache Freelance and special");
606         if (fidp->vnode > 1 && fidp->vnode <= cm_noLocalMountPoints + 2) {
607             lock_ObtainMutex(&cm_Freelance_Lock);
608             mp =(cm_localMountPoints+fidp->vnode-2)->mountPointStringp;
609             lock_ReleaseMutex(&cm_Freelance_Lock);
610         } else {
611             mp = "";
612         }
613         scp = cm_GetNewSCache();
614         if (scp == NULL) {
615             osi_Log0(afsd_logp,"cm_GetSCache unable to obtain *new* scache entry");
616             lock_ReleaseWrite(&cm_scacheLock);
617             return CM_ERROR_WOULDBLOCK;
618         }
619
620 #if not_too_dangerous
621         /* dropping the cm_scacheLock allows more than one thread
622          * to obtain the same cm_scache_t from the LRU list.  Since
623          * the refCount is known to be zero at this point we have to
624          * assume that no one else is using the one this is returned.
625          */
626         lock_ReleaseWrite(&cm_scacheLock);
627         lock_ObtainMutex(&scp->mx);
628         lock_ObtainWrite(&cm_scacheLock);
629 #endif
630         scp->fid = *fidp;
631         scp->volp = cm_data.rootSCachep->volp;
632         scp->dotdotFid.cell=AFS_FAKE_ROOT_CELL_ID;
633         scp->dotdotFid.volume=AFS_FAKE_ROOT_VOL_ID;
634         scp->dotdotFid.unique=1;
635         scp->dotdotFid.vnode=1;
636         scp->flags |= (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO);
637         scp->nextp=cm_data.hashTablep[hash];
638         cm_data.hashTablep[hash]=scp;
639         scp->flags |= CM_SCACHEFLAG_INHASH;
640         scp->refCount = 1;
641         osi_Log1(afsd_logp,"cm_GetSCache (freelance) sets refCount to 1 scp 0x%x", scp);
642         if (fidp->vnode > 1 && fidp->vnode <= cm_noLocalMountPoints + 2)
643             scp->fileType = (cm_localMountPoints+fidp->vnode-2)->fileType;
644         else 
645             scp->fileType = CM_SCACHETYPE_INVALID;
646
647         lock_ObtainMutex(&cm_Freelance_Lock);
648         scp->length.LowPart = (DWORD)strlen(mp)+4;
649         scp->length.HighPart = 0;
650         strncpy(scp->mountPointStringp,mp,MOUNTPOINTLEN);
651         scp->mountPointStringp[MOUNTPOINTLEN-1] = '\0';
652         lock_ReleaseMutex(&cm_Freelance_Lock);
653
654         scp->owner=0x0;
655         scp->unixModeBits=0x1ff;
656         scp->clientModTime=FakeFreelanceModTime;
657         scp->serverModTime=FakeFreelanceModTime;
658         scp->parentUnique = 0x1;
659         scp->parentVnode=0x1;
660         scp->group=0;
661         scp->dataVersion=cm_data.fakeDirVersion;
662         scp->lockDataVersion=-1; /* no lock yet */
663 #if not_too_dangerous
664         lock_ReleaseMutex(&scp->mx);
665 #endif
666         *outScpp = scp;
667         lock_ReleaseWrite(&cm_scacheLock);
668 #ifdef DEBUG_REFCOUNT
669         afsi_log("%s:%d cm_GetSCache (2) outScpp 0x%p ref %d", file, line, scp, scp->refCount);
670         osi_Log1(afsd_logp,"cm_GetSCache (2) outScpp 0x%p", scp);
671 #endif
672         return 0;
673     }
674     // end of yj code
675 #endif /* AFS_FREELANCE_CLIENT */
676
677     /* otherwise, we need to find the volume */
678     if (!cm_freelanceEnabled || !isRoot) {
679         lock_ReleaseWrite(&cm_scacheLock);      /* for perf. reasons */
680         cellp = cm_FindCellByID(fidp->cell);
681         if (!cellp) 
682             return CM_ERROR_NOSUCHCELL;
683
684         code = cm_GetVolumeByID(cellp, fidp->volume, userp, reqp, &volp);
685         if (code) 
686             return code;
687         lock_ObtainWrite(&cm_scacheLock);
688     }
689         
690     /* otherwise, we have the volume, now reverify that the scp doesn't
691      * exist, and proceed.
692      */
693     for (scp=cm_data.hashTablep[hash]; scp; scp=scp->nextp) {
694         if (cm_FidCmp(fidp, &scp->fid) == 0) {
695 #ifdef DEBUG_REFCOUNT
696             afsi_log("%s:%d cm_GetSCache (3) outScpp 0x%p ref %d", file, line, scp, scp->refCount);
697             osi_Log1(afsd_logp,"cm_GetSCache (3) outScpp 0x%p", scp);
698 #endif
699             cm_HoldSCacheNoLock(scp);
700             osi_assert(scp->volp == volp);
701             cm_AdjustLRU(scp);
702             lock_ReleaseWrite(&cm_scacheLock);
703             if (volp)
704                 cm_PutVolume(volp);
705             *outScpp = scp;
706             return 0;
707         }
708     }
709         
710     /* now, if we don't have the fid, recycle something */
711     scp = cm_GetNewSCache();
712     if (scp == NULL) {
713         osi_Log0(afsd_logp,"cm_GetNewSCache unable to obtain *new* scache entry");
714         lock_ReleaseWrite(&cm_scacheLock);
715         return CM_ERROR_WOULDBLOCK;
716     }
717     osi_Log2(afsd_logp,"cm_GetNewSCache returns scp 0x%x flags 0x%x", scp, scp->flags);
718
719     osi_assert(!(scp->flags & CM_SCACHEFLAG_INHASH));
720
721 #if not_too_dangerous
722     /* dropping the cm_scacheLock allows more than one thread
723      * to obtain the same cm_scache_t from the LRU list.  Since
724      * the refCount is known to be zero at this point we have to
725      * assume that no one else is using the one this is returned.
726      */
727     lock_ReleaseWrite(&cm_scacheLock);
728     lock_ObtainMutex(&scp->mx);
729     lock_ObtainWrite(&cm_scacheLock);
730 #endif
731     scp->fid = *fidp;
732     scp->volp = volp;   /* a held reference */
733
734     if (!cm_freelanceEnabled || !isRoot) {
735         /* if this scache entry represents a volume root then we need 
736          * to copy the dotdotFipd from the volume structure where the 
737          * "master" copy is stored (defect 11489)
738          */
739         if (scp->fid.vnode == 1 && scp->fid.unique == 1) {
740             scp->dotdotFid = volp->dotdotFid;
741         }
742           
743         if (volp->roID == fidp->volume)
744             scp->flags |= (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO);
745         else if (volp->bkID == fidp->volume)
746             scp->flags |= CM_SCACHEFLAG_RO;
747     }
748     scp->nextp = cm_data.hashTablep[hash];
749     cm_data.hashTablep[hash] = scp;
750     scp->flags |= CM_SCACHEFLAG_INHASH;
751     scp->refCount = 1;
752     osi_Log1(afsd_logp,"cm_GetSCache sets refCount to 1 scp 0x%x", scp);
753 #if not_too_dangerous
754     lock_ReleaseMutex(&scp->mx);
755 #endif
756
757     /* XXX - The following fields in the cm_scache are 
758      * uninitialized:
759      *   fileType
760      *   parentVnode
761      *   parentUnique
762      */
763     lock_ReleaseWrite(&cm_scacheLock);
764         
765     /* now we have a held scache entry; just return it */
766     *outScpp = scp;
767 #ifdef DEBUG_REFCOUNT
768     afsi_log("%s:%d cm_GetSCache (4) outScpp 0x%p ref %d", file, line, scp, scp->refCount);
769     osi_Log1(afsd_logp,"cm_GetSCache (4) outScpp 0x%p", scp);
770 #endif
771     return 0;
772 }
773
774 /* Returns a held reference to the scache's parent 
775  * if it exists */
776 cm_scache_t * cm_FindSCacheParent(cm_scache_t * scp)
777 {
778     long code = 0;
779     int i;
780     cm_fid_t    parent_fid;
781     cm_scache_t * pscp = NULL;
782
783     lock_ObtainRead(&cm_scacheLock);
784     parent_fid = scp->fid;
785     parent_fid.vnode = scp->parentVnode;
786     parent_fid.unique = scp->parentUnique;
787
788     if (cm_FidCmp(&scp->fid, &parent_fid)) {
789         i = CM_SCACHE_HASH(&parent_fid);
790         for (pscp = cm_data.hashTablep[i]; pscp; pscp = pscp->nextp) {
791             if (!cm_FidCmp(&pscp->fid, &parent_fid)) {
792                 cm_HoldSCacheNoLock(pscp);
793                 break;
794             }
795         }
796     }
797
798     lock_ReleaseRead(&cm_scacheLock);
799
800     return pscp;
801 }
802
803 /* synchronize a fetch, store, read, write, fetch status or store status.
804  * Called with scache mutex held, and returns with it held, but temporarily
805  * drops it during the fetch.
806  * 
807  * At most one flag can be on in flags, if this is an RPC request.
808  *
809  * Also, if we're fetching or storing data, we must ensure that we have a buffer.
810  *
811  * There are a lot of weird restrictions here; here's an attempt to explain the
812  * rationale for the concurrency restrictions implemented in this function.
813  *
814  * First, although the file server will break callbacks when *another* machine
815  * modifies a file or status block, the client itself is responsible for
816  * concurrency control on its own requests.  Callback breaking events are rare,
817  * and simply invalidate any concurrent new status info.
818  *
819  * In the absence of callback breaking messages, we need to know how to
820  * synchronize incoming responses describing updates to files.  We synchronize
821  * operations that update the data version by comparing the data versions.
822  * However, updates that do not update the data, but only the status, can't be
823  * synchronized with fetches or stores, since there's nothing to compare
824  * to tell which operation executed first at the server.
825  *
826  * Thus, we can allow multiple ops that change file data, or dir data, and
827  * fetches.  However, status storing ops have to be done serially.
828  *
829  * Furthermore, certain data-changing ops are incompatible: we can't read or
830  * write a buffer while doing a truncate.  We can't read and write the same
831  * buffer at the same time, or write while fetching or storing, or read while
832  * fetching a buffer (this may change).  We can't fetch and store at the same
833  * time, either.
834  *
835  * With respect to status, we can't read and write at the same time, read while
836  * fetching, write while fetching or storing, or fetch and store at the same time.
837  *
838  * We can't allow a get callback RPC to run in concurrently with something that
839  * will return updated status, since we could start a call, have the server
840  * return status, have another machine make an update to the status (which
841  * doesn't change serverModTime), have the original machine get a new callback,
842  * and then have the original machine merge in the early, old info from the
843  * first call.  At this point, the easiest way to avoid this problem is to have
844  * getcallback calls conflict with all others for the same vnode.  Other calls
845  * to cm_MergeStatus that aren't associated with calls to cm_SyncOp on the same
846  * vnode must be careful not to merge in their status unless they have obtained
847  * a callback from the start of their call.
848  *
849  * Note added 1/23/96
850  * Concurrent StoreData RPC's can cause trouble if the file is being extended.
851  * Each such RPC passes a FileLength parameter, which the server uses to do
852  * pre-truncation if necessary.  So if two RPC's are processed out of order at
853  * the server, the one with the smaller FileLength will be processed last,
854  * possibly resulting in a bogus truncation.  The simplest way to avoid this
855  * is to serialize all StoreData RPC's.  This is the reason we defined
856  * CM_SCACHESYNC_STOREDATA_EXCL and CM_SCACHEFLAG_DATASTORING.
857  */
858 long cm_SyncOp(cm_scache_t *scp, cm_buf_t *bufp, cm_user_t *userp, cm_req_t *reqp,
859                afs_uint32 rights, afs_uint32 flags)
860 {
861     osi_queueData_t *qdp;
862     long code;
863     cm_buf_t *tbufp;
864     afs_uint32 outRights;
865     int bufLocked;
866     afs_uint32 sleep_scp_flags = 0;
867     afs_uint32 sleep_buf_cmflags = 0;
868     afs_uint32 sleep_scp_bufs = 0;
869
870     /* lookup this first */
871     bufLocked = flags & CM_SCACHESYNC_BUFLOCKED;
872
873         if (bufp)
874                 osi_assert(bufp->refCount > 0);
875
876
877     /* Do the access check.  Now we don't really do the access check
878      * atomically, since the caller doesn't expect the parent dir to be
879      * returned locked, and that is what we'd have to do to prevent a
880      * callback breaking message on the parent due to a setacl call from
881      * being processed while we're running.  So, instead, we check things
882      * here, and if things look fine with the access, we proceed to finish
883      * the rest of this check.  Sort of a hack, but probably good enough.
884      */
885
886     while (1) {
887         if (flags & CM_SCACHESYNC_FETCHSTATUS) {
888             /* if we're bringing in a new status block, ensure that
889              * we aren't already doing so, and that no one is
890              * changing the status concurrently, either.  We need
891              * to do this, even if the status is of a different
892              * type, since we don't have the ability to figure out,
893              * in the AFS 3 protocols, which status-changing
894              * operation ran first, or even which order a read and
895              * a write occurred in.
896              */
897             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
898                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
899                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want FETCHSTATUS", scp);
900                 goto sleep;
901             }
902         }
903         if (flags & (CM_SCACHESYNC_STORESIZE | CM_SCACHESYNC_STORESTATUS
904                       | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_GETCALLBACK)) {
905             /* if we're going to make an RPC to change the status, make sure
906              * that no one is bringing in or sending out the status.
907              */
908             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING |
909                               CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
910                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want STORESIZE|STORESTATUS|SETSIZE|GETCALLBACK", scp);
911                 goto sleep;
912             }
913             if (scp->bufReadsp || scp->bufWritesp) {
914                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is bufRead|bufWrite want STORESIZE|STORESTATUS|SETSIZE|GETCALLBACK", scp);
915                 goto sleep;
916             }
917         }
918         if (flags & CM_SCACHESYNC_FETCHDATA) {
919             /* if we're bringing in a new chunk of data, make sure that
920              * nothing is happening to that chunk, and that we aren't
921              * changing the basic file status info, either.
922              */
923             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
924                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
925                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want FETCHDATA", scp);
926                 goto sleep;
927             }
928             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING))) {
929                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING|BUF_CMSTORING want FETCHDATA", scp, bufp);
930                 goto sleep;
931             }
932         }
933         if (flags & CM_SCACHESYNC_STOREDATA) {
934             /* same as fetch data */
935             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
936                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
937                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want STOREDATA", scp);
938                 goto sleep;
939             }
940             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING))) {
941                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING|BUF_CMSTORING want STOREDATA", scp, bufp);
942                 goto sleep;
943             }
944         }
945
946         if (flags & CM_SCACHESYNC_STOREDATA_EXCL) {
947             /* Don't allow concurrent StoreData RPC's */
948             if (scp->flags & CM_SCACHEFLAG_DATASTORING) {
949                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is DATASTORING want STOREDATA_EXCL", scp);
950                 goto sleep;
951             }
952         }
953
954         if (flags & CM_SCACHESYNC_ASYNCSTORE) {
955             /* Don't allow more than one BKG store request */
956             if (scp->flags & CM_SCACHEFLAG_ASYNCSTORING) {
957                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is ASYNCSTORING want ASYNCSTORE", scp);
958                 goto sleep;
959             }
960         }
961
962         if (flags & CM_SCACHESYNC_LOCK) {
963             /* Don't allow concurrent fiddling with lock lists */
964             if (scp->flags & CM_SCACHEFLAG_LOCKING) {
965                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is LOCKING want LOCK", scp);
966                 goto sleep;
967             }
968         }
969
970         /* now the operations that don't correspond to making RPCs */
971         if (flags & CM_SCACHESYNC_GETSTATUS) {
972             /* we can use the status that's here, if we're not
973              * bringing in new status.
974              */
975             if (scp->flags & (CM_SCACHEFLAG_FETCHING)) {
976                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING want GETSTATUS", scp);
977                 goto sleep;
978             }
979         }
980         if (flags & CM_SCACHESYNC_SETSTATUS) {
981             /* we can make a change to the local status, as long as
982              * the status isn't changing now.
983              *
984              * If we're fetching or storing a chunk of data, we can
985              * change the status locally, since the fetch/store
986              * operations don't change any of the data that we're
987              * changing here.
988              */
989             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING | CM_SCACHEFLAG_SIZESTORING)) {
990                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING want SETSTATUS", scp);
991                 goto sleep;
992             }
993         }
994         if (flags & CM_SCACHESYNC_READ) {
995             /* we're going to read the data, make sure that the
996              * status is available, and that the data is here.  It
997              * is OK to read while storing the data back.
998              */
999             if (scp->flags & CM_SCACHEFLAG_FETCHING) {
1000                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING want READ", scp);
1001                 goto sleep;
1002             }
1003             if (bufp && ((bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED)) == CM_BUF_CMFETCHING)) {
1004                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING want READ", scp, bufp);
1005                 goto sleep;
1006             }
1007         }
1008         if (flags & CM_SCACHESYNC_WRITE) {
1009             /* don't write unless the status is stable and the chunk
1010              * is stable.
1011              */
1012             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
1013                                | CM_SCACHEFLAG_SIZESTORING)) {
1014                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING want WRITE", scp);
1015                 goto sleep;
1016             }
1017             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING))) {
1018                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING|BUF_CMSTORING want WRITE", scp, bufp);
1019                 goto sleep;
1020             }
1021         }
1022
1023         // yj: modified this so that callback only checked if we're
1024         // not checking something on /afs
1025         /* fix the conditional to match the one in cm_HaveCallback */
1026         if ((flags & CM_SCACHESYNC_NEEDCALLBACK)
1027 #ifdef AFS_FREELANCE_CLIENT
1028              && (!cm_freelanceEnabled || 
1029                   !(scp->fid.vnode==0x1 && scp->fid.unique==0x1) ||
1030                   scp->fid.cell!=AFS_FAKE_ROOT_CELL_ID ||
1031                   scp->fid.volume!=AFS_FAKE_ROOT_VOL_ID ||
1032                   cm_fakeDirCallback < 2)
1033 #endif /* AFS_FREELANCE_CLIENT */
1034              ) {
1035             if ((flags & CM_SCACHESYNC_FORCECB) || !cm_HaveCallback(scp)) {
1036                 osi_Log1(afsd_logp, "CM SyncOp getting callback on scp 0x%p",
1037                           scp);
1038                 if (bufLocked) 
1039                     lock_ReleaseMutex(&bufp->mx);
1040                 code = cm_GetCallback(scp, userp, reqp, (flags & CM_SCACHESYNC_FORCECB)?1:0);
1041                 if (bufLocked) {
1042                     lock_ReleaseMutex(&scp->mx);
1043                     lock_ObtainMutex(&bufp->mx);
1044                     lock_ObtainMutex(&scp->mx);
1045                 }
1046                 if (code) 
1047                     return code;
1048                 flags &= ~CM_SCACHESYNC_FORCECB;        /* only force once */
1049                 continue;
1050             }
1051         }
1052
1053         if (rights) {
1054             /* can't check access rights without a callback */
1055             osi_assert(flags & CM_SCACHESYNC_NEEDCALLBACK);
1056
1057             if ((rights & PRSFS_WRITE) && (scp->flags & CM_SCACHEFLAG_RO))
1058                 return CM_ERROR_READONLY;
1059
1060             if (cm_HaveAccessRights(scp, userp, rights, &outRights)) {
1061                 if (~outRights & rights) 
1062                     return CM_ERROR_NOACCESS;
1063             }
1064             else {
1065                 /* we don't know the required access rights */
1066                 if (bufLocked) lock_ReleaseMutex(&bufp->mx);
1067                 code = cm_GetAccessRights(scp, userp, reqp);
1068                 if (bufLocked) {
1069                     lock_ReleaseMutex(&scp->mx);
1070                     lock_ObtainMutex(&bufp->mx);
1071                     lock_ObtainMutex(&scp->mx);
1072                 }
1073                 if (code) 
1074                     return code;
1075                 continue;
1076             }
1077         }
1078
1079         /* if we get here, we're happy */
1080         break;
1081
1082       sleep:
1083         /* first check if we're not supposed to wait: fail 
1084          * in this case, returning with everything still locked.
1085          */
1086         if (flags & CM_SCACHESYNC_NOWAIT) 
1087             return CM_ERROR_WOULDBLOCK;
1088
1089         sleep_scp_flags = scp->flags;           /* so we know why we slept */
1090         sleep_buf_cmflags = bufp ? bufp->cmFlags : 0;
1091         sleep_scp_bufs = (scp->bufReadsp ? 1 : 0) | (scp->bufWritesp ? 2 : 0);
1092
1093         /* wait here, then try again */
1094         osi_Log1(afsd_logp, "CM SyncOp sleeping scp 0x%p", scp);
1095         if ( scp->flags & CM_SCACHEFLAG_WAITING ) {
1096             scp->waitCount++;
1097             scp->waitRequests++;
1098             osi_Log3(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING already set for 0x%p; %d threads; %d requests", 
1099                      scp, scp->waitCount, scp->waitRequests);
1100         } else {
1101             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING set for 0x%p", scp);
1102             scp->flags |= CM_SCACHEFLAG_WAITING;
1103             scp->waitCount = scp->waitRequests = 1;
1104         }
1105         if (bufLocked) 
1106             lock_ReleaseMutex(&bufp->mx);
1107         osi_SleepM((LONG_PTR) &scp->flags, &scp->mx);
1108
1109         smb_UpdateServerPriority();
1110
1111         if (bufLocked) 
1112             lock_ObtainMutex(&bufp->mx);
1113         lock_ObtainMutex(&scp->mx);
1114         scp->waitCount--;
1115         osi_Log3(afsd_logp, "CM SyncOp woke! scp 0x%p; still waiting %d threads of %d requests", 
1116                  scp, scp->waitCount, scp->waitRequests);
1117         if (scp->waitCount == 0) {
1118             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING reset for 0x%p", scp);
1119             scp->flags &= ~CM_SCACHEFLAG_WAITING;
1120             scp->waitRequests = 0;
1121         }
1122     } /* big while loop */
1123         
1124     /* now, update the recorded state for RPC-type calls */
1125     if (flags & CM_SCACHESYNC_FETCHSTATUS)
1126         scp->flags |= CM_SCACHEFLAG_FETCHING;
1127     if (flags & CM_SCACHESYNC_STORESTATUS)
1128         scp->flags |= CM_SCACHEFLAG_STORING;
1129     if (flags & CM_SCACHESYNC_STORESIZE)
1130         scp->flags |= CM_SCACHEFLAG_SIZESTORING;
1131     if (flags & CM_SCACHESYNC_GETCALLBACK)
1132         scp->flags |= CM_SCACHEFLAG_GETCALLBACK;
1133     if (flags & CM_SCACHESYNC_STOREDATA_EXCL)
1134         scp->flags |= CM_SCACHEFLAG_DATASTORING;
1135     if (flags & CM_SCACHESYNC_ASYNCSTORE)
1136         scp->flags |= CM_SCACHEFLAG_ASYNCSTORING;
1137     if (flags & CM_SCACHESYNC_LOCK)
1138         scp->flags |= CM_SCACHEFLAG_LOCKING;
1139
1140     /* now update the buffer pointer */
1141     if (flags & CM_SCACHESYNC_FETCHDATA) {
1142         /* ensure that the buffer isn't already in the I/O list */
1143         if (bufp) {
1144             for(qdp = scp->bufReadsp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1145                 tbufp = osi_GetQData(qdp);
1146                 osi_assert(tbufp != bufp);
1147             }
1148         }
1149
1150         /* queue a held reference to the buffer in the "reading" I/O list */
1151         qdp = osi_QDAlloc();
1152         osi_SetQData(qdp, bufp);
1153         if (bufp) {
1154             buf_Hold(bufp);
1155             bufp->cmFlags |= CM_BUF_CMFETCHING;
1156         }
1157         osi_QAdd((osi_queue_t **) &scp->bufReadsp, &qdp->q);
1158     }
1159
1160     if (flags & CM_SCACHESYNC_STOREDATA) {
1161         /* ensure that the buffer isn't already in the I/O list */
1162         if (bufp) {
1163             for(qdp = scp->bufWritesp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1164                 tbufp = osi_GetQData(qdp);
1165                 osi_assert(tbufp != bufp);
1166             }
1167         }
1168
1169         /* queue a held reference to the buffer in the "writing" I/O list */
1170         qdp = osi_QDAlloc();
1171         osi_SetQData(qdp, bufp);
1172         if (bufp) {
1173             buf_Hold(bufp);
1174             bufp->cmFlags |= CM_BUF_CMSTORING;
1175         }
1176         osi_QAdd((osi_queue_t **) &scp->bufWritesp, &qdp->q);
1177     }
1178
1179     return 0;
1180 }
1181
1182 /* for those syncops that setup for RPCs.
1183  * Called with scache locked.
1184  */
1185 void cm_SyncOpDone(cm_scache_t *scp, cm_buf_t *bufp, afs_uint32 flags)
1186 {
1187     osi_queueData_t *qdp;
1188     cm_buf_t *tbufp;
1189
1190     lock_AssertMutex(&scp->mx);
1191
1192     /* now, update the recorded state for RPC-type calls */
1193     if (flags & CM_SCACHESYNC_FETCHSTATUS)
1194         scp->flags &= ~CM_SCACHEFLAG_FETCHING;
1195     if (flags & CM_SCACHESYNC_STORESTATUS)
1196         scp->flags &= ~CM_SCACHEFLAG_STORING;
1197     if (flags & CM_SCACHESYNC_STORESIZE)
1198         scp->flags &= ~CM_SCACHEFLAG_SIZESTORING;
1199     if (flags & CM_SCACHESYNC_GETCALLBACK)
1200         scp->flags &= ~CM_SCACHEFLAG_GETCALLBACK;
1201     if (flags & CM_SCACHESYNC_STOREDATA_EXCL)
1202         scp->flags &= ~CM_SCACHEFLAG_DATASTORING;
1203     if (flags & CM_SCACHESYNC_ASYNCSTORE)
1204         scp->flags &= ~CM_SCACHEFLAG_ASYNCSTORING;
1205     if (flags & CM_SCACHESYNC_LOCK)
1206         scp->flags &= ~CM_SCACHEFLAG_LOCKING;
1207
1208     /* now update the buffer pointer */
1209     if (flags & CM_SCACHESYNC_FETCHDATA) {
1210         /* ensure that the buffer isn't already in the I/O list */
1211         for(qdp = scp->bufReadsp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1212             tbufp = osi_GetQData(qdp);
1213             if (tbufp == bufp) 
1214                 break;
1215         }
1216         if (qdp) {
1217             osi_QRemove((osi_queue_t **) &scp->bufReadsp, &qdp->q);
1218             osi_QDFree(qdp);
1219         }
1220         if (bufp) {
1221             int release = 0;
1222             if (bufp->cmFlags & CM_BUF_CMFETCHING)
1223                 release = 1;
1224             bufp->cmFlags &= ~(CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED);
1225             if (bufp->flags & CM_BUF_WAITING) {
1226                 osi_Log2(afsd_logp, "CM SyncOpDone Waking [scp 0x%p] bufp 0x%p", scp, bufp);
1227                 osi_Wakeup((LONG_PTR) &bufp);
1228             }
1229             if (release)
1230                 buf_Release(bufp);
1231         }
1232     }
1233
1234     /* now update the buffer pointer */
1235     if (flags & CM_SCACHESYNC_STOREDATA) {
1236         /* ensure that the buffer isn't already in the I/O list */
1237         for(qdp = scp->bufWritesp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1238             tbufp = osi_GetQData(qdp);
1239             if (tbufp == bufp) 
1240                 break;
1241         }
1242         if (qdp) {
1243             osi_QRemove((osi_queue_t **) &scp->bufWritesp, &qdp->q);
1244             osi_QDFree(qdp);
1245         }
1246         if (bufp) {
1247             int release = 0;
1248             if (bufp->cmFlags & CM_BUF_CMSTORING)
1249                 release = 1;
1250             bufp->cmFlags &= ~CM_BUF_CMSTORING;
1251             if (bufp->flags & CM_BUF_WAITING) {
1252                 osi_Log2(afsd_logp, "CM SyncOpDone Waking [scp 0x%p] bufp 0x%p", scp, bufp);
1253                 osi_Wakeup((LONG_PTR) &bufp);
1254             }
1255             if (release)
1256                 buf_Release(bufp);
1257         }
1258     }
1259
1260     /* and wakeup anyone who is waiting */
1261     if (scp->flags & CM_SCACHEFLAG_WAITING) {
1262         osi_Log1(afsd_logp, "CM SyncOpDone Waking scp 0x%p", scp);
1263         osi_Wakeup((LONG_PTR) &scp->flags);
1264     }
1265 }       
1266
1267 /* merge in a response from an RPC.  The scp must be locked, and the callback
1268  * is optional.
1269  *
1270  * Don't overwrite any status info that is dirty, since we could have a store
1271  * operation (such as store data) that merges some info in, and we don't want
1272  * to lose the local updates.  Typically, there aren't many updates we do
1273  * locally, anyway, probably only mtime.
1274  *
1275  * There is probably a bug in here where a chmod (which doesn't change
1276  * serverModTime) that occurs between two fetches, both of whose responses are
1277  * handled after the callback breaking is done, but only one of whose calls
1278  * started before that, can cause old info to be merged from the first call.
1279  */
1280 void cm_MergeStatus(cm_scache_t *scp, AFSFetchStatus *statusp, AFSVolSync *volp,
1281                     cm_user_t *userp, afs_uint32 flags)
1282 {
1283     // yj: i want to create some fake status for the /afs directory and the
1284     // entries under that directory
1285 #ifdef AFS_FREELANCE_CLIENT
1286     if (cm_freelanceEnabled && scp == cm_data.rootSCachep) {
1287         osi_Log0(afsd_logp,"cm_MergeStatus Freelance cm_data.rootSCachep");
1288         statusp->InterfaceVersion = 0x1;
1289         statusp->FileType = CM_SCACHETYPE_DIRECTORY;
1290         statusp->LinkCount = scp->linkCount;
1291         statusp->Length = cm_fakeDirSize;
1292         statusp->Length_hi = 0;
1293         statusp->DataVersion = cm_data.fakeDirVersion;
1294         statusp->Author = 0x1;
1295         statusp->Owner = 0x0;
1296         statusp->CallerAccess = 0x9;
1297         statusp->AnonymousAccess = 0x9;
1298         statusp->UnixModeBits = 0x1ff;
1299         statusp->ParentVnode = 0x1;
1300         statusp->ParentUnique = 0x1;
1301         statusp->ResidencyMask = 0;
1302         statusp->ClientModTime = FakeFreelanceModTime;
1303         statusp->ServerModTime = FakeFreelanceModTime;
1304         statusp->Group = 0;
1305         statusp->SyncCounter = 0;
1306         statusp->dataVersionHigh = 0;
1307         statusp->errorCode = 0;
1308     }
1309 #endif /* AFS_FREELANCE_CLIENT */
1310
1311     if (statusp->errorCode != 0) {      
1312         scp->flags |= CM_SCACHEFLAG_EACCESS;
1313         osi_Log2(afsd_logp, "Merge, Failure scp %x code 0x%x", scp, statusp->errorCode);
1314         return;
1315     } else {
1316         scp->flags &= ~CM_SCACHEFLAG_EACCESS;
1317     }
1318
1319     if (!(flags & CM_MERGEFLAG_FORCE)
1320          && statusp->DataVersion < (unsigned long) scp->dataVersion) {
1321         struct cm_cell *cellp;
1322
1323         cellp = cm_FindCellByID(scp->fid.cell);
1324         if (scp->cbServerp) {
1325             struct cm_volume *volp = NULL;
1326
1327             cm_GetVolumeByID(cellp, scp->fid.volume, userp,
1328                               (cm_req_t *) NULL, &volp);
1329             osi_Log2(afsd_logp, "old data from server %x volume %s",
1330                       scp->cbServerp->addr.sin_addr.s_addr,
1331                       volp ? volp->namep : "(unknown)");
1332             if (volp)
1333                 cm_PutVolume(volp);
1334         }
1335         osi_Log3(afsd_logp, "Bad merge, scp %x, scp dv %d, RPC dv %d",
1336                   scp, scp->dataVersion, statusp->DataVersion);
1337         /* we have a number of data fetch/store operations running
1338          * concurrently, and we can tell which one executed last at the
1339          * server by its mtime.
1340          * Choose the one with the largest mtime, and ignore the rest.
1341          *
1342          * These concurrent calls are incompatible with setting the
1343          * mtime, so we won't have a locally changed mtime here.
1344          *
1345          * We could also have ACL info for a different user than usual,
1346          * in which case we have to do that part of the merge, anyway.
1347          * We won't have to worry about the info being old, since we
1348          * won't have concurrent calls
1349          * that change file status running from this machine.
1350          *
1351          * Added 3/17/98:  if we see data version regression on an RO
1352          * file, it's probably due to a server holding an out-of-date
1353          * replica, rather than to concurrent RPC's.  Failures to
1354          * release replicas are now flagged by the volserver, but only
1355          * since AFS 3.4 5.22, so there are plenty of clients getting
1356          * out-of-date replicas out there.
1357          *
1358          * If we discover an out-of-date replica, by this time it's too
1359          * late to go to another server and retry.  Also, we can't
1360          * reject the merge, because then there is no way for
1361          * GetAccess to do its work, and the caller gets into an
1362          * infinite loop.  So we just grin and bear it.
1363          */
1364         if (!(scp->flags & CM_SCACHEFLAG_RO))
1365             return;
1366     }       
1367     scp->serverModTime = statusp->ServerModTime;
1368
1369     if (!(scp->mask & CM_SCACHEMASK_CLIENTMODTIME)) {
1370         scp->clientModTime = statusp->ClientModTime;
1371     }
1372     if (!(scp->mask & CM_SCACHEMASK_LENGTH)) {
1373         scp->length.LowPart = statusp->Length;
1374         scp->length.HighPart = statusp->Length_hi;
1375     }
1376
1377     scp->serverLength.LowPart = statusp->Length;
1378     scp->serverLength.HighPart = statusp->Length_hi;
1379
1380     scp->linkCount = statusp->LinkCount;
1381     scp->dataVersion = statusp->DataVersion;
1382     scp->owner = statusp->Owner;
1383     scp->group = statusp->Group;
1384     scp->unixModeBits = statusp->UnixModeBits & 07777;
1385
1386     if (statusp->FileType == File)
1387         scp->fileType = CM_SCACHETYPE_FILE;
1388     else if (statusp->FileType == Directory)
1389         scp->fileType = CM_SCACHETYPE_DIRECTORY;
1390     else if (statusp->FileType == SymbolicLink) {
1391         if ((scp->unixModeBits & 0111) == 0)
1392             scp->fileType = CM_SCACHETYPE_MOUNTPOINT;
1393         else
1394             scp->fileType = CM_SCACHETYPE_SYMLINK;
1395     }       
1396     else {
1397         osi_Log2(afsd_logp, "Merge, Invalid File Type (%d), scp %x", statusp->FileType, scp);
1398         scp->fileType = CM_SCACHETYPE_INVALID;  /* invalid */
1399     }
1400     /* and other stuff */
1401     scp->parentVnode = statusp->ParentVnode;
1402     scp->parentUnique = statusp->ParentUnique;
1403         
1404     /* and merge in the private acl cache info, if this is more than the public
1405      * info; merge in the public stuff in any case.
1406      */
1407     scp->anyAccess = statusp->AnonymousAccess;
1408
1409     if (userp != NULL) {
1410         cm_AddACLCache(scp, userp, statusp->CallerAccess);
1411     }
1412 }
1413
1414 /* note that our stat cache info is incorrect, so force us eventually
1415  * to stat the file again.  There may be dirty data associated with
1416  * this vnode, and we want to preserve that information.
1417  *
1418  * This function works by simply simulating a loss of the callback.
1419  *
1420  * This function must be called with the scache locked.
1421  */
1422 void cm_DiscardSCache(cm_scache_t *scp)
1423 {
1424     lock_AssertMutex(&scp->mx);
1425     if (scp->cbServerp) {
1426         cm_PutServer(scp->cbServerp);
1427         scp->cbServerp = NULL;
1428     }
1429     scp->cbExpires = 0;
1430     scp->flags &= ~CM_SCACHEFLAG_CALLBACK;
1431     cm_dnlcPurgedp(scp);
1432     cm_dnlcPurgevp(scp);
1433     cm_FreeAllACLEnts(scp);
1434
1435     /* Force mount points and symlinks to be re-evaluated */
1436     scp->mountPointStringp[0] = '\0';
1437 }
1438
1439 void cm_AFSFidFromFid(AFSFid *afsFidp, cm_fid_t *fidp)
1440 {
1441     afsFidp->Volume = fidp->volume;
1442     afsFidp->Vnode = fidp->vnode;
1443     afsFidp->Unique = fidp->unique;
1444 }       
1445
1446 #ifdef DEBUG_REFCOUNT
1447 void cm_HoldSCacheNoLockDbg(cm_scache_t *scp, char * file, long line)
1448 #else
1449 void cm_HoldSCacheNoLock(cm_scache_t *scp)
1450 #endif
1451 {
1452     osi_assert(scp != 0);
1453     scp->refCount++;
1454 #ifdef DEBUG_REFCOUNT
1455     osi_Log2(afsd_logp,"cm_HoldSCacheNoLock scp 0x%p ref %d",scp, scp->refCount);
1456     afsi_log("%s:%d cm_HoldSCacheNoLock scp 0x%p, ref %d", file, line, scp, scp->refCount);
1457 #endif
1458 }
1459
1460 #ifdef DEBUG_REFCOUNT
1461 void cm_HoldSCacheDbg(cm_scache_t *scp, char * file, long line)
1462 #else
1463 void cm_HoldSCache(cm_scache_t *scp)
1464 #endif
1465 {
1466     osi_assert(scp != 0);
1467     lock_ObtainWrite(&cm_scacheLock);
1468     scp->refCount++;
1469 #ifdef DEBUG_REFCOUNT
1470     osi_Log2(afsd_logp,"cm_HoldSCache scp 0x%p ref %d",scp, scp->refCount);
1471     afsi_log("%s:%d cm_HoldSCache scp 0x%p ref %d", file, line, scp, scp->refCount);
1472 #endif
1473     lock_ReleaseWrite(&cm_scacheLock);
1474 }
1475
1476 #ifdef DEBUG_REFCOUNT
1477 void cm_ReleaseSCacheNoLockDbg(cm_scache_t *scp, char * file, long line)
1478 #else
1479 void cm_ReleaseSCacheNoLock(cm_scache_t *scp)
1480 #endif
1481 {
1482     osi_assert(scp != NULL);
1483     if (scp->refCount == 0)
1484         osi_Log1(afsd_logp,"cm_ReleaseSCacheNoLock about to panic scp 0x%x",scp);
1485     osi_assert(scp->refCount-- >= 0);
1486 #ifdef DEBUG_REFCOUNT
1487     osi_Log2(afsd_logp,"cm_ReleaseSCacheNoLock scp 0x%p ref %d",scp,scp->refCount);
1488     afsi_log("%s:%d cm_ReleaseSCacheNoLock scp 0x%p ref %d", file, line, scp, scp->refCount);
1489 #endif
1490 }
1491
1492 #ifdef DEBUG_REFCOUNT
1493 void cm_ReleaseSCacheDbg(cm_scache_t *scp, char * file, long line)
1494 #else
1495 void cm_ReleaseSCache(cm_scache_t *scp)
1496 #endif
1497 {
1498     osi_assert(scp != NULL);
1499     lock_ObtainWrite(&cm_scacheLock);
1500     if (scp->refCount == 0)
1501         osi_Log1(afsd_logp,"cm_ReleaseSCache about to panic scp 0x%x",scp);
1502     osi_assert(scp->refCount != 0);
1503     scp->refCount--;
1504 #ifdef DEBUG_REFCOUNT
1505     osi_Log2(afsd_logp,"cm_ReleaseSCache scp 0x%p ref %d",scp,scp->refCount);
1506     afsi_log("%s:%d cm_ReleaseSCache scp 0x%p ref %d", file, line, scp, scp->refCount);
1507 #endif
1508     lock_ReleaseWrite(&cm_scacheLock);
1509 }
1510
1511 /* just look for the scp entry to get filetype */
1512 /* doesn't need to be perfectly accurate, so locking doesn't matter too much */
1513 int cm_FindFileType(cm_fid_t *fidp)
1514 {
1515     long hash;
1516     cm_scache_t *scp;
1517         
1518     hash = CM_SCACHE_HASH(fidp);
1519         
1520     osi_assert(fidp->cell != 0);
1521
1522     lock_ObtainWrite(&cm_scacheLock);
1523     for (scp=cm_data.hashTablep[hash]; scp; scp=scp->nextp) {
1524         if (cm_FidCmp(fidp, &scp->fid) == 0) {
1525             lock_ReleaseWrite(&cm_scacheLock);
1526             return scp->fileType;
1527         }
1528     }
1529     lock_ReleaseWrite(&cm_scacheLock);
1530     return 0;
1531 }
1532
1533 /* dump all scp's that have reference count > 0 to a file. 
1534  * cookie is used to identify this batch for easy parsing, 
1535  * and it a string provided by a caller 
1536  */
1537 int cm_DumpSCache(FILE *outputFile, char *cookie, int lock)
1538 {
1539     int zilch;
1540     cm_scache_t *scp;
1541     char output[1024];
1542     int i;
1543   
1544     if (lock)
1545         lock_ObtainRead(&cm_scacheLock);
1546   
1547     sprintf(output, "%s - dumping scache - cm_data.currentSCaches=%d, cm_data.maxSCaches=%d\n", cookie, cm_data.currentSCaches, cm_data.maxSCaches);
1548     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1549   
1550     for (scp = cm_data.scacheLRULastp; scp; scp = (cm_scache_t *) osi_QPrev(&scp->q)) 
1551     {
1552         if (scp->refCount != 0)
1553         {
1554             sprintf(output, "%s fid (cell=%d, volume=%d, vnode=%d, unique=%d) refCount=%u\n", 
1555                     cookie, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique, 
1556                     scp->refCount);
1557             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1558         }
1559     }
1560   
1561     sprintf(output, "%s - dumping cm_data.hashTable - cm_data.hashTableSize=%d\n", cookie, cm_data.hashTableSize);
1562     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1563   
1564     for (i = 0; i < cm_data.hashTableSize; i++)
1565     {
1566         for(scp = cm_data.hashTablep[i]; scp; scp=scp->nextp) 
1567         {
1568             if (scp->refCount != 0)
1569             {
1570                 sprintf(output, "%s scp=0x%p, hash=%d, fid (cell=%d, volume=%d, vnode=%d, unique=%d) refCount=%u\n", 
1571                          cookie, scp, i, scp->fid.cell, scp->fid.volume, scp->fid.vnode, 
1572                          scp->fid.unique, scp->refCount);
1573                 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1574             }
1575         }
1576     }
1577
1578     sprintf(output, "%s - Done dumping scache.\n", cookie);
1579     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1580   
1581     if (lock)
1582         lock_ReleaseRead(&cm_scacheLock);       
1583     return (0);     
1584 }
1585