Skip to contentSkip to conversation

ceph: use an enum instead of 'static const' to define constants

PATCH In review Arnd Bergmann 2 participants 4 messages Oct 5, 2018 – Oct 8, 2018 Ceph common code (libceph)

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ceph: use an enum instead of 'static const' to define constants

Building with W=1 produces lots of warnings for files including ceph_features.h:

include/linux/ceph/ceph_features.h:15:24: error: 'CEPH_FEATUREMASK_SERVER_M' defined but not used [-Werror=unused-const-variable=]

The normal way to define compile-time constants in the kernel is to use either macros or enums, and gcc does not warn about those.

Converting to an enum is simple here and means we can still use the names while debugging.

---
 include/linux/ceph/ceph_features.h | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
include/linux/ceph/ceph_features.h +10 -10
index 6b92b3395fa9..676908eca060 100644
@@ -11,15 +11,15 @@
 #define CEPH_FEATURE_INCARNATION_2 (1ull<<57) // CEPH_FEATURE_SERVER_JEWEL
 
 #define DEFINE_CEPH_FEATURE(bit, incarnation, name)			\
-	static const uint64_t CEPH_FEATURE_##name = (1ULL<<bit);		\
-	static const uint64_t CEPH_FEATUREMASK_##name =			\
-		(1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation);
+	CEPH_FEATURE_##name = (1ULL<<bit),				\
+	CEPH_FEATUREMASK_##name =					\
+		(1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation),
 
 /* this bit is ignored but still advertised by release *when* */
-#define DEFINE_CEPH_FEATURE_DEPRECATED(bit, incarnation, name, when) \
-	static const uint64_t DEPRECATED_CEPH_FEATURE_##name = (1ULL<<bit); \
-	static const uint64_t DEPRECATED_CEPH_FEATUREMASK_##name =		\
-		(1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation);
+#define DEFINE_CEPH_FEATURE_DEPRECATED(bit, incarnation, name, when)	\
+	DEPRECATED_CEPH_FEATURE_##name = (1ULL<<bit),			\
+	DEPRECATED_CEPH_FEATUREMASK_##name =				\
+		(1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation),
 
 /*
  * this bit is ignored by release *unused* and not advertised by
@@ -71,7 +71,7 @@
  * This ensures that no two versions who have different meanings for
  * the bit ever speak to each other.
  */
-
+enum ceph_features {
 DEFINE_CEPH_FEATURE( 0, 1, UID)
 DEFINE_CEPH_FEATURE( 1, 1, NOSRCADDR)
 DEFINE_CEPH_FEATURE_RETIRED( 2, 1, MONCLOCKCHECK, JEWEL, LUMINOUS)
@@ -170,13 +170,13 @@ DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2)             // *do not share this bit*
 
 DEFINE_CEPH_FEATURE(62, 1, RESERVED)           // do not use; used as a sentinal
 DEFINE_CEPH_FEATURE_DEPRECATED(63, 1, RESERVED_BROKEN, LUMINOUS) // client-facing
-
+};
 
 /*
  * Features supported.
  */
 #define CEPH_FEATURES_SUPPORTED_DEFAULT		\
-	(CEPH_FEATURE_NOSRCADDR |		\
+	(u64)(CEPH_FEATURE_NOSRCADDR |		\
 	 CEPH_FEATURE_FLOCK |			\
 	 CEPH_FEATURE_SUBSCRIBE2 |		\
 	 CEPH_FEATURE_RECONNECT_SEQ |		\
Signature · 1 line
2.18.0
maintainer
#1 lore raw
Quoted 54 lines · Arnd Bergmann

Building with W=1 produces lots of warnings for files including ceph_features.h:

include/linux/ceph/ceph_features.h:15:24: error: 'CEPH_FEATUREMASK_SERVER_M' defined but not used [-Werror=unused-const-variable=]

The normal way to define compile-time constants in the kernel is to use either macros or enums, and gcc does not warn about those.

Converting to an enum is simple here and means we can still use the names while debugging.

---
 include/linux/ceph/ceph_features.h | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
include/linux/ceph/ceph_features.h +8 -8
index 6b92b3395fa9..676908eca060 100644
@@ -11,15 +11,15 @@
 #define CEPH_FEATURE_INCARNATION_2 (1ull<<57) // CEPH_FEATURE_SERVER_JEWEL
 
 #define DEFINE_CEPH_FEATURE(bit, incarnation, name)                    \
-       static const uint64_t CEPH_FEATURE_##name = (1ULL<<bit);                \
-       static const uint64_t CEPH_FEATUREMASK_##name =                 \
-               (1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation);
+       CEPH_FEATURE_##name = (1ULL<<bit),                              \
+       CEPH_FEATUREMASK_##name =                                       \
+               (1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation),
 
 /* this bit is ignored but still advertised by release *when* */
-#define DEFINE_CEPH_FEATURE_DEPRECATED(bit, incarnation, name, when) \
-       static const uint64_t DEPRECATED_CEPH_FEATURE_##name = (1ULL<<bit); \
-       static const uint64_t DEPRECATED_CEPH_FEATUREMASK_##name =              \
-               (1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation);
+#define DEFINE_CEPH_FEATURE_DEPRECATED(bit, incarnation, name, when)   \
+       DEPRECATED_CEPH_FEATURE_##name = (1ULL<<bit),                   \
+       DEPRECATED_CEPH_FEATUREMASK_##name =                            \
+               (1ULL<<bit | CEPH_FEATURE_INCARNATION_##incarnation),
 
 /*
  * this bit is ignored by release *unused* and not advertised by
@@ -71,7 +71,7 @@
  * This ensures that no two versions who have different meanings for
  * the bit ever speak to each other.
  */
-
+enum ceph_features {
 DEFINE_CEPH_FEATURE( 0, 1, UID)
 DEFINE_CEPH_FEATURE( 1, 1, NOSRCADDR)
 DEFINE_CEPH_FEATURE_RETIRED( 2, 1, MONCLOCKCHECK, JEWEL, LUMINOUS)

include/linux/ceph/ceph_features.h DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2) // *do not share this bit* · line 173

Quoted 5 lines
include/linux/ceph/ceph_features.h +1 -1
@@ -170,13 +170,13 @@ DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2)             // *do not share this bit*
 
 DEFINE_CEPH_FEATURE(62, 1, RESERVED)           // do not use; used as a sentinal
 DEFINE_CEPH_FEATURE_DEPRECATED(63, 1, RESERVED_BROKEN, LUMINOUS) // client-facing
-
+};

I don't particularly like this because it looks like lower constants are actually ints and the rest are unsigned longs, even though they all have ULL suffixes. The standard seems to require that enum constants be representable as ints, is the non-pedantic behaviour documented somewhere?

Thanks,

Ilya

#2 lore raw
Quoted 12 lines · Ilya Dryomov
Quoted 11 lines · Arnd Bergmann
include/linux/ceph/ceph_features.h +1 -1
@@ -71,7 +71,7 @@
  * This ensures that no two versions who have different meanings for
  * the bit ever speak to each other.
  */
-
+enum ceph_features {
 DEFINE_CEPH_FEATURE( 0, 1, UID)
 DEFINE_CEPH_FEATURE( 1, 1, NOSRCADDR)
 DEFINE_CEPH_FEATURE_RETIRED( 2, 1, MONCLOCKCHECK, JEWEL, LUMINOUS)
@@ -170,13 +170,13 @@ DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2)             // *do not share this bit*
 
Quoted 10 lines

include/linux/ceph/ceph_features.h DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2) // *do not share this bit* · line 173

Quoted 4 lines
include/linux/ceph/ceph_features.h +1 -1
 DEFINE_CEPH_FEATURE(62, 1, RESERVED)           // do not use; used as a sentinal
 DEFINE_CEPH_FEATURE_DEPRECATED(63, 1, RESERVED_BROKEN, LUMINOUS) // client-facing
-
+};

I don't particularly like this because it looks like lower constants are actually ints and the rest are unsigned longs, even though they all have ULL suffixes. The standard seems to require that enum constants be representable as ints, is the non-pedantic behaviour documented somewhere?

I had not realized that this is a gcc extension, or that it behaves slightly differently from the standard C++ behavior that apparently adopted a saner variant (all values in an enum have the same type).

How about we just add a __maybe_unused to DEFINE_CEPH_FEATURE then to shut up the warning?

Arnd

maintainer
#3 lore raw
Quoted 25 lines · Arnd Bergmann
Quoted 12 lines · Ilya Dryomov
Quoted 11 lines · Arnd Bergmann
include/linux/ceph/ceph_features.h +1 -1
@@ -71,7 +71,7 @@
  * This ensures that no two versions who have different meanings for
  * the bit ever speak to each other.
  */
-
+enum ceph_features {
 DEFINE_CEPH_FEATURE( 0, 1, UID)
 DEFINE_CEPH_FEATURE( 1, 1, NOSRCADDR)
 DEFINE_CEPH_FEATURE_RETIRED( 2, 1, MONCLOCKCHECK, JEWEL, LUMINOUS)
@@ -170,13 +170,13 @@ DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2)             // *do not share this bit*
 
Quoted 10 lines

include/linux/ceph/ceph_features.h DEFINE_CEPH_FEATURE(61, 1, CEPHX_V2) // *do not share this bit* · line 173

Quoted 4 lines
include/linux/ceph/ceph_features.h +1 -1
 DEFINE_CEPH_FEATURE(62, 1, RESERVED)           // do not use; used as a sentinal
 DEFINE_CEPH_FEATURE_DEPRECATED(63, 1, RESERVED_BROKEN, LUMINOUS) // client-facing
-
+};

I don't particularly like this because it looks like lower constants are actually ints and the rest are unsigned longs, even though they all have ULL suffixes. The standard seems to require that enum constants be representable as ints, is the non-pedantic behaviour documented somewhere?

Quoted 6 lines

I had not realized that this is a gcc extension, or that it behaves slightly differently from the standard C++ behavior that apparently adopted a saner variant (all values in an enum have the same type).

How about we just add a __maybe_unused to DEFINE_CEPH_FEATURE then to shut up the warning?

Fine with me.

Thanks,

Ilya