windows-linked-cells-20081103
[openafs.git] / src / WINNT / afsd / cm_volume.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 __CM_VOLUME_H_ENV__
11 #define __CM_VOLUME_H_ENV__ 1
12
13 #define VL_MAXNAMELEN                   65
14
15 #define CM_VOLUME_MAGIC    ('V' | 'O' <<8 | 'L'<<16 | 'M'<<24)
16
17 /* 
18  *
19  */
20
21 typedef struct cm_vol_state {
22     struct cm_volume *nextp;            /* volumeIDHashTable; by cm_volumeLock */
23     afs_uint32      ID;                 /* by rw */
24     struct cm_fid dotdotFid;            /* parent of volume root */
25     cm_serverRef_t *serversp;           /* by cm_serverLock */
26     enum volstatus  state;              /* by rw */
27     afs_uint32      flags;              /* by rw */
28 } cm_vol_state_t;
29
30 /* RWVOL, ROVOL, BACKVOL are defined in cm.h */
31 #define NUM_VOL_TYPES 3
32
33 typedef struct cm_volume {
34     osi_queue_t q;                      /* LRU queue; cm_volumeLock */
35     afs_uint32  magic;
36     struct cm_volume *allNextp;         /* allVolumes; by cm_volumeLock */
37     struct cm_volume *nameNextp;        /* volumeNameHashTable; by cm_volumeLock */
38     cm_cell_t *cellp;                   /* never changes */
39     char namep[VL_MAXNAMELEN];          /* name of the normal volume - assigned during allocation; */
40                                         /* by cm_volumeLock */
41     struct cm_vol_state vol[NUM_VOL_TYPES]; /* by cm_volumeLock */
42     osi_rwlock_t rw;
43     afs_uint32 flags;                   /* by rw */
44     afs_int32 refCount;                 /* by Interlocked operations */
45     time_t cbExpiresRO;                 /* latest RO expiration time; by cm_scacheLock */
46 } cm_volume_t;
47
48 #define CM_VOLUMEFLAG_RESET        1    /* reload this info on next use */
49 #define CM_VOLUMEFLAG_IN_HASH      2
50 #define CM_VOLUMEFLAG_IN_LRU_QUEUE 4
51 #define CM_VOLUMEFLAG_UPDATING_VL  8
52
53
54 typedef struct cm_volumeRef {
55     struct cm_volumeRef * next;
56     afs_uint32  volID;
57 } cm_volumeRef_t;
58
59 extern void cm_InitVolume(int newFile, long maxVols);
60
61 extern long cm_FindVolumeByName(struct cm_cell *cellp, char *volNamep, 
62                                struct cm_user *userp, struct cm_req *reqp, 
63                                afs_uint32 flags, cm_volume_t **outVolpp);
64
65 extern long cm_FindVolumeByID(struct cm_cell *cellp, afs_uint32 volumeID,
66                              cm_user_t *userp, cm_req_t *reqp, 
67                              afs_uint32 flags, cm_volume_t **outVolpp);
68
69 #define CM_GETVOL_FLAG_CREATE               1
70 #define CM_GETVOL_FLAG_NO_LRU_UPDATE        2
71 #define CM_GETVOL_FLAG_NO_RESET             4
72 #define CM_GETVOL_FLAG_IGNORE_LINKED_CELL   8
73
74 /* hash define.  Must not include the cell, since the callback revocation code
75  * doesn't necessarily know the cell in the case of a multihomed server
76  * contacting us from a mystery address.
77  */
78 #define CM_VOLUME_ID_HASH(volid)   ((unsigned long) volid \
79                                         % cm_data.volumeHashTableSize)
80
81 #define CM_VOLUME_NAME_HASH(name)  (SDBMHash(name) % cm_data.volumeHashTableSize)
82
83 extern afs_uint32 SDBMHash(const char *);
84
85 extern void cm_GetVolume(cm_volume_t *volp);
86
87 extern cm_volume_t *cm_GetVolumeByFID(cm_fid_t *);
88
89 extern void cm_PutVolume(cm_volume_t *volp);
90
91 extern long cm_GetROVolumeID(cm_volume_t *volp);
92
93 extern long cm_ForceUpdateVolume(struct cm_fid *fidp, cm_user_t *userp,
94         cm_req_t *reqp);
95
96 extern cm_serverRef_t **cm_GetVolServers(cm_volume_t *volp, afs_uint32 volume, 
97                                          cm_user_t *userp, cm_req_t *reqp);
98
99 extern void cm_ChangeRankVolume(cm_server_t *tsp);
100
101 extern void cm_RefreshVolumes(void);
102
103 extern long cm_ValidateVolume(void);
104
105 extern long cm_ShutdownVolume(void);
106
107 extern int cm_DumpVolumes(FILE *outputFile, char *cookie, int lock);
108
109 extern int cm_VolNameIsID(char *aname);
110
111 extern void cm_RemoveVolumeFromNameHashTable(cm_volume_t * volp);
112
113 extern void cm_RemoveVolumeFromIDHashTable(cm_volume_t * volp, afs_uint32 volType);
114
115 extern void cm_AddVolumeToNameHashTable(cm_volume_t * volp);
116
117 extern void cm_AddVolumeToIDHashTable(cm_volume_t * volp, afs_uint32 volType);
118
119 extern void cm_AdjustVolumeLRU(cm_volume_t *volp);
120
121 extern void cm_MoveVolumeToLRULast(cm_volume_t *volp);
122
123 extern void cm_RemoveVolumeFromLRU(cm_volume_t *volp);
124
125 extern void cm_CheckOfflineVolumes(void);
126
127 extern long cm_CheckOfflineVolume(cm_volume_t *volp, afs_uint32 volID);
128
129 extern void cm_CheckOfflineVolumeState(cm_volume_t *volp, cm_vol_state_t *statep, 
130                                        afs_uint32 volID,  afs_uint32 *onlinep, 
131                                        afs_uint32 *volumeUpdatedp);
132
133 extern void cm_UpdateVolumeStatus(cm_volume_t *volp, afs_uint32 volID);
134
135 extern void cm_VolumeStatusNotification(cm_volume_t * volp, afs_uint32 volID, enum volstatus oldState, enum volstatus newState);
136
137 extern enum volstatus cm_GetVolumeStatus(cm_volume_t *volp, afs_uint32 volID);
138
139 extern void cm_VolumeRenewROCallbacks(void);
140
141 extern cm_vol_state_t * cm_VolumeStateByType(cm_volume_t *volp, afs_uint32 type);
142
143 extern cm_vol_state_t * cm_VolumeStateByID(cm_volume_t *volp, afs_uint32 id);
144
145 extern cm_vol_state_t * cm_VolumeStateByName(cm_volume_t *volp, char *volname);
146
147 extern osi_rwlock_t cm_volumeLock;
148 #endif /*  __CM_VOLUME_H_ENV__ */