ceph/src/include/ceph_features.h

   1 #ifndef __CEPH_FEATURES
   2 #define __CEPH_FEATURES
   3
   4 #include "sys/types.h"
   5
   6 /*
   7  * Each time we reclaim bits for reuse we need to specify another
   8  * bitmask that, if all bits are set, indicates we have the new
   9  * incarnation of that feature.  Base case is 1 (first use)
  10  */
  11 #define CEPH_FEATURE_INCARNATION_1 (0ull)
  12 #define CEPH_FEATURE_INCARNATION_2 (1ull<<57)              // SERVER_JEWEL
  13 #define CEPH_FEATURE_INCARNATION_3 ((1ull<<57)|(1ull<<28)) // SERVER_MIMIC
  14
  15 #define DEFINE_CEPH_FEATURE(bit, incarnation, name)                     \
  16         const static uint64_t CEPH_FEATURE_##name = (1ULL<<bit);                \
  17         const static uint64_t CEPH_FEATUREMASK_##name =                 \
  18                 (1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation);
  19
  20 // this bit is ignored but still advertised by release *when*
  21 #define DEFINE_CEPH_FEATURE_DEPRECATED(bit, incarnation, name, when) \
  22         const static uint64_t DEPRECATED_CEPH_FEATURE_##name = (1ULL<<bit); \
  23         const static uint64_t DEPRECATED_CEPH_FEATUREMASK_##name =              \
  24                 (1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation);
  25
  26 // this bit is ignored by release *unused* and not advertised by
  27 // release *unadvertised*
  28 #define DEFINE_CEPH_FEATURE_RETIRED(bit, inc, name, unused, unadvertised)
  29
  30
  31 // test for a feature.  this test is safer than a typical mask against
  32 // the bit because it ensures that we have the bit AND the marker for the
  33 // bit's incarnation.  this must be used in any case where the features
  34 // bits may include an old meaning of the bit.
  35 #define HAVE_FEATURE(x, name)                           \
  36         (((x) & (CEPH_FEATUREMASK_##name)) == (CEPH_FEATUREMASK_##name))
  37
  38
  39 /*
  40  * Notes on deprecation:
  41  *
  42  * For feature bits used *only* on the server-side:
  43  *
  44  *  - In the first phase we indicate that a feature is DEPRECATED as of
  45  *    a particular release.  This is the first major release X (say,
  46  *    mimic) that does not depend on its peers advertising the feature.
  47  *    That is, it safely assumes its peers all have the feature.  We
  48  *    indicate this with the DEPRECATED macro.  For example,
  49  *
  50  *      DEFINE_CEPH_FEATURE_DEPRECATED( 2, 1, MON_METADATA, MIMIC)
  51  *
  52  *    because 13.2.z (mimic) did not care if its peers advertised this
  53  *    feature bit.
  54  *
  55  *  - In the second phase we stop advertising the the bit and call it
  56  *    RETIRED.  This can normally be done 2 major releases
  57  *    following the one in which we marked the feature DEPRECATED.  In
  58  *    the above example, for 15.0.z (octopus) we can say:
  59  *
  60  *      DEFINE_CEPH_FEATURE_RETIRED( 2, 1, MON_METADATA, MIMIC, OCTOPUS)
  61  *
  62  *  - The bit can be reused in the next release that will never talk to
  63  *    a pre-octopus daemon (13 mimic or 14 nautlius) that advertises the
  64  *    bit: in this case, the 16.y.z (P-release).
  65  *
  66  * This ensures that no two versions who have different meanings for
  67  * the bit ever speak to each other.
  68  */
  69
  70 /*
  71  * Notes on the kernel client:
  72  *
  73  * - "X" means that the feature bit has been advertised and supported
  74  *   since kernel X
  75  *
  76  * - "X req" means that the feature bit has been advertised and required
  77  *   since kernel X
  78  *
  79  * The remaining feature bits are not and have never been used by the
  80  * kernel client.
  81  */
  82
  83 DEFINE_CEPH_FEATURE( 0, 1, UID)
  84 DEFINE_CEPH_FEATURE( 1, 1, NOSRCADDR)        // 2.6.35 req
  85 DEFINE_CEPH_FEATURE_RETIRED( 2, 1, MONCLOCKCHECK, JEWEL, LUMINOUS)
  86
  87 DEFINE_CEPH_FEATURE( 2, 3, SERVER_NAUTILUS)
  88 DEFINE_CEPH_FEATURE( 3, 1, FLOCK)            // 2.6.36
  89 DEFINE_CEPH_FEATURE( 4, 1, SUBSCRIBE2)       // 4.6 req
  90 DEFINE_CEPH_FEATURE( 5, 1, MONNAMES)
  91 DEFINE_CEPH_FEATURE( 6, 1, RECONNECT_SEQ)    // 3.10 req
  92 DEFINE_CEPH_FEATURE( 7, 1, DIRLAYOUTHASH)    // 2.6.38
  93 DEFINE_CEPH_FEATURE( 8, 1, OBJECTLOCATOR)
  94 DEFINE_CEPH_FEATURE( 9, 1, PGID64)           // 3.9 req
  95 DEFINE_CEPH_FEATURE(10, 1, INCSUBOSDMAP)
  96 DEFINE_CEPH_FEATURE(11, 1, PGPOOL3)          // 3.9 req
  97 DEFINE_CEPH_FEATURE(12, 1, OSDREPLYMUX)
  98 DEFINE_CEPH_FEATURE(13, 1, OSDENC)           // 3.9 req
  99 DEFINE_CEPH_FEATURE_RETIRED(14, 1, OMAP, HAMMER, JEWEL)
 100
 101 DEFINE_CEPH_FEATURE(14, 2, SERVER_KRAKEN)
 102 DEFINE_CEPH_FEATURE(15, 1, MONENC)
 103 DEFINE_CEPH_FEATURE_RETIRED(16, 1, QUERY_T, JEWEL, LUMINOUS)
 104
 105 DEFINE_CEPH_FEATURE(16, 3, SERVER_OCTOPUS)
 106 DEFINE_CEPH_FEATURE(16, 3, OSD_REPOP_MLCOD)
 107 DEFINE_CEPH_FEATURE_RETIRED(17, 1, INDEP_PG_MAP, JEWEL, LUMINOUS)
 108
 109 DEFINE_CEPH_FEATURE(17, 3, OS_PERF_STAT_NS)
 110 DEFINE_CEPH_FEATURE(18, 1, CRUSH_TUNABLES)   // 3.6
 111 DEFINE_CEPH_FEATURE_RETIRED(19, 1, CHUNKY_SCRUB, JEWEL, LUMINOUS)
 112 DEFINE_CEPH_FEATURE(19, 2, OSD_PGLOG_HARDLIMIT)
 113 DEFINE_CEPH_FEATURE_RETIRED(20, 1, MON_NULLROUTE, JEWEL, LUMINOUS)
 114
 115 DEFINE_CEPH_FEATURE_RETIRED(21, 1, MON_GV, HAMMER, JEWEL)
 116
 117 DEFINE_CEPH_FEATURE(21, 2, SERVER_LUMINOUS)  // 4.13
 118 DEFINE_CEPH_FEATURE(21, 2, RESEND_ON_SPLIT)  // overlap
 119 DEFINE_CEPH_FEATURE(21, 2, RADOS_BACKOFF)    // overlap
 120 DEFINE_CEPH_FEATURE(21, 2, OSDMAP_PG_UPMAP)  // overlap
 121 DEFINE_CEPH_FEATURE(21, 2, CRUSH_CHOOSE_ARGS) // overlap
 122 DEFINE_CEPH_FEATURE_RETIRED(22, 1, BACKFILL_RESERVATION, JEWEL, LUMINOUS)
 123 DEFINE_CEPH_FEATURE(22, 2, OSD_FIXED_COLLECTION_LIST)
 124 DEFINE_CEPH_FEATURE(23, 1, MSG_AUTH)         // 3.19 req (unless nocephx_require_signatures)
 125 DEFINE_CEPH_FEATURE_RETIRED(24, 1, RECOVERY_RESERVATION, JEWEL, LUMINOUS)
 126
 127 DEFINE_CEPH_FEATURE(24, 2, RECOVERY_RESERVATION_2)
 128 DEFINE_CEPH_FEATURE(25, 1, CRUSH_TUNABLES2)  // 3.9
 129 DEFINE_CEPH_FEATURE(26, 1, CREATEPOOLID)
 130 DEFINE_CEPH_FEATURE(27, 1, REPLY_CREATE_INODE) // 3.9
 131 DEFINE_CEPH_FEATURE_RETIRED(28, 1, OSD_HBMSGS, HAMMER, JEWEL)
 132
 133 DEFINE_CEPH_FEATURE(28, 2, SERVER_MIMIC)
 134 DEFINE_CEPH_FEATURE(29, 1, MDSENC)           // 4.7
 135 DEFINE_CEPH_FEATURE(30, 1, OSDHASHPSPOOL)    // 3.9
 136 DEFINE_CEPH_FEATURE_DEPRECATED(31, 1, MON_SINGLE_PAXOS, NAUTILUS)
 137 DEFINE_CEPH_FEATURE_RETIRED(32, 1, OSD_SNAPMAPPER, JEWEL, LUMINOUS)
 138
 139 DEFINE_CEPH_FEATURE_RETIRED(33, 1, MON_SCRUB, JEWEL, LUMINOUS)
 140
 141 DEFINE_CEPH_FEATURE_RETIRED(34, 1, OSD_PACKED_RECOVERY, JEWEL, LUMINOUS)
 142
 143 DEFINE_CEPH_FEATURE(35, 1, OSD_CACHEPOOL)    // 3.14
 144 DEFINE_CEPH_FEATURE(36, 1, CRUSH_V2)         // 3.14
 145 DEFINE_CEPH_FEATURE(37, 1, EXPORT_PEER)      // 3.14
 146 DEFINE_CEPH_FEATURE_RETIRED(38, 1, OSD_ERASURE_CODES, MIMIC, OCTOPUS)
 147 DEFINE_CEPH_FEATURE(39, 1, OSDMAP_ENC)       // 3.15
 148 DEFINE_CEPH_FEATURE(40, 1, MDS_INLINE_DATA)  // 3.19
 149 DEFINE_CEPH_FEATURE(41, 1, CRUSH_TUNABLES3)  // 3.15
 150 DEFINE_CEPH_FEATURE(41, 1, OSD_PRIMARY_AFFINITY) // overlap
 151 DEFINE_CEPH_FEATURE(42, 1, MSGR_KEEPALIVE2)  // 4.3 (for consistency)
 152 DEFINE_CEPH_FEATURE(43, 1, OSD_POOLRESEND)   // 4.13
 153 DEFINE_CEPH_FEATURE_RETIRED(44, 1, ERASURE_CODE_PLUGINS_V2, MIMIC, OCTOPUS)
 154 DEFINE_CEPH_FEATURE_RETIRED(45, 1, OSD_SET_ALLOC_HINT, JEWEL, LUMINOUS)
 155
 156 DEFINE_CEPH_FEATURE(46, 1, OSD_FADVISE_FLAGS)
 157 DEFINE_CEPH_FEATURE_RETIRED(46, 1, OSD_REPOP, JEWEL, LUMINOUS) // overlap
 158 DEFINE_CEPH_FEATURE_RETIRED(46, 1, OSD_OBJECT_DIGEST, JEWEL, LUMINOUS) // overlap
 159 DEFINE_CEPH_FEATURE_RETIRED(46, 1, OSD_TRANSACTION_MAY_LAYOUT, JEWEL, LUMINOUS) // overlap
 160
 161 DEFINE_CEPH_FEATURE(47, 1, MDS_QUOTA)        // 4.17
 162 DEFINE_CEPH_FEATURE(48, 1, CRUSH_V4)         // 4.1
 163 DEFINE_CEPH_FEATURE_RETIRED(49, 1, OSD_MIN_SIZE_RECOVERY, JEWEL, LUMINOUS)
 164 DEFINE_CEPH_FEATURE_RETIRED(49, 1, OSD_PROXY_FEATURES, JEWEL, LUMINOUS) // overlap
 165
 166 DEFINE_CEPH_FEATURE_RETIRED(50, 1, MON_METADATA, MIMIC, OCTOPUS)
 167 DEFINE_CEPH_FEATURE_RETIRED(51, 1, OSD_BITWISE_HOBJ_SORT, MIMIC, OCTOPUS)
 168 DEFINE_CEPH_FEATURE_RETIRED(52, 1, OSD_PROXY_WRITE_FEATURES, MIMIC, OCTOPUS)
 169 DEFINE_CEPH_FEATURE_RETIRED(53, 1, ERASURE_CODE_PLUGINS_V3, MIMIC, OCTOPUS)
 170 DEFINE_CEPH_FEATURE_RETIRED(54, 1, OSD_HITSET_GMT, MIMIC, OCTOPUS)
 171 DEFINE_CEPH_FEATURE_RETIRED(55, 1, HAMMER_0_94_4, MIMIC, OCTOPUS)
 172
 173 DEFINE_CEPH_FEATURE(56, 1, NEW_OSDOP_ENCODING) // 4.13 (for pg_pool_t >= v25)
 174 DEFINE_CEPH_FEATURE(57, 1, MON_STATEFUL_SUB) // 4.13
 175 DEFINE_CEPH_FEATURE_RETIRED(57, 1, MON_ROUTE_OSDMAP, MIMIC, OCTOPUS) // overlap
 176 DEFINE_CEPH_FEATURE(57, 1, SERVER_JEWEL) // overlap
 177 DEFINE_CEPH_FEATURE(58, 1, CRUSH_TUNABLES5)  // 4.5
 178 DEFINE_CEPH_FEATURE(58, 1, NEW_OSDOPREPLY_ENCODING) // overlap
 179 DEFINE_CEPH_FEATURE(58, 1, FS_FILE_LAYOUT_V2) // overlap
 180 DEFINE_CEPH_FEATURE(59, 1, FS_BTIME)
 181 DEFINE_CEPH_FEATURE(59, 1, FS_CHANGE_ATTR) // overlap
 182 DEFINE_CEPH_FEATURE(59, 1, MSG_ADDR2) // overlap
 183 DEFINE_CEPH_FEATURE(60, 1, OSD_RECOVERY_DELETES) // *do not share this bit*
 184 DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2)         // 4.19, *do not share this bit*
 185
 186 DEFINE_CEPH_FEATURE(62, 1, RESERVED)           // do not use; used as a sentinel
 187 DEFINE_CEPH_FEATURE_DEPRECATED(63, 1, RESERVED_BROKEN, LUMINOUS) // client-facing
 188
 189
 190 /*
 191  * Features supported.  Should be everything above.
 192  */
 193 #define CEPH_FEATURES_ALL                \
 194         (CEPH_FEATURE_UID |              \
 195          CEPH_FEATURE_NOSRCADDR |        \
 196          CEPH_FEATURE_FLOCK |            \
 197          CEPH_FEATURE_SUBSCRIBE2 |       \
 198          CEPH_FEATURE_MONNAMES |         \
 199          CEPH_FEATURE_RECONNECT_SEQ |    \
 200          CEPH_FEATURE_DIRLAYOUTHASH |    \
 201          CEPH_FEATURE_OBJECTLOCATOR |    \
 202          CEPH_FEATURE_PGID64 |           \
 203          CEPH_FEATURE_INCSUBOSDMAP |     \
 204          CEPH_FEATURE_PGPOOL3 |          \
 205          CEPH_FEATURE_OSDREPLYMUX |      \
 206          CEPH_FEATURE_OSDENC |           \
 207          CEPH_FEATURE_MONENC |           \
 208          CEPH_FEATURE_CRUSH_TUNABLES |   \
 209          CEPH_FEATURE_MSG_AUTH |             \
 210          CEPH_FEATURE_CRUSH_TUNABLES2 |      \
 211          CEPH_FEATURE_CREATEPOOLID |         \
 212          CEPH_FEATURE_REPLY_CREATE_INODE |   \
 213          CEPH_FEATURE_MDSENC |                  \
 214          CEPH_FEATURE_OSDHASHPSPOOL |       \
 215          CEPH_FEATURE_NEW_OSDOP_ENCODING |        \
 216          CEPH_FEATURE_NEW_OSDOPREPLY_ENCODING | \
 217          DEPRECATED_CEPH_FEATURE_MON_SINGLE_PAXOS |    \
 218          CEPH_FEATURE_OSD_CACHEPOOL |       \
 219          CEPH_FEATURE_CRUSH_V2 |            \
 220          CEPH_FEATURE_EXPORT_PEER |         \
 221          CEPH_FEATURE_OSDMAP_ENC |          \
 222          CEPH_FEATURE_MDS_INLINE_DATA |     \
 223          CEPH_FEATURE_CRUSH_TUNABLES3 |     \
 224          CEPH_FEATURE_OSD_PRIMARY_AFFINITY |    \
 225          CEPH_FEATURE_MSGR_KEEPALIVE2 | \
 226          CEPH_FEATURE_OSD_POOLRESEND |  \
 227          CEPH_FEATURE_OSD_FADVISE_FLAGS |     \
 228          CEPH_FEATURE_MDS_QUOTA | \
 229          CEPH_FEATURE_CRUSH_V4 |             \
 230          CEPH_FEATURE_MON_STATEFUL_SUB |         \
 231          CEPH_FEATURE_CRUSH_TUNABLES5 |     \
 232          CEPH_FEATURE_SERVER_JEWEL |  \
 233          CEPH_FEATURE_FS_FILE_LAYOUT_V2 |                \
 234          CEPH_FEATURE_SERVER_KRAKEN |   \
 235          CEPH_FEATURE_FS_BTIME |                         \
 236          CEPH_FEATURE_FS_CHANGE_ATTR |                   \
 237          CEPH_FEATURE_MSG_ADDR2 | \
 238          CEPH_FEATURE_SERVER_LUMINOUS |         \
 239          CEPH_FEATURE_RESEND_ON_SPLIT |         \
 240          CEPH_FEATURE_RADOS_BACKOFF |           \
 241          CEPH_FEATURE_OSD_RECOVERY_DELETES |    \
 242          CEPH_FEATURE_SERVER_MIMIC |            \
 243          CEPH_FEATURE_RECOVERY_RESERVATION_2 |  \
 244          CEPH_FEATURE_SERVER_NAUTILUS |         \
 245          CEPH_FEATURE_CEPHX_V2 | \
 246          CEPH_FEATURE_OSD_PGLOG_HARDLIMIT | \
 247          CEPH_FEATUREMASK_SERVER_OCTOPUS | \
 248          CEPH_FEATUREMASK_OSD_REPOP_MLCOD | \
 249          CEPH_FEATURE_OSD_FIXED_COLLECTION_LIST | \
 250          0ULL)
 251
 252 #define CEPH_FEATURES_SUPPORTED_DEFAULT  CEPH_FEATURES_ALL
 253
 254 /*
 255  * crush related features
 256  */
 257 #define CEPH_FEATURES_CRUSH                     \
 258         (CEPH_FEATURE_CRUSH_TUNABLES |          \
 259          CEPH_FEATURE_CRUSH_TUNABLES2 |         \
 260          CEPH_FEATURE_CRUSH_TUNABLES3 |         \
 261          CEPH_FEATURE_CRUSH_TUNABLES5 |         \
 262          CEPH_FEATURE_CRUSH_V2 |                \
 263          CEPH_FEATURE_CRUSH_V4 |                \
 264          CEPH_FEATUREMASK_CRUSH_CHOOSE_ARGS)
 265
 266 /*
 267  * make sure we don't try to use the reserved features
 268  */
 269 #define CEPH_STATIC_ASSERT(x) (void)(sizeof(int[((x)==0) ? -1 : 0]))
 270
 271 static inline void ____build_time_check_for_reserved_bits(void) {
 272         CEPH_STATIC_ASSERT((CEPH_FEATURES_ALL &
 273                             (CEPH_FEATURE_RESERVED |
 274                              DEPRECATED_CEPH_FEATURE_RESERVED_BROKEN)) == 0);
 275 }
 276
 277 #endif