no-std support in naga

gfx-rs · brody4hire · Jan 17, 2025 · Jan 19, 2025 · Jan 19, 2025 · Jan 19, 2025
commit cb81b7606fc5107a6b02ef65b6b78a038386349b
@@ -281,9 +281,11 @@ jobs:
         run: |
           set -e
 
+          # XXX TODO REPEAT THIS SUB-STEP for naga
           # check with no features
           cargo clippy --target ${{ matrix.target }} ${{ matrix.extra-flags }} -p wgpu-types --no-default-features
 
+          # XXX TODO SIMILAR SUB-STEP for naga with all features possible with no-std (once this is supported)
           # Check with all features except "std".
           cargo clippy --target ${{ matrix.target }} ${{ matrix.extra-flags }} -p wgpu-types --no-default-features --features strict_asserts,fragile-send-sync-non-atomic-wasm,serde,counters
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,6 +40,12 @@ Bottom level categories:
 
 ## Unreleased
 
+### Major changes
+
+#### no-std support in naga
+
+XXX TODO
+
 ### Bug Fixes
 
 #### Vulkan

@@ -25,7 +25,14 @@ path = "tests/root.rs"
 all-features = true
 
 [features]
-default = []
+default = ["std"]
+
+# XXX TBD ADD DESCRIPTION HERE (???)
+std = []
+
+# XXX TODO ALL FEATURES BELOW REQUIRE std feature to build - NEED TO SPECIFY THIS
+# XXX TODO DETERMINE which features may or may not be able to work with no-std
+
 dot-out = []
 glsl-in = ["dep:pp-rs"]
 glsl-out = []
@@ -72,6 +79,7 @@ termcolor = { version = "1.4.1" }
 # termcolor minimum version was wrong and was fixed in
 # https://github.com/brendanzab/codespan/commit/e99c867339a877731437e7ee6a903a3d03b5439e
 codespan-reporting = { version = "0.11.0" }
+hashbrown = { workspace = true, features = ["serde"] }
 rustc-hash.workspace = true
 indexmap.workspace = true
 log = "0.4"

@@ -5,6 +5,9 @@
 //! [`Arena`]: super::Arena
 //! [`UniqueArena`]: super::UniqueArena
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use std::{cmp::Ordering, fmt, hash, marker::PhantomData};
 
 /// An unique index in the arena array that a handle points to.

@@ -1,5 +1,8 @@
 //! The [`HandleSet`] type and associated definitions.
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::arena::{Arena, Handle, UniqueArena};
 
 /// A set of `Handle<T>` values.

@@ -1,5 +1,8 @@
 //! The [`HandleVec`] type and associated definitions.
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use super::handle::Handle;
 
 use std::marker::PhantomData;

@@ -32,6 +32,9 @@ pub(crate) use handlevec::HandleVec;
 pub use range::{BadRangeError, Range};
 pub use unique_arena::UniqueArena;
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::Span;
 
 use handle::Index;

@@ -5,6 +5,9 @@
 //!
 //! [`Arena`]: super::Arena
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use super::{
     handle::{Handle, Index},
     Arena,

@@ -1,5 +1,8 @@
 //! The [`UniqueArena`] type and supporting definitions.
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::{FastIndexSet, Span};
 
 use super::handle::{BadHandle, Handle, Index};

@@ -3,6 +3,9 @@ Backend functions that export shader [`Module`](super::Module)s into binary and
 */
 #![allow(dead_code)] // can be dead if none of the enabled backends need it
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::proc::ExpressionKindTracker;
 
 #[cfg(dot_out)]

@@ -1,4 +1,8 @@
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::{Span, Statement};
+
 use std::ops::{Deref, DerefMut, RangeBounds};
 
 /// A code block is a vector of statements, with maybe a vector of spans.

@@ -2,6 +2,9 @@
 
 use std::fmt::{self, Display, Formatter};
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::diagnostic_filter::{
     FilterableTriggeringRule, Severity, StandardFilterableTriggeringRule,
 };

@@ -1,5 +1,8 @@
 //! [`DiagnosticFilter`]s and supporting functionality.
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 #[cfg(feature = "wgsl-in")]
 use crate::Span;
 use crate::{Arena, Handle};

@@ -1,3 +1,6 @@
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use std::{error::Error, fmt};
 
 #[derive(Clone, Debug)]

@@ -14,6 +14,9 @@ pub mod spv;
 #[cfg(feature = "wgsl-in")]
 pub mod wgsl;
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::{
     arena::{Arena, Handle, HandleVec, UniqueArena},
     proc::{ResolveContext, ResolveError, TypeResolution},

@@ -2,6 +2,9 @@
 Type generators.
 */
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::{arena::Handle, span::Span};
 
 impl crate::Module {

@@ -249,6 +249,67 @@ An override expression can be evaluated at pipeline creation time.
         clippy::todo
     )
 )]
+// XXX TODO ADD SOME COMMENTS FOR THIS:
+#![cfg_attr(not(feature = "std"), no_std)]
+
+// XXX TBD WHERE TO PUT THIS MOD - ??? - XXX TBD SEPARATE SOURCE FILE ???
+#[cfg(not(feature = "std"))]
+pub(crate) mod aliases {
+    pub(crate) mod external {
+        pub(crate) extern crate alloc;
+    }
+
+    pub(crate) mod std {
+        pub(crate) mod prelude {
+            pub(crate) mod v1 {
+                pub(crate) use crate::aliases::std::{
+                    // XXX XXX TBD COMBINE LINES ???
+                    borrow::ToOwned,
+                    boxed::Box,
+                    format,
+                    string::String,
+                    string::ToString,
+                    vec,
+                    vec::Vec,
+                };
+            }
+        }
+
+        pub(crate) use core::{
+            // XXX XXX TBD COMBINE LINES ???
+            any,
+            cmp,
+            convert,
+            fmt,
+            hash,
+            iter,
+            marker,
+            mem,
+            num,
+            ops,
+            slice,
+        };
+
+        pub(crate) use super::external::alloc::{
+            // XXX XXX TBD COMBINE LINES ???
+            borrow,
+            boxed,
+            format,
+            string,
+            vec,
+        };
+
+        // XXX TODO REMOVE THIS HACK IN FAVOR OF UPDATE FROM OTHER PR: https://github.com/gfx-rs/wgpu/pull/6938
+        pub(crate) use hashbrown as collections;
+
+        // XXX TBD POSSIBLE IMPACT ON CORE MSRV with no-std - ???
+        pub(crate) use core::error;
+    }
+    pub(crate) use std::prelude::v1::*;
+}
+
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
 
 mod arena;
 pub mod back;

@@ -16,6 +16,9 @@
 //! [`NonZeroU32`]: std::num::NonZeroU32
 #![allow(dead_code)]
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use std::num::NonZeroU32;
 
 /// An unsigned 32-bit value known not to be [`u32::MAX`].

@@ -1,3 +1,8 @@
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
+// XXX TBD MOVE IMPORTS ???
+
 use std::iter;
 
 use arrayvec::ArrayVec;
@@ -2468,6 +2473,9 @@ impl TryFromAbstract<f64> for u64 {
 mod tests {
     use std::vec;
 
+    #[cfg(not(feature = "std"))]
+    use crate::aliases::*;
+
     use crate::{
         Arena, Constant, Expression, Literal, ScalarKind, Type, TypeInner, UnaryOperator,
         UniqueArena, VectorSize,

@@ -1,4 +1,8 @@
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::arena::{Handle, HandleVec};
+
 use std::{fmt::Display, num::NonZeroU32, ops};
 
 /// A newtype struct where its only valid values are powers of 2

@@ -10,6 +10,9 @@ mod namer;
 mod terminator;
 mod typifier;
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 pub use constant_evaluator::{
     ConstantEvaluator, ConstantEvaluatorError, ExpressionKind, ExpressionKindTracker,
 };

@@ -1,4 +1,8 @@
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::{arena::Handle, FastHashMap, FastHashSet};
+
 use std::borrow::Cow;
 use std::hash::{Hash, Hasher};
 

@@ -1,3 +1,6 @@
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::arena::{Arena, Handle, UniqueArena};
 
 use thiserror::Error;

@@ -1,3 +1,5 @@
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
 use crate::{Arena, Handle, UniqueArena};
 use std::{error::Error, fmt, ops::Range};
 

@@ -6,12 +6,17 @@
 //! - expression reference counts
 
 use super::{ExpressionError, FunctionError, ModuleInfo, ShaderStages, ValidationFlags};
+
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::diagnostic_filter::{DiagnosticFilterNode, StandardFilterableTriggeringRule};
 use crate::span::{AddSpan as _, WithSpan};
 use crate::{
     arena::{Arena, Handle},
     proc::{ResolveContext, TypeResolution},
 };
+
 use std::ops;
 
 pub type NonUniformResult = Option<Handle<crate::Expression>>;

@@ -1,4 +1,9 @@
 use super::{compose::validate_compose, FunctionInfo, ModuleInfo, ShaderStages, TypeFlags};
+
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
+// XXX TODO COMBINE with arena::Handle import below:
 use crate::arena::UniqueArena;
 
 use crate::{

@@ -1,3 +1,6 @@
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::arena::{Arena, UniqueArena};
 use crate::arena::{Handle, HandleSet};
 
@@ -7,6 +10,8 @@ use super::{
     analyzer::{UniformityDisruptor, UniformityRequirements},
     ExpressionError, FunctionInfo, ModuleInfo,
 };
+
+// XXX TODO MOVE THESE CLOSER TO OTHER use::crate::... imports
 use crate::span::WithSpan;
 use crate::span::{AddSpan as _, MapErrWithSpan as _};
 

@@ -1,5 +1,8 @@
 //! Implementation of `Validator::validate_module_handles`.
 
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::{
     arena::{BadHandle, BadRangeError},
     diagnostic_filter::DiagnosticFilterNode,

@@ -2,9 +2,14 @@ use super::{
     analyzer::{FunctionInfo, GlobalUse},
     Capabilities, Disalignment, FunctionError, ModuleInfo,
 };
+
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
 use crate::arena::{Handle, UniqueArena};
 
 use crate::span::{AddSpan as _, MapErrWithSpan as _, SpanProvider as _, WithSpan};
+
 use bit_set::BitSet;
 
 const MAX_WORKGROUP_SIZE: u32 = 0x4000;