windows-cpluscplus-compat-20080528
[openafs.git] / src / WINNT / afsd / cm_volume.h
index 06cd1ac..cc4f0ba 100644 (file)
 
 #define CM_VOLUME_MAGIC    ('V' | 'O' <<8 | 'L'<<16 | 'M'<<24)
 
+/* 
+ *
+ */
+
+typedef struct cm_vol_state {
+    struct cm_volume *nextp;            /* volumeIDHashTable; by cm_volumeLock */
+    afs_uint32      ID;                 /* by rw */
+    struct cm_fid dotdotFid;           /* parent of volume root */
+    cm_serverRef_t *serversp;           /* by cm_serverLock */
+    enum volstatus  state;              /* by rw */
+    afs_uint32      flags;              /* by rw */
+} cm_vol_state_t;
+
+/* RWVOL, ROVOL, BACKVOL are defined in cm.h */
+#define NUM_VOL_TYPES 3
+
 typedef struct cm_volume {
+    osi_queue_t q;                      /* LRU queue; cm_volumeLock */
     afs_uint32  magic;
+    struct cm_volume *allNextp;                /* allVolumes; by cm_volumeLock */
+    struct cm_volume *nameNextp;        /* volumeNameHashTable; by cm_volumeLock */
     cm_cell_t *cellp;                  /* never changes */
-    char namep[VL_MAXNAMELEN];         /* by cm_volumeLock */
-    unsigned long rwID;                        /* by cm_volumeLock */
-    unsigned long roID;                        /* by cm_volumeLock */
-    unsigned long bkID;                        /* by cm_volumeLock */
-    struct cm_volume *nextp;           /* by cm_volumeLock */
-    struct cm_fid dotdotFid;           /* parent of volume root */
-    osi_mutex_t mx;
-    long flags;                                /* by mx */
-    unsigned long refCount;            /* by cm_volumeLock */
-    cm_serverRef_t *rwServersp;                /* by mx */
-    cm_serverRef_t *roServersp;                /* by mx */
-    cm_serverRef_t *bkServersp;                /* by mx */
+    char namep[VL_MAXNAMELEN];         /* name of the normal volume - assigned during allocation; */
+                                        /* by cm_volumeLock */
+    struct cm_vol_state vol[NUM_VOL_TYPES]; /* by cm_volumeLock */
+    osi_rwlock_t rw;
+    afs_uint32 flags;                  /* by rw */
+    afs_int32 refCount;                        /* by Interlocked operations */
+    time_t cbExpiresRO;                 /* latest RO expiration time; by cm_scacheLock */
 } cm_volume_t;
 
-#define CM_VOLUMEFLAG_RESET    1       /* reload this info on next use */
+#define CM_VOLUMEFLAG_RESET       1    /* reload this info on next use */
+#define CM_VOLUMEFLAG_IN_HASH      2
+#define CM_VOLUMEFLAG_IN_LRU_QUEUE 4
+#define CM_VOLUMEFLAG_UPDATING_VL  8
+
+
+typedef struct cm_volumeRef {
+    struct cm_volumeRef * next;
+    afs_uint32  volID;
+} cm_volumeRef_t;
 
 extern void cm_InitVolume(int newFile, long maxVols);
 
-extern long cm_GetVolumeByName(struct cm_cell *, char *, struct cm_user *,
-       struct cm_req *, long, cm_volume_t **);
+extern long cm_FindVolumeByName(struct cm_cell *cellp, char *volNamep, 
+                               struct cm_user *userp, struct cm_req *reqp, 
+                               afs_uint32 flags, cm_volume_t **outVolpp);
 
-extern long cm_GetVolumeByID(struct cm_cell *cellp, long volumeID,
-       cm_user_t *userp, cm_req_t *reqp, cm_volume_t **outVolpp);
+extern long cm_FindVolumeByID(struct cm_cell *cellp, afs_uint32 volumeID,
+                             cm_user_t *userp, cm_req_t *reqp, 
+                             afs_uint32 flags, cm_volume_t **outVolpp);
+
+#define CM_GETVOL_FLAG_CREATE               1
+#define CM_GETVOL_FLAG_NO_LRU_UPDATE        2
+#define CM_GETVOL_FLAG_NO_RESET                    4
+
+/* hash define.  Must not include the cell, since the callback revocation code
+ * doesn't necessarily know the cell in the case of a multihomed server
+ * contacting us from a mystery address.
+ */
+#define CM_VOLUME_ID_HASH(volid)   ((unsigned long) volid \
+                                       % cm_data.volumeHashTableSize)
+
+#define CM_VOLUME_NAME_HASH(name)  (SDBMHash(name) % cm_data.volumeHashTableSize)
+
+extern afs_uint32 SDBMHash(const char *);
 
 extern void cm_GetVolume(cm_volume_t *volp);
 
+extern cm_volume_t *cm_GetVolumeByFID(cm_fid_t *);
+
 extern void cm_PutVolume(cm_volume_t *volp);
 
 extern long cm_GetROVolumeID(cm_volume_t *volp);
@@ -50,7 +92,7 @@ extern long cm_GetROVolumeID(cm_volume_t *volp);
 extern void cm_ForceUpdateVolume(struct cm_fid *fidp, cm_user_t *userp,
        cm_req_t *reqp);
 
-extern cm_serverRef_t **cm_GetVolServers(cm_volume_t *volp, unsigned long volume);
+extern cm_serverRef_t **cm_GetVolServers(cm_volume_t *volp, afs_uint32 volume);
 
 extern void cm_ChangeRankVolume(cm_server_t *tsp);
 
@@ -61,4 +103,40 @@ extern long cm_ValidateVolume(void);
 extern long cm_ShutdownVolume(void);
 
 extern int cm_DumpVolumes(FILE *outputFile, char *cookie, int lock);
+
+extern int cm_VolNameIsID(char *aname);
+
+extern void cm_RemoveVolumeFromNameHashTable(cm_volume_t * volp);
+
+extern void cm_RemoveVolumeFromIDHashTable(cm_volume_t * volp, afs_uint32 volType);
+
+extern void cm_AddVolumeToNameHashTable(cm_volume_t * volp);
+
+extern void cm_AddVolumeToIDHashTable(cm_volume_t * volp, afs_uint32 volType);
+
+extern void cm_AdjustVolumeLRU(cm_volume_t *volp);
+
+extern void cm_MoveVolumeToLRULast(cm_volume_t *volp);
+
+extern void cm_RemoveVolumeFromLRU(cm_volume_t *volp);
+
+extern void cm_CheckOfflineVolumes(void);
+
+extern long cm_CheckOfflineVolume(cm_volume_t *volp, afs_uint32 volID);
+
+extern void cm_UpdateVolumeStatus(cm_volume_t *volp, afs_uint32 volID);
+
+extern void cm_VolumeStatusNotification(cm_volume_t * volp, afs_uint32 volID, enum volstatus oldState, enum volstatus newState);
+
+extern enum volstatus cm_GetVolumeStatus(cm_volume_t *volp, afs_uint32 volID);
+
+extern void cm_VolumeRenewROCallbacks(void);
+
+extern cm_vol_state_t * cm_VolumeStateByType(cm_volume_t *volp, afs_uint32 type);
+
+extern cm_vol_state_t * cm_VolumeStateByID(cm_volume_t *volp, afs_uint32 id);
+
+extern cm_vol_state_t * cm_VolumeStateByName(cm_volume_t *volp, char *volname);
+
+extern osi_rwlock_t cm_volumeLock;
 #endif /*  __CM_VOLUME_H_ENV__ */