]> git.proxmox.com Git - ceph.git/blame - ceph/src/include/ceph_features.h
update ceph source to reef 18.2.1
[ceph.git] / ceph / src / include / ceph_features.h
CommitLineData
7c673cae
FG
1#ifndef __CEPH_FEATURES
2#define __CEPH_FEATURES
3
4#include "sys/types.h"
5
6/*
11fdf7f2
TL
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)
7c673cae
FG
10 */
11#define CEPH_FEATURE_INCARNATION_1 (0ull)
11fdf7f2
TL
12#define CEPH_FEATURE_INCARNATION_2 (1ull<<57) // SERVER_JEWEL
13#define CEPH_FEATURE_INCARNATION_3 ((1ull<<57)|(1ull<<28)) // SERVER_MIMIC
7c673cae
FG
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 *
7c673cae
FG
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,
9f95a23c 46 * mimic) that does not depend on its peers advertising the feature.
7c673cae
FG
47 * That is, it safely assumes its peers all have the feature. We
48 * indicate this with the DEPRECATED macro. For example,
49 *
9f95a23c 50 * DEFINE_CEPH_FEATURE_DEPRECATED( 2, 1, MON_METADATA, MIMIC)
7c673cae 51 *
9f95a23c 52 * because 13.2.z (mimic) did not care if its peers advertised this
7c673cae
FG
53 * feature bit.
54 *
55 * - In the second phase we stop advertising the the bit and call it
9f95a23c 56 * RETIRED. This can normally be done 2 major releases
7c673cae 57 * following the one in which we marked the feature DEPRECATED. In
9f95a23c 58 * the above example, for 15.0.z (octopus) we can say:
7c673cae 59 *
9f95a23c 60 * DEFINE_CEPH_FEATURE_RETIRED( 2, 1, MON_METADATA, MIMIC, OCTOPUS)
7c673cae 61 *
9f95a23c
TL
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).
7c673cae
FG
65 *
66 * This ensures that no two versions who have different meanings for
67 * the bit ever speak to each other.
68 */
69
11fdf7f2
TL
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
7c673cae 83DEFINE_CEPH_FEATURE( 0, 1, UID)
11fdf7f2 84DEFINE_CEPH_FEATURE( 1, 1, NOSRCADDR) // 2.6.35 req
7c673cae 85DEFINE_CEPH_FEATURE_RETIRED( 2, 1, MONCLOCKCHECK, JEWEL, LUMINOUS)
11fdf7f2
TL
86DEFINE_CEPH_FEATURE( 2, 3, SERVER_NAUTILUS)
87DEFINE_CEPH_FEATURE( 3, 1, FLOCK) // 2.6.36
88DEFINE_CEPH_FEATURE( 4, 1, SUBSCRIBE2) // 4.6 req
7c673cae 89DEFINE_CEPH_FEATURE( 5, 1, MONNAMES)
11fdf7f2
TL
90DEFINE_CEPH_FEATURE( 6, 1, RECONNECT_SEQ) // 3.10 req
91DEFINE_CEPH_FEATURE( 7, 1, DIRLAYOUTHASH) // 2.6.38
7c673cae 92DEFINE_CEPH_FEATURE( 8, 1, OBJECTLOCATOR)
11fdf7f2 93DEFINE_CEPH_FEATURE( 9, 1, PGID64) // 3.9 req
7c673cae 94DEFINE_CEPH_FEATURE(10, 1, INCSUBOSDMAP)
11fdf7f2 95DEFINE_CEPH_FEATURE(11, 1, PGPOOL3) // 3.9 req
7c673cae 96DEFINE_CEPH_FEATURE(12, 1, OSDREPLYMUX)
11fdf7f2 97DEFINE_CEPH_FEATURE(13, 1, OSDENC) // 3.9 req
7c673cae
FG
98DEFINE_CEPH_FEATURE_RETIRED(14, 1, OMAP, HAMMER, JEWEL)
99DEFINE_CEPH_FEATURE(14, 2, SERVER_KRAKEN)
100DEFINE_CEPH_FEATURE(15, 1, MONENC)
101DEFINE_CEPH_FEATURE_RETIRED(16, 1, QUERY_T, JEWEL, LUMINOUS)
9f95a23c
TL
102DEFINE_CEPH_FEATURE(16, 3, SERVER_OCTOPUS)
103DEFINE_CEPH_FEATURE(16, 3, OSD_REPOP_MLCOD)
7c673cae 104DEFINE_CEPH_FEATURE_RETIRED(17, 1, INDEP_PG_MAP, JEWEL, LUMINOUS)
11fdf7f2
TL
105DEFINE_CEPH_FEATURE(17, 3, OS_PERF_STAT_NS)
106DEFINE_CEPH_FEATURE(18, 1, CRUSH_TUNABLES) // 3.6
7c673cae 107DEFINE_CEPH_FEATURE_RETIRED(19, 1, CHUNKY_SCRUB, JEWEL, LUMINOUS)
f64942e4 108DEFINE_CEPH_FEATURE(19, 2, OSD_PGLOG_HARDLIMIT)
7c673cae 109DEFINE_CEPH_FEATURE_RETIRED(20, 1, MON_NULLROUTE, JEWEL, LUMINOUS)
f67539c2 110DEFINE_CEPH_FEATURE(20, 3, SERVER_PACIFIC)
7c673cae 111DEFINE_CEPH_FEATURE_RETIRED(21, 1, MON_GV, HAMMER, JEWEL)
11fdf7f2 112DEFINE_CEPH_FEATURE(21, 2, SERVER_LUMINOUS) // 4.13
7c673cae
FG
113DEFINE_CEPH_FEATURE(21, 2, RESEND_ON_SPLIT) // overlap
114DEFINE_CEPH_FEATURE(21, 2, RADOS_BACKOFF) // overlap
115DEFINE_CEPH_FEATURE(21, 2, OSDMAP_PG_UPMAP) // overlap
31f18b77 116DEFINE_CEPH_FEATURE(21, 2, CRUSH_CHOOSE_ARGS) // overlap
7c673cae 117DEFINE_CEPH_FEATURE_RETIRED(22, 1, BACKFILL_RESERVATION, JEWEL, LUMINOUS)
f91f0fd5 118DEFINE_CEPH_FEATURE(22, 2, OSD_FIXED_COLLECTION_LIST)
11fdf7f2 119DEFINE_CEPH_FEATURE(23, 1, MSG_AUTH) // 3.19 req (unless nocephx_require_signatures)
9f95a23c 120DEFINE_CEPH_FEATURE_RETIRED(24, 1, RECOVERY_RESERVATION, JEWEL, LUMINOUS)
11fdf7f2
TL
121DEFINE_CEPH_FEATURE(24, 2, RECOVERY_RESERVATION_2)
122DEFINE_CEPH_FEATURE(25, 1, CRUSH_TUNABLES2) // 3.9
7c673cae 123DEFINE_CEPH_FEATURE(26, 1, CREATEPOOLID)
11fdf7f2 124DEFINE_CEPH_FEATURE(27, 1, REPLY_CREATE_INODE) // 3.9
7c673cae 125DEFINE_CEPH_FEATURE_RETIRED(28, 1, OSD_HBMSGS, HAMMER, JEWEL)
11fdf7f2
TL
126DEFINE_CEPH_FEATURE(28, 2, SERVER_MIMIC)
127DEFINE_CEPH_FEATURE(29, 1, MDSENC) // 4.7
128DEFINE_CEPH_FEATURE(30, 1, OSDHASHPSPOOL) // 3.9
20effc67 129DEFINE_CEPH_FEATURE_RETIRED(31, 1, MON_SINGLE_PAXOS, NAUTILUS, PACIFIC)
1e59de90 130DEFINE_CEPH_FEATURE(31, 3, SERVER_REEF)
7c673cae 131DEFINE_CEPH_FEATURE_RETIRED(32, 1, OSD_SNAPMAPPER, JEWEL, LUMINOUS)
f67539c2 132DEFINE_CEPH_FEATURE(32, 3, STRETCH_MODE)
7c673cae 133DEFINE_CEPH_FEATURE_RETIRED(33, 1, MON_SCRUB, JEWEL, LUMINOUS)
20effc67 134DEFINE_CEPH_FEATURE(33, 3, SERVER_QUINCY)
7c673cae 135DEFINE_CEPH_FEATURE_RETIRED(34, 1, OSD_PACKED_RECOVERY, JEWEL, LUMINOUS)
33c7a0ef 136DEFINE_CEPH_FEATURE(34, 3, RANGE_BLOCKLIST)
11fdf7f2
TL
137DEFINE_CEPH_FEATURE(35, 1, OSD_CACHEPOOL) // 3.14
138DEFINE_CEPH_FEATURE(36, 1, CRUSH_V2) // 3.14
139DEFINE_CEPH_FEATURE(37, 1, EXPORT_PEER) // 3.14
9f95a23c 140DEFINE_CEPH_FEATURE_RETIRED(38, 1, OSD_ERASURE_CODES, MIMIC, OCTOPUS)
f67539c2 141// available
11fdf7f2
TL
142DEFINE_CEPH_FEATURE(39, 1, OSDMAP_ENC) // 3.15
143DEFINE_CEPH_FEATURE(40, 1, MDS_INLINE_DATA) // 3.19
144DEFINE_CEPH_FEATURE(41, 1, CRUSH_TUNABLES3) // 3.15
7c673cae 145DEFINE_CEPH_FEATURE(41, 1, OSD_PRIMARY_AFFINITY) // overlap
11fdf7f2
TL
146DEFINE_CEPH_FEATURE(42, 1, MSGR_KEEPALIVE2) // 4.3 (for consistency)
147DEFINE_CEPH_FEATURE(43, 1, OSD_POOLRESEND) // 4.13
9f95a23c 148DEFINE_CEPH_FEATURE_RETIRED(44, 1, ERASURE_CODE_PLUGINS_V2, MIMIC, OCTOPUS)
f67539c2 149// available
7c673cae 150DEFINE_CEPH_FEATURE_RETIRED(45, 1, OSD_SET_ALLOC_HINT, JEWEL, LUMINOUS)
f67539c2 151// available
7c673cae
FG
152DEFINE_CEPH_FEATURE(46, 1, OSD_FADVISE_FLAGS)
153DEFINE_CEPH_FEATURE_RETIRED(46, 1, OSD_REPOP, JEWEL, LUMINOUS) // overlap
154DEFINE_CEPH_FEATURE_RETIRED(46, 1, OSD_OBJECT_DIGEST, JEWEL, LUMINOUS) // overlap
155DEFINE_CEPH_FEATURE_RETIRED(46, 1, OSD_TRANSACTION_MAY_LAYOUT, JEWEL, LUMINOUS) // overlap
11fdf7f2
TL
156DEFINE_CEPH_FEATURE(47, 1, MDS_QUOTA) // 4.17
157DEFINE_CEPH_FEATURE(48, 1, CRUSH_V4) // 4.1
7c673cae
FG
158DEFINE_CEPH_FEATURE_RETIRED(49, 1, OSD_MIN_SIZE_RECOVERY, JEWEL, LUMINOUS)
159DEFINE_CEPH_FEATURE_RETIRED(49, 1, OSD_PROXY_FEATURES, JEWEL, LUMINOUS) // overlap
f67539c2 160// available
9f95a23c 161DEFINE_CEPH_FEATURE_RETIRED(50, 1, MON_METADATA, MIMIC, OCTOPUS)
f67539c2 162// available
9f95a23c 163DEFINE_CEPH_FEATURE_RETIRED(51, 1, OSD_BITWISE_HOBJ_SORT, MIMIC, OCTOPUS)
f67539c2 164// available
9f95a23c 165DEFINE_CEPH_FEATURE_RETIRED(52, 1, OSD_PROXY_WRITE_FEATURES, MIMIC, OCTOPUS)
f67539c2 166// available
9f95a23c 167DEFINE_CEPH_FEATURE_RETIRED(53, 1, ERASURE_CODE_PLUGINS_V3, MIMIC, OCTOPUS)
f67539c2 168// available
9f95a23c 169DEFINE_CEPH_FEATURE_RETIRED(54, 1, OSD_HITSET_GMT, MIMIC, OCTOPUS)
f67539c2 170// available
9f95a23c 171DEFINE_CEPH_FEATURE_RETIRED(55, 1, HAMMER_0_94_4, MIMIC, OCTOPUS)
f67539c2 172// available
11fdf7f2
TL
173DEFINE_CEPH_FEATURE(56, 1, NEW_OSDOP_ENCODING) // 4.13 (for pg_pool_t >= v25)
174DEFINE_CEPH_FEATURE(57, 1, MON_STATEFUL_SUB) // 4.13
9f95a23c 175DEFINE_CEPH_FEATURE_RETIRED(57, 1, MON_ROUTE_OSDMAP, MIMIC, OCTOPUS) // overlap
7c673cae 176DEFINE_CEPH_FEATURE(57, 1, SERVER_JEWEL) // overlap
11fdf7f2 177DEFINE_CEPH_FEATURE(58, 1, CRUSH_TUNABLES5) // 4.5
7c673cae
FG
178DEFINE_CEPH_FEATURE(58, 1, NEW_OSDOPREPLY_ENCODING) // overlap
179DEFINE_CEPH_FEATURE(58, 1, FS_FILE_LAYOUT_V2) // overlap
180DEFINE_CEPH_FEATURE(59, 1, FS_BTIME)
181DEFINE_CEPH_FEATURE(59, 1, FS_CHANGE_ATTR) // overlap
182DEFINE_CEPH_FEATURE(59, 1, MSG_ADDR2) // overlap
c07f9fc5 183DEFINE_CEPH_FEATURE(60, 1, OSD_RECOVERY_DELETES) // *do not share this bit*
11fdf7f2 184DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2) // 4.19, *do not share this bit*
7c673cae 185
11fdf7f2 186DEFINE_CEPH_FEATURE(62, 1, RESERVED) // do not use; used as a sentinel
1e59de90
TL
187DEFINE_CEPH_FEATURE_RETIRED(63, 1, RESERVED_BROKEN, LUMINOUS, QUINCY) // client-facing
188// available
7c673cae
FG
189
190
7c673cae
FG
191/*
192 * Features supported. Should be everything above.
193 */
194#define CEPH_FEATURES_ALL \
195 (CEPH_FEATURE_UID | \
196 CEPH_FEATURE_NOSRCADDR | \
197 CEPH_FEATURE_FLOCK | \
198 CEPH_FEATURE_SUBSCRIBE2 | \
199 CEPH_FEATURE_MONNAMES | \
200 CEPH_FEATURE_RECONNECT_SEQ | \
201 CEPH_FEATURE_DIRLAYOUTHASH | \
202 CEPH_FEATURE_OBJECTLOCATOR | \
203 CEPH_FEATURE_PGID64 | \
204 CEPH_FEATURE_INCSUBOSDMAP | \
205 CEPH_FEATURE_PGPOOL3 | \
206 CEPH_FEATURE_OSDREPLYMUX | \
207 CEPH_FEATURE_OSDENC | \
208 CEPH_FEATURE_MONENC | \
209 CEPH_FEATURE_CRUSH_TUNABLES | \
210 CEPH_FEATURE_MSG_AUTH | \
211 CEPH_FEATURE_CRUSH_TUNABLES2 | \
212 CEPH_FEATURE_CREATEPOOLID | \
213 CEPH_FEATURE_REPLY_CREATE_INODE | \
214 CEPH_FEATURE_MDSENC | \
215 CEPH_FEATURE_OSDHASHPSPOOL | \
216 CEPH_FEATURE_NEW_OSDOP_ENCODING | \
217 CEPH_FEATURE_NEW_OSDOPREPLY_ENCODING | \
7c673cae
FG
218 CEPH_FEATURE_OSD_CACHEPOOL | \
219 CEPH_FEATURE_CRUSH_V2 | \
220 CEPH_FEATURE_EXPORT_PEER | \
7c673cae
FG
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 | \
7c673cae
FG
227 CEPH_FEATURE_OSD_FADVISE_FLAGS | \
228 CEPH_FEATURE_MDS_QUOTA | \
229 CEPH_FEATURE_CRUSH_V4 | \
7c673cae 230 CEPH_FEATURE_MON_STATEFUL_SUB | \
7c673cae
FG
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 | \
11fdf7f2
TL
241 CEPH_FEATURE_OSD_RECOVERY_DELETES | \
242 CEPH_FEATURE_SERVER_MIMIC | \
243 CEPH_FEATURE_RECOVERY_RESERVATION_2 | \
244 CEPH_FEATURE_SERVER_NAUTILUS | \
28e407b8 245 CEPH_FEATURE_CEPHX_V2 | \
f64942e4 246 CEPH_FEATURE_OSD_PGLOG_HARDLIMIT | \
9f95a23c 247 CEPH_FEATUREMASK_SERVER_OCTOPUS | \
f67539c2 248 CEPH_FEATUREMASK_STRETCH_MODE | \
9f95a23c 249 CEPH_FEATUREMASK_OSD_REPOP_MLCOD | \
f67539c2 250 CEPH_FEATUREMASK_SERVER_PACIFIC | \
f91f0fd5 251 CEPH_FEATURE_OSD_FIXED_COLLECTION_LIST | \
20effc67 252 CEPH_FEATUREMASK_SERVER_QUINCY | \
33c7a0ef 253 CEPH_FEATURE_RANGE_BLOCKLIST | \
1e59de90 254 CEPH_FEATUREMASK_SERVER_REEF | \
7c673cae
FG
255 0ULL)
256
257#define CEPH_FEATURES_SUPPORTED_DEFAULT CEPH_FEATURES_ALL
258
259/*
260 * crush related features
261 */
262#define CEPH_FEATURES_CRUSH \
263 (CEPH_FEATURE_CRUSH_TUNABLES | \
264 CEPH_FEATURE_CRUSH_TUNABLES2 | \
265 CEPH_FEATURE_CRUSH_TUNABLES3 | \
266 CEPH_FEATURE_CRUSH_TUNABLES5 | \
267 CEPH_FEATURE_CRUSH_V2 | \
268 CEPH_FEATURE_CRUSH_V4 | \
c07f9fc5 269 CEPH_FEATUREMASK_CRUSH_CHOOSE_ARGS)
7c673cae
FG
270
271/*
272 * make sure we don't try to use the reserved features
273 */
274#define CEPH_STATIC_ASSERT(x) (void)(sizeof(int[((x)==0) ? -1 : 0]))
275
276static inline void ____build_time_check_for_reserved_bits(void) {
1e59de90 277 CEPH_STATIC_ASSERT((CEPH_FEATURES_ALL & CEPH_FEATURE_RESERVED) == 0);
7c673cae
FG
278}
279
280#endif