Merge pull request #103 from anp/master

Automatically use the allocation-free API for Rust 1.27.0+.

Author: KodrAus

.travis.yml

@@ -11,6 +11,8 @@ matrix:
         - cargo bench
         - cargo test --features nightly
         - cargo bench --features nightly
+        - CARGO_CFG_LAZY_STATIC_HEAP_IMPL=1 cargo test
+        - CARGO_CFG_LAZY_STATIC_HEAP_IMPL=1 cargo bench
         - cargo test --features spin_no_std
         - cargo bench --features spin_no_std
         - cd compiletest

Cargo.toml

@@ -13,10 +13,15 @@ repository = "https://github.com/rust-lang-nursery/lazy-static.rs"
 keywords = ["macro", "lazy", "static"]
 categories = [ "no-std", "rust-patterns", "memory-management" ]
 
+build = "build.rs"
+
 [dependencies.spin]
 version = "0.4.6"
 optional = true
 
+[build-dependencies]
+rustc_version = "0.2.2"
+
 [features]
 nightly = []
 spin_no_std = ["nightly", "spin"]

build.rs

@@ -0,0 +1,46 @@
+extern crate rustc_version;
+
+use rustc_version::{version, Version};
+
+fn main() {
+    let is_var_set = |s| std::env::var_os(s).is_some();
+
+    // one can manually set a cfg to force an impl -- mostly useful for our own testing
+    let force_heap_cfg = is_var_set("CARGO_CFG_LAZY_STATIC_HEAP_IMPL");
+    let force_inline_cfg = is_var_set("CARGO_CFG_LAZY_STATIC_INLINE_IMPL");
+    let force_spin_cfg = is_var_set("CARGO_CFG_LAZY_STATIC_SPIN_IMPL");
+
+    let impls_forced = [force_heap_cfg, force_inline_cfg, force_spin_cfg]
+        .into_iter()
+        .filter(|&&f| f)
+        .count();
+
+    assert!(
+        impls_forced <= 1,
+        "lazy_static can only be built with one configuration at a time."
+    );
+
+    let nightly_feature_enabled = is_var_set("CARGO_FEATURE_NIGHTLY");
+    let spin_feature_enabled = is_var_set("CARGO_FEATURE_SPIN_NO_STD");
+
+    let version_geq_122 = version().unwrap() >= Version::new(1, 22, 0);
+    let drop_in_static_supported = version_geq_122 || nightly_feature_enabled;
+
+    // precedence:
+    // 1. explicit requests via cfg or spin_no_std feature
+    // 2. inline impl with newer rustc version or nightly feature (latter for backcompat)
+    // 3. fallback to allocating implementation
+    let impl_name = if force_heap_cfg {
+        "heap"
+    } else if force_inline_cfg {
+        "inline"
+    } else if force_spin_cfg || spin_feature_enabled {
+        "spin"
+    } else if drop_in_static_supported {
+        "inline"
+    } else {
+        "heap"
+    };
+
+    println!("cargo:rustc-cfg=lazy_static_{}_impl", impl_name);
+}

src/lazy.rs renamed to src/heap_lazy.rs

@@ -11,12 +11,15 @@ use self::std::prelude::v1::*;
 use self::std::sync::Once;
 pub use self::std::sync::ONCE_INIT;
 
-pub struct Lazy<T: Sync>(pub *const T, pub Once);
+pub struct Lazy<T: Sync>(*const T, Once);
 
 impl<T: Sync> Lazy<T> {
+    pub const INIT: Self = Lazy(0 as *const T, ONCE_INIT);
+
     #[inline(always)]
     pub fn get<F>(&'static mut self, f: F) -> &T
-        where F: FnOnce() -> T
+    where
+        F: FnOnce() -> T,
     {
         unsafe {
             let r = &mut self.0;
@@ -35,6 +38,6 @@ unsafe impl<T: Sync> Sync for Lazy<T> {}
 #[doc(hidden)]
 macro_rules! __lazy_static_create {
     ($NAME:ident, $T:ty) => {
-        static mut $NAME: $crate::lazy::Lazy<$T> = $crate::lazy::Lazy(0 as *const $T, $crate::lazy::ONCE_INIT);
-    }
+        static mut $NAME: $crate::lazy::Lazy<$T> = $crate::lazy::Lazy::INIT;
+    };
 }

src/nightly_lazy.rs renamed to src/inline_lazy.rs

@@ -5,19 +5,22 @@
 // http://opensource.org/licenses/MIT>, at your option. This file may not be
 // copied, modified, or distributed except according to those terms.
 
-extern crate std;
 extern crate core;
+extern crate std;
 
 use self::std::prelude::v1::*;
 use self::std::sync::Once;
 pub use self::std::sync::ONCE_INIT;
 
-pub struct Lazy<T: Sync>(pub Option<T>, pub Once);
+pub struct Lazy<T: Sync>(Option<T>, Once);
 
 impl<T: Sync> Lazy<T> {
+    pub const INIT: Self = Lazy(None, ONCE_INIT);
+
     #[inline(always)]
     pub fn get<F>(&'static mut self, f: F) -> &T
-        where F: FnOnce() -> T
+    where
+        F: FnOnce() -> T,
     {
         {
             let r = &mut self.0;
@@ -28,7 +31,7 @@ impl<T: Sync> Lazy<T> {
         unsafe {
             match self.0 {
                 Some(ref x) => x,
-                None => core::hint::unreachable_unchecked(),
+                None => unreachable_unchecked(),
             }
         }
     }
@@ -40,6 +43,17 @@ unsafe impl<T: Sync> Sync for Lazy<T> {}
 #[doc(hidden)]
 macro_rules! __lazy_static_create {
     ($NAME:ident, $T:ty) => {
-        static mut $NAME: $crate::lazy::Lazy<$T> = $crate::lazy::Lazy(None, $crate::lazy::ONCE_INIT);
-    }
+        static mut $NAME: $crate::lazy::Lazy<$T> = $crate::lazy::Lazy::INIT;
+    };
+}
+
+/// Polyfill for std::hint::unreachable_unchecked. There currently exists a
+/// [crate](https://docs.rs/unreachable) for an equivalent to std::hint::unreachable_unchecked, but
+/// lazy_static currently doesn't include any runtime dependencies and we've chosen to include this
+/// short polyfill rather than include a new crate in every consumer's build.
+///
+/// This should be replaced by std's version when lazy_static starts to require at least Rust 1.27.
+unsafe fn unreachable_unchecked() -> ! {
+    enum Void {}
+    match std::mem::uninitialized::<Void>() {}
 }

src/lib.rs

@@ -100,22 +100,23 @@ no guarantees can be made about them in regard to SemVer stability.
 
 */
 
-#![cfg_attr(feature="spin_no_std", feature(const_fn))]
-#![cfg_attr(feature="nightly", feature(unreachable))]
+// NOTE: see build.rs for where these cfg values are set.
+#![cfg_attr(lazy_static_spin_impl, feature(const_fn))]
 
 #![doc(html_root_url = "https://docs.rs/lazy_static/1.0.2")]
 #![no_std]
 
-#[cfg(not(feature="nightly"))]
+#[cfg(lazy_static_heap_impl)]
+#[path="heap_lazy.rs"]
 #[doc(hidden)]
 pub mod lazy;
 
-#[cfg(all(feature="nightly", not(feature="spin_no_std")))]
-#[path="nightly_lazy.rs"]
+#[cfg(lazy_static_inline_impl)]
+#[path="inline_lazy.rs"]
 #[doc(hidden)]
 pub mod lazy;
 
-#[cfg(all(feature="nightly", feature="spin_no_std"))]
+#[cfg(lazy_static_spin_impl)]
 #[path="core_lazy.rs"]
 #[doc(hidden)]
 pub mod lazy;

tests/test.rs

@@ -1,5 +1,3 @@
-#![cfg_attr(feature="nightly", feature(const_fn))]
-
 #[macro_use]
 extern crate lazy_static;
 use std::collections::HashMap;