Add support for setting -gdwarf-{version} based on RUSTFLAGS (#1395)

Detect if `-Zdwarf-version` (which will probably be stabilized soon
as `-Cdwarf-version`) was passed in RUSTFLAGS and set the corresponding
Clang/GCC option to the same value.

Author: wesleywiser

src/flags.rs

@@ -18,6 +18,7 @@ pub(crate) struct RustcCodegenFlags<'a> {
     force_frame_pointers: Option<bool>,
     no_redzone: Option<bool>,
     soft_float: Option<bool>,
+    dwarf_version: Option<u32>,
 }
 
 impl<'this> RustcCodegenFlags<'this> {
@@ -86,6 +87,10 @@ impl<'this> RustcCodegenFlags<'this> {
             }
         }
 
+        fn arg_to_u32(arg: impl AsRef<str>) -> Option<u32> {
+            arg.as_ref().parse().ok()
+        }
+
         let (flag, value) = if let Some((flag, value)) = flag.split_once('=') {
             (flag, Some(value))
         } else {
@@ -148,6 +153,14 @@ impl<'this> RustcCodegenFlags<'this> {
                 self.branch_protection =
                     Some(flag_ok_or(value, "-Zbranch-protection must have a value")?);
             }
+            // https://doc.rust-lang.org/beta/unstable-book/compiler-flags/dwarf-version.html
+            // FIXME: Drop the -Z variant and update the doc link once the option is stablized
+            "-Zdwarf-version" | "-Cdwarf-version" => {
+                self.dwarf_version = Some(value.and_then(arg_to_u32).ok_or(Error::new(
+                    ErrorKind::InvalidFlag,
+                    "-Zdwarf-version must have a value",
+                ))?);
+            }
             _ => {}
         }
         Ok(())
@@ -250,6 +263,11 @@ impl<'this> RustcCodegenFlags<'this> {
                 };
                 push_if_supported(cc_flag.into());
             }
+            // https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang-gdwarf-2
+            // https://gcc.gnu.org/onlinedocs/gcc/Debugging-Options.html#index-gdwarf
+            if let Some(value) = self.dwarf_version {
+                push_if_supported(format!("-gdwarf-{value}").into());
+            }
         }
 
         // Compiler-exclusive flags
@@ -390,6 +408,7 @@ mod tests {
             "-Crelocation-model=pic",
             "-Csoft-float=yes",
             "-Zbranch-protection=bti,pac-ret,leaf",
+            "-Zdwarf-version=5",
             // Set flags we don't recognise but rustc supports next
             // rustc flags
             "--cfg",
@@ -496,6 +515,7 @@ mod tests {
                 relocation_model: Some("pic"),
                 soft_float: Some(true),
                 branch_protection: Some("bti,pac-ret,leaf"),
+                dwarf_version: Some(5),
             },
         );
     }

tests/rustflags.rs

@@ -19,12 +19,13 @@ fn inherits_rustflags() {
     // Correctly inherits flags from rustc
     std::env::set_var(
         "CARGO_ENCODED_RUSTFLAGS",
-        "-Cforce-frame-pointers=true\u{1f}-Ccode-model=small\u{1f}-Csoft-float",
+        "-Cforce-frame-pointers=true\u{1f}-Ccode-model=small\u{1f}-Csoft-float\u{1f}-Cdwarf-version=5",
     );
     let test = Test::gnu();
     test.gcc().file("foo.c").compile("foo");
     test.cmd(0)
         .must_have("-fno-omit-frame-pointer")
         .must_have("-mcmodel=small")
-        .must_have("-msoft-float");
+        .must_have("-msoft-float")
+        .must_have("-gdwarf-5");
 }