refactor: extract mun_hir_input (#571)

Extracts the input part of the hir database into its own seperate crate: `mun_hir_input`. The goals is to create a cleaner API separation and at the same time decrease incremental compilation time by splitting crates.
mun-lang · Jul 30, 2024 · 7c7a3c7 · 7c7a3c7
1 parent cf1bae3
commit 7c7a3c7
Show file tree

Hide file tree

Showing 84 changed files with 507 additions and 791 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/mun_codegen/Cargo.toml b/crates/mun_codegen/Cargo.toml
@@ -19,7 +19,9 @@ apple-codesign = { workspace = true }
 array-init = { workspace = true }
 by_address = { workspace = true }
 bytemuck = { workspace = true }
+mun_db = { version = "0.6.0-dev", path = "../mun_db" }
 mun_hir = { version = "0.6.0-dev", path = "../mun_hir" }
+mun_hir_input = { version = "0.6.0-dev", path = "../mun_hir_input" }
 inkwell = { workspace = true, features = ["llvm14-0", "target-x86", "target-aarch64"] }
 itertools = { workspace = true }
 mun_codegen_macros = { version = "0.6.0-dev", path = "../mun_codegen_macros" }

diff --git a/crates/mun_codegen/src/db.rs b/crates/mun_codegen/src/db.rs
@@ -14,9 +14,7 @@ use crate::{AssemblyIr, ModuleGroupId, ModulePartition, TargetAssembly};
 /// generation cache is pretty granular there is still a benefit to not having
 /// to recompile assemblies if not required.
 #[salsa::query_group(CodeGenDatabaseStorage)]
-pub trait CodeGenDatabase:
-    mun_hir::HirDatabase + mun_hir::Upcast<dyn mun_hir::HirDatabase>
-{
+pub trait CodeGenDatabase: mun_hir::HirDatabase + mun_db::Upcast<dyn mun_hir::HirDatabase> {
     /// Set the optimization level used to generate assemblies
     #[salsa::input]
     fn optimization_level(&self) -> inkwell::OptimizationLevel;

diff --git a/crates/mun_codegen/src/mock.rs b/crates/mun_codegen/src/mock.rs
@@ -1,6 +1,7 @@
 use std::sync::Arc;
 
-use mun_hir::{FileId, HirDatabase, SourceDatabase, SourceRoot, SourceRootId};
+use mun_hir::HirDatabase;
+use mun_hir_input::{FileId, PackageSet, SourceDatabase, SourceRoot, SourceRootId};
 use mun_paths::RelativePathBuf;
 use mun_target::spec::Target;
 use parking_lot::Mutex;
@@ -13,7 +14,7 @@ use crate::{
 /// A mock implementation of the IR database. It can be used to set up a simple
 /// test case.
 #[salsa::database(
-    mun_hir::SourceDatabaseStorage,
+    mun_hir_input::SourceDatabaseStorage,
     mun_hir::AstDatabaseStorage,
     mun_hir::InternDatabaseStorage,
     mun_hir::DefDatabaseStorage,
@@ -34,31 +35,31 @@ impl salsa::Database for MockDatabase {
     }
 }
 
-impl mun_hir::Upcast<dyn mun_hir::AstDatabase> for MockDatabase {
+impl mun_db::Upcast<dyn mun_hir::AstDatabase> for MockDatabase {
     fn upcast(&self) -> &(dyn mun_hir::AstDatabase + 'static) {
         self
     }
 }
 
-impl mun_hir::Upcast<dyn mun_hir::SourceDatabase> for MockDatabase {
-    fn upcast(&self) -> &(dyn mun_hir::SourceDatabase + 'static) {
+impl mun_db::Upcast<dyn SourceDatabase> for MockDatabase {
+    fn upcast(&self) -> &(dyn SourceDatabase + 'static) {
         self
     }
 }
 
-impl mun_hir::Upcast<dyn mun_hir::DefDatabase> for MockDatabase {
+impl mun_db::Upcast<dyn mun_hir::DefDatabase> for MockDatabase {
     fn upcast(&self) -> &(dyn mun_hir::DefDatabase + 'static) {
         self
     }
 }
 
-impl mun_hir::Upcast<dyn mun_hir::HirDatabase> for MockDatabase {
+impl mun_db::Upcast<dyn mun_hir::HirDatabase> for MockDatabase {
     fn upcast(&self) -> &(dyn mun_hir::HirDatabase + 'static) {
         self
     }
 }
 
-impl mun_hir::Upcast<dyn CodeGenDatabase> for MockDatabase {
+impl mun_db::Upcast<dyn CodeGenDatabase> for MockDatabase {
     fn upcast(&self) -> &(dyn CodeGenDatabase + 'static) {
         self
     }
@@ -93,7 +94,7 @@ impl MockDatabase {
 
         db.set_source_root(source_root_id, Arc::new(source_root));
 
-        let mut packages = mun_hir::PackageSet::default();
+        let mut packages = PackageSet::default();
         packages.add_package(source_root_id);
         db.set_packages(Arc::new(packages));
 

diff --git a/crates/mun_codegen/src/module_group.rs b/crates/mun_codegen/src/module_group.rs
@@ -7,6 +7,7 @@ use std::{
 };
 
 use mun_hir::{HasVisibility, HirDatabase};
+use mun_hir_input::FileId;
 use rustc_hash::{FxHashMap, FxHashSet};
 
 /// A `ModuleGroup` describes a grouping of modules
@@ -118,10 +119,7 @@ impl ModuleGroup {
     }
 
     /// Returns the `mun_hir::FileId`s that are included in this module group.
-    pub fn files<'s>(
-        &'s self,
-        db: &'s dyn HirDatabase,
-    ) -> impl Iterator<Item = mun_hir::FileId> + 's {
+    pub fn files<'s>(&'s self, db: &'s dyn HirDatabase) -> impl Iterator<Item = FileId> + 's {
         self.ordered_modules
             .iter()
             .filter_map(move |module| module.file_id(db))

diff --git a/crates/mun_codegen/src/module_partition.rs b/crates/mun_codegen/src/module_partition.rs
@@ -1,5 +1,6 @@
 use std::{ops::Index, sync::Arc};
 
+use mun_hir_input::FileId;
 use rustc_hash::FxHashMap;
 
 use crate::{CodeGenDatabase, ModuleGroup};
@@ -14,7 +15,7 @@ pub struct ModuleGroupId(usize);
 pub struct ModulePartition {
     groups: Vec<ModuleGroup>,
     module_to_group: FxHashMap<mun_hir::Module, ModuleGroupId>,
-    file_to_group: FxHashMap<mun_hir::FileId, ModuleGroupId>,
+    file_to_group: FxHashMap<FileId, ModuleGroupId>,
 }
 
 impl ModulePartition {
@@ -49,7 +50,7 @@ impl ModulePartition {
     }
 
     /// Returns the group to which the specified module belongs.
-    pub fn group_for_file(&self, file: mun_hir::FileId) -> Option<ModuleGroupId> {
+    pub fn group_for_file(&self, file: FileId) -> Option<ModuleGroupId> {
         self.file_to_group.get(&file).copied()
     }
 

diff --git a/crates/mun_codegen/src/test.rs b/crates/mun_codegen/src/test.rs
@@ -1,9 +1,9 @@
 use std::cell::RefCell;
 
 use inkwell::{context::Context, OptimizationLevel};
-use mun_hir::{
-    diagnostics::DiagnosticSink, with_fixture::WithFixture, HirDatabase, SourceDatabase, Upcast,
-};
+use mun_db::Upcast;
+use mun_hir::{diagnostics::DiagnosticSink, HirDatabase};
+use mun_hir_input::{SourceDatabase, WithFixture};
 use mun_target::spec::Target;
 
 use crate::{

diff --git a/crates/mun_compiler/Cargo.toml b/crates/mun_compiler/Cargo.toml
@@ -15,6 +15,8 @@ license.workspace = true
 [dependencies]
 mun_codegen = { version = "0.6.0-dev", path = "../mun_codegen" }
 mun_syntax = { version = "0.6.0-dev", path = "../mun_syntax" }
+mun_db = { version = "0.6.0-dev", path = "../mun_db" }
+mun_hir_input = { version = "0.6.0-dev", path = "../mun_hir_input" }
 mun_hir = { version = "0.6.0-dev", path = "../mun_hir" }
 mun_paths = { version = "0.6.0-dev", path = "../mun_paths" }
 mun_target = { version = "0.6.0-dev", path = "../mun_target" }

diff --git a/crates/mun_compiler/src/db.rs b/crates/mun_compiler/src/db.rs
@@ -1,11 +1,13 @@
 use mun_codegen::{CodeGenDatabase, CodeGenDatabaseStorage};
-use mun_hir::{salsa, HirDatabase, Upcast};
+use mun_db::Upcast;
+use mun_hir::{salsa, HirDatabase};
+use mun_hir_input::SourceDatabase;
 
 use crate::Config;
 
 /// A compiler database is a salsa database that enables increment compilation.
 #[salsa::database(
-    mun_hir::SourceDatabaseStorage,
+    mun_hir_input::SourceDatabaseStorage,
     mun_hir::InternDatabaseStorage,
     mun_hir::AstDatabaseStorage,
     mun_hir::DefDatabaseStorage,
@@ -22,8 +24,8 @@ impl Upcast<dyn mun_hir::AstDatabase> for CompilerDatabase {
     }
 }
 
-impl Upcast<dyn mun_hir::SourceDatabase> for CompilerDatabase {
-    fn upcast(&self) -> &(dyn mun_hir::SourceDatabase + 'static) {
+impl Upcast<dyn SourceDatabase> for CompilerDatabase {
+    fn upcast(&self) -> &(dyn SourceDatabase + 'static) {
         self
     }
 }

diff --git a/crates/mun_compiler/src/diagnostics_snippets.rs b/crates/mun_compiler/src/diagnostics_snippets.rs
@@ -2,7 +2,8 @@ use std::{collections::HashMap, sync::Arc};
 
 use annotate_snippets::{Annotation, AnnotationType, Renderer, Slice, Snippet, SourceAnnotation};
 use mun_diagnostics::DiagnosticForWith;
-use mun_hir::{line_index::LineIndex, FileId, HirDatabase};
+use mun_hir::HirDatabase;
+use mun_hir_input::{FileId, LineIndex};
 use mun_paths::RelativePathBuf;
 use mun_syntax::SyntaxError;
 

diff --git a/crates/mun_compiler/src/driver.rs b/crates/mun_compiler/src/driver.rs
@@ -2,10 +2,8 @@
 //! compilation by retaining state from previous compilation.
 
 use mun_codegen::{AssemblyIr, CodeGenDatabase, ModuleGroup, TargetAssembly};
-use mun_hir::{
-    AstDatabase, DiagnosticSink, FileId, Module, PackageSet, SourceDatabase, SourceRoot,
-    SourceRootId, Upcast,
-};
+use mun_hir::{AstDatabase, DiagnosticSink, Module};
+use mun_hir_input::{FileId, PackageSet, SourceDatabase, SourceRoot, SourceRootId};
 use mun_paths::RelativePathBuf;
 
 use crate::{
@@ -25,6 +23,7 @@ use std::{
     time::Duration,
 };
 
+use mun_db::Upcast;
 use mun_project::{Package, LOCKFILE_NAME};
 use walkdir::WalkDir;
 

diff --git a/crates/mun_compiler/src/lib.rs b/crates/mun_compiler/src/lib.rs
@@ -14,7 +14,7 @@ use std::{
 
 pub use annotate_snippets::AnnotationType;
 pub use mun_codegen::OptimizationLevel;
-pub use mun_hir::FileId;
+pub use mun_hir_input::FileId;
 pub use mun_paths::{RelativePath, RelativePathBuf};
 use mun_project::Package;
 pub use mun_target::spec::Target;

diff --git a/crates/mun_db/Cargo.toml b/crates/mun_db/Cargo.toml
@@ -0,0 +1,14 @@
+[package]
+name = "mun_db"
+description = "Salsa database utilities for everything mun related."
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+documentation.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
+categories.workspace = true
+
+[dependencies]
diff --git a/crates/mun_db/src/lib.rs b/crates/mun_db/src/lib.rs
@@ -0,0 +1,6 @@
+//! This crate provides utilitiy functions to be used alongside salsa databases
+//! used by mun.
+
+pub trait Upcast<T: ?Sized> {
+    fn upcast(&self) -> &T;
+}
diff --git a/crates/mun_hir/Cargo.toml b/crates/mun_hir/Cargo.toml
@@ -17,6 +17,8 @@ la-arena = { workspace = true }
 mun_syntax = { version = "0.6.0-dev", path = "../mun_syntax" }
 mun_target = { version = "0.6.0-dev", path = "../mun_target" }
 mun_paths = { version = "0.6.0-dev", path="../mun_paths" }
+mun_db = { version = "0.6.0-dev", path="../mun_db" }
+mun_hir_input = { version = "0.6.0-dev", path="../mun_hir_input" }
 drop_bomb = { workspace = true }
 either = { workspace = true }
 ena = { workspace = true }

diff --git a/crates/mun_hir/src/code_model/function.rs b/crates/mun_hir/src/code_model/function.rs
@@ -1,5 +1,6 @@
 use std::{iter::once, sync::Arc};
 
+use mun_hir_input::FileId;
 use mun_syntax::{ast, ast::TypeAscriptionOwner};
 
 use super::Module;
@@ -12,7 +13,7 @@ use crate::{
     resolve::HasResolver,
     type_ref::{LocalTypeRefId, TypeRefMap, TypeRefSourceMap},
     visibility::RawVisibility,
-    Body, DefDatabase, DiagnosticSink, FileId, HasSource, HasVisibility, HirDatabase, InFile,
+    Body, DefDatabase, DiagnosticSink, HasSource, HasVisibility, HirDatabase, InFile,
     InferenceResult, Name, Pat, Ty, Visibility,
 };
 
@@ -117,8 +118,7 @@ impl Function {
                 .path_to_root(db)
                 .into_iter()
                 .filter_map(|module| module.name(db))
-                .chain(once(self.name(db)))
-                .map(|name| name.to_string()),
+                .chain(once(self.name(db).to_string())),
             String::from("::"),
         )
         .collect()

diff --git a/crates/mun_hir/src/code_model/impl.rs b/crates/mun_hir/src/code_model/impl.rs
@@ -1,11 +1,13 @@
 use std::sync::Arc;
 
+use mun_hir_input::FileId;
+
 use crate::{
     has_module::HasModule,
     ids::{AssocItemId, FunctionLoc, ImplId, Intern, ItemContainerId, Lookup},
     item_tree::{AssociatedItem, ItemTreeId},
     type_ref::{LocalTypeRefId, TypeRefMap, TypeRefMapBuilder, TypeRefSourceMap},
-    DefDatabase, FileId, Function, HirDatabase, ItemLoc, Module, Package, Ty,
+    DefDatabase, Function, HirDatabase, ItemLoc, Module, Package, Ty,
 };
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]