Auto merge of #50044 - DiamondLovesYou:polly, r=<try>

Add Polly support

It is always compiled and linked, but not used by default.

Use can be triggered via `-Z polly=true` or at compiler build-time (see `config.toml.example`).

config.toml.example

@@ -346,6 +346,10 @@
 # Whether to deny warnings in crates
 #deny-warnings = true
 
+# Use polyhedral optimizations by default.  Note, enabling this on a build of
+# LLVM which lacks Polly (or only has a shared version) *won't* error.
+#use-polly-by-default = false
+
 # =============================================================================
 # Options for specific targets
 #

src/bootstrap/bootstrap.py

@@ -690,6 +690,10 @@ def update_submodules(self):
             recorded_submodules[data[3]] = data[2]
         for module in filtered_submodules:
             self.update_submodule(module[0], module[1], recorded_submodules)
+        polly_path = "src/llvm/tools/polly"
+        if not os.path.exists(os.path.join(self.rust_root, polly_path)):
+            run(["git", "clone", "https://github.com/llvm-mirror/polly.git",
+                 "src/llvm/tools/polly", "-b", "release_60"])
         print("Submodules updated in %.2f seconds" % (time() - start_time))
 
     def set_dev_environment(self):

src/bootstrap/compile.rs

@@ -553,6 +553,9 @@ pub fn rustc_cargo_env(builder: &Builder, cargo: &mut Command) {
     if builder.config.rustc_parallel_queries {
         cargo.env("RUSTC_PARALLEL_QUERIES", "1");
     }
+    if builder.config.rust_codegen_polly_by_default {
+        cargo.env("RUSTC_FORCE_USE_POLLY", "1");
+    }
 }
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]

src/bootstrap/config.rs

@@ -103,6 +103,7 @@ pub struct Config {
     pub rust_dist_src: bool,
     pub rust_codegen_backends: Vec<Interned<String>>,
     pub rust_codegen_backends_dir: String,
+    pub rust_codegen_polly_by_default: bool,
 
     pub build: Interned<String>,
     pub hosts: Vec<Interned<String>>,
@@ -306,6 +307,7 @@ struct Rust {
     wasm_syscall: Option<bool>,
     lld: Option<bool>,
     deny_warnings: Option<bool>,
+    use_polly_by_default: Option<bool>,
 }
 
 /// TOML representation of how each build target is configured.
@@ -537,6 +539,10 @@ impl Config {
                 Some(n) => config.rust_codegen_units = Some(n),
                 None => {}
             }
+
+            config.rust_codegen_polly_by_default = rust
+              .use_polly_by_default
+              .unwrap_or(false);
         }
 
         if let Some(ref t) = toml.target {

src/librustc/session/config.rs

@@ -1291,6 +1291,9 @@ options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
           "make the current crate share its generic instantiations"),
     chalk: bool = (false, parse_bool, [TRACKED],
           "enable the experimental Chalk-based trait solving engine"),
+    polly: bool = (option_env!("RUSTC_FORCE_USE_POLLY").is_some(),
+                   parse_bool, [UNTRACKED], "Run the Polly polyhedral \
+           model optimization passes."),
 }
 
 pub fn default_lib_output() -> CrateType {

src/librustc_llvm/build.rs

@@ -157,11 +157,53 @@ fn main() {
         cfg.define("LLVM_RUSTLLVM", None);
     }
 
+    let (enable_polly, polly_link_kind, polly_link_isl) = {
+        let mut cmd = Command::new(&llvm_config);
+        cmd.arg("--libdir");
+        let libdir = output(&mut cmd);
+        let libdir = libdir.lines().next().unwrap();
+        let libdir = Path::new(&libdir);
+        assert!(libdir.exists());
+
+        // We can't specify the full libname to rust, so the linker will always expect (on unix)
+        // LLVMPolly to be libLLVMPolly, which won't be present. I didn't realize this fact until
+        // after I won't the following, but maybe this issue will be resolved in the future.
+        let allow_shared = false;
+        let mut found_static = false;
+        let mut found_shared = false;
+        for entry in libdir.read_dir().unwrap() {
+            if let Ok(entry) = entry {
+                if let Some(name) = entry.path().file_name() {
+                    let name = name.to_str().unwrap();
+                    if name.contains("Polly") {
+                        if !found_static {
+                            found_static = !name.contains("LLVM");
+                        }
+                        if !found_shared {
+                            found_shared = name.contains("LLVM");
+                        }
+                    }
+                }
+            }
+        }
+
+        let found_static = found_static;
+        let found_shared = allow_shared && found_shared;
+        let enabled = found_static || found_shared;
+        let (kind, isl) = match (found_static, found_shared) {
+            (false, false) => ("", false),
+            (true, _) => ("static", true),
+            (false, true) => ("dylib", false),
+        };
+        (enabled, kind, isl)
+    };
+
     build_helper::rerun_if_changed_anything_in_dir(Path::new("../rustllvm"));
     cfg.file("../rustllvm/PassWrapper.cpp")
        .file("../rustllvm/RustWrapper.cpp")
        .file("../rustllvm/ArchiveWrapper.cpp")
        .file("../rustllvm/Linker.cpp")
+       .define("ENABLE_POLLY", if enable_polly { "1" } else { "0" })
        .cpp(true)
        .cpp_link_stdlib(None) // we handle this below
        .compile("rustllvm");
@@ -214,6 +256,20 @@ fn main() {
         println!("cargo:rustc-link-lib={}={}", kind, name);
     }
 
+    if enable_polly {
+        match polly_link_kind {
+            "dylib" => {
+                panic!("dynamically linking polly is not possible :(");
+                //println!("cargo:rustc-flags=-l:LLVMPolly")
+            },
+            _ => println!("cargo:rustc-link-lib={}=Polly", polly_link_kind),
+        }
+
+        if polly_link_isl {
+            println!("cargo:rustc-link-lib={}=PollyISL", polly_link_kind);
+        }
+    }
+
     // LLVM ldflags
     //
     // If we're a cross-compile of LLVM then unfortunately we can't trust these

src/librustc_llvm/ffi.rs

@@ -1642,7 +1642,8 @@ extern "C" {
                                        Singlethread: bool)
                                        -> TargetMachineRef;
     pub fn LLVMRustDisposeTargetMachine(T: TargetMachineRef);
-    pub fn LLVMRustAddAnalysisPasses(T: TargetMachineRef, PM: PassManagerRef, M: ModuleRef);
+    pub fn LLVMRustAddAnalysisPasses(T: TargetMachineRef, PM: PassManagerRef, M: ModuleRef,
+                                     Polly: bool);
     pub fn LLVMRustAddBuilderLibraryInfo(PMB: PassManagerBuilderRef,
                                          M: ModuleRef,
                                          DisableSimplifyLibCalls: bool);

src/librustc_trans/back/lto.rs

@@ -460,7 +460,7 @@ fn run_pass_manager(cgcx: &CodegenContext,
     debug!("running the pass manager");
     unsafe {
         let pm = llvm::LLVMCreatePassManager();
-        llvm::LLVMRustAddAnalysisPasses(tm, pm, llmod);
+        llvm::LLVMRustAddAnalysisPasses(tm, pm, llmod, config.polly);
         let pass = llvm::LLVMRustFindAndCreatePass("verify\0".as_ptr() as *const _);
         assert!(!pass.is_null());
         llvm::LLVMRustAddPass(pm, pass);

src/librustc_trans/back/write.rs

@@ -250,6 +250,7 @@ pub struct ModuleConfig {
     no_integrated_as: bool,
     embed_bitcode: bool,
     embed_bitcode_marker: bool,
+    pub polly: bool,
 }
 
 impl ModuleConfig {
@@ -281,7 +282,8 @@ impl ModuleConfig {
             vectorize_loop: false,
             vectorize_slp: false,
             merge_functions: false,
-            inline_threshold: None
+            inline_threshold: None,
+            polly: false,
         }
     }
 
@@ -319,6 +321,8 @@ impl ModuleConfig {
 
         self.merge_functions = sess.opts.optimize == config::OptLevel::Default ||
                                sess.opts.optimize == config::OptLevel::Aggressive;
+        self.polly = sess.opts.debugging_opts.polly && !self.no_prepopulate_passes &&
+                     !sess.target.target.options.is_like_emscripten;
     }
 }
 
@@ -546,8 +550,8 @@ unsafe fn optimize(cgcx: &CodegenContext,
 
         if !config.no_verify { assert!(addpass("verify")); }
         if !config.no_prepopulate_passes {
-            llvm::LLVMRustAddAnalysisPasses(tm, fpm, llmod);
-            llvm::LLVMRustAddAnalysisPasses(tm, mpm, llmod);
+            llvm::LLVMRustAddAnalysisPasses(tm, fpm, llmod, config.polly);
+            llvm::LLVMRustAddAnalysisPasses(tm, mpm, llmod, config.polly);
             let opt_level = config.opt_level.unwrap_or(llvm::CodeGenOptLevel::None);
             with_llvm_pmb(llmod, &config, opt_level, &mut |b| {
                 llvm::LLVMPassManagerBuilderPopulateFunctionPassManager(b, fpm);
@@ -645,11 +649,12 @@ unsafe fn codegen(cgcx: &CodegenContext,
     unsafe fn with_codegen<F, R>(tm: TargetMachineRef,
                                  llmod: ModuleRef,
                                  no_builtins: bool,
+                                 polly: bool,
                                  f: F) -> R
         where F: FnOnce(PassManagerRef) -> R,
     {
         let cpm = llvm::LLVMCreatePassManager();
-        llvm::LLVMRustAddAnalysisPasses(tm, cpm, llmod);
+        llvm::LLVMRustAddAnalysisPasses(tm, cpm, llmod, polly);
         llvm::LLVMRustAddLibraryInfo(cpm, llmod, no_builtins);
         f(cpm)
     }
@@ -744,7 +749,8 @@ unsafe fn codegen(cgcx: &CodegenContext,
                 cursor.position() as size_t
             }
 
-            with_codegen(tm, llmod, config.no_builtins, |cpm| {
+            with_codegen(tm, llmod, config.no_builtins, config.polly,
+                         |cpm| {
                 llvm::LLVMRustPrintModule(cpm, llmod, out.as_ptr(), demangle_callback);
                 llvm::LLVMDisposePassManager(cpm);
             });
@@ -762,7 +768,8 @@ unsafe fn codegen(cgcx: &CodegenContext,
             } else {
                 llmod
             };
-            with_codegen(tm, llmod, config.no_builtins, |cpm| {
+            with_codegen(tm, llmod, config.no_builtins, config.polly,
+                         |cpm| {
                 write_output_file(diag_handler, tm, cpm, llmod, &path,
                                   llvm::FileType::AssemblyFile)
             })?;
@@ -773,7 +780,8 @@ unsafe fn codegen(cgcx: &CodegenContext,
         }
 
         if write_obj {
-            with_codegen(tm, llmod, config.no_builtins, |cpm| {
+            with_codegen(tm, llmod, config.no_builtins, config.polly,
+                         |cpm| {
                 write_output_file(diag_handler, tm, cpm, llmod, &obj_out,
                                   llvm::FileType::ObjectFile)
             })?;

src/rustllvm/PassWrapper.cpp

@@ -61,6 +61,13 @@ DEFINE_STDCXX_CONVERSION_FUNCTIONS(TargetMachine, LLVMTargetMachineRef)
 DEFINE_STDCXX_CONVERSION_FUNCTIONS(PassManagerBuilder,
                                    LLVMPassManagerBuilderRef)
 
+#if ENABLE_POLLY
+namespace polly {
+void initializePollyPasses(llvm::PassRegistry &Registry);
+void registerPollyPasses(llvm::legacy::PassManagerBase &PM);
+}
+#endif
+
 extern "C" void LLVMInitializePasses() {
   PassRegistry &Registry = *PassRegistry::getPassRegistry();
   initializeCore(Registry);
@@ -73,6 +80,10 @@ extern "C" void LLVMInitializePasses() {
   initializeInstCombine(Registry);
   initializeInstrumentation(Registry);
   initializeTarget(Registry);
+
+#if ENABLE_POLLY
+  polly::initializePollyPasses(Registry);
+#endif
 }
 
 enum class LLVMRustPassKind {
@@ -420,10 +431,19 @@ extern "C" void LLVMRustDisposeTargetMachine(LLVMTargetMachineRef TM) {
 // this function.
 extern "C" void LLVMRustAddAnalysisPasses(LLVMTargetMachineRef TM,
                                           LLVMPassManagerRef PMR,
-                                          LLVMModuleRef M) {
+                                          LLVMModuleRef M,
+                                          bool Polly) {
   PassManagerBase *PM = unwrap(PMR);
   PM->add(
       createTargetTransformInfoWrapperPass(unwrap(TM)->getTargetIRAnalysis()));
+
+#if ENABLE_POLLY
+  if(Polly) {
+    polly::registerPollyPasses(*PM);
+  }
+#else
+  (void)Polly;
+#endif
 }
 
 extern "C" void LLVMRustConfigurePassManagerBuilder(

src/rustllvm/llvm-rebuild-trigger

@@ -1,4 +1,4 @@
 # If this file is modified, then llvm will be (optionally) cleaned and then rebuilt.
 # The actual contents of this file do not matter, but to trigger a change on the
 # build bots then the contents should be changed so git updates the mtime.
-2018-04-05
+2018-04-18