Replace sanitize feature with cfg(crossbeam_sanitize)

Feature flag can be accidentally enabled by --all-features, so use cfg instead.
crossbeam-rs · Jan 4, 2021 · e83c134 · e83c134
1 parent 8796beb
commit e83c134
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/ci/test.sh b/ci/test.sh
@@ -36,8 +36,11 @@ if [[ "$RUST_VERSION" == "nightly"* ]]; then
         cd crossbeam-epoch
         cargo clean
 
+        # TODO: Once `cfg(sanitize = "..")` is stable, replace
+        # `cfg(crossbeam_sanitize)` with `cfg(sanitize = "..")` and remove
+        # `--cfg crossbeam_sanitize`.
         ASAN_OPTIONS="detect_odr_violation=0 detect_leaks=0" \
-        RUSTFLAGS="-Z sanitizer=address" \
+        RUSTFLAGS="-Z sanitizer=address --cfg crossbeam_sanitize" \
         cargo run \
             --release \
             --target x86_64-unknown-linux-gnu \

diff --git a/crossbeam-epoch/Cargo.toml b/crossbeam-epoch/Cargo.toml
@@ -33,9 +33,6 @@ alloc = []
 # of crossbeam may make breaking changes to them at any time.
 nightly = ["crossbeam-utils/nightly", "const_fn"]
 
-# TODO: docs
-sanitize = [] # Makes it more likely to trigger any potential data races.
-
 [dependencies]
 cfg-if = "1"
 const_fn = { version = "0.4.4", optional = true }

diff --git a/crossbeam-epoch/src/internal.rs b/crossbeam-epoch/src/internal.rs
@@ -55,9 +55,9 @@ use crate::sync::list::{Entry, IsElement, IterError, List};
 use crate::sync::queue::Queue;
 
 /// Maximum number of objects a bag can contain.
-#[cfg(not(feature = "sanitize"))]
+#[cfg(not(crossbeam_sanitize))]
 const MAX_OBJECTS: usize = 62;
-#[cfg(feature = "sanitize")]
+#[cfg(crossbeam_sanitize)]
 const MAX_OBJECTS: usize = 4;
 
 /// A bag of deferred functions.
@@ -109,7 +109,7 @@ impl Default for Bag {
     #[rustfmt::skip]
     fn default() -> Self {
         // TODO: [no_op; MAX_OBJECTS] syntax blocked by https://github.com/rust-lang/rust/issues/49147
-        #[cfg(not(feature = "sanitize"))]
+        #[cfg(not(crossbeam_sanitize))]
         return Bag {
             len: 0,
             deferreds: [
@@ -177,7 +177,7 @@ impl Default for Bag {
                 Deferred::new(no_op_func),
             ],
         };
-        #[cfg(feature = "sanitize")]
+        #[cfg(crossbeam_sanitize)]
         return Bag {
             len: 0,
             deferreds: [
@@ -278,7 +278,7 @@ impl Global {
     pub(crate) fn collect(&self, guard: &Guard) {
         let global_epoch = self.try_advance(guard);
 
-        let steps = if cfg!(feature = "sanitize") {
+        let steps = if cfg!(crossbeam_sanitize) {
             usize::max_value()
         } else {
             Self::COLLECT_STEPS