rust/crates/ra_hir_def/src/db.rs

//! Defines database & queries for name resolution.
use std::sync::Arc;

use hir_expand::{db::AstDatabase, HirFileId};
use ra_db::{salsa, CrateId, SourceDatabase, Upcast};
use ra_prof::profile;
use ra_syntax::SmolStr;

use crate::{
    adt::{EnumData, StructData},
    attr::Attrs,
    body::{scope::ExprScopes, Body, BodySourceMap},
    data::{ConstData, FunctionData, ImplData, TraitData, TypeAliasData},
    docs::Documentation,
    generics::GenericParams,
    lang_item::{LangItemTarget, LangItems},
    nameres::{raw::RawItems, CrateDefMap},
    AttrDefId, ConstId, ConstLoc, DefWithBodyId, EnumId, EnumLoc, FunctionId, FunctionLoc,
    GenericDefId, ImplId, ImplLoc, ModuleId, StaticId, StaticLoc, StructId, StructLoc, TraitId,
    TraitLoc, TypeAliasId, TypeAliasLoc, UnionId, UnionLoc,
};

#[salsa::query_group(InternDatabaseStorage)]
pub trait InternDatabase: SourceDatabase {
    #[salsa::interned]
    fn intern_function(&self, loc: FunctionLoc) -> FunctionId;
    #[salsa::interned]
    fn intern_struct(&self, loc: StructLoc) -> StructId;
    #[salsa::interned]
    fn intern_union(&self, loc: UnionLoc) -> UnionId;
    #[salsa::interned]
    fn intern_enum(&self, loc: EnumLoc) -> EnumId;
    #[salsa::interned]
    fn intern_const(&self, loc: ConstLoc) -> ConstId;
    #[salsa::interned]
    fn intern_static(&self, loc: StaticLoc) -> StaticId;
    #[salsa::interned]
    fn intern_trait(&self, loc: TraitLoc) -> TraitId;
    #[salsa::interned]
    fn intern_type_alias(&self, loc: TypeAliasLoc) -> TypeAliasId;
    #[salsa::interned]
    fn intern_impl(&self, loc: ImplLoc) -> ImplId;
}

#[salsa::query_group(DefDatabaseStorage)]
pub trait DefDatabase: InternDatabase + AstDatabase + Upcast<dyn AstDatabase> {
    #[salsa::invoke(RawItems::raw_items_query)]
    fn raw_items(&self, file_id: HirFileId) -> Arc<RawItems>;

    #[salsa::invoke(crate_def_map_wait)]
    #[salsa::transparent]
    fn crate_def_map(&self, krate: CrateId) -> Arc<CrateDefMap>;

    #[salsa::invoke(CrateDefMap::crate_def_map_query)]
    fn crate_def_map_query(&self, krate: CrateId) -> Arc<CrateDefMap>;

    #[salsa::invoke(StructData::struct_data_query)]
    fn struct_data(&self, id: StructId) -> Arc<StructData>;
    #[salsa::invoke(StructData::union_data_query)]
    fn union_data(&self, id: UnionId) -> Arc<StructData>;

    #[salsa::invoke(EnumData::enum_data_query)]
    fn enum_data(&self, e: EnumId) -> Arc<EnumData>;

    #[salsa::invoke(ImplData::impl_data_query)]
    fn impl_data(&self, e: ImplId) -> Arc<ImplData>;

    #[salsa::invoke(TraitData::trait_data_query)]
    fn trait_data(&self, e: TraitId) -> Arc<TraitData>;

    #[salsa::invoke(TypeAliasData::type_alias_data_query)]
    fn type_alias_data(&self, e: TypeAliasId) -> Arc<TypeAliasData>;

    #[salsa::invoke(FunctionData::fn_data_query)]
    fn function_data(&self, func: FunctionId) -> Arc<FunctionData>;

    #[salsa::invoke(ConstData::const_data_query)]
    fn const_data(&self, konst: ConstId) -> Arc<ConstData>;

    #[salsa::invoke(ConstData::static_data_query)]
    fn static_data(&self, konst: StaticId) -> Arc<ConstData>;

    #[salsa::invoke(Body::body_with_source_map_query)]
    fn body_with_source_map(&self, def: DefWithBodyId) -> (Arc<Body>, Arc<BodySourceMap>);

    #[salsa::invoke(Body::body_query)]
    fn body(&self, def: DefWithBodyId) -> Arc<Body>;

    #[salsa::invoke(ExprScopes::expr_scopes_query)]
    fn expr_scopes(&self, def: DefWithBodyId) -> Arc<ExprScopes>;

    #[salsa::invoke(GenericParams::generic_params_query)]
    fn generic_params(&self, def: GenericDefId) -> Arc<GenericParams>;

    #[salsa::invoke(Attrs::attrs_query)]
    fn attrs(&self, def: AttrDefId) -> Attrs;

    #[salsa::invoke(LangItems::module_lang_items_query)]
    fn module_lang_items(&self, module: ModuleId) -> Option<Arc<LangItems>>;

    #[salsa::invoke(LangItems::crate_lang_items_query)]
    fn crate_lang_items(&self, krate: CrateId) -> Arc<LangItems>;

    #[salsa::invoke(LangItems::lang_item_query)]
    fn lang_item(&self, start_crate: CrateId, item: SmolStr) -> Option<LangItemTarget>;

    // FIXME(https://github.com/rust-analyzer/rust-analyzer/issues/2148#issuecomment-550519102)
    // Remove this query completely, in favor of `Attrs::docs` method
    #[salsa::invoke(Documentation::documentation_query)]
    fn documentation(&self, def: AttrDefId) -> Option<Documentation>;
}

fn crate_def_map_wait(db: &impl DefDatabase, krate: CrateId) -> Arc<CrateDefMap> {
    let _p = profile("crate_def_map:wait");
    db.crate_def_map_query(krate)
}
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00			`//! Defines database & queries for name resolution.`
move raw_items to hir_def 2019-10-30 08:12:55 -05:00			`use std::sync::Arc;`
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00
move raw_items to hir_def 2019-10-30 08:12:55 -05:00			`use hir_expand::{db::AstDatabase, HirFileId};`
Use `dyn Trait` for working with databse It improves compile time in `--release` mode quite a bit, it doesn't really slow things down and, conceptually, it seems closer to what we want the physical architecture to look like (we don't want to monomorphise EVERYTHING in a single leaf crate). 2020-03-13 10:05:46 -05:00			`use ra_db::{salsa, CrateId, SourceDatabase, Upcast};`
Split `crate_def_map` into two methods This change: - introduces `compute_crate_def_map` query and renames `CrateDefMap::crate_def_map_query` for consistency, - annotates `crate_def_map` as `salsa::transparent` and adds a top-level `crate_def_map` wrapper function around that starts the profiler and immediately calls into `compute_crate_def_map` query. This allows us to better understand where we spent the time, in particular, how much is spent in the recomputaiton and how much in salsa. Example output (where we don't actually re-compute anything, but the query still takes a non-trivial amount of time): ``` 211ms - handle_inlay_hints 150ms - get_inlay_hints 150ms - SourceAnalyzer::new 65ms - def_with_body_from_child_node 65ms - analyze_container 65ms - analyze_container 65ms - Module::from_definition 65ms - Module::from_file 65ms - crate_def_map 1ms - parse_macro_query (6 calls) 0ms - raw_items_query (1 calls) 64ms - ??? ``` Signed-off-by: Michal Terepeta <michal.terepeta@gmail.com> 2020-01-03 06:59:46 -06:00			`use ra_prof::profile;`
Move enum&union to new loc 2019-12-12 08:11:57 -06:00			`use ra_syntax::SmolStr;`
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00
move struct & enum data to hir_def 2019-10-31 08:40:36 -05:00			`use crate::{`
			`adt::{EnumData, StructData},`
Move attrs query to hir_def 2019-11-23 02:14:10 -06:00			`attr::Attrs,`
Move body queries to hir_def 2019-11-14 08:37:22 -06:00			`body::{scope::ExprScopes, Body, BodySourceMap},`
Move const&static date to hir_def 2019-11-22 09:46:39 -06:00			`data::{ConstData, FunctionData, ImplData, TraitData, TypeAliasData},`
Move docs to hir_def 2019-11-23 05:43:38 -06:00			`docs::Documentation,`
Move generic_params query to HIR 2019-11-20 11:33:18 -06:00			`generics::GenericParams,`
Move lang_items to hir_def 2019-11-23 03:58:01 -06:00			`lang_item::{LangItemTarget, LangItems},`
Remove import source map 2019-12-21 10:26:05 -06:00			`nameres::{raw::RawItems, CrateDefMap},`
Move enum&union to new loc 2019-12-12 08:11:57 -06:00			`AttrDefId, ConstId, ConstLoc, DefWithBodyId, EnumId, EnumLoc, FunctionId, FunctionLoc,`
			`GenericDefId, ImplId, ImplLoc, ModuleId, StaticId, StaticLoc, StructId, StructLoc, TraitId,`
			`TraitLoc, TypeAliasId, TypeAliasLoc, UnionId, UnionLoc,`
move struct & enum data to hir_def 2019-10-31 08:40:36 -05:00			`};`
move raw_items to hir_def 2019-10-30 08:12:55 -05:00
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00			`#[salsa::query_group(InternDatabaseStorage)]`
			`pub trait InternDatabase: SourceDatabase {`
			`#[salsa::interned]`
Cleanup imports 2019-11-23 06:33:21 -06:00			`fn intern_function(&self, loc: FunctionLoc) -> FunctionId;`
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00			`#[salsa::interned]`
Move structs to new loc 2019-12-12 07:58:04 -06:00			`fn intern_struct(&self, loc: StructLoc) -> StructId;`
Fix hir for ast::UnionDef 2019-11-25 08:30:50 -06:00			`#[salsa::interned]`
Move enum&union to new loc 2019-12-12 08:11:57 -06:00			`fn intern_union(&self, loc: UnionLoc) -> UnionId;`
move raw_items to hir_def 2019-10-30 08:12:55 -05:00			`#[salsa::interned]`
Move enum&union to new loc 2019-12-12 08:11:57 -06:00			`fn intern_enum(&self, loc: EnumLoc) -> EnumId;`
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00			`#[salsa::interned]`
Cleanup imports 2019-11-23 06:33:21 -06:00			`fn intern_const(&self, loc: ConstLoc) -> ConstId;`
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00			`#[salsa::interned]`
Switch to StaticLoc for statics 2019-11-24 06:13:56 -06:00			`fn intern_static(&self, loc: StaticLoc) -> StaticId;`
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00			`#[salsa::interned]`
Move traits to the new loc 2019-12-12 07:34:03 -06:00			`fn intern_trait(&self, loc: TraitLoc) -> TraitId;`
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00			`#[salsa::interned]`
Cleanup imports 2019-11-23 06:33:21 -06:00			`fn intern_type_alias(&self, loc: TypeAliasLoc) -> TypeAliasId;`
Add ImplId 2019-11-15 10:14:50 -06:00			`#[salsa::interned]`
Switch to the new location for impls 2019-12-12 07:09:13 -06:00			`fn intern_impl(&self, loc: ImplLoc) -> ImplId;`
Move ids to hir_def crate 2019-10-30 05:10:38 -05:00			`}`
move raw_items to hir_def 2019-10-30 08:12:55 -05:00
Get rid of DefDatabase2 2019-11-23 05:44:43 -06:00			`#[salsa::query_group(DefDatabaseStorage)]`
Use `dyn Trait` for working with databse It improves compile time in `--release` mode quite a bit, it doesn't really slow things down and, conceptually, it seems closer to what we want the physical architecture to look like (we don't want to monomorphise EVERYTHING in a single leaf crate). 2020-03-13 10:05:46 -05:00			`pub trait DefDatabase: InternDatabase + AstDatabase + Upcast<dyn AstDatabase> {`
move raw_items to hir_def 2019-10-30 08:12:55 -05:00			`#[salsa::invoke(RawItems::raw_items_query)]`
			`fn raw_items(&self, file_id: HirFileId) -> Arc<RawItems>;`
move struct & enum data to hir_def 2019-10-31 08:40:36 -05:00
Normalize waiting queries names 2020-03-06 17:11:52 -06:00			`#[salsa::invoke(crate_def_map_wait)]`
Cleanup memory usage stats 2020-03-25 12:41:46 -05:00			`#[salsa::transparent]`
Move CrateDefMap to hir_def 2019-10-31 10:45:10 -05:00			`fn crate_def_map(&self, krate: CrateId) -> Arc<CrateDefMap>;`

Normalize waiting queries names 2020-03-06 17:11:52 -06:00			`#[salsa::invoke(CrateDefMap::crate_def_map_query)]`
			`fn crate_def_map_query(&self, krate: CrateId) -> Arc<CrateDefMap>;`
Split `crate_def_map` into two methods This change: - introduces `compute_crate_def_map` query and renames `CrateDefMap::crate_def_map_query` for consistency, - annotates `crate_def_map` as `salsa::transparent` and adds a top-level `crate_def_map` wrapper function around that starts the profiler and immediately calls into `compute_crate_def_map` query. This allows us to better understand where we spent the time, in particular, how much is spent in the recomputaiton and how much in salsa. Example output (where we don't actually re-compute anything, but the query still takes a non-trivial amount of time): ``` 211ms - handle_inlay_hints 150ms - get_inlay_hints 150ms - SourceAnalyzer::new 65ms - def_with_body_from_child_node 65ms - analyze_container 65ms - analyze_container 65ms - Module::from_definition 65ms - Module::from_file 65ms - crate_def_map 1ms - parse_macro_query (6 calls) 0ms - raw_items_query (1 calls) 64ms - ??? ``` Signed-off-by: Michal Terepeta <michal.terepeta@gmail.com> 2020-01-03 06:59:46 -06:00
move struct & enum data to hir_def 2019-10-31 08:40:36 -05:00			`#[salsa::invoke(StructData::struct_data_query)]`
Fix hir for ast::UnionDef 2019-11-25 08:30:50 -06:00			`fn struct_data(&self, id: StructId) -> Arc<StructData>;`
			`#[salsa::invoke(StructData::union_data_query)]`
			`fn union_data(&self, id: UnionId) -> Arc<StructData>;`
Move CrateDefMap to hir_def 2019-10-31 10:45:10 -05:00
move struct & enum data to hir_def 2019-10-31 08:40:36 -05:00			`#[salsa::invoke(EnumData::enum_data_query)]`
			`fn enum_data(&self, e: EnumId) -> Arc<EnumData>;`
Move body queries to hir_def 2019-11-14 08:37:22 -06:00
Remove old impls infrastructure 2019-11-15 12:28:00 -06:00			`#[salsa::invoke(ImplData::impl_data_query)]`
			`fn impl_data(&self, e: ImplId) -> Arc<ImplData>;`

Move traits to hir_def 2019-11-20 05:22:06 -06:00			`#[salsa::invoke(TraitData::trait_data_query)]`
			`fn trait_data(&self, e: TraitId) -> Arc<TraitData>;`

Move TypeAlias to hir_def 2019-11-22 03:57:40 -06:00			`#[salsa::invoke(TypeAliasData::type_alias_data_query)]`
			`fn type_alias_data(&self, e: TypeAliasId) -> Arc<TypeAliasData>;`

Move FunctionData to hir_def 2019-11-22 08:10:51 -06:00			`#[salsa::invoke(FunctionData::fn_data_query)]`
			`fn function_data(&self, func: FunctionId) -> Arc<FunctionData>;`

Move const&static date to hir_def 2019-11-22 09:46:39 -06:00			`#[salsa::invoke(ConstData::const_data_query)]`
			`fn const_data(&self, konst: ConstId) -> Arc<ConstData>;`

			`#[salsa::invoke(ConstData::static_data_query)]`
			`fn static_data(&self, konst: StaticId) -> Arc<ConstData>;`

Move body queries to hir_def 2019-11-14 08:37:22 -06:00			`#[salsa::invoke(Body::body_with_source_map_query)]`
			`fn body_with_source_map(&self, def: DefWithBodyId) -> (Arc<Body>, Arc<BodySourceMap>);`

			`#[salsa::invoke(Body::body_query)]`
			`fn body(&self, def: DefWithBodyId) -> Arc<Body>;`

			`#[salsa::invoke(ExprScopes::expr_scopes_query)]`
			`fn expr_scopes(&self, def: DefWithBodyId) -> Arc<ExprScopes>;`
Move generic_params query to HIR 2019-11-20 11:33:18 -06:00
			`#[salsa::invoke(GenericParams::generic_params_query)]`
			`fn generic_params(&self, def: GenericDefId) -> Arc<GenericParams>;`
Move attrs query to hir_def 2019-11-23 02:14:10 -06:00
			`#[salsa::invoke(Attrs::attrs_query)]`
			`fn attrs(&self, def: AttrDefId) -> Attrs;`
Move lang_items to hir_def 2019-11-23 03:58:01 -06:00
			`#[salsa::invoke(LangItems::module_lang_items_query)]`
			`fn module_lang_items(&self, module: ModuleId) -> Option<Arc<LangItems>>;`

			`#[salsa::invoke(LangItems::crate_lang_items_query)]`
			`fn crate_lang_items(&self, krate: CrateId) -> Arc<LangItems>;`

			`#[salsa::invoke(LangItems::lang_item_query)]`
			`fn lang_item(&self, start_crate: CrateId, item: SmolStr) -> Option<LangItemTarget>;`
Move docs to hir_def 2019-11-23 05:43:38 -06:00
			`// FIXME(https://github.com/rust-analyzer/rust-analyzer/issues/2148#issuecomment-550519102)`
			// Remove this query completely, in favor of `Attrs::docs` method
			`#[salsa::invoke(Documentation::documentation_query)]`
			`fn documentation(&self, def: AttrDefId) -> Option<Documentation>;`
move raw_items to hir_def 2019-10-30 08:12:55 -05:00			`}`
Split `crate_def_map` into two methods This change: - introduces `compute_crate_def_map` query and renames `CrateDefMap::crate_def_map_query` for consistency, - annotates `crate_def_map` as `salsa::transparent` and adds a top-level `crate_def_map` wrapper function around that starts the profiler and immediately calls into `compute_crate_def_map` query. This allows us to better understand where we spent the time, in particular, how much is spent in the recomputaiton and how much in salsa. Example output (where we don't actually re-compute anything, but the query still takes a non-trivial amount of time): ``` 211ms - handle_inlay_hints 150ms - get_inlay_hints 150ms - SourceAnalyzer::new 65ms - def_with_body_from_child_node 65ms - analyze_container 65ms - analyze_container 65ms - Module::from_definition 65ms - Module::from_file 65ms - crate_def_map 1ms - parse_macro_query (6 calls) 0ms - raw_items_query (1 calls) 64ms - ??? ``` Signed-off-by: Michal Terepeta <michal.terepeta@gmail.com> 2020-01-03 06:59:46 -06:00
Normalize waiting queries names 2020-03-06 17:11:52 -06:00			`fn crate_def_map_wait(db: &impl DefDatabase, krate: CrateId) -> Arc<CrateDefMap> {`
			`let _p = profile("crate_def_map:wait");`
			`db.crate_def_map_query(krate)`
Split `crate_def_map` into two methods This change: - introduces `compute_crate_def_map` query and renames `CrateDefMap::crate_def_map_query` for consistency, - annotates `crate_def_map` as `salsa::transparent` and adds a top-level `crate_def_map` wrapper function around that starts the profiler and immediately calls into `compute_crate_def_map` query. This allows us to better understand where we spent the time, in particular, how much is spent in the recomputaiton and how much in salsa. Example output (where we don't actually re-compute anything, but the query still takes a non-trivial amount of time): ``` 211ms - handle_inlay_hints 150ms - get_inlay_hints 150ms - SourceAnalyzer::new 65ms - def_with_body_from_child_node 65ms - analyze_container 65ms - analyze_container 65ms - Module::from_definition 65ms - Module::from_file 65ms - crate_def_map 1ms - parse_macro_query (6 calls) 0ms - raw_items_query (1 calls) 64ms - ??? ``` Signed-off-by: Michal Terepeta <michal.terepeta@gmail.com> 2020-01-03 06:59:46 -06:00			`}`