windows-check-offline-volumes-20080214
[openafs.git] / src / WINNT / afsd / cm_cell.h
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 #ifndef __CELL_H_ENV_
11 #define __CELL_H_ENV_ 1
12
13 #define CELL_MAXNAMELEN                 256
14
15 #define CM_CELL_MAGIC    ('C' | 'E' <<8 | 'L'<<16 | 'L'<<24)
16
17 /* a cell structure */
18 typedef struct cm_cell {        
19     afs_uint32  magic;
20     afs_int32 cellID;                   /* cell ID */
21     struct cm_cell *allNextp;           /* locked by cm_cellLock */
22     struct cm_cell *nameNextp;          /* locked by cm_cellLock */
23     struct cm_cell *idNextp;            /* locked by cm_cellLock */
24     char name[CELL_MAXNAMELEN];         /* cell name; never changes */
25     cm_serverRef_t *vlServersp;         /* locked by cm_serverLock */
26     osi_mutex_t mx;                     /* mutex locking fields (flags) */
27     long flags;                         /* locked by mx */
28     time_t timeout;                     /* if dns, time at which the server addrs expire */
29 } cm_cell_t;
30
31 /* These are bit flag values */
32 #define CM_CELLFLAG_SUID               1        /* setuid flag; not yet used */
33 #define CM_CELLFLAG_DNS                2  /* cell servers are from DNS */
34 #define CM_CELLFLAG_VLSERVER_INVALID   4  /* cell servers are invalid */
35 #define CM_CELLFLAG_FREELANCE          8  /* local freelance fake cell */
36 #define CM_CELLFLAG_IN_NAMEHASH        0x10
37 #define CM_CELLFLAG_IN_IDHASH          0x20
38
39 typedef struct cm_cell_rock {
40     cm_cell_t * cellp;
41     afs_uint32  flags;
42 } cm_cell_rock_t;
43
44
45 #define CM_CELL_NAME_HASH(name)  (SDBMHash(name) % cm_data.cellHashTableSize)
46
47 #define CM_CELL_ID_HASH(id)   ((unsigned long) id % cm_data.cellHashTableSize)
48
49 extern void cm_InitCell(int newFile, long maxCells);
50
51 extern long cm_ShutdownCell(void);
52
53 extern long cm_ValidateCell(void);
54
55 extern cm_cell_t *cm_GetCell(char *namep, afs_uint32 flags);
56
57 extern cm_cell_t *cm_GetCell_Gen(char *namep, char *newnamep, afs_uint32 flags);
58
59 extern cm_cell_t *cm_FindCellByID(afs_int32 cellID, afs_uint32 flags);
60
61 extern void cm_ChangeRankCellVLServer(cm_server_t *tsp);
62
63 extern osi_rwlock_t cm_cellLock;
64
65 extern cm_cell_t *cm_allCellsp;
66
67 extern int cm_DumpCells(FILE *, char *, int);
68
69 extern void cm_AddCellToNameHashTable(cm_cell_t * cellp);
70
71 extern void cm_AddCellToIDHashTable(cm_cell_t * cellp);
72
73 extern long cm_AddCellProc(void *rockp, struct sockaddr_in *addrp, char *namep);
74
75 extern cm_cell_t *cm_UpdateCell(cm_cell_t * cp, afs_uint32 flags);
76
77 #endif /* __CELL_H_ENV_ */