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