2 * Copyright 2000, International Business Machines Corporation and others.
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
10 #ifndef __CM_VOLUME_H_ENV__
11 #define __CM_VOLUME_H_ENV__ 1
13 #define VL_MAXNAMELEN 65
15 #define CM_VOLUME_MAGIC ('V' | 'O' <<8 | 'L'<<16 | 'M'<<24)
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 */
30 /* RWVOL, ROVOL, BACKVOL are defined in cm.h */
31 #define NUM_VOL_TYPES 3
33 typedef struct cm_volume {
34 osi_queue_t q; /* LRU queue; cm_volumeLock */
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 */
43 afs_uint32 flags; /* by rw */
44 afs_int32 refCount; /* by Interlocked operations */
45 struct cm_server *cbServerpRO; /* server granting RO callback; by cm_scacheLock */
46 time_t cbExpiresRO; /* latest RO expiration time; by cm_scacheLock */
49 #define CM_VOLUMEFLAG_RESET 1 /* reload this info on next use */
50 #define CM_VOLUMEFLAG_IN_HASH 2
51 #define CM_VOLUMEFLAG_IN_LRU_QUEUE 4
52 #define CM_VOLUMEFLAG_UPDATING_VL 8
53 #define CM_VOLUMEFLAG_DFS_VOLUME 16
55 typedef struct cm_volumeRef {
56 struct cm_volumeRef * next;
60 extern void cm_InitVolume(int newFile, long maxVols);
62 extern long cm_FindVolumeByName(struct cm_cell *cellp, char *volNamep,
63 struct cm_user *userp, struct cm_req *reqp,
64 afs_uint32 flags, cm_volume_t **outVolpp);
66 extern long cm_FindVolumeByID(struct cm_cell *cellp, afs_uint32 volumeID,
67 cm_user_t *userp, cm_req_t *reqp,
68 afs_uint32 flags, cm_volume_t **outVolpp);
70 #define CM_GETVOL_FLAG_CREATE 1
71 #define CM_GETVOL_FLAG_NO_LRU_UPDATE 2
72 #define CM_GETVOL_FLAG_NO_RESET 4
73 #define CM_GETVOL_FLAG_IGNORE_LINKED_CELL 8
75 /* hash define. Must not include the cell, since the callback revocation code
76 * doesn't necessarily know the cell in the case of a multihomed server
77 * contacting us from a mystery address.
79 #define CM_VOLUME_ID_HASH(volid) ((unsigned long) volid \
80 % cm_data.volumeHashTableSize)
82 #define CM_VOLUME_NAME_HASH(name) (SDBMHash(name) % cm_data.volumeHashTableSize)
84 extern afs_uint32 SDBMHash(const char *);
86 extern void cm_GetVolume(cm_volume_t *volp);
88 extern cm_volume_t *cm_GetVolumeByFID(cm_fid_t *);
90 extern void cm_PutVolume(cm_volume_t *volp);
92 extern long cm_GetROVolumeID(cm_volume_t *volp);
94 extern long cm_ForceUpdateVolume(struct cm_fid *fidp, cm_user_t *userp,
97 extern cm_serverRef_t **cm_GetVolServers(cm_volume_t *volp, afs_uint32 volume,
98 cm_user_t *userp, cm_req_t *reqp);
100 extern void cm_ChangeRankVolume(cm_server_t *tsp);
102 extern void cm_RefreshVolumes(void);
104 extern long cm_ValidateVolume(void);
106 extern long cm_ShutdownVolume(void);
108 extern int cm_DumpVolumes(FILE *outputFile, char *cookie, int lock);
110 extern int cm_VolNameIsID(char *aname);
112 extern void cm_RemoveVolumeFromNameHashTable(cm_volume_t * volp);
114 extern void cm_RemoveVolumeFromIDHashTable(cm_volume_t * volp, afs_uint32 volType);
116 extern void cm_AddVolumeToNameHashTable(cm_volume_t * volp);
118 extern void cm_AddVolumeToIDHashTable(cm_volume_t * volp, afs_uint32 volType);
120 extern void cm_AdjustVolumeLRU(cm_volume_t *volp);
122 extern void cm_MoveVolumeToLRULast(cm_volume_t *volp);
124 extern void cm_RemoveVolumeFromLRU(cm_volume_t *volp);
126 extern void cm_CheckOfflineVolumes(void);
128 extern long cm_CheckOfflineVolume(cm_volume_t *volp, afs_uint32 volID);
130 extern void cm_CheckOfflineVolumeState(cm_volume_t *volp, cm_vol_state_t *statep,
131 afs_uint32 volID, afs_uint32 *onlinep,
132 afs_uint32 *volumeUpdatedp);
134 extern void cm_UpdateVolumeStatus(cm_volume_t *volp, afs_uint32 volID);
136 extern void cm_VolumeStatusNotification(cm_volume_t * volp, afs_uint32 volID, enum volstatus oldState, enum volstatus newState);
138 extern enum volstatus cm_GetVolumeStatus(cm_volume_t *volp, afs_uint32 volID);
140 extern void cm_VolumeRenewROCallbacks(void);
142 extern cm_vol_state_t * cm_VolumeStateByType(cm_volume_t *volp, afs_uint32 type);
144 extern cm_vol_state_t * cm_VolumeStateByID(cm_volume_t *volp, afs_uint32 id);
146 extern cm_vol_state_t * cm_VolumeStateByName(cm_volume_t *volp, char *volname);
148 extern osi_rwlock_t cm_volumeLock;
149 #endif /* __CM_VOLUME_H_ENV__ */