no-std support in wgpu-core

.github/workflows/ci.yml

@@ -278,15 +278,24 @@ jobs:
       - name: check no_std
         if: matrix.kind == 'no_std'
         shell: bash
+        # XXX TBD CHECK no-std for wgpu-types & wgpu-core in separate steps - ???
         run: |
           set -e
 
-          # check with no features
+          # check wgpu-types with no features
           cargo clippy --target ${{ matrix.target }} ${{ matrix.extra-flags }} -p wgpu-types --no-default-features
 
-          # Check with all features except "std".
+          # check wgpu-core with no features
+          cargo clippy --target ${{ matrix.target }} ${{ matrix.extra-flags }} -p wgpu-core --no-default-features
+
+          # Check wgpu-types 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
 
+          # XXX TODO ENABLE:
+          # check wgpu-core with all no-std features (all features possible for no-std)
+          # XXX TODO IMPROVE COMMA-SEPARATED no-std feature list here
+          # cargo clippy --target ${{ matrix.target }} ${{ matrix.extra-flags }} -p wgpu-core --no-default-features --features counters,api_log_info,resource_log_info,renderdoc,strict_asserts,indirect-validation,serde,raw-window-handle,wgsl,glsl,fragile-send-sync-non-atomic-wasm,metal,vulkan,gles,dx12
+
       # Building for native platforms with standard tests.
       - name: check native
         if: matrix.kind == 'native'

CHANGELOG.md

@@ -40,6 +40,14 @@ Bottom level categories:
 
 ## Unreleased
 
+### Major changes
+
+#### no-std support in `wgpu-core`
+
+XXX TODO
+
+By XXX in XXX
+
 ### Bug Fixes
 
 #### Vulkan

wgpu-core/Cargo.toml

@@ -35,6 +35,13 @@ unexpected_cfgs = { level = "warn", check-cfg = ['cfg(wgpu_validate_locks)'] }
 [lib]
 
 [features]
+default = ["std"]
+
+## XXX TODO DOCUMENT THIS
+std = []
+
+# XXX TODO I think I got it right which features actually require std - I think we should find a way to check this in CI
+
 ## Internally count resources and events for debugging purposes. If the counters
 ## feature is disabled, the counting infrastructure is removed from the build and
 ## the exposed counters always return 0.
@@ -63,13 +70,13 @@ indirect-validation = ["naga/wgsl-in"]
 serde = ["dep:serde", "wgt/serde", "arrayvec/serde"]
 
 ## Enable API tracing.
-trace = ["dep:ron", "serde", "naga/serialize"]
+trace = ["std", "dep:ron", "serde", "naga/serialize"]
 
 ## Enable lock order observation.
-observe_locks = ["dep:ron", "serde/serde_derive"]
+observe_locks = ["std", "dep:ron", "serde/serde_derive"]
 
 ## Enable API replaying
-replay = ["serde", "naga/deserialize"]
+replay = ["std", "serde", "naga/deserialize"]
 
 ## Enable creating instances using raw-window-handle
 raw-window-handle = ["dep:raw-window-handle"]

wgpu-core/src/binding_model.rs

@@ -1,4 +1,5 @@
 use crate::{
+    alias::*,
     device::{
         bgl, Device, DeviceError, MissingDownlevelFlags, MissingFeatures, SHADER_STAGE_COUNT,
     },

wgpu-core/src/command/allocator.rs

@@ -1,3 +1,4 @@
+use crate::alias::*;
 use crate::lock::{rank, Mutex};
 
 /// A pool of free [`wgpu_hal::CommandEncoder`]s, owned by a `Device`.

wgpu-core/src/command/bind.rs

@@ -1,6 +1,7 @@
 use std::sync::Arc;
 
 use crate::{
+    alias::*,
     binding_model::{BindGroup, LateMinBufferBindingSizeMismatch, PipelineLayout},
     device::SHADER_STAGE_COUNT,
     pipeline::LateSizedBufferGroup,
@@ -16,6 +17,7 @@ mod compat {
     use wgt::{BindingType, ShaderStages};
 
     use crate::{
+        alias::*,
         binding_model::BindGroupLayout,
         error::MultiError,
         resource::{Labeled, ParentDevice, ResourceErrorIdent},

wgpu-core/src/command/bundle.rs

@@ -79,6 +79,7 @@ index format changes.
 #![allow(clippy::reversed_empty_ranges)]
 
 use crate::{
+    alias::*,
     binding_model::{BindError, BindGroup, PipelineLayout},
     command::{
         BasePass, BindGroupStateChange, ColorAttachmentError, DrawError, MapPassErr,
@@ -1573,7 +1574,7 @@ where
 
 pub mod bundle_ffi {
     use super::{RenderBundleEncoder, RenderCommand};
-    use crate::{id, RawString};
+    use crate::{alias::*, id, RawString};
     use std::{convert::TryInto, slice};
     use wgt::{BufferAddress, BufferSize, DynamicOffset, IndexFormat};
 

wgpu-core/src/command/clear.rs

@@ -1,3 +1,5 @@
+use crate::alias::*;
+
 use std::{ops::Range, sync::Arc};
 
 #[cfg(feature = "trace")]

wgpu-core/src/command/compute.rs

@@ -1,4 +1,5 @@
 use crate::{
+    alias::*,
     binding_model::{
         BindError, BindGroup, LateMinBufferBindingSizeMismatch, PushConstantUploadError,
     },

wgpu-core/src/command/compute_command.rs

@@ -1,6 +1,7 @@
 use std::sync::Arc;
 
 use crate::{
+    alias::*,
     binding_model::BindGroup,
     id,
     pipeline::ComputePipeline,

wgpu-core/src/command/draw.rs

@@ -1,4 +1,5 @@
 use crate::{
+    alias::*,
     binding_model::{LateMinBufferBindingSizeMismatch, PushConstantUploadError},
     resource::{
         DestroyedResourceError, MissingBufferUsageError, MissingTextureUsageError,

wgpu-core/src/command/memory_init.rs

@@ -3,6 +3,7 @@ use std::{ops::Range, sync::Arc, vec::Drain};
 use hashbrown::hash_map::Entry;
 
 use crate::{
+    alias::*,
     device::Device,
     init_tracker::*,
     resource::{DestroyedResourceError, ParentDevice, Texture, Trackable},

wgpu-core/src/command/mod.rs

@@ -13,6 +13,8 @@ mod render_command;
 mod timestamp_writes;
 mod transfer;
 
+use crate::alias::*;
+
 use std::mem::{self, ManuallyDrop};
 use std::sync::Arc;
 

wgpu-core/src/command/query.rs

@@ -1,6 +1,7 @@
 #[cfg(feature = "trace")]
 use crate::device::trace::Command as TraceCommand;
 use crate::{
+    alias::*,
     command::{CommandBuffer, CommandEncoderError},
     device::{DeviceError, MissingFeatures},
     global::Global,

wgpu-core/src/command/ray_tracing.rs

@@ -1,4 +1,5 @@
 use crate::{
+    alias::*,
     device::queue::TempResource,
     global::Global,
     hub::Hub,

wgpu-core/src/command/render.rs

@@ -1,3 +1,4 @@
+use crate::alias::*;
 use crate::binding_model::BindGroup;
 use crate::command::{
     validate_and_begin_occlusion_query, validate_and_begin_pipeline_statistics_query,

wgpu-core/src/command/render_command.rs

@@ -1,4 +1,5 @@
 use crate::{
+    alias::*,
     binding_model::BindGroup,
     id,
     pipeline::RenderPipeline,

wgpu-core/src/command/timestamp_writes.rs

@@ -1,5 +1,6 @@
 use std::sync::Arc;
 
+use crate::alias::*;
 use crate::id;
 
 /// Describes the writing of timestamp values in a render or compute pass.

wgpu-core/src/command/transfer.rs

@@ -1,6 +1,7 @@
 #[cfg(feature = "trace")]
 use crate::device::trace::Command as TraceCommand;
 use crate::{
+    alias::*,
     api_log,
     command::{clear_texture, CommandEncoderError},
     conv,

wgpu-core/src/device/bgl.rs

@@ -1,6 +1,7 @@
 use std::hash::{Hash, Hasher};
 
 use crate::{
+    alias::*,
     binding_model::{self},
     FastIndexMap,
 };

wgpu-core/src/device/global.rs

@@ -1,6 +1,7 @@
 #[cfg(feature = "trace")]
 use crate::device::trace;
 use crate::{
+    alias::*,
     api_log,
     binding_model::{
         self, BindGroupEntry, BindingResource, BufferBinding, ResolvedBindGroupDescriptor,

wgpu-core/src/device/life.rs

@@ -1,4 +1,5 @@
 use crate::{
+    alias::*,
     device::{
         queue::{EncoderInFlight, SubmittedWorkDoneClosure, TempResource},
         DeviceError,

wgpu-core/src/device/mod.rs

@@ -1,4 +1,5 @@
 use crate::{
+    alias::*,
     binding_model,
     hub::Hub,
     id::{BindGroupLayoutId, PipelineLayoutId},

wgpu-core/src/device/queue.rs

@@ -1,6 +1,7 @@
 #[cfg(feature = "trace")]
 use crate::device::trace::Action;
 use crate::{
+    alias::*,
     api_log,
     command::{
         extract_texture_selector, validate_linear_texture_data, validate_texture_copy_range,

wgpu-core/src/device/ray_tracing.rs

@@ -1,3 +1,5 @@
+use crate::alias::*;
+
 use std::mem::ManuallyDrop;
 use std::sync::Arc;
 

wgpu-core/src/device/resource.rs

@@ -1,6 +1,7 @@
 #[cfg(feature = "trace")]
 use crate::device::trace;
 use crate::{
+    alias::*,
     binding_model::{self, BindGroup, BindGroupLayout, BindGroupLayoutEntryError},
     command, conv,
     device::{

wgpu-core/src/device/trace.rs

@@ -1,3 +1,4 @@
+use crate::alias::*;
 use crate::id;
 use std::ops::Range;
 #[cfg(feature = "trace")]

wgpu-core/src/error.rs

@@ -1,3 +1,5 @@
+use crate::alias::*;
+
 use core::fmt;
 use std::{error::Error, sync::Arc};
 

wgpu-core/src/global.rs

@@ -1,3 +1,5 @@
+use crate::alias::*;
+
 use std::{fmt, sync::Arc};
 
 use crate::{

wgpu-core/src/hash_utils.rs

@@ -2,6 +2,8 @@
 //!
 //! Named hash_utils to prevent clashing with the std::hash module.
 
+use crate::alias::*;
+
 /// HashMap using a fast, non-cryptographic hash algorithm.
 pub type FastHashMap<K, V> =
     hashbrown::HashMap<K, V, std::hash::BuildHasherDefault<rustc_hash::FxHasher>>;

wgpu-core/src/hub.rs

@@ -101,6 +101,7 @@ flagged as errors as well.
 */
 
 use crate::{
+    alias::*,
     binding_model::{BindGroup, BindGroupLayout, PipelineLayout},
     command::{CommandBuffer, RenderBundle},
     device::{queue::Queue, Device},

wgpu-core/src/id.rs

@@ -1,3 +1,5 @@
+// XXX TBD FMT ???
+use crate::alias::*;
 use crate::{Epoch, Index};
 use std::{
     cmp::Ordering,

wgpu-core/src/identity.rs

@@ -1,4 +1,5 @@
 use crate::{
+    alias::*,
     id::{Id, Marker},
     lock::{rank, Mutex},
     Epoch, Index,

wgpu-core/src/indirect_validation.rs

@@ -1,3 +1,5 @@
+use crate::alias::*;
+
 use std::mem::size_of;
 use std::num::NonZeroU64;
 

wgpu-core/src/init_tracker/buffer.rs

@@ -1,4 +1,5 @@
 use super::{InitTracker, MemoryInitKind};
+use crate::alias::*;
 use crate::resource::Buffer;
 use std::{ops::Range, sync::Arc};
 

wgpu-core/src/init_tracker/mod.rs

@@ -31,6 +31,8 @@ system there are two kind of writes:
 
  */
 
+use crate::alias::*;
+
 use smallvec::SmallVec;
 use std::{fmt, iter, ops::Range};
 
@@ -280,6 +282,7 @@ impl InitTracker<u32> {
 
 #[cfg(test)]
 mod test {
+    use crate::alias::*;
     use std::ops::Range;
 
     type Tracker = super::InitTracker<u32>;

wgpu-core/src/init_tracker/texture.rs

@@ -1,4 +1,6 @@
 use super::{InitTracker, MemoryInitKind};
+// XXX TBD FMT ???
+use crate::alias::*;
 use crate::{resource::Texture, track::TextureSelector};
 use arrayvec::ArrayVec;
 use std::{ops::Range, sync::Arc};

wgpu-core/src/instance.rs

@@ -1,3 +1,5 @@
+use crate::alias::*;
+
 use std::borrow::Cow;
 use std::sync::Arc;