src/WINNT/afsd/cm_cell.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 <nb30.h>
  15 #include <winsock2.h>
  16 #include <stdlib.h>
  17 #include <stdio.h>
  18 #include <malloc.h>
  19 #include <osi.h>
  20 #include <string.h>
  21
  22 #include "afsd.h"
  23
  24 osi_rwlock_t cm_cellLock;
  25
  26 /* function called as callback proc from cm_SearchCellFile.  Return 0 to
  27  * continue processing.
  28  *
  29  * At the present time the return value is ignored by the caller.
  30  */
  31 typedef struct cm_cell_rock {
  32     cm_cell_t * cellp;
  33     afs_uint32  flags;
  34 } cm_cell_rock_t;
  35
  36 long cm_AddCellProc(void *rockp, struct sockaddr_in *addrp, char *hostnamep)
  37 {
  38     cm_server_t *tsp;
  39     cm_serverRef_t *tsrp;
  40     cm_cell_t *cellp;
  41     cm_cell_rock_t *cellrockp = (cm_cell_rock_t *)rockp;
  42     afs_uint32 probe;
  43
  44     cellp = cellrockp->cellp;
  45     probe = !(cellrockp->flags & CM_FLAG_NOPROBE);
  46
  47     /* if this server was previously created by fs setserverprefs */
  48     if ( tsp = cm_FindServer(addrp, CM_SERVER_VLDB))
  49     {
  50         if ( !tsp->cellp )
  51             tsp->cellp = cellp;
  52         else if (tsp->cellp != cellp) {
  53             osi_Log3(afsd_logp, "found a vlserver %s associated with two cells named %s and %s",
  54                      osi_LogSaveString(afsd_logp,hostnamep),
  55                      osi_LogSaveString(afsd_logp,tsp->cellp->name),
  56                      osi_LogSaveString(afsd_logp,cellp->name));
  57         }
  58     }
  59     else
  60         tsp = cm_NewServer(addrp, CM_SERVER_VLDB, cellp, probe ? 0 : CM_FLAG_NOPROBE);
  61
  62     /* Insert the vlserver into a sorted list, sorted by server rank */
  63     tsrp = cm_NewServerRef(tsp, 0);
  64     cm_InsertServerList(&cellp->vlServersp, tsrp);
  65     /* drop the allocation reference */
  66     lock_ObtainWrite(&cm_serverLock);
  67     tsrp->refCount--;
  68     lock_ReleaseWrite(&cm_serverLock);
  69
  70     return 0;
  71 }
  72
  73 /* if it's from DNS, see if it has expired
  74  * and check to make sure we have a valid set of volume servers
  75  * this function must be called with a Write Lock on cm_cellLock
  76  */
  77 static cm_cell_t *cm_UpdateCell(cm_cell_t * cp, afs_uint32 flags)
  78 {
  79     long code = 0;
  80     cm_cell_rock_t rock;
  81
  82     if (cp == NULL)
  83         return NULL;
  84
  85     lock_ObtainMutex(&cp->mx);
  86     if ((cp->vlServersp == NULL
  87 #ifdef AFS_FREELANCE_CLIENT
  88           && !(cp->flags & CM_CELLFLAG_FREELANCE)
  89 #endif
  90           ) || (time(0) > cp->timeout)
  91 #ifdef AFS_AFSDB_ENV
  92         || (cm_dnsEnabled && (cp->flags & CM_CELLFLAG_DNS) &&
  93          ((cp->flags & CM_CELLFLAG_VLSERVER_INVALID)))
  94 #endif
  95             ) {
  96         /* must empty cp->vlServersp */
  97         if (cp->vlServersp) {
  98             cm_FreeServerList(&cp->vlServersp, CM_FREESERVERLIST_DELETE);
  99             cp->vlServersp = NULL;
 100         }
 101
 102         rock.cellp = cp;
 103         rock.flags = flags;
 104         code = cm_SearchCellFile(cp->name, NULL, cm_AddCellProc, &rock);
 105 #ifdef AFS_AFSDB_ENV
 106         if (code) {
 107             if (cm_dnsEnabled) {
 108                 int ttl;
 109
 110                 code = cm_SearchCellByDNS(cp->name, NULL, &ttl, cm_AddCellProc, &rock);
 111                 if (code == 0) {   /* got cell from DNS */
 112                     cp->flags |= CM_CELLFLAG_DNS;
 113                     cp->flags &= ~CM_CELLFLAG_VLSERVER_INVALID;
 114                     cp->timeout = time(0) + ttl;
 115 #ifdef DEBUG
 116                     fprintf(stderr, "cell %s: ttl=%d\n", cp->name, ttl);
 117 #endif
 118                 } else {
 119                     /* if we fail to find it this time, we'll just do nothing and leave the
 120                      * current entry alone
 121                      */
 122                     cp->flags |= CM_CELLFLAG_VLSERVER_INVALID;
 123                 }
 124             }
 125         } else
 126 #endif /* AFS_AFSDB_ENV */
 127         {
 128             cp->timeout = time(0) + 7200;
 129         }
 130     }
 131     lock_ReleaseMutex(&cp->mx);
 132     return code ? NULL : cp;
 133 }
 134
 135 /* load up a cell structure from the cell database, afsdcell.ini */
 136 cm_cell_t *cm_GetCell(char *namep, afs_uint32 flags)
 137 {
 138     return cm_GetCell_Gen(namep, NULL, flags);
 139 }
 140
 141 cm_cell_t *cm_GetCell_Gen(char *namep, char *newnamep, afs_uint32 flags)
 142 {
 143     cm_cell_t *cp, *cp2;
 144     long code;
 145     char fullname[200]="";
 146     int  hasWriteLock = 0;
 147     afs_uint32 hash;
 148     cm_cell_rock_t rock;
 149
 150     if (!strcmp(namep,SMB_IOCTL_FILENAME_NOSLASH))
 151         return NULL;
 152
 153     hash = CM_CELL_NAME_HASH(namep);
 154
 155     lock_ObtainRead(&cm_cellLock);
 156     for (cp = cm_data.cellNameHashTablep[hash]; cp; cp=cp->nameNextp) {
 157         if (stricmp(namep, cp->name) == 0) {
 158             strcpy(fullname, cp->name);
 159             break;
 160         }
 161     }
 162
 163     if (!cp) {
 164         for (cp = cm_data.allCellsp; cp; cp=cp->allNextp) {
 165             if (strnicmp(namep, cp->name, strlen(namep)) == 0) {
 166                 strcpy(fullname, cp->name);
 167                 break;
 168             }
 169         }
 170     }
 171
 172     lock_ReleaseRead(&cm_cellLock);
 173
 174     if (cp) {
 175         cm_UpdateCell(cp, flags);
 176     } else if (flags & CM_FLAG_CREATE) {
 177         lock_ObtainWrite(&cm_cellLock);
 178         hasWriteLock = 1;
 179
 180         /* when we dropped the lock the cell could have been added
 181          * to the list so check again while holding the write lock
 182          */
 183         for (cp = cm_data.cellNameHashTablep[hash]; cp; cp=cp->nameNextp) {
 184             if (stricmp(namep, cp->name) == 0) {
 185                 strcpy(fullname, cp->name);
 186                 break;
 187             }
 188         }
 189
 190         if (cp)
 191             goto done;
 192
 193         for (cp = cm_data.allCellsp; cp; cp=cp->allNextp) {
 194             if (strnicmp(namep, cp->name, strlen(namep)) == 0) {
 195                 strcpy(fullname, cp->name);
 196                 break;
 197             }
 198         }
 199
 200         if (cp)
 201             goto done;
 202
 203         if ( cm_data.currentCells >= cm_data.maxCells )
 204             osi_panic("Exceeded Max Cells", __FILE__, __LINE__);
 205
 206         /* don't increment currentCells until we know that we
 207          * are going to keep this entry
 208          */
 209         cp = &cm_data.cellBaseAddress[cm_data.currentCells];
 210         memset(cp, 0, sizeof(cm_cell_t));
 211         cp->magic = CM_CELL_MAGIC;
 212
 213         rock.cellp = cp;
 214         rock.flags = flags;
 215         code = cm_SearchCellFile(namep, fullname, cm_AddCellProc, &rock);
 216         if (code) {
 217             osi_Log3(afsd_logp,"in cm_GetCell_gen cm_SearchCellFile(%s) returns code= %d fullname= %s",
 218                       osi_LogSaveString(afsd_logp,namep), code, osi_LogSaveString(afsd_logp,fullname));
 219
 220 #ifdef AFS_AFSDB_ENV
 221             if (cm_dnsEnabled) {
 222                 int ttl;
 223
 224                 code = cm_SearchCellByDNS(namep, fullname, &ttl, cm_AddCellProc, &rock);
 225                 if ( code ) {
 226                     osi_Log3(afsd_logp,"in cm_GetCell_gen cm_SearchCellByDNS(%s) returns code= %d fullname= %s",
 227                              osi_LogSaveString(afsd_logp,namep), code, osi_LogSaveString(afsd_logp,fullname));
 228                     cp = NULL;
 229                     goto done;
 230                 } else {   /* got cell from DNS */
 231                     cp->flags |= CM_CELLFLAG_DNS;
 232                     cp->flags &= ~CM_CELLFLAG_VLSERVER_INVALID;
 233                     cp->timeout = time(0) + ttl;
 234                 }
 235             } else {
 236 #endif
 237                 cp = NULL;
 238                 goto done;
 239 #ifdef AFS_AFSDB_ENV
 240             }
 241 #endif
 242         } else {
 243             cp->timeout = time(0) + 7200;       /* two hour timeout */
 244         }
 245
 246         /* we have now been given the fullname of the cell.  It may
 247          * be that we already have a cell with that name.  If so,
 248          * we should use it instead of completing the allocation
 249          * of a new cm_cell_t
 250          */
 251         hash = CM_CELL_NAME_HASH(fullname);
 252         for (cp2 = cm_data.cellNameHashTablep[hash]; cp2; cp2=cp2->nameNextp) {
 253             if (stricmp(fullname, cp2->name) == 0) {
 254                 break;
 255             }
 256         }
 257
 258         if (cp2) {
 259             cm_FreeServerList(&cp->vlServersp, CM_FREESERVERLIST_DELETE);
 260             cp = cp2;
 261             goto done;
 262         }
 263
 264
 265         /* randomise among those vlservers having the same rank*/
 266         cm_RandomizeServer(&cp->vlServersp);
 267
 268         /* otherwise we found the cell, and so we're nearly done */
 269         lock_InitializeMutex(&cp->mx, "cm_cell_t mutex");
 270
 271         /* copy in name */
 272         strncpy(cp->name, fullname, CELL_MAXNAMELEN);
 273         cp->name[CELL_MAXNAMELEN-1] = '\0';
 274
 275         /* the cellID cannot be 0 */
 276         cp->cellID = ++cm_data.currentCells;
 277
 278                 /* append cell to global list */
 279         if (cm_data.allCellsp == NULL) {
 280             cm_data.allCellsp = cp;
 281         } else {
 282             for (cp2 = cm_data.allCellsp; cp2->allNextp; cp2=cp2->allNextp)
 283                 ;
 284             cp2->allNextp = cp;
 285         }
 286         cp->allNextp = NULL;
 287
 288         cm_AddCellToNameHashTable(cp);
 289         cm_AddCellToIDHashTable(cp);
 290     }
 291
 292   done:
 293     if (hasWriteLock)
 294         lock_ReleaseWrite(&cm_cellLock);
 295
 296     /* fullname is not valid if cp == NULL */
 297     if (cp && newnamep)
 298         strcpy(newnamep, fullname);
 299
 300     return cp;
 301 }
 302
 303 cm_cell_t *cm_FindCellByID(afs_int32 cellID, afs_uint32 flags)
 304 {
 305     cm_cell_t *cp;
 306     afs_uint32 hash;
 307
 308     lock_ObtainRead(&cm_cellLock);
 309
 310     hash = CM_CELL_ID_HASH(cellID);
 311
 312     for (cp = cm_data.cellIDHashTablep[hash]; cp; cp=cp->idNextp) {
 313         if (cellID == cp->cellID)
 314             break;
 315     }
 316     lock_ReleaseRead(&cm_cellLock);
 317
 318     if (cp)
 319         cm_UpdateCell(cp, flags);
 320
 321     return cp;
 322 }
 323
 324 long
 325 cm_ValidateCell(void)
 326 {
 327     cm_cell_t * cellp;
 328     afs_uint32 count;
 329
 330     for (cellp = cm_data.allCellsp, count = 0; cellp; cellp=cellp->allNextp, count++) {
 331         if ( cellp->magic != CM_CELL_MAGIC ) {
 332             afsi_log("cm_ValidateCell failure: cellp->magic != CM_CELL_MAGIC");
 333             fprintf(stderr, "cm_ValidateCell failure: cellp->magic != CM_CELL_MAGIC\n");
 334             return -1;
 335         }
 336         if ( count != 0 && cellp == cm_data.allCellsp ||
 337              count > cm_data.maxCells ) {
 338             afsi_log("cm_ValidateCell failure: cm_data.allCellsp infinite loop");
 339             fprintf(stderr, "cm_ValidateCell failure: cm_data.allCellsp infinite loop\n");
 340             return -2;
 341         }
 342     }
 343
 344     if ( count != cm_data.currentCells ) {
 345         afsi_log("cm_ValidateCell failure: count != cm_data.currentCells");
 346         fprintf(stderr, "cm_ValidateCell failure: count != cm_data.currentCells\n");
 347         return -3;
 348     }
 349
 350     return 0;
 351 }
 352
 353
 354 long
 355 cm_ShutdownCell(void)
 356 {
 357     cm_cell_t * cellp;
 358
 359     for (cellp = cm_data.allCellsp; cellp; cellp=cellp->allNextp)
 360         lock_FinalizeMutex(&cellp->mx);
 361
 362     return 0;
 363 }
 364
 365
 366 void cm_InitCell(int newFile, long maxCells)
 367 {
 368     static osi_once_t once;
 369
 370     if (osi_Once(&once)) {
 371         cm_cell_t * cellp;
 372
 373         lock_InitializeRWLock(&cm_cellLock, "cell global lock");
 374
 375         if ( newFile ) {
 376             cm_data.allCellsp = NULL;
 377             cm_data.currentCells = 0;
 378             cm_data.maxCells = maxCells;
 379             memset(cm_data.cellNameHashTablep, 0, sizeof(cm_cell_t *) * cm_data.cellHashTableSize);
 380             memset(cm_data.cellIDHashTablep, 0, sizeof(cm_cell_t *) * cm_data.cellHashTableSize);
 381
 382 #ifdef AFS_FREELANCE_CLIENT
 383             /* Generate a dummy entry for the Freelance cell whether or not
 384              * freelance mode is being used in this session
 385              */
 386
 387             cellp = &cm_data.cellBaseAddress[cm_data.currentCells++];
 388             memset(cellp, 0, sizeof(cm_cell_t));
 389             cellp->magic = CM_CELL_MAGIC;
 390
 391             lock_InitializeMutex(&cellp->mx, "cm_cell_t mutex");
 392
 393             /* copy in name */
 394             strncpy(cellp->name, "Freelance.Local.Cell", CELL_MAXNAMELEN); /*safe*/
 395
 396             /* thread on global list */
 397             cellp->allNextp = cm_data.allCellsp;
 398             cm_data.allCellsp = cellp;
 399
 400             cellp->cellID = AFS_FAKE_ROOT_CELL_ID;
 401             cellp->vlServersp = NULL;
 402             cellp->flags = CM_CELLFLAG_FREELANCE;
 403
 404             cm_AddCellToNameHashTable(cellp);
 405             cm_AddCellToIDHashTable(cellp);
 406 #endif
 407         } else {
 408             for (cellp = cm_data.allCellsp; cellp; cellp=cellp->allNextp) {
 409                 lock_InitializeMutex(&cellp->mx, "cm_cell_t mutex");
 410                 cellp->vlServersp = NULL;
 411             }
 412         }
 413
 414         osi_EndOnce(&once);
 415     }
 416 }
 417
 418 void cm_ChangeRankCellVLServer(cm_server_t *tsp)
 419 {
 420     cm_cell_t *cp;
 421     int code;
 422
 423     cp = tsp->cellp;    /* cell that this vlserver belongs to */
 424     if (cp) {
 425         lock_ObtainMutex(&cp->mx);
 426         code = cm_ChangeRankServer(&cp->vlServersp, tsp);
 427
 428         if ( !code )            /* if the server list was rearranged */
 429             cm_RandomizeServer(&cp->vlServersp);
 430
 431         lock_ReleaseMutex(&cp->mx);
 432     }
 433 }
 434
 435 int cm_DumpCells(FILE *outputFile, char *cookie, int lock)
 436 {
 437     cm_cell_t *cellp;
 438     int zilch;
 439     char output[1024];
 440
 441     if (lock)
 442         lock_ObtainRead(&cm_cellLock);
 443
 444     sprintf(output, "%s - dumping cells - cm_data.currentCells=%d, cm_data.maxCells=%d\r\n",
 445             cookie, cm_data.currentCells, cm_data.maxCells);
 446     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
 447
 448     for (cellp = cm_data.allCellsp; cellp; cellp=cellp->allNextp) {
 449         sprintf(output, "%s cellp=0x%p,name=%s ID=%d flags=0x%x\r\n",
 450                 cookie, cellp, cellp->name, cellp->cellID, cellp->flags);
 451         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
 452     }
 453
 454     sprintf(output, "%s - Done dumping cells.\r\n", cookie);
 455     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
 456
 457     if (lock)
 458         lock_ReleaseRead(&cm_cellLock);
 459
 460     return(0);
 461 }
 462
 463 /* call with volume write-locked and mutex held */
 464 void cm_AddCellToNameHashTable(cm_cell_t *cellp)
 465 {
 466     int i;
 467
 468     if (cellp->flags & CM_CELLFLAG_IN_NAMEHASH)
 469         return;
 470
 471     i = CM_CELL_NAME_HASH(cellp->name);
 472
 473     cellp->nameNextp = cm_data.cellNameHashTablep[i];
 474     cm_data.cellNameHashTablep[i] = cellp;
 475     cellp->flags |= CM_CELLFLAG_IN_NAMEHASH;
 476 }
 477
 478 /* call with cell write-locked and mutex held */
 479 void cm_RemoveCellFromNameHashTable(cm_cell_t *cellp)
 480 {
 481     cm_cell_t **lcellpp;
 482     cm_cell_t *tcellp;
 483     int i;
 484
 485     if (cellp->flags & CM_CELLFLAG_IN_NAMEHASH) {
 486         /* hash it out first */
 487         i = CM_CELL_NAME_HASH(cellp->name);
 488         for (lcellpp = &cm_data.cellNameHashTablep[i], tcellp = cm_data.cellNameHashTablep[i];
 489              tcellp;
 490              lcellpp = &tcellp->nameNextp, tcellp = tcellp->nameNextp) {
 491             if (tcellp == cellp) {
 492                 *lcellpp = cellp->nameNextp;
 493                 cellp->flags &= ~CM_CELLFLAG_IN_NAMEHASH;
 494                 cellp->nameNextp = NULL;
 495                 break;
 496             }
 497         }
 498     }
 499 }
 500
 501 /* call with cell write-locked and mutex held */
 502 void cm_AddCellToIDHashTable(cm_cell_t *cellp)
 503 {
 504     int i;
 505
 506     if (cellp->flags & CM_CELLFLAG_IN_IDHASH)
 507         return;
 508
 509     i = CM_CELL_ID_HASH(cellp->cellID);
 510
 511     cellp->idNextp = cm_data.cellIDHashTablep[i];
 512     cm_data.cellIDHashTablep[i] = cellp;
 513     cellp->flags |= CM_CELLFLAG_IN_IDHASH;
 514 }
 515
 516 /* call with cell write-locked and mutex held */
 517 void cm_RemoveCellFromIDHashTable(cm_cell_t *cellp)
 518 {
 519     cm_cell_t **lcellpp;
 520     cm_cell_t *tcellp;
 521     int i;
 522
 523     if (cellp->flags & CM_CELLFLAG_IN_IDHASH) {
 524         /* hash it out first */
 525         i = CM_CELL_ID_HASH(cellp->cellID);
 526         for (lcellpp = &cm_data.cellIDHashTablep[i], tcellp = cm_data.cellIDHashTablep[i];
 527              tcellp;
 528              lcellpp = &tcellp->idNextp, tcellp = tcellp->idNextp) {
 529             if (tcellp == cellp) {
 530                 *lcellpp = cellp->idNextp;
 531                 cellp->flags &= ~CM_CELLFLAG_IN_IDHASH;
 532                 cellp->idNextp = NULL;
 533                 break;
 534             }
 535         }
 536     }
 537 }
 538