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