no-std support in naga

.github/workflows/ci.yml

@@ -52,6 +52,7 @@ env:
   RUST_LOG: debug
   RUST_BACKTRACE: full
   PKG_CONFIG_ALLOW_CROSS: 1 # allow android to work
+  # XXX TODO CONFIGURE THIS PER JOB - NOT ALL JOBS SHOULD FAIL WITH CARGO WARNINGS
   RUSTFLAGS: -D warnings
   RUSTDOCFLAGS: -D warnings
   WASM_BINDGEN_TEST_TIMEOUT: 300 # 5 minutes
@@ -175,6 +176,13 @@ jobs:
             tier: 2
             kind: no_std
 
+          # XXX TODO MOVE INTO SEPARATE CI JOB:
+          - name: no-std feature test - Linux x86_64
+            os: ubuntu-22.04
+            target: x86_64-unknown-linux-gnu
+            tier: 1
+            kind: no-std-feature-test
+
     name: Clippy ${{ matrix.name }}
     runs-on: ${{ matrix.os }}
 
@@ -282,9 +290,12 @@ jobs:
         run: |
           set -e
 
-          # check with no features
+          # check with no features - wgpu-types
           cargo clippy --target ${{ matrix.target }} ${{ matrix.extra-flags }} -p wgpu-types --no-default-features
+          # check with no features - naga
+          cargo clippy --target ${{ matrix.target }} ${{ matrix.extra-flags }} -p naga --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
 
@@ -304,6 +315,20 @@ jobs:
           # build docs
           cargo doc --target ${{ matrix.target }} ${{ matrix.extra-flags }} --all-features --no-deps
 
+      # XXX TODO MOVE INTO SEPARATE CI JOB - MAY SHOW UP AS A "Clippy" job in GitHub CI
+      - name: no-std feature test
+        if: matrix.kind == 'no-std-feature-test'
+        shell: bash
+        run: |
+          set -e
+
+          # no-std feature test with no features - naga
+          cargo test --target ${{ matrix.target }} ${{ matrix.extra-flags }} -p naga --no-default-features
+
+          # XXX TODO FIX & TEST MULTIPLE naga features for no-std
+          # no-std test with multiple features - naga
+          # cargo test [...]
+
       - name: check private item docs
         if: matrix.kind == 'native'
         shell: bash

CHANGELOG.md

@@ -40,6 +40,12 @@ Bottom level categories:
 
 ## Unreleased
 
+### Major changes
+
+#### no-std support in naga
+
+XXX TODO
+
 ### New Features
 
 #### Naga

Cargo.toml

@@ -74,9 +74,12 @@ wgpu-types = { version = "24.0.0", path = "./wgpu-types" }
 
 anyhow = "1.0.95"
 argh = "0.1.13"
-arrayvec = "0.7"
+arrayvec = { version = "0.7", default-features = false }
+# XXX TODO MOVE ITEM IN SEPARATE PR: approx
 approx = "0.5"
 bincode = "1"
+# XXX RESOLVE WHERE TO KEEP ITEM: bit-set - ???
+bit-set = { version = "0.8", default-features = false }
 bit-vec = "0.8"
 bitflags = "2.7"
 bytemuck = { version = "1.21", features = ["derive", "min_const_generics"] }
@@ -99,7 +102,7 @@ hashbrown = { version = "0.15.2", default-features = false, features = [
 ] }
 heck = "0.5.0"
 image = { version = "0.24", default-features = false, features = ["png"] }
-indexmap = "2"
+indexmap = { version = "2", default-features = false }
 itertools = { version = "0.13.0" }
 ktx2 = "0.3"
 libc = "0.2"
@@ -135,10 +138,10 @@ serde_json = "1.0.137"
 serde = { version = "1", default-features = false }
 smallvec = "1"
 static_assertions = "1.1.0"
-strum = { version = "0.26.0", features = ["derive"] }
+strum = { version = "0.26", default-features = false, features = ["derive"] }
 trybuild = "1"
 tracy-client = "0.17"
-thiserror = "2"
+thiserror = { version = "2", default-features = false }
 winit = { version = "0.29", features = ["android-native-activity"] }
 
 # Metal dependencies
@@ -154,7 +157,6 @@ gpu-alloc = "0.6"
 gpu-descriptor = "0.3"
 
 # DX12 dependencies
-bit-set = "0.8"
 gpu-allocator = { version = "0.27", default-features = false }
 range-alloc = "0.1"
 mach-dxcompiler-rs = { version = "0.1.4", default-features = false }

naga/Cargo.toml

@@ -25,9 +25,24 @@ path = "tests/root.rs"
 all-features = true
 
 [features]
-default = []
+default = ["std"]
+
+# XXX TBD ADD DESCRIPTION HERE (???)
+std = [
+    "dep:codespan-reporting",
+    # XXX TBD does strum need to be gated on std ???
+    "dep:strum",
+    "dep:termcolor",
+    "indexmap/std",
+    # XXX TBD IS / WHY IS THIS NEEDED ???
+    "strum/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-in = ["std", "dep:pp-rs"]
 glsl-out = []
 
 ## Enables outputting to the Metal Shading Language (MSL).
@@ -72,16 +87,20 @@ arbitrary = { version = "1.4", features = ["derive"], optional = true }
 arrayvec.workspace = true
 bitflags.workspace = true
 bit-set.workspace = true
-termcolor = { version = "1.4.1" }
-# remove termcolor dep when updating to the next version of codespan-reporting
+# XXX TODO RAISE SEPARATE PR FOR UPDATE RE: remove termcolor dep [...]
+# remove termcolor from here when updating to the next version of codespan-reporting
 # termcolor minimum version was wrong and was fixed in
 # https://github.com/brendanzab/codespan/commit/e99c867339a877731437e7ee6a903a3d03b5439e
-codespan-reporting = { version = "0.11.0" }
+termcolor = { version = "1.4.1", optional = true }
+codespan-reporting = { version = "0.11.0", optional = true }
 hashbrown.workspace = true
 rustc-hash.workspace = true
 indexmap.workspace = true
 log = "0.4"
-strum.workspace = true
+num-traits = { version = "0.2.19", default-features = false, features = [
+    "libm",
+] }
+strum = { workspace = true, optional = true }
 spirv = { version = "0.3", optional = true }
 thiserror.workspace = true
 serde = { version = "1.0.217", features = [

naga/src/arena/handle.rs

@@ -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.

naga/src/arena/handle_set.rs

@@ -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.

naga/src/arena/handlevec.rs

@@ -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;

naga/src/arena/mod.rs

@@ -31,6 +31,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;

naga/src/arena/range.rs

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

naga/src/arena/unique_arena.rs

@@ -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};

naga/src/back/mod.rs

@@ -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)]

naga/src/block.rs

@@ -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.

naga/src/common/wgsl.rs

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

naga/src/diagnostic_filter.rs

@@ -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};

naga/src/error.rs

@@ -1,4 +1,12 @@
-use std::{error::Error, fmt};
+#[cfg(not(feature = "std"))]
+use crate::aliases::*;
+
+#[cfg(feature = "std")]
+use std::error::Error;
+
+// XXX TODO ADD & IMPROVE NOTE: multiple features below only working with std at this point
+#[cfg(feature = "std")]
+use std::fmt;
 
 #[derive(Clone, Debug)]
 pub struct ShaderError<E> {
@@ -32,6 +40,8 @@ impl fmt::Display for ShaderError<crate::front::spv::Error> {
         write!(f, "\nShader '{label}' parsing {string}")
     }
 }
+// XXX TBD FIX for no-std ???
+#[cfg(feature = "std")]
 impl fmt::Display for ShaderError<crate::WithSpan<crate::valid::ValidationError>> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         use codespan_reporting::{files::SimpleFile, term};
@@ -49,6 +59,9 @@ impl fmt::Display for ShaderError<crate::WithSpan<crate::valid::ValidationError>
         )
     }
 }
+
+// XXX TODO ADD NOTE WITH TODO: supporting core::error::Error would be a nice feature but may affect core MSRV
+#[cfg(feature = "std")]
 impl<E> Error for ShaderError<E>
 where
     ShaderError<E>: fmt::Display,

naga/src/front/mod.rs

@@ -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},

naga/src/front/type_gen.rs

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

naga/src/front/wgsl/parse/mod.rs

@@ -16,6 +16,8 @@ use crate::{Arena, FastIndexSet, Handle, ShaderStage, Span};
 
 pub mod ast;
 pub mod conv;
+// XXX TBD ENABLE OR ENABLE PARTIALLY for no-std ???
+#[cfg(feature = "std")]
 pub mod directive;
 pub mod lexer;
 pub mod number;