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