• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //! Defines database & queries for name resolution.
2 use base_db::{salsa, CrateId, SourceDatabase, Upcast};
3 use either::Either;
4 use hir_expand::{db::ExpandDatabase, HirFileId};
5 use intern::Interned;
6 use la_arena::ArenaMap;
7 use syntax::{ast, AstPtr};
8 use triomphe::Arc;
9 
10 use crate::{
11     attr::{Attrs, AttrsWithOwner},
12     body::{scope::ExprScopes, Body, BodySourceMap},
13     data::{
14         adt::{EnumData, StructData},
15         ConstData, FunctionData, ImplData, Macro2Data, MacroRulesData, ProcMacroData, StaticData,
16         TraitAliasData, TraitData, TypeAliasData,
17     },
18     generics::GenericParams,
19     import_map::ImportMap,
20     item_tree::{AttrOwner, ItemTree},
21     lang_item::{LangItem, LangItemTarget, LangItems},
22     nameres::{diagnostics::DefDiagnostic, DefMap},
23     visibility::{self, Visibility},
24     AttrDefId, BlockId, BlockLoc, ConstBlockId, ConstBlockLoc, ConstId, ConstLoc, DefWithBodyId,
25     EnumId, EnumLoc, ExternBlockId, ExternBlockLoc, FunctionId, FunctionLoc, GenericDefId, ImplId,
26     ImplLoc, InTypeConstId, InTypeConstLoc, LocalEnumVariantId, LocalFieldId, Macro2Id, Macro2Loc,
27     MacroRulesId, MacroRulesLoc, ProcMacroId, ProcMacroLoc, StaticId, StaticLoc, StructId,
28     StructLoc, TraitAliasId, TraitAliasLoc, TraitId, TraitLoc, TypeAliasId, TypeAliasLoc, UnionId,
29     UnionLoc, VariantId,
30 };
31 
32 #[salsa::query_group(InternDatabaseStorage)]
33 pub trait InternDatabase: SourceDatabase {
34     // region: items
35     #[salsa::interned]
intern_function(&self, loc: FunctionLoc) -> FunctionId36     fn intern_function(&self, loc: FunctionLoc) -> FunctionId;
37     #[salsa::interned]
intern_struct(&self, loc: StructLoc) -> StructId38     fn intern_struct(&self, loc: StructLoc) -> StructId;
39     #[salsa::interned]
intern_union(&self, loc: UnionLoc) -> UnionId40     fn intern_union(&self, loc: UnionLoc) -> UnionId;
41     #[salsa::interned]
intern_enum(&self, loc: EnumLoc) -> EnumId42     fn intern_enum(&self, loc: EnumLoc) -> EnumId;
43     #[salsa::interned]
intern_const(&self, loc: ConstLoc) -> ConstId44     fn intern_const(&self, loc: ConstLoc) -> ConstId;
45     #[salsa::interned]
intern_static(&self, loc: StaticLoc) -> StaticId46     fn intern_static(&self, loc: StaticLoc) -> StaticId;
47     #[salsa::interned]
intern_trait(&self, loc: TraitLoc) -> TraitId48     fn intern_trait(&self, loc: TraitLoc) -> TraitId;
49     #[salsa::interned]
intern_trait_alias(&self, loc: TraitAliasLoc) -> TraitAliasId50     fn intern_trait_alias(&self, loc: TraitAliasLoc) -> TraitAliasId;
51     #[salsa::interned]
intern_type_alias(&self, loc: TypeAliasLoc) -> TypeAliasId52     fn intern_type_alias(&self, loc: TypeAliasLoc) -> TypeAliasId;
53     #[salsa::interned]
intern_impl(&self, loc: ImplLoc) -> ImplId54     fn intern_impl(&self, loc: ImplLoc) -> ImplId;
55     #[salsa::interned]
intern_extern_block(&self, loc: ExternBlockLoc) -> ExternBlockId56     fn intern_extern_block(&self, loc: ExternBlockLoc) -> ExternBlockId;
57     #[salsa::interned]
intern_macro2(&self, loc: Macro2Loc) -> Macro2Id58     fn intern_macro2(&self, loc: Macro2Loc) -> Macro2Id;
59     #[salsa::interned]
intern_proc_macro(&self, loc: ProcMacroLoc) -> ProcMacroId60     fn intern_proc_macro(&self, loc: ProcMacroLoc) -> ProcMacroId;
61     #[salsa::interned]
intern_macro_rules(&self, loc: MacroRulesLoc) -> MacroRulesId62     fn intern_macro_rules(&self, loc: MacroRulesLoc) -> MacroRulesId;
63     // endregion: items
64 
65     #[salsa::interned]
intern_block(&self, loc: BlockLoc) -> BlockId66     fn intern_block(&self, loc: BlockLoc) -> BlockId;
67     #[salsa::interned]
intern_anonymous_const(&self, id: ConstBlockLoc) -> ConstBlockId68     fn intern_anonymous_const(&self, id: ConstBlockLoc) -> ConstBlockId;
69     #[salsa::interned]
intern_in_type_const(&self, id: InTypeConstLoc) -> InTypeConstId70     fn intern_in_type_const(&self, id: InTypeConstLoc) -> InTypeConstId;
71 }
72 
73 #[salsa::query_group(DefDatabaseStorage)]
74 pub trait DefDatabase: InternDatabase + ExpandDatabase + Upcast<dyn ExpandDatabase> {
75     #[salsa::input]
expand_proc_attr_macros(&self) -> bool76     fn expand_proc_attr_macros(&self) -> bool;
77 
78     #[salsa::invoke(ItemTree::file_item_tree_query)]
file_item_tree(&self, file_id: HirFileId) -> Arc<ItemTree>79     fn file_item_tree(&self, file_id: HirFileId) -> Arc<ItemTree>;
80 
81     #[salsa::invoke(crate_def_map_wait)]
82     #[salsa::transparent]
crate_def_map(&self, krate: CrateId) -> Arc<DefMap>83     fn crate_def_map(&self, krate: CrateId) -> Arc<DefMap>;
84 
85     #[salsa::invoke(DefMap::crate_def_map_query)]
crate_def_map_query(&self, krate: CrateId) -> Arc<DefMap>86     fn crate_def_map_query(&self, krate: CrateId) -> Arc<DefMap>;
87 
88     /// Computes the block-level `DefMap`, returning `None` when `block` doesn't contain any inner
89     /// items directly.
90     ///
91     /// For example:
92     ///
93     /// ```
94     /// fn f() { // (0)
95     ///     { // (1)
96     ///         fn inner() {}
97     ///     }
98     /// }
99     /// ```
100     ///
101     /// The `block_def_map` for block 0 would return `None`, while `block_def_map` of block 1 would
102     /// return a `DefMap` containing `inner`.
103     #[salsa::invoke(DefMap::block_def_map_query)]
block_def_map(&self, block: BlockId) -> Arc<DefMap>104     fn block_def_map(&self, block: BlockId) -> Arc<DefMap>;
105 
106     // region:data
107 
108     #[salsa::invoke(StructData::struct_data_query)]
struct_data(&self, id: StructId) -> Arc<StructData>109     fn struct_data(&self, id: StructId) -> Arc<StructData>;
110 
111     #[salsa::invoke(StructData::struct_data_with_diagnostics_query)]
struct_data_with_diagnostics(&self, id: StructId) -> (Arc<StructData>, Arc<[DefDiagnostic]>)112     fn struct_data_with_diagnostics(&self, id: StructId)
113         -> (Arc<StructData>, Arc<[DefDiagnostic]>);
114 
115     #[salsa::invoke(StructData::union_data_query)]
union_data(&self, id: UnionId) -> Arc<StructData>116     fn union_data(&self, id: UnionId) -> Arc<StructData>;
117 
118     #[salsa::invoke(StructData::union_data_with_diagnostics_query)]
union_data_with_diagnostics(&self, id: UnionId) -> (Arc<StructData>, Arc<[DefDiagnostic]>)119     fn union_data_with_diagnostics(&self, id: UnionId) -> (Arc<StructData>, Arc<[DefDiagnostic]>);
120 
121     #[salsa::invoke(EnumData::enum_data_query)]
enum_data(&self, e: EnumId) -> Arc<EnumData>122     fn enum_data(&self, e: EnumId) -> Arc<EnumData>;
123 
124     #[salsa::invoke(EnumData::enum_data_with_diagnostics_query)]
enum_data_with_diagnostics(&self, e: EnumId) -> (Arc<EnumData>, Arc<[DefDiagnostic]>)125     fn enum_data_with_diagnostics(&self, e: EnumId) -> (Arc<EnumData>, Arc<[DefDiagnostic]>);
126 
127     #[salsa::invoke(ImplData::impl_data_query)]
impl_data(&self, e: ImplId) -> Arc<ImplData>128     fn impl_data(&self, e: ImplId) -> Arc<ImplData>;
129 
130     #[salsa::invoke(ImplData::impl_data_with_diagnostics_query)]
impl_data_with_diagnostics(&self, e: ImplId) -> (Arc<ImplData>, Arc<[DefDiagnostic]>)131     fn impl_data_with_diagnostics(&self, e: ImplId) -> (Arc<ImplData>, Arc<[DefDiagnostic]>);
132 
133     #[salsa::invoke(TraitData::trait_data_query)]
trait_data(&self, e: TraitId) -> Arc<TraitData>134     fn trait_data(&self, e: TraitId) -> Arc<TraitData>;
135 
136     #[salsa::invoke(TraitData::trait_data_with_diagnostics_query)]
trait_data_with_diagnostics(&self, tr: TraitId) -> (Arc<TraitData>, Arc<[DefDiagnostic]>)137     fn trait_data_with_diagnostics(&self, tr: TraitId) -> (Arc<TraitData>, Arc<[DefDiagnostic]>);
138 
139     #[salsa::invoke(TraitAliasData::trait_alias_query)]
trait_alias_data(&self, e: TraitAliasId) -> Arc<TraitAliasData>140     fn trait_alias_data(&self, e: TraitAliasId) -> Arc<TraitAliasData>;
141 
142     #[salsa::invoke(TypeAliasData::type_alias_data_query)]
type_alias_data(&self, e: TypeAliasId) -> Arc<TypeAliasData>143     fn type_alias_data(&self, e: TypeAliasId) -> Arc<TypeAliasData>;
144 
145     #[salsa::invoke(FunctionData::fn_data_query)]
function_data(&self, func: FunctionId) -> Arc<FunctionData>146     fn function_data(&self, func: FunctionId) -> Arc<FunctionData>;
147 
148     #[salsa::invoke(ConstData::const_data_query)]
const_data(&self, konst: ConstId) -> Arc<ConstData>149     fn const_data(&self, konst: ConstId) -> Arc<ConstData>;
150 
151     #[salsa::invoke(StaticData::static_data_query)]
static_data(&self, konst: StaticId) -> Arc<StaticData>152     fn static_data(&self, konst: StaticId) -> Arc<StaticData>;
153 
154     #[salsa::invoke(Macro2Data::macro2_data_query)]
macro2_data(&self, makro: Macro2Id) -> Arc<Macro2Data>155     fn macro2_data(&self, makro: Macro2Id) -> Arc<Macro2Data>;
156 
157     #[salsa::invoke(MacroRulesData::macro_rules_data_query)]
macro_rules_data(&self, makro: MacroRulesId) -> Arc<MacroRulesData>158     fn macro_rules_data(&self, makro: MacroRulesId) -> Arc<MacroRulesData>;
159 
160     #[salsa::invoke(ProcMacroData::proc_macro_data_query)]
proc_macro_data(&self, makro: ProcMacroId) -> Arc<ProcMacroData>161     fn proc_macro_data(&self, makro: ProcMacroId) -> Arc<ProcMacroData>;
162 
163     // endregion:data
164 
165     #[salsa::invoke(Body::body_with_source_map_query)]
body_with_source_map(&self, def: DefWithBodyId) -> (Arc<Body>, Arc<BodySourceMap>)166     fn body_with_source_map(&self, def: DefWithBodyId) -> (Arc<Body>, Arc<BodySourceMap>);
167 
168     #[salsa::invoke(Body::body_query)]
body(&self, def: DefWithBodyId) -> Arc<Body>169     fn body(&self, def: DefWithBodyId) -> Arc<Body>;
170 
171     #[salsa::invoke(ExprScopes::expr_scopes_query)]
expr_scopes(&self, def: DefWithBodyId) -> Arc<ExprScopes>172     fn expr_scopes(&self, def: DefWithBodyId) -> Arc<ExprScopes>;
173 
174     #[salsa::invoke(GenericParams::generic_params_query)]
generic_params(&self, def: GenericDefId) -> Interned<GenericParams>175     fn generic_params(&self, def: GenericDefId) -> Interned<GenericParams>;
176 
177     // region:attrs
178 
179     #[salsa::invoke(Attrs::variants_attrs_query)]
variants_attrs(&self, def: EnumId) -> Arc<ArenaMap<LocalEnumVariantId, Attrs>>180     fn variants_attrs(&self, def: EnumId) -> Arc<ArenaMap<LocalEnumVariantId, Attrs>>;
181 
182     #[salsa::invoke(Attrs::fields_attrs_query)]
fields_attrs(&self, def: VariantId) -> Arc<ArenaMap<LocalFieldId, Attrs>>183     fn fields_attrs(&self, def: VariantId) -> Arc<ArenaMap<LocalFieldId, Attrs>>;
184 
185     #[salsa::invoke(crate::attr::variants_attrs_source_map)]
variants_attrs_source_map( &self, def: EnumId, ) -> Arc<ArenaMap<LocalEnumVariantId, AstPtr<ast::Variant>>>186     fn variants_attrs_source_map(
187         &self,
188         def: EnumId,
189     ) -> Arc<ArenaMap<LocalEnumVariantId, AstPtr<ast::Variant>>>;
190 
191     #[salsa::invoke(crate::attr::fields_attrs_source_map)]
fields_attrs_source_map( &self, def: VariantId, ) -> Arc<ArenaMap<LocalFieldId, Either<AstPtr<ast::TupleField>, AstPtr<ast::RecordField>>>>192     fn fields_attrs_source_map(
193         &self,
194         def: VariantId,
195     ) -> Arc<ArenaMap<LocalFieldId, Either<AstPtr<ast::TupleField>, AstPtr<ast::RecordField>>>>;
196 
197     #[salsa::invoke(AttrsWithOwner::attrs_query)]
attrs(&self, def: AttrDefId) -> Attrs198     fn attrs(&self, def: AttrDefId) -> Attrs;
199 
200     #[salsa::transparent]
201     #[salsa::invoke(AttrsWithOwner::attrs_with_owner)]
attrs_with_owner(&self, def: AttrDefId) -> AttrsWithOwner202     fn attrs_with_owner(&self, def: AttrDefId) -> AttrsWithOwner;
203 
204     // endregion:attrs
205 
206     #[salsa::invoke(LangItems::lang_item_query)]
lang_item(&self, start_crate: CrateId, item: LangItem) -> Option<LangItemTarget>207     fn lang_item(&self, start_crate: CrateId, item: LangItem) -> Option<LangItemTarget>;
208 
209     #[salsa::invoke(ImportMap::import_map_query)]
import_map(&self, krate: CrateId) -> Arc<ImportMap>210     fn import_map(&self, krate: CrateId) -> Arc<ImportMap>;
211 
212     // region:visibilities
213 
214     #[salsa::invoke(visibility::field_visibilities_query)]
field_visibilities(&self, var: VariantId) -> Arc<ArenaMap<LocalFieldId, Visibility>>215     fn field_visibilities(&self, var: VariantId) -> Arc<ArenaMap<LocalFieldId, Visibility>>;
216 
217     // FIXME: unify function_visibility and const_visibility?
218     #[salsa::invoke(visibility::function_visibility_query)]
function_visibility(&self, def: FunctionId) -> Visibility219     fn function_visibility(&self, def: FunctionId) -> Visibility;
220 
221     #[salsa::invoke(visibility::const_visibility_query)]
const_visibility(&self, def: ConstId) -> Visibility222     fn const_visibility(&self, def: ConstId) -> Visibility;
223 
224     // endregion:visibilities
225 
226     #[salsa::invoke(LangItems::crate_lang_items_query)]
crate_lang_items(&self, krate: CrateId) -> Arc<LangItems>227     fn crate_lang_items(&self, krate: CrateId) -> Arc<LangItems>;
228 
229     #[salsa::transparent]
crate_limits(&self, crate_id: CrateId) -> CrateLimits230     fn crate_limits(&self, crate_id: CrateId) -> CrateLimits;
231 
232     #[salsa::transparent]
recursion_limit(&self, crate_id: CrateId) -> u32233     fn recursion_limit(&self, crate_id: CrateId) -> u32;
234 
crate_supports_no_std(&self, crate_id: CrateId) -> bool235     fn crate_supports_no_std(&self, crate_id: CrateId) -> bool;
236 }
237 
crate_def_map_wait(db: &dyn DefDatabase, krate: CrateId) -> Arc<DefMap>238 fn crate_def_map_wait(db: &dyn DefDatabase, krate: CrateId) -> Arc<DefMap> {
239     let _p = profile::span("crate_def_map:wait");
240     db.crate_def_map_query(krate)
241 }
242 
243 pub struct CrateLimits {
244     /// The maximum depth for potentially infinitely-recursive compile-time operations like macro expansion or auto-dereference.
245     pub recursion_limit: u32,
246 }
247 
crate_limits(db: &dyn DefDatabase, crate_id: CrateId) -> CrateLimits248 fn crate_limits(db: &dyn DefDatabase, crate_id: CrateId) -> CrateLimits {
249     let def_map = db.crate_def_map(crate_id);
250 
251     CrateLimits {
252         // 128 is the default in rustc.
253         recursion_limit: def_map.recursion_limit().unwrap_or(128),
254     }
255 }
256 
recursion_limit(db: &dyn DefDatabase, crate_id: CrateId) -> u32257 fn recursion_limit(db: &dyn DefDatabase, crate_id: CrateId) -> u32 {
258     db.crate_limits(crate_id).recursion_limit
259 }
260 
crate_supports_no_std(db: &dyn DefDatabase, crate_id: CrateId) -> bool261 fn crate_supports_no_std(db: &dyn DefDatabase, crate_id: CrateId) -> bool {
262     let file = db.crate_graph()[crate_id].root_file_id;
263     let item_tree = db.file_item_tree(file.into());
264     let attrs = item_tree.raw_attrs(AttrOwner::TopLevel);
265     for attr in &**attrs {
266         match attr.path().as_ident().and_then(|id| id.as_text()) {
267             Some(ident) if ident == "no_std" => return true,
268             Some(ident) if ident == "cfg_attr" => {}
269             _ => continue,
270         }
271 
272         // This is a `cfg_attr`; check if it could possibly expand to `no_std`.
273         // Syntax is: `#[cfg_attr(condition(cfg, style), attr0, attr1, <...>)]`
274         let tt = match attr.token_tree_value() {
275             Some(tt) => &tt.token_trees,
276             None => continue,
277         };
278 
279         let segments = tt.split(|tt| match tt {
280             tt::TokenTree::Leaf(tt::Leaf::Punct(p)) if p.char == ',' => true,
281             _ => false,
282         });
283         for output in segments.skip(1) {
284             match output {
285                 [tt::TokenTree::Leaf(tt::Leaf::Ident(ident))] if ident.text == "no_std" => {
286                     return true
287                 }
288                 _ => {}
289             }
290         }
291     }
292 
293     false
294 }
295