3dffceb8eff2a0e8c74348cb7886070ab73bd85e
[openafs.git] / src / WINNT / afsd / cm_volume.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 <string.h>
17 #include <malloc.h>
18 #include "afsd.h"
19 #include <osi.h>
20 #include <rx/rx.h>
21
22 osi_rwlock_t cm_volumeLock;
23
24 long 
25 cm_ValidateVolume(void)
26 {
27     cm_volume_t * volp;
28     afs_uint32 count;
29
30     for (volp = cm_data.allVolumesp, count = 0; volp; volp=volp->allNextp, count++) {
31         if ( volp->magic != CM_VOLUME_MAGIC ) {
32             afsi_log("cm_ValidateVolume failure: volp->magic != CM_VOLUME_MAGIC");
33             fprintf(stderr, "cm_ValidateVolume failure: volp->magic != CM_VOLUME_MAGIC\n");
34             return -1;
35         }
36         if ( volp->cellp && volp->cellp->magic != CM_CELL_MAGIC ) {
37             afsi_log("cm_ValidateVolume failure: volp->cellp->magic != CM_CELL_MAGIC");
38             fprintf(stderr, "cm_ValidateVolume failure: volp->cellp->magic != CM_CELL_MAGIC\n");
39             return -2;
40         }
41         if ( volp->allNextp && volp->allNextp->magic != CM_VOLUME_MAGIC ) {
42             afsi_log("cm_ValidateVolume failure: volp->allNextp->magic != CM_VOLUME_MAGIC");
43             fprintf(stderr, "cm_ValidateVolume failure: volp->allNextp->magic != CM_VOLUME_MAGIC\n");
44             return -3;
45         }
46         if ( count != 0 && volp == cm_data.allVolumesp || 
47              count > cm_data.maxVolumes ) {
48             afsi_log("cm_ValidateVolume failure: cm_data.allVolumep loop detected");
49             fprintf(stderr, "cm_ValidateVolume failure: cm_data.allVolumep loop detected\n");
50             return -4;
51         }
52     }
53
54     if ( count != cm_data.currentVolumes ) {
55         afsi_log("cm_ValidateVolume failure: count != cm_data.currentVolumes");
56         fprintf(stderr, "cm_ValidateVolume failure: count != cm_data.currentVolumes\n");
57         return -5;
58     }
59     
60     return 0;
61 }
62
63 long
64 cm_ShutdownVolume(void)
65 {
66     cm_volume_t * volp;
67
68     for (volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
69         afs_uint32 volType;
70         for ( volType = RWVOL; volType < NUM_VOL_TYPES; volType++) {
71             if (volp->vol[volType].ID)
72                 cm_VolumeStatusNotification(volp, volp->vol[volType].ID, volp->vol[volType].state, vl_alldown);
73         }
74         volp->cbExpiresRO = 0;
75         lock_FinalizeRWLock(&volp->rw);
76     }
77
78     return 0;
79 }
80
81 void cm_InitVolume(int newFile, long maxVols)
82 {
83     static osi_once_t once;
84
85     if (osi_Once(&once)) {
86         lock_InitializeRWLock(&cm_volumeLock, "cm global volume lock");
87
88         if ( newFile ) {
89             cm_data.allVolumesp = NULL;
90             cm_data.currentVolumes = 0;
91             cm_data.maxVolumes = maxVols;
92             memset(cm_data.volumeNameHashTablep, 0, sizeof(cm_volume_t *) * cm_data.volumeHashTableSize);
93             memset(cm_data.volumeRWIDHashTablep, 0, sizeof(cm_volume_t *) * cm_data.volumeHashTableSize);
94             memset(cm_data.volumeROIDHashTablep, 0, sizeof(cm_volume_t *) * cm_data.volumeHashTableSize);
95             memset(cm_data.volumeBKIDHashTablep, 0, sizeof(cm_volume_t *) * cm_data.volumeHashTableSize);
96             cm_data.volumeLRUFirstp = cm_data.volumeLRULastp = NULL;
97         } else {
98             cm_volume_t * volp;
99
100             for (volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
101                 afs_uint32 volType;
102
103                 lock_InitializeRWLock(&volp->rw, "cm_volume_t rwlock");
104                 volp->flags |= CM_VOLUMEFLAG_RESET;
105                 volp->flags &= CM_VOLUMEFLAG_UPDATING_VL;
106                 for (volType = RWVOL; volType < NUM_VOL_TYPES; volType++) {
107                     volp->vol[volType].state = vl_unknown;
108                     volp->vol[volType].serversp = NULL;
109                     if (volp->vol[volType].ID)
110                         cm_VolumeStatusNotification(volp, volp->vol[volType].ID, vl_alldown, volp->vol[volType].state);
111                 }
112                 volp->cbExpiresRO = 0;
113             }
114         }
115         osi_EndOnce(&once);
116     }
117 }
118
119
120 /* returns true if the id is a decimal integer, in which case we interpret it
121  * as an id.  make the cache manager much simpler.  
122  * Stolen from src/volser/vlprocs.c */
123 int
124 cm_VolNameIsID(char *aname)
125 {
126     int tc;
127     while (tc = *aname++) {
128         if (tc > '9' || tc < '0')
129             return 0;
130     }
131     return 1;
132 }
133
134
135 /*
136  * Update a volume.  Caller holds a write lock on the volume (volp->rw).
137  *
138  *
139  *  shadow / openafs / jhutz@CS.CMU.EDU {ANDREW.CMU.EDU}  01:38    (JHutz)
140  *    Yes, we support multihomed fileservers.
141  *    Since before we got the code from IBM.
142  *    But to find out about multiple addresses on a multihomed server, you need
143  *    to use VL_GetEntryByNameU and VL_GetAddrsU.  If you use
144  *    VL_GetEntryByNameO or VL_GetEntryByNameN, the vlserver just gives you one
145  *    address per server.
146  *  shadow / openafs / jhutz@CS.CMU.EDU {ANDREW.CMU.EDU}  01:39    (JHutz)
147  *    see src/afs/afs_volume.c, paying particular attention to
148  *    afs_NewVolumeByName, afs_SetupVolume, and InstallUVolumeEntry
149  *  shadow / openafs / jaltman {ANDREW.CMU.EDU}  01:40    (Jeffrey Altman)
150  *    thanks.  The windows client calls the 0 versions.
151  *  shadow / openafs / jhutz@CS.CMU.EDU {ANDREW.CMU.EDU}  01:51    (JHutz)
152  *    Oh.  Ew.
153  *    By not using the N versions, you only get up to 8 sites instead of 13.
154  *    By not using the U versions, you don't get to know about multihomed serve
155  *  shadow / openafs / jhutz@CS.CMU.EDU {ANDREW.CMU.EDU}  01:52    (JHutz)
156  *    Of course, you probably want to support the older versions for backward
157  *    compatibility.  If you do that, you need to call the newest interface
158  *    first, and fall back to successively older versions if you get
159  *    RXGEN_OPCODE.
160  */
161 #define MULTIHOMED 1
162 long cm_UpdateVolumeLocation(struct cm_cell *cellp, cm_user_t *userp, cm_req_t *reqp,
163                      cm_volume_t *volp)
164 {
165     cm_conn_t *connp;
166     int i, j, k;
167     cm_serverRef_t *tsrp;
168     cm_server_t *tsp;
169     struct sockaddr_in tsockAddr;
170     long tflags;
171     u_long tempAddr;
172     struct vldbentry vldbEntry;
173     struct nvldbentry nvldbEntry;
174 #ifdef MULTIHOMED
175     struct uvldbentry uvldbEntry;
176 #endif
177     int method = -1;
178     int ROcount = 0;
179     long code;
180     enum volstatus rwNewstate = vl_online;
181     enum volstatus roNewstate = vl_online;
182     enum volstatus bkNewstate = vl_online;
183 #ifdef AFS_FREELANCE_CLIENT
184     int freelance = 0;
185 #endif
186     afs_uint32 volType;
187
188 #ifdef AFS_FREELANCE_CLIENT
189     if ( cellp->cellID == AFS_FAKE_ROOT_CELL_ID && volp->vol[RWVOL].ID == AFS_FAKE_ROOT_VOL_ID ) 
190     {
191         freelance = 1;
192         memset(&vldbEntry, 0, sizeof(vldbEntry));
193         vldbEntry.flags |= VLF_RWEXISTS;
194         vldbEntry.volumeId[0] = AFS_FAKE_ROOT_VOL_ID;
195         code = 0;
196         method = 0;
197     } else
198 #endif
199     {
200         while (volp->flags & CM_VOLUMEFLAG_UPDATING_VL) {
201             osi_Log3(afsd_logp, "cm_UpdateVolumeLocation sleeping name %s:%s flags 0x%x", 
202                      volp->cellp->name, volp->namep, volp->flags);
203             osi_SleepW((LONG_PTR) &volp->flags, &volp->rw);
204             lock_ObtainWrite(&volp->rw);
205             osi_Log3(afsd_logp, "cm_UpdateVolumeLocation awake name %s:%s flags 0x%x", 
206                      volp->cellp->name, volp->namep, volp->flags);
207             if (!(volp->flags & CM_VOLUMEFLAG_RESET)) {
208                 osi_Log3(afsd_logp, "cm_UpdateVolumeLocation nothing to do, waking others name %s:%s flags 0x%x", 
209                          volp->cellp->name, volp->namep, volp->flags);
210                 osi_Wakeup((LONG_PTR) &volp->flags);
211                 return 0;
212             }
213         }
214
215         /* clear out old bindings */
216         for ( volType = RWVOL; volType < NUM_VOL_TYPES; volType++) {
217             if (volp->vol[volType].serversp)
218                 cm_FreeServerList(&volp->vol[volType].serversp, CM_FREESERVERLIST_DELETE);
219         }
220
221         volp->flags |= CM_VOLUMEFLAG_UPDATING_VL;
222         lock_ReleaseWrite(&volp->rw);
223
224         if (cellp->flags & CM_CELLFLAG_VLSERVER_INVALID)
225             cm_UpdateCell(cellp, 0);
226
227         /* now we have volume structure locked and held; make RPC to fill it */
228         osi_Log2(afsd_logp, "CALL VL_GetEntryByName{UNO} name %s:%s", volp->cellp->name, volp->namep);
229         do {
230             struct rx_connection * rxconnp;
231
232             code = cm_ConnByMServers(cellp->vlServersp, userp, reqp, &connp);
233             if (code) 
234                 continue;
235
236             rxconnp = cm_GetRxConn(connp);
237 #ifdef MULTIHOMED
238             code = VL_GetEntryByNameU(rxconnp, volp->namep, &uvldbEntry);
239             method = 2;
240             if ( code == RXGEN_OPCODE ) 
241 #endif
242             {
243                 code = VL_GetEntryByNameN(rxconnp, volp->namep, &nvldbEntry);
244                 method = 1;
245             }
246             if ( code == RXGEN_OPCODE ) {
247                 code = VL_GetEntryByNameO(rxconnp, volp->namep, &vldbEntry);
248                 method = 0;
249             }
250             rx_PutConnection(rxconnp);
251         } while (cm_Analyze(connp, userp, reqp, NULL, NULL, cellp->vlServersp, NULL, code));
252         code = cm_MapVLRPCError(code, reqp);
253         if ( code )
254             osi_Log3(afsd_logp, "CALL VL_GetEntryByName{UNO} name %s:%s FAILURE, code 0x%x", 
255                       volp->cellp->name, volp->namep, code);
256         else
257             osi_Log2(afsd_logp, "CALL VL_GetEntryByName{UNO} name %s:%s SUCCESS", 
258                       volp->cellp->name, volp->namep);
259     }
260
261     /* We can end up here with code == CM_ERROR_NOSUCHVOLUME if the base volume name
262      * does not exist but there might exist a .readonly volume.  If the base name 
263      * doesn't exist we will not care about the .backup that might be left behind
264      * since there should be no method to access it.  
265      */
266     if (code == CM_ERROR_NOSUCHVOLUME && volp->vol[RWVOL].ID == 0 && strlen(volp->namep) < (VL_MAXNAMELEN - 9)) {
267         char name[VL_MAXNAMELEN];
268
269         snprintf(name, VL_MAXNAMELEN, "%s.readonly", volp->namep);
270                 
271         /* now we have volume structure locked and held; make RPC to fill it */
272         osi_Log2(afsd_logp, "CALL VL_GetEntryByName{UNO} name %s:%s", volp->cellp->name, 
273                  osi_LogSaveString(afsd_logp,name));
274         do {
275             struct rx_connection * rxconnp;
276
277             code = cm_ConnByMServers(cellp->vlServersp, userp, reqp, &connp);
278             if (code) 
279                 continue;
280
281             rxconnp = cm_GetRxConn(connp);
282 #ifdef MULTIHOMED
283             code = VL_GetEntryByNameU(connp->rxconnp, name, &uvldbEntry);
284             method = 2;
285             if ( code == RXGEN_OPCODE ) 
286 #endif
287             {
288                 code = VL_GetEntryByNameN(connp->rxconnp, name, &nvldbEntry);
289                 method = 1;
290             }
291             if ( code == RXGEN_OPCODE ) {
292                 code = VL_GetEntryByNameO(connp->rxconnp, name, &vldbEntry);
293                 method = 0;
294             }
295             rx_PutConnection(rxconnp);
296         } while (cm_Analyze(connp, userp, reqp, NULL, NULL, cellp->vlServersp, NULL, code));
297         code = cm_MapVLRPCError(code, reqp);
298         if ( code )
299             osi_Log3(afsd_logp, "CALL VL_GetEntryByName{UNO} name %s:%s FAILURE, code 0x%x", 
300                       volp->cellp->name, osi_LogSaveString(afsd_logp,name), code);
301         else
302             osi_Log2(afsd_logp, "CALL VL_GetEntryByName{UNO} name %s:%s SUCCESS", 
303                       volp->cellp->name, osi_LogSaveString(afsd_logp,name));
304     }
305     
306     lock_ObtainWrite(&volp->rw);
307     if (code == 0) {
308         afs_int32 flags;
309         afs_int32 nServers;
310         afs_int32 rwID;
311         afs_int32 roID;
312         afs_int32 bkID;
313         afs_int32 serverNumber[NMAXNSERVERS];
314         afs_int32 serverFlags[NMAXNSERVERS];
315         afs_int32 rwServers_alldown = 1;
316         afs_int32 roServers_alldown = 1;
317         afs_int32 bkServers_alldown = 1;
318         char      name[VL_MAXNAMELEN];
319
320 #ifdef AFS_FREELANCE_CLIENT
321         if (freelance)
322             rwServers_alldown = 0;
323 #endif
324
325         switch ( method ) {
326         case 0:
327             flags = vldbEntry.flags;
328             nServers = vldbEntry.nServers;
329             rwID = vldbEntry.volumeId[0];
330             roID = vldbEntry.volumeId[1];
331             bkID = vldbEntry.volumeId[2];
332             for ( i=0; i<nServers; i++ ) {
333                 serverFlags[i] = vldbEntry.serverFlags[i];
334                 serverNumber[i] = vldbEntry.serverNumber[i];
335             }
336             strncpy(name, vldbEntry.name, VL_MAXNAMELEN);
337             name[VL_MAXNAMELEN - 1] = '\0';
338             break;
339         case 1:
340             flags = nvldbEntry.flags;
341             nServers = nvldbEntry.nServers;
342             rwID = nvldbEntry.volumeId[0];
343             roID = nvldbEntry.volumeId[1];
344             bkID = nvldbEntry.volumeId[2];
345             for ( i=0; i<nServers; i++ ) {
346                 serverFlags[i] = nvldbEntry.serverFlags[i];
347                 serverNumber[i] = nvldbEntry.serverNumber[i];
348             }
349             strncpy(name, nvldbEntry.name, VL_MAXNAMELEN);
350             name[VL_MAXNAMELEN - 1] = '\0';
351             break;
352 #ifdef MULTIHOMED
353         case 2:
354             flags = uvldbEntry.flags;
355             nServers = uvldbEntry.nServers;
356             rwID = uvldbEntry.volumeId[0];
357             roID = uvldbEntry.volumeId[1];
358             bkID = uvldbEntry.volumeId[2];
359             for ( i=0, j=0; code == 0 && i<nServers && j<NMAXNSERVERS; i++ ) {
360                 if ( !(uvldbEntry.serverFlags[i] & VLSERVER_FLAG_UUID) ) {
361                     serverFlags[j] = uvldbEntry.serverFlags[i];
362                     serverNumber[j] = uvldbEntry.serverNumber[i].time_low;
363                     j++;
364                 } else {
365                     afs_uint32 * addrp, nentries, code, unique;
366                     bulkaddrs  addrs;
367                     ListAddrByAttributes attrs;
368                     afsUUID uuid;
369
370                     memset((char *)&attrs, 0, sizeof(attrs));
371                     attrs.Mask = VLADDR_UUID;
372                     attrs.uuid = uvldbEntry.serverNumber[i];
373                     memset((char *)&uuid, 0, sizeof(uuid));
374                     memset((char *)&addrs, 0, sizeof(addrs));
375
376                     do {
377                         struct rx_connection *rxconnp;
378
379                         code = cm_ConnByMServers(cellp->vlServersp, userp, reqp, &connp);
380                         if (code) 
381                             continue;
382                    
383                         rxconnp = cm_GetRxConn(connp);
384                         code = VL_GetAddrsU(rxconnp, &attrs, &uuid, &unique, &nentries, &addrs);
385                         rx_PutConnection(rxconnp);
386                     } while (cm_Analyze(connp, userp, reqp, NULL, NULL, cellp->vlServersp, NULL, code));
387
388                     if ( code ) {
389                         code = cm_MapVLRPCError(code, reqp);
390                         osi_Log2(afsd_logp, "CALL VL_GetAddrsU serverNumber %u FAILURE, code 0x%x", 
391                                  i, code);
392                         continue;
393                     } 
394                     osi_Log1(afsd_logp, "CALL VL_GetAddrsU serverNumber %u SUCCESS", i);
395
396                     addrp = addrs.bulkaddrs_val;
397                     for (k = 0; k < nentries && j < NMAXNSERVERS; j++, k++) {
398                         serverFlags[j] = uvldbEntry.serverFlags[i];
399                         serverNumber[j] = addrp[k];
400                     }
401
402                     free(addrs.bulkaddrs_val);  /* This is wrong */
403
404                     if (nentries == 0)
405                         code = CM_ERROR_INVAL;
406                 }
407             }
408             nServers = j;                                       /* update the server count */
409             strncpy(name, uvldbEntry.name, VL_MAXNAMELEN);
410             name[VL_MAXNAMELEN - 1] = '\0';
411             break;
412 #endif
413         }
414
415         /* decode the response */
416         lock_ObtainWrite(&cm_volumeLock);
417         if (cm_VolNameIsID(volp->namep)) {
418             size_t    len;
419
420             len = strlen(name);
421
422             if (len >= 8 && strcmp(name + len - 7, ".backup") == 0) {
423                 name[len - 7] = '\0';
424             } else if (len >= 10 && strcmp(name + len - 9, ".readonly") == 0) {
425                 name[len - 9] = '\0';
426             }
427             
428             osi_Log2(afsd_logp, "cm_UpdateVolume name %s -> %s", volp->namep, name);
429
430             if (volp->flags & CM_VOLUMEFLAG_IN_HASH)
431                 cm_RemoveVolumeFromNameHashTable(volp);
432
433             strcpy(volp->namep, name);
434
435             cm_AddVolumeToNameHashTable(volp);
436         }
437
438         if (flags & VLF_RWEXISTS) {
439             if (volp->vol[RWVOL].ID != rwID) {
440                 if (volp->vol[RWVOL].flags & CM_VOLUMEFLAG_IN_HASH)
441                     cm_RemoveVolumeFromIDHashTable(volp, RWVOL);
442                 volp->vol[RWVOL].ID = rwID;
443                 cm_AddVolumeToIDHashTable(volp, RWVOL);
444             }
445         } else {
446             if (volp->vol[RWVOL].flags & CM_VOLUMEFLAG_IN_HASH)
447                 cm_RemoveVolumeFromIDHashTable(volp, RWVOL);
448             volp->vol[RWVOL].ID = 0;
449         }
450         if (flags & VLF_ROEXISTS) {
451             if (volp->vol[ROVOL].ID != roID) {
452                 if (volp->vol[ROVOL].flags & CM_VOLUMEFLAG_IN_HASH)
453                     cm_RemoveVolumeFromIDHashTable(volp, ROVOL);
454                 volp->vol[ROVOL].ID = roID;
455                 cm_AddVolumeToIDHashTable(volp, ROVOL);
456             }
457         } else {
458             if (volp->vol[ROVOL].flags & CM_VOLUMEFLAG_IN_HASH)
459                 cm_RemoveVolumeFromIDHashTable(volp, ROVOL);
460             volp->vol[ROVOL].ID = 0;
461         }
462         if (flags & VLF_BACKEXISTS) {
463             if (volp->vol[BACKVOL].ID != bkID) {
464                 if (volp->vol[BACKVOL].flags & CM_VOLUMEFLAG_IN_HASH)
465                     cm_RemoveVolumeFromIDHashTable(volp, BACKVOL);
466                 volp->vol[BACKVOL].ID = bkID;
467                 cm_AddVolumeToIDHashTable(volp, BACKVOL);
468             }
469         } else {
470             if (volp->vol[BACKVOL].flags & CM_VOLUMEFLAG_IN_HASH)
471                 cm_RemoveVolumeFromIDHashTable(volp, BACKVOL);
472             volp->vol[BACKVOL].ID = 0;
473         }
474         lock_ReleaseWrite(&cm_volumeLock);
475         for (i=0; i<nServers; i++) {
476             /* create a server entry */
477             tflags = serverFlags[i];
478             if (tflags & VLSF_DONTUSE) 
479                 continue;
480             tsockAddr.sin_family = AF_INET;
481             tempAddr = htonl(serverNumber[i]);
482             tsockAddr.sin_addr.s_addr = tempAddr;
483             tsp = cm_FindServer(&tsockAddr, CM_SERVER_FILE);
484             if (!tsp)
485                 tsp = cm_NewServer(&tsockAddr, CM_SERVER_FILE,
486                                     cellp, 0);
487
488             /* if this server was created by fs setserverprefs */
489             if ( !tsp->cellp ) 
490                 tsp->cellp = cellp;
491
492             osi_assertx(tsp != NULL, "null cm_server_t");
493                         
494             /* and add it to the list(s). */
495             /*
496              * Each call to cm_NewServerRef() increments the
497              * ref count of tsp.  These reference will be dropped,
498              * if and when the volume is reset; see reset code
499              * earlier in this function.
500              */
501             if ((tflags & VLSF_RWVOL) && (flags & VLF_RWEXISTS)) {
502                 tsrp = cm_NewServerRef(tsp, rwID);
503                 cm_InsertServerList(&volp->vol[RWVOL].serversp, tsrp);
504
505                 lock_ObtainWrite(&cm_serverLock);
506                 tsrp->refCount--;       /* drop allocation reference */
507                 lock_ReleaseWrite(&cm_serverLock);
508
509                 if (!(tsp->flags & CM_SERVERFLAG_DOWN))
510                     rwServers_alldown = 0;
511             }
512             if ((tflags & VLSF_ROVOL) && (flags & VLF_ROEXISTS)) {
513                 tsrp = cm_NewServerRef(tsp, roID);
514                 cm_InsertServerList(&volp->vol[ROVOL].serversp, tsrp);
515                 lock_ObtainWrite(&cm_serverLock);
516                 tsrp->refCount--;       /* drop allocation reference */
517                 lock_ReleaseWrite(&cm_serverLock);
518                 ROcount++;
519
520                 if (!(tsp->flags & CM_SERVERFLAG_DOWN))
521                     roServers_alldown = 0;
522             }
523             /* We don't use VLSF_BACKVOL !?! */
524             /* Because only the backup on the server holding the RW 
525              * volume can be valid.  This check prevents errors if a
526              * RW is moved but the old backup is not removed.
527              */
528             if ((tflags & VLSF_RWVOL) && (flags & VLF_BACKEXISTS)) {
529                 tsrp = cm_NewServerRef(tsp, bkID);
530                 cm_InsertServerList(&volp->vol[BACKVOL].serversp, tsrp);
531                 lock_ObtainWrite(&cm_serverLock);
532                 tsrp->refCount--;       /* drop allocation reference */
533                 lock_ReleaseWrite(&cm_serverLock);
534
535                 if (!(tsp->flags & CM_SERVERFLAG_DOWN))
536                     bkServers_alldown = 0;
537             }
538             /* Drop the reference obtained by cm_FindServer() */
539             cm_PutServer(tsp);
540         }       
541
542         /*
543          * Randomize RO list
544          *
545          * If the first n servers have the same ipRank, then we 
546          * randomly pick one among them and move it to the beginning.
547          * We don't bother to re-order the whole list because
548          * the rest of the list is used only if the first server is
549          * down.  We only do this for the RO list; we assume the other
550          * lists are length 1.
551          */
552         if (ROcount > 1) {
553             cm_RandomizeServer(&volp->vol[ROVOL].serversp);
554         }
555
556         rwNewstate = rwServers_alldown ? vl_alldown : vl_online;
557         roNewstate = roServers_alldown ? vl_alldown : vl_online;
558         bkNewstate = bkServers_alldown ? vl_alldown : vl_online;
559     } else if (code == CM_ERROR_NOSUCHVOLUME || code == VL_NOENT) {
560         /* this volume does not exist - we should discard it */
561         if (volp->flags & CM_VOLUMEFLAG_IN_HASH)
562             cm_RemoveVolumeFromNameHashTable(volp);
563         for ( volType = RWVOL; volType < NUM_VOL_TYPES; volType++) {
564             if (volp->vol[volType].flags & CM_VOLUMEFLAG_IN_HASH)
565                 cm_RemoveVolumeFromIDHashTable(volp, volType);
566             if (volp->vol[volType].ID) {
567                 cm_VolumeStatusNotification(volp, volp->vol[volType].ID, volp->vol[volType].state, vl_alldown);
568                 volp->vol[volType].ID = 0;
569             }
570             cm_SetFid(&volp->vol[volType].dotdotFid, 0, 0, 0, 0);
571         }
572
573         /* Move to the end so it will be recycled first */
574         cm_MoveVolumeToLRULast(volp);
575
576         volp->namep[0] ='\0';
577     } else {
578         rwNewstate = roNewstate = bkNewstate = vl_alldown;
579     }
580
581     if (volp->vol[RWVOL].state != rwNewstate) {
582         if (volp->vol[RWVOL].ID)
583             cm_VolumeStatusNotification(volp, volp->vol[RWVOL].ID, volp->vol[RWVOL].state, rwNewstate);
584         volp->vol[RWVOL].state = rwNewstate;
585     }
586     if (volp->vol[ROVOL].state != roNewstate) {
587         if (volp->vol[ROVOL].ID)
588             cm_VolumeStatusNotification(volp, volp->vol[ROVOL].ID, volp->vol[ROVOL].state, roNewstate);
589         volp->vol[ROVOL].state = roNewstate;
590     }
591     if (volp->vol[BACKVOL].state != bkNewstate) {
592         if (volp->vol[BACKVOL].ID)
593             cm_VolumeStatusNotification(volp, volp->vol[BACKVOL].ID, volp->vol[BACKVOL].state, bkNewstate);
594         volp->vol[BACKVOL].state = bkNewstate;
595     }
596
597     if (code == 0)
598         volp->flags &= ~CM_VOLUMEFLAG_RESET;
599
600     volp->flags &= ~CM_VOLUMEFLAG_UPDATING_VL;
601     osi_Log4(afsd_logp, "cm_UpdateVolumeLocation done, waking others name %s:%s flags 0x%x code 0x%x", 
602              volp->cellp->name, volp->namep, volp->flags, code);
603     osi_Wakeup((LONG_PTR) &volp->flags);
604
605     return code;
606 }
607
608 /* Requires read or write lock on cm_volumeLock */
609 void cm_GetVolume(cm_volume_t *volp)
610 {
611     InterlockedIncrement(&volp->refCount);
612 }
613
614 cm_volume_t *cm_GetVolumeByFID(cm_fid_t *fidp)
615 {
616     cm_volume_t *volp;
617     afs_uint32 hash;
618
619     lock_ObtainRead(&cm_volumeLock);
620     hash = CM_VOLUME_ID_HASH(fidp->volume);
621     /* The volumeID can be any one of the three types.  So we must
622      * search the hash table for all three types until we find it.
623      * We will search in the order of RO, RW, BK.
624      */
625     for ( volp = cm_data.volumeROIDHashTablep[hash]; volp; volp = volp->vol[ROVOL].nextp) {
626         if ( fidp->cell == volp->cellp->cellID && fidp->volume == volp->vol[ROVOL].ID )
627             break;
628     }
629     if (!volp) {
630         /* try RW volumes */
631         for ( volp = cm_data.volumeRWIDHashTablep[hash]; volp; volp = volp->vol[RWVOL].nextp) {
632             if ( fidp->cell == volp->cellp->cellID && fidp->volume == volp->vol[RWVOL].ID )
633                 break;
634         }
635     }
636     if (!volp) {
637         /* try BK volumes */
638         for ( volp = cm_data.volumeBKIDHashTablep[hash]; volp; volp = volp->vol[BACKVOL].nextp) {
639             if ( fidp->cell == volp->cellp->cellID && fidp->volume == volp->vol[BACKVOL].ID )
640                 break;
641         }
642     }
643
644     /* hold the volume if we found it */
645     if (volp) 
646         cm_GetVolume(volp);
647         
648     lock_ReleaseRead(&cm_volumeLock);
649     return volp;
650 }
651
652 long cm_FindVolumeByID(cm_cell_t *cellp, afs_uint32 volumeID, cm_user_t *userp,
653                       cm_req_t *reqp, afs_uint32 flags, cm_volume_t **outVolpp)
654 {
655     cm_volume_t *volp;
656 #ifdef SEARCH_ALL_VOLUMES
657     cm_volume_t *volp2;
658 #endif
659     char volNameString[VL_MAXNAMELEN];
660     afs_uint32 hash;
661     long code = 0;
662
663     lock_ObtainRead(&cm_volumeLock);
664 #ifdef SEARCH_ALL_VOLUMES
665     for(volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
666         if (cellp == volp->cellp &&
667              ((unsigned) volumeID == volp->vol[RWVOL].ID ||
668                (unsigned) volumeID == volp->vol[ROVOL].ID ||
669                (unsigned) volumeID == volp->vol[BACKVOL].ID))
670             break;
671     }   
672
673     volp2 = volp;
674 #endif /* SEARCH_ALL_VOLUMES */
675
676     hash = CM_VOLUME_ID_HASH(volumeID);
677     /* The volumeID can be any one of the three types.  So we must
678      * search the hash table for all three types until we find it.
679      * We will search in the order of RO, RW, BK.
680      */
681     for ( volp = cm_data.volumeROIDHashTablep[hash]; volp; volp = volp->vol[ROVOL].nextp) {
682         if ( cellp == volp->cellp && volumeID == volp->vol[ROVOL].ID )
683             break;
684     }
685     if (!volp) {
686         /* try RW volumes */
687         for ( volp = cm_data.volumeRWIDHashTablep[hash]; volp; volp = volp->vol[RWVOL].nextp) {
688             if ( cellp == volp->cellp && volumeID == volp->vol[RWVOL].ID )
689                 break;
690         }
691     }
692     if (!volp) {
693         /* try BK volumes */
694         for ( volp = cm_data.volumeBKIDHashTablep[hash]; volp; volp = volp->vol[BACKVOL].nextp) {
695             if ( cellp == volp->cellp && volumeID == volp->vol[BACKVOL].ID )
696                 break;
697         }
698     }
699
700 #ifdef SEARCH_ALL_VOLUMES
701     osi_assertx(volp == volp2, "unexpected cm_vol_t");
702 #endif
703
704     /* hold the volume if we found it */
705     if (volp) 
706         cm_GetVolume(volp);
707         
708     lock_ReleaseRead(&cm_volumeLock);
709
710     /* return it held */
711     if (volp) {
712         lock_ObtainWrite(&volp->rw);
713         
714         code = 0;
715         if ((volp->flags & CM_VOLUMEFLAG_RESET) && !(flags & CM_GETVOL_FLAG_NO_RESET)) {
716             code = cm_UpdateVolumeLocation(cellp, userp, reqp, volp);
717         }
718         lock_ReleaseWrite(&volp->rw);
719         if (code == 0) {
720             *outVolpp = volp;
721
722             if (!(flags & CM_GETVOL_FLAG_NO_LRU_UPDATE)) {
723                 lock_ObtainWrite(&cm_volumeLock);
724                 cm_AdjustVolumeLRU(volp);
725                 lock_ReleaseWrite(&cm_volumeLock);
726             }
727         } else {
728             lock_ObtainRead(&cm_volumeLock);
729             cm_PutVolume(volp);
730             lock_ReleaseRead(&cm_volumeLock);
731         }
732         return code;
733     }
734         
735     /* otherwise, we didn't find it so consult the VLDB */
736     sprintf(volNameString, "%u", volumeID);
737     code = cm_FindVolumeByName(cellp, volNameString, userp, reqp,
738                               flags, outVolpp);
739     return code;
740 }
741
742
743 long cm_FindVolumeByName(struct cm_cell *cellp, char *volumeNamep,
744                         struct cm_user *userp, struct cm_req *reqp,
745                         afs_uint32 flags, cm_volume_t **outVolpp)
746 {
747     cm_volume_t *volp;
748 #ifdef SEARCH_ALL_VOLUMES
749     cm_volume_t *volp2;
750 #endif
751     long        code = 0;
752     char        name[VL_MAXNAMELEN];
753     size_t      len;
754     int         type;
755     afs_uint32  hash;
756
757     strncpy(name, volumeNamep, VL_MAXNAMELEN);
758     name[VL_MAXNAMELEN-1] = '\0';
759     len = strlen(name);
760
761     if (len >= 8 && strcmp(name + len - 7, ".backup") == 0) {
762         type = BACKVOL;
763         name[len - 7] = '\0';
764     } else if (len >= 10 && strcmp(name + len - 9, ".readonly") == 0) {
765         type = ROVOL;
766         name[len - 9] = '\0';
767     } else {
768         type = RWVOL;
769     }
770
771     lock_ObtainRead(&cm_volumeLock);
772 #ifdef SEARCH_ALL_VOLUMES
773     for (volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
774         if (cellp == volp->cellp && strcmp(name, volp->namep) == 0) {
775             break;
776         }
777     }   
778     volp2 = volp;
779 #endif /* SEARCH_ALL_VOLUMES */
780
781     hash = CM_VOLUME_NAME_HASH(name);
782     for (volp = cm_data.volumeNameHashTablep[hash]; volp; volp = volp->nameNextp) {
783         if (cellp == volp->cellp && strcmp(name, volp->namep) == 0)
784             break;
785     }
786
787 #ifdef SEARCH_ALL_VOLUMES
788     osi_assertx(volp2 == volp, "unexpected cm_vol_t");
789 #endif
790
791     if (!volp && (flags & CM_GETVOL_FLAG_CREATE)) {
792         afs_uint32 volType;
793         /* otherwise, get from VLDB */
794
795         if ( cm_data.currentVolumes >= cm_data.maxVolumes ) {
796 #ifdef RECYCLE_FROM_ALL_VOLUMES_LIST
797             for (volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
798                 if ( volp->refCount == 0 ) {
799                     /* There is one we can re-use */
800                     break;
801                 }
802             }
803 #else
804             for ( volp = cm_data.volumeLRULastp;
805                   volp;
806                   volp = (cm_volume_t *) osi_QPrev(&volp->q)) 
807             {
808                 if ( volp->refCount == 0 ) {
809                     /* There is one we can re-use */
810                     break;
811                 }
812             }
813 #endif
814             if (!volp)
815                 osi_panic("Exceeded Max Volumes", __FILE__, __LINE__);
816
817             lock_ReleaseRead(&cm_volumeLock);
818             lock_ObtainWrite(&volp->rw);
819             lock_ObtainWrite(&cm_volumeLock);
820
821             osi_Log2(afsd_logp, "Recycling Volume %s:%s",
822                      volp->cellp->name, volp->namep);
823
824             if (volp->flags & CM_VOLUMEFLAG_IN_LRU_QUEUE)
825                 cm_RemoveVolumeFromLRU(volp);
826             if (volp->flags & CM_VOLUMEFLAG_IN_HASH)
827                 cm_RemoveVolumeFromNameHashTable(volp);
828
829             for ( volType = RWVOL; volType < NUM_VOL_TYPES; volType++) {
830                 if (volp->vol[volType].flags & CM_VOLUMEFLAG_IN_HASH)
831                     cm_RemoveVolumeFromIDHashTable(volp, volType);
832                 if (volp->vol[volType].ID)
833                     cm_VolumeStatusNotification(volp, volp->vol[volType].ID, volp->vol[volType].state, vl_unknown);
834                 volp->vol[volType].ID = 0;
835                 cm_SetFid(&volp->vol[volType].dotdotFid, 0, 0, 0, 0);
836             }
837         } else {
838             volp = &cm_data.volumeBaseAddress[cm_data.currentVolumes++];
839             memset(volp, 0, sizeof(cm_volume_t));
840             volp->magic = CM_VOLUME_MAGIC;
841             volp->allNextp = cm_data.allVolumesp;
842             cm_data.allVolumesp = volp;
843             lock_InitializeRWLock(&volp->rw, "cm_volume_t rwlock");
844             lock_ReleaseRead(&cm_volumeLock);
845             lock_ObtainWrite(&volp->rw);
846             lock_ObtainWrite(&cm_volumeLock);
847         }
848         volp->cellp = cellp;
849         strncpy(volp->namep, name, VL_MAXNAMELEN);
850         volp->namep[VL_MAXNAMELEN-1] = '\0';
851         volp->refCount = 1;     /* starts off held */
852         volp->flags = CM_VOLUMEFLAG_RESET;
853     
854         for ( volType = RWVOL; volType < NUM_VOL_TYPES; volType++) {
855             volp->vol[volType].state = vl_unknown;
856             volp->vol[volType].nextp = NULL;
857             volp->vol[volType].flags = 0;
858         }
859         volp->cbExpiresRO = 0;
860         cm_AddVolumeToNameHashTable(volp);
861         lock_ReleaseWrite(&cm_volumeLock);
862     }
863     else {
864         if (volp)
865             cm_GetVolume(volp);
866         lock_ReleaseRead(&cm_volumeLock);
867         
868         if (!volp)
869             return CM_ERROR_NOSUCHVOLUME;
870
871         lock_ObtainWrite(&volp->rw);
872     }
873
874     /* if we get here we are holding the mutex */
875     if ((volp->flags & CM_VOLUMEFLAG_RESET) && !(flags & CM_GETVOL_FLAG_NO_RESET)) {
876         code = cm_UpdateVolumeLocation(cellp, userp, reqp, volp);
877     }   
878     lock_ReleaseWrite(&volp->rw);
879
880     if (code == 0 && (type == BACKVOL && volp->vol[BACKVOL].ID == 0 ||
881                       type == ROVOL && volp->vol[ROVOL].ID == 0))
882         code = CM_ERROR_NOSUCHVOLUME;
883
884     if (code == 0) {
885         *outVolpp = volp;
886                 
887         if (!(flags & CM_GETVOL_FLAG_NO_LRU_UPDATE)) {
888             lock_ObtainWrite(&cm_volumeLock);
889             cm_AdjustVolumeLRU(volp);
890             lock_ReleaseWrite(&cm_volumeLock);
891         }
892     } else {
893         lock_ObtainRead(&cm_volumeLock);
894         cm_PutVolume(volp);
895         lock_ReleaseRead(&cm_volumeLock);
896     }
897     return code;
898 }       
899
900 void cm_ForceUpdateVolume(cm_fid_t *fidp, cm_user_t *userp, cm_req_t *reqp)
901 {
902     cm_cell_t *cellp;
903     cm_volume_t *volp;
904 #ifdef SEARCH_ALL_VOLUMES
905     cm_volume_t *volp2;
906 #endif
907     afs_uint32  hash;
908
909     if (!fidp) return;
910
911     cellp = cm_FindCellByID(fidp->cell, 0);
912     if (!cellp) return;
913
914     /* search for the volume */
915     lock_ObtainRead(&cm_volumeLock);
916 #ifdef SEARCH_ALL_VOLUMES
917     for(volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
918         if (cellp == volp->cellp &&
919              (fidp->volume == volp->vol[RWVOL].ID ||
920                fidp->volume == volp->vol[ROVOL].ID ||
921                fidp->volume == volp->vol[BACKVOL].ID))
922             break;
923     }   
924 #endif /* SEARCH_ALL_VOLUMES */
925
926     hash = CM_VOLUME_ID_HASH(fidp->volume);
927     /* The volumeID can be any one of the three types.  So we must
928      * search the hash table for all three types until we find it.
929      * We will search in the order of RO, RW, BK.
930      */
931     for ( volp = cm_data.volumeROIDHashTablep[hash]; volp; volp = volp->vol[ROVOL].nextp) {
932         if ( cellp == volp->cellp && fidp->volume == volp->vol[ROVOL].ID )
933             break;
934     }
935     if (!volp) {
936         /* try RW volumes */
937         for ( volp = cm_data.volumeRWIDHashTablep[hash]; volp; volp = volp->vol[RWVOL].nextp) {
938             if ( cellp == volp->cellp && fidp->volume == volp->vol[RWVOL].ID )
939                 break;
940         }
941     }
942     if (!volp) {
943         /* try BK volumes */
944         for ( volp = cm_data.volumeBKIDHashTablep[hash]; volp; volp = volp->vol[BACKVOL].nextp) {
945             if ( cellp == volp->cellp && fidp->volume == volp->vol[BACKVOL].ID )
946                 break;
947         }
948     }
949
950 #ifdef SEARCH_ALL_VOLUMES
951     osi_assertx(volp == volp2, "unexpected cm_vol_t");
952 #endif
953     /* hold the volume if we found it */
954     if (volp) 
955         cm_GetVolume(volp);
956
957     lock_ReleaseRead(&cm_volumeLock);
958
959     if (!volp)
960         return;
961
962     /* update it */
963     cm_data.mountRootGen = time(NULL);
964     lock_ObtainWrite(&volp->rw);
965     volp->flags |= CM_VOLUMEFLAG_RESET;
966 #ifdef COMMENT
967     /* Mark the volume to be updated but don't update it now.
968      * This function is called only from within cm_Analyze
969      * when cm_ConnByMServers has failed with all servers down
970      * The problem is that cm_UpdateVolume is going to call
971      * cm_ConnByMServers which may cause a recursive chain
972      * of calls each returning a retry on failure.
973      * Instead, set the flag so the next time the volume is
974      * accessed by Name or ID the UpdateVolume call will
975      * occur.
976      */
977     code = cm_UpdateVolumeLocation(cellp, userp, reqp, volp);
978 #endif
979     lock_ReleaseWrite(&volp->rw);
980
981     lock_ObtainRead(&cm_volumeLock);
982     cm_PutVolume(volp);
983     lock_ReleaseRead(&cm_volumeLock);
984 }
985
986 /* find the appropriate servers from a volume */
987 cm_serverRef_t **cm_GetVolServers(cm_volume_t *volp, afs_uint32 volume)
988 {
989     cm_serverRef_t **serverspp;
990     cm_serverRef_t *current;;
991
992     lock_ObtainWrite(&cm_serverLock);
993
994     if (volume == volp->vol[RWVOL].ID)
995         serverspp = &volp->vol[RWVOL].serversp;
996     else if (volume == volp->vol[ROVOL].ID)
997         serverspp = &volp->vol[ROVOL].serversp;
998     else if (volume == volp->vol[BACKVOL].ID)
999         serverspp = &volp->vol[BACKVOL].serversp;
1000     else 
1001         osi_panic("bad volume ID in cm_GetVolServers", __FILE__, __LINE__);
1002         
1003     for (current = *serverspp; current; current = current->next)
1004         current->refCount++;
1005
1006     lock_ReleaseWrite(&cm_serverLock);
1007
1008     return serverspp;
1009 }
1010
1011 void cm_PutVolume(cm_volume_t *volp)
1012 {
1013     afs_int32 refCount = InterlockedDecrement(&volp->refCount);
1014     osi_assertx(refCount >= 0, "cm_volume_t refCount underflow has occurred");
1015 }
1016
1017 /* return the read-only volume, if there is one, or the read-write volume if
1018  * not.
1019  */
1020 long cm_GetROVolumeID(cm_volume_t *volp)
1021 {
1022     long id;
1023
1024     lock_ObtainRead(&volp->rw);
1025     if (volp->vol[ROVOL].ID && volp->vol[ROVOL].serversp)
1026         id = volp->vol[ROVOL].ID;
1027     else
1028         id = volp->vol[RWVOL].ID;
1029     lock_ReleaseRead(&volp->rw);
1030
1031     return id;
1032 }
1033
1034 void cm_RefreshVolumes(void)
1035 {
1036     cm_volume_t *volp;
1037     cm_scache_t *scp;
1038     afs_int32 refCount;
1039
1040     cm_data.mountRootGen = time(NULL);
1041
1042     /* force a re-loading of volume data from the vldb */
1043     lock_ObtainRead(&cm_volumeLock);
1044     for (volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
1045         InterlockedIncrement(&volp->refCount);
1046         lock_ReleaseRead(&cm_volumeLock);
1047
1048         lock_ObtainWrite(&volp->rw);
1049         volp->flags |= CM_VOLUMEFLAG_RESET;
1050         lock_ReleaseWrite(&volp->rw);
1051         
1052         lock_ObtainRead(&cm_volumeLock);
1053         refCount = InterlockedDecrement(&volp->refCount);
1054         osi_assertx(refCount >= 0, "cm_volume_t refCount underflow");
1055     }
1056     lock_ReleaseRead(&cm_volumeLock);
1057
1058     /* force mount points to be re-evaluated so that 
1059      * if the volume location has changed we will pick 
1060      * that up
1061      */
1062     for ( scp = cm_data.scacheLRUFirstp; 
1063           scp;
1064           scp = (cm_scache_t *) osi_QNext(&scp->q)) {
1065         if ( scp->fileType == CM_SCACHETYPE_MOUNTPOINT 
1066 #ifdef AFS_FREELANCE_CLIENT
1067              && !(scp->fid.cell == AFS_FAKE_ROOT_CELL_ID && scp->fid.volume == AFS_FAKE_ROOT_VOL_ID)
1068 #endif
1069              ) {
1070             lock_ObtainWrite(&scp->rw);
1071             scp->mountPointStringp[0] = '\0';
1072             lock_ReleaseWrite(&scp->rw);
1073         }
1074     }
1075
1076 }
1077
1078
1079 /* The return code is 0 if the volume is not online and 
1080  * 1 if the volume is online
1081  */
1082 long
1083 cm_CheckOfflineVolume(cm_volume_t *volp, afs_uint32 volID)
1084 {
1085     cm_conn_t *connp;
1086     long code;
1087     AFSFetchVolumeStatus volStat;
1088     char *Name;
1089     char *OfflineMsg;
1090     char *MOTD;
1091     cm_req_t req;
1092     struct rx_connection * rxconnp;
1093     char volName[32];
1094     char offLineMsg[256];
1095     char motd[256];
1096     long online = 0;
1097     cm_serverRef_t *serversp;
1098
1099     Name = volName;
1100     OfflineMsg = offLineMsg;
1101     MOTD = motd;
1102
1103     lock_ObtainWrite(&volp->rw);
1104
1105     if (volp->flags & CM_VOLUMEFLAG_RESET) {
1106         cm_InitReq(&req);
1107         code = cm_UpdateVolumeLocation(volp->cellp, cm_rootUserp, &req, volp);
1108     }
1109
1110     if (volp->vol[RWVOL].ID != 0 && (!volID || volID == volp->vol[RWVOL].ID) &&
1111          volp->vol[RWVOL].serversp) {
1112        
1113         for (serversp = volp->vol[RWVOL].serversp; serversp; serversp = serversp->next) {
1114             if (serversp->status == srv_busy || serversp->status == srv_offline) {
1115                 serversp->status = srv_not_busy;
1116                 online = 1;
1117             }
1118         }
1119
1120         if (volp->vol[RWVOL].state == vl_busy || volp->vol[RWVOL].state == vl_offline || volp->vol[RWVOL].state == vl_unknown) {
1121             cm_InitReq(&req);
1122
1123             lock_ReleaseWrite(&volp->rw);
1124             do {
1125                 code = cm_ConnFromVolume(volp, volp->vol[RWVOL].ID, cm_rootUserp, &req, &connp);
1126                 if (code) 
1127                     continue;
1128
1129                 rxconnp = cm_GetRxConn(connp);
1130                 code = RXAFS_GetVolumeStatus(rxconnp, volp->vol[RWVOL].ID,
1131                                              &volStat, &Name, &OfflineMsg, &MOTD);
1132                 rx_PutConnection(rxconnp);            
1133
1134             } while (cm_Analyze(connp, cm_rootUserp, &req, NULL, NULL, NULL, NULL, code));
1135             code = cm_MapRPCError(code, &req);
1136
1137             lock_ObtainWrite(&volp->rw);
1138             if (code == 0 && volStat.Online) {
1139                 cm_VolumeStatusNotification(volp, volp->vol[RWVOL].ID, volp->vol[RWVOL].state, vl_online);
1140                 volp->vol[RWVOL].state = vl_online;
1141                 online = 1;
1142             } else if (code == CM_ERROR_NOACCESS) {
1143                 cm_VolumeStatusNotification(volp, volp->vol[RWVOL].ID, volp->vol[RWVOL].state, vl_unknown);
1144                 volp->vol[RWVOL].state = vl_unknown;
1145                 online = 1;
1146             }
1147         }
1148     }
1149
1150     if (volp->vol[ROVOL].ID != 0 && (!volID || volID == volp->vol[ROVOL].ID) &&
1151          volp->vol[ROVOL].serversp) {
1152
1153         for (serversp = volp->vol[ROVOL].serversp; serversp; serversp = serversp->next) {
1154             if (serversp->status == srv_busy || serversp->status == srv_offline) {
1155                 serversp->status = srv_not_busy;
1156                 online = 1;
1157             }
1158         }
1159
1160         if (volp->vol[ROVOL].state == vl_busy || volp->vol[ROVOL].state == vl_offline || volp->vol[ROVOL].state == vl_unknown) {
1161             cm_InitReq(&req);
1162
1163             lock_ReleaseWrite(&volp->rw);
1164             do {
1165                 code = cm_ConnFromVolume(volp, volp->vol[ROVOL].ID, cm_rootUserp, &req, &connp);
1166                 if (code) 
1167                     continue;
1168
1169                 rxconnp = cm_GetRxConn(connp);
1170                 code = RXAFS_GetVolumeStatus(rxconnp, volp->vol[ROVOL].ID,
1171                                               &volStat, &Name, &OfflineMsg, &MOTD);
1172                 rx_PutConnection(rxconnp);        
1173
1174             } while (cm_Analyze(connp, cm_rootUserp, &req, NULL, NULL, NULL, NULL, code));
1175             code = cm_MapRPCError(code, &req);
1176
1177             lock_ObtainWrite(&volp->rw);
1178             if (code == 0 && volStat.Online) {
1179                 cm_VolumeStatusNotification(volp, volp->vol[ROVOL].ID, volp->vol[ROVOL].state, vl_online);
1180                 volp->vol[ROVOL].state = vl_online;
1181                 online = 1;
1182             } else if (code == CM_ERROR_NOACCESS) {
1183                 cm_VolumeStatusNotification(volp, volp->vol[ROVOL].ID, volp->vol[ROVOL].state, vl_unknown);
1184                 volp->vol[ROVOL].state = vl_unknown;
1185                 online = 1;
1186             }
1187         }
1188     }
1189
1190     if (volp->vol[BACKVOL].ID != 0 && (!volID || volID == volp->vol[BACKVOL].ID) &&
1191          volp->vol[BACKVOL].serversp) {
1192         
1193         for (serversp = volp->vol[BACKVOL].serversp; serversp; serversp = serversp->next) {
1194             if (serversp->status == srv_busy || serversp->status == srv_offline) {
1195                 serversp->status = srv_not_busy;
1196                 online = 1;
1197             }
1198         }
1199
1200         if (volp->vol[BACKVOL].state == vl_busy || volp->vol[BACKVOL].state == vl_offline || volp->vol[BACKVOL].state == vl_unknown) {
1201             cm_InitReq(&req);
1202
1203             lock_ReleaseWrite(&volp->rw);
1204             do {
1205                 code = cm_ConnFromVolume(volp, volp->vol[BACKVOL].ID, cm_rootUserp, &req, &connp);
1206                 if (code) 
1207                     continue;
1208
1209                 rxconnp = cm_GetRxConn(connp);
1210                 code = RXAFS_GetVolumeStatus(rxconnp, volp->vol[BACKVOL].ID,
1211                                               &volStat, &Name, &OfflineMsg, &MOTD);
1212                 rx_PutConnection(rxconnp);        
1213
1214             } while (cm_Analyze(connp, cm_rootUserp, &req, NULL, NULL, NULL, NULL, code));
1215             code = cm_MapRPCError(code, &req);
1216
1217             lock_ObtainWrite(&volp->rw);
1218             if (code == 0 && volStat.Online) {
1219                 cm_VolumeStatusNotification(volp, volp->vol[BACKVOL].ID, volp->vol[BACKVOL].state, vl_online);
1220                 volp->vol[BACKVOL].state = vl_online;
1221                 online = 1;
1222             } else if (code == CM_ERROR_NOACCESS) {
1223                 cm_VolumeStatusNotification(volp, volp->vol[BACKVOL].ID, volp->vol[BACKVOL].state, vl_unknown);
1224                 volp->vol[BACKVOL].state = vl_unknown;
1225                 online = 1;
1226             }
1227         }
1228     }
1229
1230     lock_ReleaseWrite(&volp->rw);
1231     return online;
1232 }
1233
1234
1235 /* called from the Daemon thread */
1236 void cm_CheckOfflineVolumes(void)
1237 {
1238     cm_volume_t *volp;
1239     afs_int32 refCount;
1240
1241     lock_ObtainRead(&cm_volumeLock);
1242     for (volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
1243         if (volp->flags & CM_VOLUMEFLAG_IN_HASH) {
1244             InterlockedIncrement(&volp->refCount);
1245             lock_ReleaseRead(&cm_volumeLock);
1246             cm_CheckOfflineVolume(volp, 0);
1247             lock_ObtainRead(&cm_volumeLock);
1248             refCount = InterlockedDecrement(&volp->refCount);
1249             osi_assertx(refCount >= 0, "cm_volume_t refCount underflow");
1250         }
1251     }
1252     lock_ReleaseRead(&cm_volumeLock);
1253 }
1254
1255
1256 static void
1257 cm_UpdateVolumeStatusInt(cm_volume_t *volp, struct cm_vol_state *statep)
1258 {
1259     enum volstatus newStatus;
1260     cm_serverRef_t *tsrp;
1261     cm_server_t *tsp;
1262     int someBusy = 0, someOffline = 0, allOffline = 1, allBusy = 1, allDown = 1;
1263
1264     if (!volp || !statep) {
1265 #ifdef DEBUG
1266         DebugBreak();
1267 #endif
1268         return;
1269     }
1270
1271     lock_ObtainWrite(&cm_serverLock);
1272     for (tsrp = statep->serversp; tsrp; tsrp=tsrp->next) {
1273         tsp = tsrp->server;
1274         cm_GetServerNoLock(tsp);
1275         if (!(tsp->flags & CM_SERVERFLAG_DOWN)) {
1276             allDown = 0;
1277             if (tsrp->status == srv_busy) {
1278                 allOffline = 0;
1279                 someBusy = 1;
1280             } else if (tsrp->status == srv_offline) {
1281                 allBusy = 0;
1282                 someOffline = 1;
1283             } else {
1284                 allOffline = 0;
1285                 allBusy = 0;
1286             }
1287         }
1288         cm_PutServerNoLock(tsp);
1289     }   
1290     lock_ReleaseWrite(&cm_serverLock);
1291
1292     if (allDown)
1293         newStatus = vl_alldown;
1294     else if (allBusy || (someBusy && someOffline)) 
1295         newStatus = vl_busy;
1296     else if (allOffline)
1297         newStatus = vl_offline;
1298     else
1299         newStatus = vl_online;
1300
1301     if (statep->ID && statep->state != newStatus)
1302         cm_VolumeStatusNotification(volp, statep->ID, statep->state, newStatus);
1303
1304     statep->state = newStatus;
1305 }
1306
1307 void
1308 cm_UpdateVolumeStatus(cm_volume_t *volp, afs_uint32 volID)
1309 {
1310
1311     if (volp->vol[RWVOL].ID == volID) {
1312         cm_UpdateVolumeStatusInt(volp, &volp->vol[RWVOL]);
1313     } else if (volp->vol[ROVOL].ID == volID) {
1314         cm_UpdateVolumeStatusInt(volp, &volp->vol[ROVOL]);
1315     } else if (volp->vol[BACKVOL].ID == volID) {
1316         cm_UpdateVolumeStatusInt(volp, &volp->vol[BACKVOL]);
1317     } else {
1318         /*
1319          * If we are called with volID == 0 then something has gone wrong.
1320          * Most likely a race occurred in the server volume list maintenance.
1321          * Since we don't know which volume's status should be updated, 
1322          * just update all of them that are known to exist.  Better to be 
1323          * correct than fast.
1324          */
1325         afs_uint32 volType;
1326         for ( volType = RWVOL; volType < NUM_VOL_TYPES; volType++) {
1327             if (volp->vol[volType].ID != 0)
1328                 cm_UpdateVolumeStatusInt(volp, &volp->vol[volType]);
1329         }
1330     }
1331 }
1332
1333 /*
1334 ** Finds all volumes that reside on this server and reorders their
1335 ** RO list according to the changed rank of server.
1336 */
1337 void cm_ChangeRankVolume(cm_server_t *tsp)
1338 {       
1339     int                 code;
1340     cm_volume_t*        volp;
1341     afs_int32 refCount;
1342
1343     /* find volumes which might have RO copy on server*/
1344     lock_ObtainRead(&cm_volumeLock);
1345     for(volp = cm_data.allVolumesp; volp; volp=volp->allNextp)
1346     {
1347         code = 1 ;      /* assume that list is unchanged */
1348         InterlockedIncrement(&volp->refCount);
1349         lock_ReleaseRead(&cm_volumeLock);
1350         lock_ObtainWrite(&volp->rw);
1351
1352         if ((tsp->cellp==volp->cellp) && (volp->vol[ROVOL].serversp))
1353             code =cm_ChangeRankServer(&volp->vol[ROVOL].serversp, tsp);
1354
1355         /* this volume list was changed */
1356         if ( !code )
1357             cm_RandomizeServer(&volp->vol[ROVOL].serversp);
1358
1359         lock_ReleaseWrite(&volp->rw);
1360         lock_ObtainRead(&cm_volumeLock);
1361         refCount = InterlockedDecrement(&volp->refCount);
1362         osi_assertx(refCount >= 0, "cm_volume_t refCount underflow");
1363     }
1364     lock_ReleaseRead(&cm_volumeLock);
1365 }       
1366
1367 /* dump all volumes that have reference count > 0 to a file. 
1368  * cookie is used to identify this batch for easy parsing, 
1369  * and it a string provided by a caller 
1370  */
1371 int cm_DumpVolumes(FILE *outputFile, char *cookie, int lock)
1372 {
1373     int zilch;
1374     cm_volume_t *volp;
1375     char output[1024];
1376   
1377     if (lock) {
1378         lock_ObtainRead(&cm_scacheLock);
1379         lock_ObtainRead(&cm_volumeLock);
1380     }
1381   
1382     sprintf(output, "%s - dumping volumes - cm_data.currentVolumes=%d, cm_data.maxVolumes=%d\r\n", cookie, cm_data.currentVolumes, cm_data.maxVolumes);
1383     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1384   
1385     for (volp = cm_data.allVolumesp; volp; volp=volp->allNextp)
1386     {
1387         sprintf(output, "%s - volp=0x%p cell=%s name=%s rwID=%u roID=%u bkID=%u flags=0x%x refCount=%u\r\n", 
1388                  cookie, volp, volp->cellp->name, volp->namep, volp->vol[RWVOL].ID, volp->vol[ROVOL].ID, volp->vol[BACKVOL].ID, volp->flags, 
1389                  volp->refCount);
1390         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1391     }
1392     sprintf(output, "%s - Done dumping volumes.\r\n", cookie);
1393     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1394   
1395     if (lock) {
1396         lock_ReleaseRead(&cm_volumeLock);
1397         lock_ReleaseRead(&cm_scacheLock);
1398     }
1399     return (0);     
1400 }
1401
1402
1403 /* 
1404  * String hash function used by SDBM project.
1405  * It was chosen because it is fast and provides
1406  * decent coverage.
1407  */
1408 afs_uint32 SDBMHash(const char * str)
1409 {
1410     afs_uint32 hash = 0;
1411     size_t i, len;
1412
1413     if (str == NULL)
1414         return 0;
1415
1416     for(i = 0, len = strlen(str); i < len; i++)
1417     {
1418         hash = str[i] + (hash << 6) + (hash << 16) - hash;
1419     }
1420
1421     return (hash & 0x7FFFFFFF);
1422 }
1423
1424 /* call with volume write-locked and mutex held */
1425 void cm_AddVolumeToNameHashTable(cm_volume_t *volp)
1426 {
1427     int i;
1428     
1429     if (volp->flags & CM_VOLUMEFLAG_IN_HASH)
1430         return;
1431
1432     i = CM_VOLUME_NAME_HASH(volp->namep);
1433
1434     volp->nameNextp = cm_data.volumeNameHashTablep[i];
1435     cm_data.volumeNameHashTablep[i] = volp;
1436     volp->flags |= CM_VOLUMEFLAG_IN_HASH;
1437 }
1438
1439 /* call with volume write-locked and mutex held */
1440 void cm_RemoveVolumeFromNameHashTable(cm_volume_t *volp)
1441 {
1442     cm_volume_t **lvolpp;
1443     cm_volume_t *tvolp;
1444     int i;
1445         
1446     if (volp->flags & CM_VOLUMEFLAG_IN_HASH) {
1447         /* hash it out first */
1448         i = CM_VOLUME_NAME_HASH(volp->namep);
1449         for (lvolpp = &cm_data.volumeNameHashTablep[i], tvolp = cm_data.volumeNameHashTablep[i];
1450              tvolp;
1451              lvolpp = &tvolp->nameNextp, tvolp = tvolp->nameNextp) {
1452             if (tvolp == volp) {
1453                 *lvolpp = volp->nameNextp;
1454                 volp->flags &= ~CM_VOLUMEFLAG_IN_HASH;
1455                 volp->nameNextp = NULL;
1456                 break;
1457             }
1458         }
1459     }
1460 }
1461
1462 /* call with volume write-locked and mutex held */
1463 void cm_AddVolumeToIDHashTable(cm_volume_t *volp, afs_uint32 volType)
1464 {
1465     int i;
1466     struct cm_vol_state * statep;
1467
1468     statep = cm_VolumeStateByType(volp, volType);
1469
1470     if (statep->flags & CM_VOLUMEFLAG_IN_HASH)
1471         return;
1472
1473     i = CM_VOLUME_ID_HASH(statep->ID);
1474
1475     switch (volType) {
1476     case RWVOL:
1477         statep->nextp = cm_data.volumeRWIDHashTablep[i];
1478         cm_data.volumeRWIDHashTablep[i] = volp;
1479         break;
1480     case ROVOL:                                
1481         statep->nextp = cm_data.volumeROIDHashTablep[i];
1482         cm_data.volumeROIDHashTablep[i] = volp;
1483         break;
1484     case BACKVOL:
1485         statep->nextp = cm_data.volumeBKIDHashTablep[i];
1486         cm_data.volumeBKIDHashTablep[i] = volp;
1487         break;
1488     }
1489     statep->flags |= CM_VOLUMEFLAG_IN_HASH;
1490 }
1491
1492
1493 /* call with volume write-locked and mutex held */
1494 void cm_RemoveVolumeFromIDHashTable(cm_volume_t *volp, afs_uint32 volType)
1495 {
1496     cm_volume_t **lvolpp;
1497     cm_volume_t *tvolp;
1498     struct cm_vol_state * statep;
1499     int i;
1500         
1501     statep = cm_VolumeStateByType(volp, volType);
1502
1503     if (statep->flags & CM_VOLUMEFLAG_IN_HASH) {
1504         /* hash it out first */
1505         i = CM_VOLUME_ID_HASH(statep->ID);
1506
1507         switch (volType) {
1508         case RWVOL:
1509             lvolpp = &cm_data.volumeRWIDHashTablep[i];
1510             tvolp = cm_data.volumeRWIDHashTablep[i];
1511             break;
1512         case ROVOL:
1513             lvolpp = &cm_data.volumeROIDHashTablep[i];
1514             tvolp = cm_data.volumeROIDHashTablep[i];
1515             break;
1516         case BACKVOL:
1517             lvolpp = &cm_data.volumeBKIDHashTablep[i];
1518             tvolp = cm_data.volumeBKIDHashTablep[i];
1519             break;
1520         default:
1521             osi_assertx(0, "invalid volume type");
1522         }
1523         do {
1524             if (tvolp == volp) {
1525                 *lvolpp = statep->nextp;
1526                 statep->flags &= ~CM_VOLUMEFLAG_IN_HASH;
1527                 statep->nextp = NULL;
1528                 break;
1529             }
1530
1531             lvolpp = &tvolp->vol[volType].nextp;
1532             tvolp = tvolp->vol[volType].nextp;
1533         } while(tvolp);
1534     }
1535 }
1536
1537 /* must be called with cm_volumeLock write-locked! */
1538 void cm_AdjustVolumeLRU(cm_volume_t *volp)
1539 {
1540     if (volp == cm_data.volumeLRULastp)
1541         cm_data.volumeLRULastp = (cm_volume_t *) osi_QPrev(&volp->q);
1542     if (volp->flags & CM_VOLUMEFLAG_IN_LRU_QUEUE)
1543         osi_QRemoveHT((osi_queue_t **) &cm_data.volumeLRUFirstp, (osi_queue_t **) &cm_data.volumeLRULastp, &volp->q);
1544     osi_QAdd((osi_queue_t **) &cm_data.volumeLRUFirstp, &volp->q);
1545     volp->flags |= CM_VOLUMEFLAG_IN_LRU_QUEUE;
1546     if (!cm_data.volumeLRULastp) 
1547         cm_data.volumeLRULastp = volp;
1548 }
1549
1550 /* must be called with cm_volumeLock write-locked! */
1551 void cm_MoveVolumeToLRULast(cm_volume_t *volp)
1552 {
1553     if (volp == cm_data.volumeLRULastp)
1554         return;
1555
1556     if (volp == cm_data.volumeLRUFirstp)
1557         cm_data.volumeLRUFirstp = (cm_volume_t *) osi_QNext(&volp->q);
1558     if (volp->flags & CM_VOLUMEFLAG_IN_LRU_QUEUE)
1559         osi_QRemoveHT((osi_queue_t **) &cm_data.volumeLRUFirstp, (osi_queue_t **) &cm_data.volumeLRULastp, &volp->q);
1560     osi_QAddT((osi_queue_t **) &cm_data.volumeLRUFirstp, (osi_queue_t **) &cm_data.volumeLRULastp, &volp->q);
1561     volp->flags |= CM_VOLUMEFLAG_IN_LRU_QUEUE;
1562     if (!cm_data.volumeLRULastp) 
1563         cm_data.volumeLRULastp = volp;
1564 }
1565
1566 /* must be called with cm_volumeLock write-locked! */
1567 void cm_RemoveVolumeFromLRU(cm_volume_t *volp)
1568 {
1569     if (volp->flags & CM_VOLUMEFLAG_IN_LRU_QUEUE) {
1570         if (volp == cm_data.volumeLRULastp)
1571             cm_data.volumeLRULastp = (cm_volume_t *) osi_QPrev(&volp->q);
1572         osi_QRemoveHT((osi_queue_t **) &cm_data.volumeLRUFirstp, (osi_queue_t **) &cm_data.volumeLRULastp, &volp->q);
1573         volp->flags &= ~CM_VOLUMEFLAG_IN_LRU_QUEUE;
1574     }
1575 }
1576
1577 static char * volstatus_str(enum volstatus vs)
1578 {
1579     switch (vs) {
1580     case vl_online:
1581         return "online";
1582     case vl_busy:
1583         return "busy";
1584     case vl_offline:
1585         return "offline";
1586     case vl_alldown:
1587         return "alldown";
1588     default:
1589         return "unknown";
1590     }
1591 }
1592
1593 void cm_VolumeStatusNotification(cm_volume_t * volp, afs_uint32 volID, enum volstatus old, enum volstatus new)
1594 {
1595     char volstr[CELL_MAXNAMELEN + VL_MAXNAMELEN]="";
1596     char *ext = "";
1597
1598     if (volID == volp->vol[RWVOL].ID)
1599         ext = "";
1600     else if (volID == volp->vol[ROVOL].ID)
1601         ext = ".readonly";
1602     else if (volID == volp->vol[BACKVOL].ID)
1603         ext = ".backup";
1604     else
1605         ext = ".nomatch";
1606     snprintf(volstr, sizeof(volstr), "%s:%s%s", volp->cellp->name, volp->namep, ext);
1607
1608     osi_Log4(afsd_logp, "VolumeStatusNotification: %-48s [%10u] (%s -> %s)",
1609              osi_LogSaveString(afsd_logp, volstr), volID, volstatus_str(old), volstatus_str(new));
1610
1611     cm_VolStatus_Change_Notification(volp->cellp->cellID, volID, new);
1612 }       
1613
1614 enum volstatus cm_GetVolumeStatus(cm_volume_t *volp, afs_uint32 volID)
1615 {
1616     cm_vol_state_t * statep = cm_VolumeStateByID(volp, volID);
1617     if (statep)
1618         return statep->state;
1619     else
1620         return vl_unknown;
1621 }
1622
1623 /* Renew .readonly volume callbacks that are more than
1624  * 30 minutes old.  (A volume callback is issued for 2 hours.)
1625  */
1626 void 
1627 cm_VolumeRenewROCallbacks(void)
1628 {
1629     cm_volume_t * volp;
1630     time_t minexp = time(NULL) + 90 * 60;
1631
1632     lock_ObtainRead(&cm_volumeLock);
1633     for (volp = cm_data.allVolumesp; volp; volp=volp->allNextp) {
1634         if ( volp->cbExpiresRO > 0 && volp->cbExpiresRO < minexp) {
1635             cm_req_t      req;
1636             cm_fid_t      fid;
1637             cm_scache_t * scp;
1638
1639             cm_SetFid(&fid, volp->cellp->cellID, volp->vol[ROVOL].ID, 1, 1);
1640
1641             cm_InitReq(&req);
1642
1643             lock_ReleaseRead(&cm_volumeLock);
1644             if (cm_GetSCache(&fid, &scp, cm_rootUserp, &req) == 0) {
1645                 lock_ObtainWrite(&scp->rw);
1646                 cm_GetCallback(scp, cm_rootUserp, &req, 1);
1647                 lock_ReleaseWrite(&scp->rw);
1648                 cm_ReleaseSCache(scp);
1649             }
1650             lock_ObtainRead(&cm_volumeLock);
1651         }
1652     }
1653     lock_ReleaseRead(&cm_volumeLock);
1654 }
1655
1656 cm_vol_state_t * 
1657 cm_VolumeStateByType(cm_volume_t *volp, afs_uint32 volType)
1658 {
1659     return &volp->vol[volType];
1660 }
1661
1662 cm_vol_state_t * 
1663 cm_VolumeStateByID(cm_volume_t *volp, afs_uint32 id)
1664 {
1665     cm_vol_state_t * statep = NULL;
1666
1667     if (id == volp->vol[RWVOL].ID)
1668         statep = &volp->vol[RWVOL];
1669     else if (id == volp->vol[ROVOL].ID)
1670         statep = &volp->vol[ROVOL];
1671     else if (id == volp->vol[BACKVOL].ID)
1672         statep = &volp->vol[BACKVOL];
1673
1674     return(statep);
1675 }
1676
1677 cm_vol_state_t * 
1678 cm_VolumeStateByName(cm_volume_t *volp, char *volname)
1679 {
1680     size_t len = strlen(volname);
1681     cm_vol_state_t *statep;
1682
1683     if (cm_stricmp_utf8N(".readonly", &volname[len-9]) == 0)
1684         statep = &volp->vol[ROVOL];
1685     else if (cm_stricmp_utf8N(".backup", &volname[len-7]) == 0)
1686         statep = &volp->vol[BACKVOL];
1687     else 
1688         statep = &volp->vol[RWVOL];
1689
1690     return statep;
1691 }
1692