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)
17 typedef struct cm_vol_state {
18 struct cm_volume *nextp; /* volumeIDHashTable; by cm_volumeLock */
19 afs_uint32 ID; /* by mx */
20 struct cm_fid dotdotFid; /* parent of volume root */
21 cm_serverRef_t *serversp; /* by mx */
22 enum volstatus state; /* by mx */
23 afs_uint32 flags; /* by mx */
26 typedef struct cm_volume {
27 osi_queue_t q; /* LRU queue; cm_volumeLock */
29 struct cm_volume *allNextp; /* allVolumes; by cm_volumeLock */
30 struct cm_volume *nameNextp; /* volumeNameHashTable; by cm_volumeLock */
31 cm_cell_t *cellp; /* never changes */
32 char namep[VL_MAXNAMELEN]; /* name of the normal volume - assigned during allocation; */
33 /* by cm_volumeLock */
34 struct cm_vol_state rw; /* by cm_volumeLock */
35 struct cm_vol_state ro; /* by cm_volumeLock */
36 struct cm_vol_state bk; /* by cm_volumeLock */
38 afs_uint32 flags; /* by mx */
39 afs_int32 refCount; /* by Interlocked operations */
40 time_t cbExpiresRO; /* latest RO expiration time; by cm_scacheLock */
43 #define CM_VOLUMEFLAG_RESET 1 /* reload this info on next use */
44 #define CM_VOLUMEFLAG_IN_HASH 2
45 #define CM_VOLUMEFLAG_IN_LRU_QUEUE 4
48 typedef struct cm_volumeRef {
49 struct cm_volumeRef * next;
53 extern void cm_InitVolume(int newFile, long maxVols);
55 extern long cm_FindVolumeByName(struct cm_cell *cellp, char *volNamep,
56 struct cm_user *userp, struct cm_req *reqp,
57 afs_uint32 flags, cm_volume_t **outVolpp);
59 extern long cm_FindVolumeByID(struct cm_cell *cellp, afs_uint32 volumeID,
60 cm_user_t *userp, cm_req_t *reqp,
61 afs_uint32 flags, cm_volume_t **outVolpp);
63 #define CM_GETVOL_FLAG_CREATE 1
64 #define CM_GETVOL_FLAG_NO_LRU_UPDATE 2
65 #define CM_GETVOL_FLAG_NO_RESET 4
67 /* hash define. Must not include the cell, since the callback revocation code
68 * doesn't necessarily know the cell in the case of a multihomed server
69 * contacting us from a mystery address.
71 #define CM_VOLUME_ID_HASH(volid) ((unsigned long) volid \
72 % cm_data.volumeHashTableSize)
74 #define CM_VOLUME_NAME_HASH(name) (SDBMHash(name) % cm_data.volumeHashTableSize)
76 extern afs_uint32 SDBMHash(const char *);
78 extern void cm_GetVolume(cm_volume_t *volp);
80 extern cm_volume_t *cm_GetVolumeByFID(cm_fid_t *);
82 extern void cm_PutVolume(cm_volume_t *volp);
84 extern long cm_GetROVolumeID(cm_volume_t *volp);
86 extern void cm_ForceUpdateVolume(struct cm_fid *fidp, cm_user_t *userp,
89 extern cm_serverRef_t **cm_GetVolServers(cm_volume_t *volp, afs_uint32 volume);
91 extern void cm_ChangeRankVolume(cm_server_t *tsp);
93 extern void cm_RefreshVolumes(void);
95 extern long cm_ValidateVolume(void);
97 extern long cm_ShutdownVolume(void);
99 extern int cm_DumpVolumes(FILE *outputFile, char *cookie, int lock);
101 extern int cm_VolNameIsID(char *aname);
103 extern void cm_RemoveVolumeFromNameHashTable(cm_volume_t * volp);
105 extern void cm_RemoveVolumeFromIDHashTable(cm_volume_t * volp, afs_uint32 volType);
107 extern void cm_AddVolumeToNameHashTable(cm_volume_t * volp);
109 extern void cm_AddVolumeToIDHashTable(cm_volume_t * volp, afs_uint32 volType);
111 extern void cm_AdjustVolumeLRU(cm_volume_t *volp);
113 extern void cm_MoveVolumeToLRULast(cm_volume_t *volp);
115 extern void cm_RemoveVolumeFromLRU(cm_volume_t *volp);
117 extern void cm_CheckOfflineVolumes(void);
119 extern long cm_CheckOfflineVolume(cm_volume_t *volp, afs_uint32 volID);
121 extern void cm_UpdateVolumeStatus(cm_volume_t *volp, afs_uint32 volID);
123 extern void cm_VolumeStatusNotification(cm_volume_t * volp, afs_uint32 volID, enum volstatus old, enum volstatus new);
125 extern enum volstatus cm_GetVolumeStatus(cm_volume_t *volp, afs_uint32 volID);
127 extern void cm_VolumeRenewROCallbacks(void);
129 extern osi_rwlock_t cm_volumeLock;
130 #endif /* __CM_VOLUME_H_ENV__ */