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