target-spec: accept both targets and target envs as valid targets

Author: Firestar99

crates/rustc_codegen_spirv-types/src/target.rs

@@ -5,17 +5,29 @@ pub const SPIRV_TARGET_PREFIX: &str = "spirv-unknown-";
 
 /// A well-formed rust-gpu target.
 ///
-/// The constructors [`Self::from_target`] or [`Self::from_env`] only check whether the target is well-formed, not
-/// whether it is valid. Since `spirv-builder` is backwards compatible with older rust-gpu compilers, only the compiler
-/// itself knows what targets it can and cannot support. This also allows adding new targets to the compiler without
-/// having to update `spirv-builder` and `cargo-gpu`.
+/// The constructors only check whether the target is well-formed, not whether it is valid. Since `spirv-builder` is
+/// backwards compatible with older rust-gpu compilers, only the compiler itself knows what targets it can and cannot
+/// support. This also allows adding new targets to the compiler without having to update `spirv-builder` and
+/// `cargo-gpu`.
+///
+/// Differentiates between a full target (e.g. `spirv-unknown-vulkan1.3`) and a target env (e.g. `vulkan1.3`). Use
+/// [`Self::parse_target`] and [`Self::target`] to parse or format a full target, or use [`Self::parse_env`] and
+/// [`Self::env`] when dealing with just target envs. The convenience function [`Self::parse`] accepts both targets and
+/// target envs. Does not implement `Display`, since it is unclear whether the user wants a target or target env, though
+/// a `Debug` implementation is provided.
 #[derive(Clone)]
 pub struct SpirvTarget {
     target: String,
 }
 
 impl SpirvTarget {
-    pub fn from_target(target: &str) -> Result<Self, TargetError> {
+    /// Try to parse either a full target or a target env
+    pub fn parse(target_or_env: &str) -> Result<Self, TargetError> {
+        Self::parse_target(target_or_env).or_else(|_| Self::parse_env(target_or_env))
+    }
+
+    /// Parse a full target, e.g. `spirv-unknown-vulkan1.3`
+    pub fn parse_target(target: &str) -> Result<Self, TargetError> {
         let _target_env = target.strip_prefix(SPIRV_TARGET_PREFIX).ok_or_else(|| {
             TargetError::NonSpirvTarget {
                 target: target.to_string(),
@@ -26,17 +38,20 @@ impl SpirvTarget {
         })
     }
 
-    pub fn from_env(target_env: &str) -> Result<Self, TargetError> {
+    /// Parse a target env, e.g. `vulkan1.3`
+    pub fn parse_env(target_env: &str) -> Result<Self, TargetError> {
         Ok(Self {
             target: format!("{SPIRV_TARGET_PREFIX}{target_env}"),
         })
     }
 
+    /// returns the full target, e.g. `spirv-unknown-vulkan1.3`
     pub fn target(&self) -> &str {
         &self.target
     }
 
-    pub fn target_env(&self) -> &str {
+    /// returns the target env, e.g. `vulkan1.3`
+    pub fn env(&self) -> &str {
         &self.target[SPIRV_TARGET_PREFIX.len()..]
     }
 }

crates/rustc_codegen_spirv-types/src/target_spec.rs

@@ -50,7 +50,7 @@ impl TargetSpecVersion {
 
     /// format the target spec json
     pub fn format_spec(&self, target: &SpirvTarget) -> String {
-        let target_env = target.target_env();
+        let target_env = target.env();
         let extra = match self {
             TargetSpecVersion::Rustc_1_85_0 => r#""crt-static-respected": true,"#,
             TargetSpecVersion::Rustc_1_76_0 => r#""os": "unknown","#,

crates/spirv-builder/src/lib.rs

@@ -784,7 +784,7 @@ fn invoke_rustc(builder: &SpirvBuilder) -> Result<PathBuf, SpirvBuilderError> {
             .target
             .as_ref()
             .ok_or(SpirvBuilderError::MissingTarget)?;
-        target = SpirvTarget::from_target(target_str)?;
+        target = SpirvTarget::parse(target_str)?;
 
         if (builder.print_metadata == MetadataPrintout::Full) && builder.multimodule {
             return Err(SpirvBuilderError::MultiModuleWithPrintMetadata);

tests/compiletests/src/main.rs

@@ -156,7 +156,7 @@ impl Runner {
 
             println!("Testing env: {stage_id}\n");
 
-            let target = SpirvTarget::from_env(env).unwrap();
+            let target = SpirvTarget::parse(env).unwrap();
             let libs = self.build_deps(&target);
             let mut flags = test_rustc_flags(
                 &self.codegen_backend_path,