Update optimization to use new passes

Author: matt-cornell

cobalt-build/src/build.rs

@@ -6,6 +6,7 @@ use cobalt_parser::parse_str;
 use cobalt_utils::CellExt as Cell;
 use either::Either;
 use indexmap::IndexMap;
+use inkwell::passes::PassBuilderOptions;
 use inkwell::targets::{FileType, Target as InkwellTarget, TargetTriple};
 use os_str_bytes::OsStrBytes;
 use path_calculate::*;
@@ -149,9 +150,6 @@ fn build_file_2(
         ctx.with_vars(|v| clear_mod(&mut v.symbols));
         return Ok(false);
     }
-    let pm = inkwell::passes::PassManager::create(());
-    opt::load_profile(&opts.profile, &pm);
-    pm.run_on(&ctx.module);
     let trip = TargetTriple::create(&opts.triple);
     let target_machine = InkwellTarget::from_triple(&trip)
         .unwrap()
@@ -164,6 +162,11 @@ fn build_file_2(
             inkwell::targets::CodeModel::Small,
         )
         .expect("failed to create target machine");
+    ctx.module.run_passes(
+        &opt::expand_pass_string(&opts.profile)?,
+        &target_machine,
+        PassBuilderOptions::create(),
+    ).map_err(opt::PassError::from_llvm)?;
     if !out_path.parent().unwrap().exists() {
         out_path.parent().unwrap().create_dir_all_anyhow()?
     }

cobalt-build/src/opt.rs

@@ -1,199 +1,80 @@
-use cobalt_errors::{error, warning};
-use cobalt_llvm::inkwell;
-use inkwell::module::Module;
-use inkwell::passes::*;
-use inkwell::OptimizationLevel::*;
-use std::env::var;
-use std::fs::read;
-use std::process::exit;
-pub enum AdditionalArg {
-    Null,
-    Bool(bool),
-    Int(i32),
-}
-use AdditionalArg::*;
+use std::path::PathBuf;
+use anyhow_std::*;
+use std::env::var_os;
+use thiserror::Error;
+
+/// A profile wasn't found in any of the searched paths
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Error)]
+#[error("couldn't find profile {0}")]
+pub struct MissingProfile(pub String);
 
-pub fn add_pass(pm: &PassManager<Module>, name: &str, arg: AdditionalArg) -> bool {
-    if let Some(profile) = name.strip_prefix('@') {
-        load_profile(profile.trim(), pm);
-        return true;
+/// Something went wrong while running passes
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Error)]
+#[error("encountered an error while running passes:{}{0}", if .0.contains('\n') {'\n'} else {' '})]
+pub struct PassError(pub String);
+impl PassError {
+    /// Convenience method for use with `map_err`
+    #[inline(always)]
+    pub fn from_llvm(s: cobalt_llvm::inkwell::support::LLVMString) -> Self {
+        Self(s.to_string())
     }
-    // I wish there was a better way to do this
-    let name = name
-        .replace("attribute", "attr")
-        .replace("function", "func")
-        .replace("fn", "func")
-        .replace("argument", "arg")
-        .replace("constant", "const")
-        .replace("optimizer", "opt")
-        .replace("optimization", "opt")
-        .replace("alignment", "align")
-        .replace("variable", "var")
-        .replace("instruction", "inst")
-        .replace(['_', '-'], " ")
-        .to_lowercase();
-    match name.as_str() {
-        "const merge" => pm.add_constant_merge_pass(),
-        "merge func" | "merge funcs" => pm.add_merge_functions_pass(),
-        "dead arg" | "dead args" | "dead arg elimination" | "dead args elimination" => {
-            pm.add_dead_arg_elimination_pass()
-        }
-        "func attr" | "func attrs" => pm.add_function_attrs_pass(),
-        "func inline" | "func inlining" => pm.add_function_inlining_pass(),
-        "always inline" | "always inliner" => pm.add_always_inliner_pass(),
-        "global dce" => pm.add_global_dce_pass(),
-        "global opt" => pm.add_global_optimizer_pass(),
-        "ipsccp" => pm.add_ipsccp_pass(),
-        "internalize" => pm.add_internalize_pass(match arg {
-            Null => false,
-            Bool(val) => val,
-            Int(val) => val != 0,
+}
+
+lazy_static::lazy_static! {
+    static ref SEARCH_DIRS: Vec<PathBuf> = [
+        var_os("COBALT_DIR").map(|p| {
+            let mut p = PathBuf::from(p);
+            p.push("profiles");
+            p
         }),
-        "strip dead prototype"
-        | "strip dead prototypes"
-        | "strip prototype"
-        | "strip prototypes" => pm.add_strip_dead_prototypes_pass(),
-        "strip symbol" | "strip symbols" => pm.add_strip_symbol_pass(),
-        "loop vectorize" => pm.add_loop_vectorize_pass(),
-        "slp vectorize" => pm.add_slp_vectorize_pass(),
-        "aggresive dce" | "adce" => pm.add_aggressive_dce_pass(),
-        "bit tracking dce" | "bit dce" | "tracking dce" => pm.add_bit_tracking_dce_pass(),
-        "align from assumptions" => pm.add_alignment_from_assumptions_pass(),
-        "cfg simplification" => pm.add_cfg_simplification_pass(),
-        "dead store" | "dead store elimination" => pm.add_dead_store_elimination_pass(),
-        "scalarizer" => pm.add_scalarizer_pass(),
-        "mlsm" | "merged load store motion" => pm.add_merged_load_store_motion_pass(),
-        "gvn" | "global value numbering" => pm.add_gvn_pass(),
-        "new gvn" | "new global value numbering" => pm.add_new_gvn_pass(),
-        "ind var simplify" | "induction var simplify" => pm.add_ind_var_simplify_pass(),
-        "inst combine" | "inst combining" => pm.add_instruction_combining_pass(),
-        "jump thread" | "jump threading" => pm.add_jump_threading_pass(),
-        "licm" => pm.add_licm_pass(),
-        "dld" | "loop deletion" | "dead loop deletion" => pm.add_loop_deletion_pass(),
-        "loop idiom" => pm.add_loop_idiom_pass(),
-        "loop rotate" => pm.add_loop_rotate_pass(),
-        "loop reroll" => pm.add_loop_reroll_pass(),
-        "loop unroll" => pm.add_loop_unroll_pass(),
-        "memcpy" | "memcpy opt" => pm.add_memcpy_optimize_pass(),
-        "partially inline lib calls" => pm.add_partially_inline_lib_calls_pass(),
-        "lower switch" => pm.add_lower_switch_pass(),
-        "promote memory to register" => pm.add_promote_memory_to_register_pass(),
-        "reassociate" => pm.add_reassociate_pass(),
-        "sccp" => pm.add_sccp_pass(),
-        "scalar repl aggregates" => match arg {
-            Null | Bool(false) => pm.add_scalar_repl_aggregates_pass(),
-            Bool(true) => pm.add_scalar_repl_aggregates_pass_ssa(),
-            Int(val) => pm.add_scalar_repl_aggregates_pass_with_threshold(val),
-        },
-        "scalar repl aggregates ssa" => pm.add_scalar_repl_aggregates_pass_ssa(),
-        "simplify lib calls" => pm.add_simplify_lib_calls_pass(),
-        "tail call elimination" => pm.add_tail_call_elimination_pass(),
-        "inst simplify" => pm.add_instruction_simplify_pass(),
-        "demote memory to register" => pm.add_demote_memory_to_register_pass(),
-        "verify" | "verifier" => pm.add_verifier_pass(),
-        "correlated value propagation" => pm.add_correlated_value_propagation_pass(),
-        "early cse" => match arg {
-            Null | Bool(false) | Int(0) => pm.add_early_cse_pass(),
-            Bool(true) | Int(_) => pm.add_early_cse_mem_ssa_pass(),
-        },
-        "early cse mem ssa" => pm.add_early_cse_mem_ssa_pass(),
-        "lower expect intrinsic" => pm.add_lower_expect_intrinsic_pass(),
-        "type based alias analysis" => pm.add_type_based_alias_analysis_pass(),
-        "scoped no alias aa" => pm.add_scoped_no_alias_aa_pass(),
-        "basic alias analysis" => pm.add_basic_alias_analysis_pass(),
-        "loop unroll and jam" | "loop unroll jam" => pm.add_loop_unroll_and_jam_pass(),
-        _ => return false,
-    }
-    true
+        var_os("HOME").map(|p| {
+            let mut p = PathBuf::from(p);
+            p.push(".cobalt");
+            p.push("profiles");
+            p
+        }),
+        var_os("HOME").map(|p| {
+            let mut p = PathBuf::from(p);
+            p.push(".config");
+            p.push("cobalt");
+            p.push("profiles");
+            p
+        }),
+        Some("/usr/local/share/cobalt/profiles".into()),
+        Some("/usr/share/cobalt/profiles".into()),
+    ].into_iter().filter_map(|p| p.and_then(|p| p.is_dir().then_some(p))).collect();
 }
 
-pub fn from_file(data: &str, pm: &PassManager<Module>) {
-    for (n, mut line) in data.split('\n').enumerate() {
-        let n = n + 1;
-        if let Some(idx) = line.find('#') {
-            line = &line[..idx];
-        }
-        if line.trim().is_empty() {
-            continue;
-        }
-        if let Some(idx) = line.find('=') {
-            let pass = line[..idx].trim();
-            let val = line[(idx + 1)..].trim().to_lowercase();
-            if val.is_empty() {
-                if !add_pass(pm, pass, Null) {
-                    warning!("{n}: unknown pass '{pass}'");
-                }
-            } else if val == "true" {
-                if !add_pass(pm, pass, Bool(true)) {
-                    warning!("{n}: unknown pass '{pass}'");
-                }
-            } else if val == "false" {
-                if !add_pass(pm, pass, Bool(false)) {
-                    warning!("{n}: unknown pass '{pass}'");
-                }
-            } else if let Ok(val) = val.parse() {
-                if !add_pass(pm, pass, Int(val)) {
-                    warning!("{n}: unknown pass '{pass}'");
-                }
-            } else {
-                warning!("{n}: unrecognized value '{val}'");
-                if !add_pass(pm, pass, Null) {
-                    warning!("{n}: unknown pass '{pass}'");
-                }
-            }
-        } else {
-            let pass = line.trim();
-            if !add_pass(pm, pass, Null) {
-                warning!("{n}: unknown pass '{pass}'");
-            }
+fn expand_profile_name(name: &str) -> anyhow::Result<String> {
+    for p in SEARCH_DIRS.iter() {
+        let p = p.join(name);
+        if p.is_file() {
+            return p.read_to_string_anyhow();
         }
     }
+    Ok(match name {
+        "none" | "0" => "default<O0>",
+        "less" | "1" => "default<O1>",
+        "some" | "2" | "default" => "default<O2>",
+        "aggr" | "3" => "default<O3>",
+        _ => Err(MissingProfile(name.to_string()))?
+    }.to_string())
 }
-pub fn load_profile(name: &str, pm: &PassManager<Module>) {
-    if let Ok(cobalt_dir) = var("COBALT_DIR") {
-        if let Ok(data) = read(format!("{cobalt_dir}/profiles/{name}")) {
-            from_file(&String::from_utf8_lossy(data.as_slice()), pm);
-            return;
-        }
-    }
-    if let Ok(home_dir) = var("HOME") {
-        if let Ok(data) = read(format!("{home_dir}/.cobalt/profiles/{name}")) {
-            from_file(&String::from_utf8_lossy(data.as_slice()), pm);
-            return;
-        }
-        if let Ok(data) = read(format!("{home_dir}/.config/cobalt/profiles/{name}")) {
-            from_file(&String::from_utf8_lossy(data.as_slice()), pm);
-            return;
-        }
-    }
-    if let Ok(data) = read(format!("/usr/local/share/cobalt/profiles/{name}")) {
-        from_file(&String::from_utf8_lossy(data.as_slice()), pm);
-        return;
-    }
-    if let Ok(data) = read(format!("/usr/share/cobalt/profiles/{name}")) {
-        from_file(&String::from_utf8_lossy(data.as_slice()), pm);
-        return;
-    }
-    match name {
-        "none" | "0" => {}
-        "less" | "1" => {
-            let pmb = PassManagerBuilder::create();
-            pmb.set_optimization_level(Less);
-            pmb.populate_module_pass_manager(pm);
-        }
-        "some" | "2" | "default" => {
-            let pmb = PassManagerBuilder::create();
-            pmb.set_optimization_level(Default);
-            pmb.populate_module_pass_manager(pm);
-        }
-        "aggressive" | "3" => {
-            let pmb = PassManagerBuilder::create();
-            pmb.set_optimization_level(Aggressive);
-            pmb.populate_module_pass_manager(pm);
-        }
-        _ => {
-            error!("couldn't find profile {name}");
-            exit(103);
-        }
+
+fn non_ident(ch: char) -> bool {
+    !matches!(ch, 'a'..='z' | 'A'..='Z' | '0'..='9' | '_' | '-' | '$')
+}
+
+/// Expand a pass string, replacing `@name `with the contents of a pass.
+pub fn expand_pass_string(mut passes: &str) -> anyhow::Result<String> {
+    let mut out = String::with_capacity(passes.len());
+    while let Some(idx) = passes.find('@') {
+        out += &passes[..idx];
+        passes = &passes[(idx + 1)..];
+        let idx = passes.find(non_ident).unwrap_or(passes.len());
+        out += &expand_profile_name(&passes[..idx])?;
+        passes = &passes[idx..];
     }
+    out += passes;
+    Ok(out)
 }