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