Rename llvm_libzstd to llvm.libzstd, set it off by default except for config.dist.toml

Author: khuey

config.example.toml

@@ -87,6 +87,9 @@
 # library provided by LLVM.
 #static-libstdcpp = false
 
+# Enable LLVM to use zstd for compression.
+#libzstd = false
+
 # Whether to use Ninja to build LLVM. This runs much faster than make.
 #ninja = true
 
@@ -713,11 +716,6 @@
 # option will override this if set.
 #llvm-libunwind = 'no'
 
-# Global default for llvm-libzstd for all targets. See the target-specific
-# documentation for llvm-libzstd below. Note that the target-specific
-# option will override this if set.
-#llvm-libzstd = false
-
 # Enable Windows Control Flow Guard checks in the standard library.
 # This only applies from stage 1 onwards, and only for Windows targets.
 #control-flow-guard = false
@@ -821,9 +819,6 @@
 # it must link to `libgcc_eh.a` to get a working output, and this option have no effect.
 #llvm-libunwind = 'no' if Linux, 'in-tree' if Fuchsia
 
-# Enable LLVM to use zstd for compression.
-#llvm-libzstd = if linux { true } else { false }
-
 # Build the sanitizer runtimes for this target.
 # This option will override the same option under [build] section.
 #sanitizers = build.sanitizers (bool)

src/bootstrap/defaults/config.dist.toml

@@ -11,6 +11,7 @@ extended = true
 # Most users installing from source want to build all parts of the project from source.
 [llvm]
 download-ci-llvm = false
+libzstd = if linux { true } else { false }
 [rust]
 # We have several defaults in bootstrap that depend on whether the channel is `dev` (e.g. `omit-git-hash` and `download-ci-llvm`).
 # Make sure they don't get set when installing from source.

src/bootstrap/src/core/build_steps/llvm.rs

@@ -822,7 +822,7 @@ fn configure_llvm(builder: &Builder<'_>, target: TargetSelection, cfg: &mut cmak
         cfg.define("LLVM_ENABLE_ZLIB", "OFF");
     }
 
-    if builder.config.llvm_libzstd(target) {
+    if builder.config.llvm_libzstd {
         cfg.define("LLVM_ENABLE_ZSTD", "FORCE_ON");
         cfg.define("LLVM_USE_STATIC_ZSTD", "TRUE");
     } else {

src/bootstrap/src/core/config/config.rs

@@ -218,6 +218,7 @@ pub struct Config {
     pub llvm_thin_lto: bool,
     pub llvm_release_debuginfo: bool,
     pub llvm_static_stdcpp: bool,
+    pub llvm_libzstd: bool,
     /// `None` if `llvm_from_ci` is true and we haven't yet downloaded llvm.
     #[cfg(not(test))]
     llvm_link_shared: Cell<Option<bool>>,
@@ -280,7 +281,6 @@ pub struct Config {
     pub llvm_profile_use: Option<String>,
     pub llvm_profile_generate: bool,
     pub llvm_libunwind_default: Option<LlvmLibunwind>,
-    pub llvm_libzstd_default: Option<bool>,
     pub enable_bolt_settings: bool,
 
     pub reproducible_artifacts: Vec<String>,
@@ -551,7 +551,6 @@ pub struct Target {
     /// Some(path to FileCheck) if one was specified.
     pub llvm_filecheck: Option<PathBuf>,
     pub llvm_libunwind: Option<LlvmLibunwind>,
-    pub llvm_libzstd: Option<bool>,
     pub cc: Option<PathBuf>,
     pub cxx: Option<PathBuf>,
     pub ar: Option<PathBuf>,
@@ -880,6 +879,7 @@ define_config! {
         plugins: Option<bool> = "plugins",
         ccache: Option<StringOrBool> = "ccache",
         static_libstdcpp: Option<bool> = "static-libstdcpp",
+        libzstd: Option<bool> = "libzstd",
         ninja: Option<bool> = "ninja",
         targets: Option<String> = "targets",
         experimental_targets: Option<String> = "experimental-targets",
@@ -1108,7 +1108,6 @@ define_config! {
         jemalloc: Option<bool> = "jemalloc",
         test_compare_mode: Option<bool> = "test-compare-mode",
         llvm_libunwind: Option<String> = "llvm-libunwind",
-        llvm_libzstd: Option<bool> = "llvm-libzstd",
         control_flow_guard: Option<bool> = "control-flow-guard",
         ehcont_guard: Option<bool> = "ehcont-guard",
         new_symbol_mangling: Option<bool> = "new-symbol-mangling",
@@ -1135,7 +1134,6 @@ define_config! {
         llvm_has_rust_patches: Option<bool> = "llvm-has-rust-patches",
         llvm_filecheck: Option<String> = "llvm-filecheck",
         llvm_libunwind: Option<String> = "llvm-libunwind",
-        llvm_libzstd: Option<bool> = "llvm-libzstd",
         sanitizers: Option<bool> = "sanitizers",
         profiler: Option<StringOrBool> = "profiler",
         rpath: Option<bool> = "rpath",
@@ -1157,6 +1155,7 @@ impl Config {
             llvm_optimize: true,
             ninja_in_file: true,
             llvm_static_stdcpp: false,
+            llvm_libzstd: false,
             backtrace: true,
             rust_optimize: RustOptimize::Bool(true),
             rust_optimize_tests: true,
@@ -1637,7 +1636,6 @@ impl Config {
                 jemalloc,
                 test_compare_mode,
                 llvm_libunwind,
-                llvm_libzstd,
                 control_flow_guard,
                 ehcont_guard,
                 new_symbol_mangling,
@@ -1724,7 +1722,6 @@ impl Config {
             set(&mut config.ehcont_guard, ehcont_guard);
             config.llvm_libunwind_default =
                 llvm_libunwind.map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
-            config.llvm_libzstd_default = llvm_libzstd;
 
             if let Some(ref backends) = codegen_backends {
                 let available_backends = ["llvm", "cranelift", "gcc"];
@@ -1793,6 +1790,7 @@ impl Config {
                 plugins,
                 ccache,
                 static_libstdcpp,
+                libzstd,
                 ninja,
                 targets,
                 experimental_targets,
@@ -1827,6 +1825,7 @@ impl Config {
             set(&mut config.llvm_thin_lto, thin_lto);
             set(&mut config.llvm_release_debuginfo, release_debuginfo);
             set(&mut config.llvm_static_stdcpp, static_libstdcpp);
+            set(&mut config.llvm_libzstd, libzstd);
             if let Some(v) = link_shared {
                 config.llvm_link_shared.set(Some(v));
             }
@@ -1877,6 +1876,7 @@ impl Config {
                 check_ci_llvm!(optimize_toml);
                 check_ci_llvm!(thin_lto);
                 check_ci_llvm!(release_debuginfo);
+                //check_ci_llvm!(libzstd);
                 check_ci_llvm!(targets);
                 check_ci_llvm!(experimental_targets);
                 check_ci_llvm!(clang_cl);
@@ -1931,7 +1931,6 @@ impl Config {
                         panic!("failed to parse target.{triple}.llvm-libunwind")
                     })
                 });
-                target.llvm_libzstd = cfg.llvm_libzstd;
                 if let Some(s) = cfg.no_std {
                     target.no_std = s;
                 }
@@ -2418,14 +2417,6 @@ impl Config {
             })
     }
 
-    pub fn llvm_libzstd(&self, target: TargetSelection) -> bool {
-        self.target_config
-            .get(&target)
-            .and_then(|t| t.llvm_libzstd)
-            .or(self.llvm_libzstd_default)
-            .unwrap_or(target.contains("linux"))
-    }
-
     pub fn split_debuginfo(&self, target: TargetSelection) -> SplitDebuginfo {
         self.target_config
             .get(&target)
@@ -2730,7 +2721,6 @@ fn check_incompatible_options_for_ci_rustc(rust: &Rust) -> Result<(), String> {
         remap_debuginfo: _,
         test_compare_mode: _,
         llvm_libunwind: _,
-        llvm_libzstd: _,
         control_flow_guard: _,
         ehcont_guard: _,
         new_symbol_mangling: _,

src/bootstrap/src/utils/change_tracker.rs

@@ -223,6 +223,6 @@ pub const CONFIG_CHANGE_HISTORY: &[ChangeInfo] = &[
     ChangeInfo {
         change_id: 125642,
         severity: ChangeSeverity::Info,
-        summary: "New option `llvm-libzstd` to control whether llvm is built with zstd support.",
+        summary: "New option `llvm.libzstd` to control whether llvm is built with zstd support.",
     },
 ];