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