Skip to main content

hir_ty/
db.rs

1//! The home of `HirDatabase`, which is the Salsa database containing all the
2//! type inference-related queries.
3
4use arrayvec::ArrayVec;
5use base_db::{Crate, SourceDatabase, target::TargetLoadError};
6use either::Either;
7use hir_def::{
8    AdtId, BuiltinDeriveImplId, CallableDefId, ConstId, ConstParamId, EnumVariantId,
9    ExpressionStoreOwnerId, FunctionId, GenericDefId, HasModule, ImplId, LocalFieldId, ModuleId,
10    StaticId, TraitId, TypeAliasId, VariantId,
11    builtin_derive::BuiltinDeriveImplMethod,
12    expr_store::ExpressionStore,
13    hir::{ClosureKind, ExprId, generics::LocalTypeOrConstParamId},
14    layout::TargetDataLayout,
15    resolver::{HasResolver, Resolver},
16    signatures::{ConstSignature, StaticSignature},
17};
18use la_arena::ArenaMap;
19use salsa::Update;
20use span::Edition;
21use stdx::impl_from;
22use triomphe::Arc;
23
24use crate::{
25    FieldType, GenericDefaultsRef, GenericPredicates, ImplTraitId, InferBodyId, TyDefId,
26    TyLoweringResult, ValueTyDefId,
27    consteval::ConstEvalError,
28    dyn_compatibility::DynCompatibilityViolation,
29    layout::{Layout, LayoutError},
30    lower::{GenericDefaults, TrackedStructToken, TypeAliasBounds},
31    mir::{MirBody, MirLowerError},
32    next_solver::{
33        Allocation, Clause, EarlyBinder, GenericArgs, ParamEnv, PolyFnSig, StoredClauses,
34        StoredEarlyBinder, StoredGenericArgs, StoredPolyFnSig, StoredTraitRef, StoredTy, TraitRef,
35        Ty, VariancesOf,
36    },
37    traits::{ParamEnvAndCrate, StoredParamEnvAndCrate},
38};
39
40#[salsa::db]
41pub trait HirDatabase: SourceDatabase + 'static {
42    /// Manual implementation of upcasting from `dyn SourceDatabase` to `dyn HirDatabase`.
43    ///
44    /// This function is needed because Rust can't perform this upcasting automatically
45    /// in the general case, as `Self` could be unsized.
46    fn as_dyn(&self) -> &dyn HirDatabase;
47
48    // region:mir
49
50    // FIXME: Collapse `mir_body_for_closure` into `mir_body`
51    // and `monomorphized_mir_body_for_closure` into `monomorphized_mir_body`
52    fn mir_body<'db>(
53        &'db self,
54        def: InferBodyId<'db>,
55    ) -> Result<&'db MirBody<'db>, MirLowerError<'db>> {
56        let db = self.as_dyn();
57        crate::mir::mir_body_query(db, def).map_err(|err| err.clone())
58    }
59
60    fn mir_body_for_closure<'db>(
61        &'db self,
62        def: InternedClosureId<'db>,
63    ) -> Result<&'db MirBody<'db>, MirLowerError<'db>> {
64        let db = self.as_dyn();
65        crate::mir::mir_body_for_closure_query(db, def).map_err(|err| err.clone())
66    }
67
68    fn monomorphized_mir_body<'db>(
69        &'db self,
70        def: InferBodyId<'db>,
71        subst: StoredGenericArgs,
72        env: StoredParamEnvAndCrate,
73    ) -> Result<&'db MirBody<'db>, MirLowerError<'db>> {
74        let db = self.as_dyn();
75        crate::mir::monomorphized_mir_body_query(db, def, subst, env).map_err(|err| err.clone())
76    }
77
78    fn monomorphized_mir_body_for_closure<'db>(
79        &'db self,
80        def: InternedClosureId<'db>,
81        subst: StoredGenericArgs,
82        env: StoredParamEnvAndCrate,
83    ) -> Result<&'db MirBody<'db>, MirLowerError<'db>> {
84        let db = self.as_dyn();
85        crate::mir::monomorphized_mir_body_for_closure_query(db, def, subst, env)
86            .map_err(|err| err.clone())
87    }
88
89    fn const_eval<'db>(
90        &'db self,
91        def: ConstId,
92        subst: GenericArgs<'db>,
93        trait_env: Option<ParamEnvAndCrate<'db>>,
94    ) -> Result<Allocation<'db>, ConstEvalError<'db>> {
95        let db = self.as_dyn();
96        crate::consteval::const_eval(db, def, subst, trait_env)
97    }
98
99    fn anon_const_eval<'db>(
100        &'db self,
101        def: AnonConstId<'db>,
102        subst: GenericArgs<'db>,
103        trait_env: Option<ParamEnvAndCrate<'db>>,
104    ) -> Result<Allocation<'db>, ConstEvalError<'db>> {
105        let db = self.as_dyn();
106        crate::consteval::anon_const_eval(db, def, subst, trait_env)
107    }
108
109    fn const_eval_static<'db>(
110        &'db self,
111        def: StaticId,
112    ) -> Result<Allocation<'db>, ConstEvalError<'db>> {
113        let db = self.as_dyn();
114        crate::consteval::const_eval_static(db, def)
115    }
116
117    fn const_eval_discriminant<'db>(
118        &'db self,
119        def: EnumVariantId,
120    ) -> Result<i128, ConstEvalError<'db>> {
121        let db = self.as_dyn();
122        crate::consteval::const_eval_discriminant_variant(db, def)
123    }
124
125    fn lookup_impl_method<'db>(
126        &'db self,
127        env: ParamEnvAndCrate<'db>,
128        func: FunctionId,
129        fn_subst: GenericArgs<'db>,
130    ) -> (Either<FunctionId, (BuiltinDeriveImplId, BuiltinDeriveImplMethod)>, GenericArgs<'db>)
131    {
132        let db = self.as_dyn();
133        crate::method_resolution::lookup_impl_method_query(db, env, func, fn_subst)
134    }
135
136    // endregion:mir
137
138    fn layout_of_adt(
139        &self,
140        def: AdtId,
141        args: StoredGenericArgs,
142        trait_env: StoredParamEnvAndCrate,
143    ) -> Result<Arc<Layout>, LayoutError> {
144        let db = self.as_dyn();
145        crate::layout::layout_of_adt_query(db, def, args, trait_env)
146    }
147
148    fn layout_of_ty(
149        &self,
150        ty: StoredTy,
151        env: StoredParamEnvAndCrate,
152    ) -> Result<Arc<Layout>, LayoutError> {
153        let db = self.as_dyn();
154        crate::layout::layout_of_ty_query(db, ty, env)
155    }
156
157    fn target_data_layout(&self, krate: Crate) -> Result<&TargetDataLayout, TargetLoadError> {
158        let db = self.as_dyn();
159        crate::layout::target_data_layout_query(db, krate).map_err(|err| err.clone())
160    }
161
162    fn dyn_compatibility_of_trait(&self, trait_: TraitId) -> Option<DynCompatibilityViolation> {
163        let db = self.as_dyn();
164        crate::dyn_compatibility::dyn_compatibility_of_trait_query(db, trait_)
165    }
166
167    fn ty<'db>(&'db self, def: TyDefId) -> EarlyBinder<'db, Ty<'db>> {
168        let db = self.as_dyn();
169        crate::lower::ty_query(db, def)
170    }
171
172    fn type_for_type_alias_with_diagnostics<'db>(
173        &'db self,
174        def: TypeAliasId,
175    ) -> &'db TyLoweringResult<'db, StoredEarlyBinder<StoredTy>> {
176        let db = self.as_dyn();
177        crate::lower::type_for_type_alias_with_diagnostics(db, def)
178    }
179
180    /// Returns the type of the value of the given constant, or `None` if the `ValueTyDefId` is
181    /// a `StructId` or `EnumVariantId` with a record constructor.
182    fn value_ty<'db>(&'db self, def: ValueTyDefId) -> Option<EarlyBinder<'db, Ty<'db>>> {
183        let db = self.as_dyn();
184        crate::lower::value_ty(db, def)
185    }
186
187    fn type_for_const<'db>(&'db self, def: ConstId) -> EarlyBinder<'db, Ty<'db>> {
188        let db = self.as_dyn();
189        crate::lower::type_for_const(db, def)
190    }
191
192    fn type_for_const_with_diagnostics<'db>(
193        &'db self,
194        def: ConstId,
195    ) -> &'db TyLoweringResult<'db, StoredEarlyBinder<StoredTy>> {
196        let db = self.as_dyn();
197        crate::lower::type_for_const_with_diagnostics(db, def)
198    }
199
200    fn type_for_static<'db>(&'db self, def: StaticId) -> EarlyBinder<'db, Ty<'db>> {
201        let db = self.as_dyn();
202        crate::lower::type_for_static(db, def)
203    }
204
205    fn type_for_static_with_diagnostics<'db>(
206        &'db self,
207        def: StaticId,
208    ) -> &'db TyLoweringResult<'db, StoredEarlyBinder<StoredTy>> {
209        let db = self.as_dyn();
210        crate::lower::type_for_static_with_diagnostics(db, def)
211    }
212
213    fn impl_self_ty_with_diagnostics<'db>(
214        &'db self,
215        def: ImplId,
216    ) -> &'db TyLoweringResult<'db, StoredEarlyBinder<StoredTy>> {
217        let db = self.as_dyn();
218        crate::lower::impl_self_ty_with_diagnostics(db, def)
219    }
220
221    fn impl_self_ty<'db>(&'db self, def: ImplId) -> EarlyBinder<'db, Ty<'db>> {
222        let db = self.as_dyn();
223        crate::lower::impl_self_ty_query(db, def)
224    }
225
226    fn const_param_types_with_diagnostics<'db>(
227        &'db self,
228        def: GenericDefId,
229    ) -> &'db TyLoweringResult<'db, ArenaMap<LocalTypeOrConstParamId, StoredTy>> {
230        let db = self.as_dyn();
231        crate::lower::const_param_types_with_diagnostics(db, def)
232    }
233
234    fn const_param_types(&self, def: GenericDefId) -> &ArenaMap<LocalTypeOrConstParamId, StoredTy> {
235        let db = self.as_dyn();
236        crate::lower::const_param_types(db, def)
237    }
238
239    fn const_param_ty<'db>(&'db self, def: ConstParamId) -> Ty<'db> {
240        let db = self.as_dyn();
241        crate::lower::const_param_ty(db, def)
242    }
243
244    fn impl_trait_with_diagnostics<'db>(
245        &'db self,
246        def: ImplId,
247    ) -> &'db Option<TyLoweringResult<'db, StoredEarlyBinder<StoredTraitRef>>> {
248        let db = self.as_dyn();
249        crate::lower::impl_trait_with_diagnostics(db, def)
250    }
251
252    fn impl_trait<'db>(&'db self, def: ImplId) -> Option<EarlyBinder<'db, TraitRef<'db>>> {
253        let db = self.as_dyn();
254        crate::lower::impl_trait_query(db, def)
255    }
256
257    fn field_types_with_diagnostics<'db>(
258        &'db self,
259        var: VariantId,
260    ) -> &'db TyLoweringResult<'db, ArenaMap<LocalFieldId, FieldType>> {
261        let db = self.as_dyn();
262        crate::lower::field_types_with_diagnostics(db, var)
263    }
264
265    fn field_types(&self, var: VariantId) -> &ArenaMap<LocalFieldId, FieldType> {
266        let db = self.as_dyn();
267        crate::lower::field_types_query(db, var)
268    }
269
270    fn callable_item_signature<'db>(
271        &'db self,
272        def: CallableDefId,
273    ) -> EarlyBinder<'db, PolyFnSig<'db>> {
274        let db = self.as_dyn();
275        crate::lower::callable_item_signature(db, def)
276    }
277
278    fn callable_item_signature_with_diagnostics<'db>(
279        &'db self,
280        def: CallableDefId,
281    ) -> &'db TyLoweringResult<'db, StoredEarlyBinder<StoredPolyFnSig>> {
282        let db = self.as_dyn();
283        crate::lower::callable_item_signature_with_diagnostics(db, def)
284    }
285
286    fn trait_environment<'db>(&'db self, def: GenericDefId) -> ParamEnv<'db> {
287        let db = self.as_dyn();
288        crate::lower::trait_environment(db, def)
289    }
290
291    fn generic_defaults_with_diagnostics<'db>(
292        &'db self,
293        def: GenericDefId,
294    ) -> &'db TyLoweringResult<'db, GenericDefaults> {
295        let db = self.as_dyn();
296        crate::lower::generic_defaults_with_diagnostics(db, def)
297    }
298
299    /// This returns an empty list if no parameter has default.
300    ///
301    /// The binders of the returned defaults are only up to (not including) this parameter.
302    fn generic_defaults(&self, def: GenericDefId) -> GenericDefaultsRef<'_> {
303        let db = self.as_dyn();
304        crate::lower::generic_defaults(db, def)
305    }
306
307    fn type_alias_bounds_with_diagnostics<'db>(
308        &'db self,
309        type_alias: TypeAliasId,
310    ) -> &'db TyLoweringResult<'db, TypeAliasBounds<StoredEarlyBinder<StoredClauses>>> {
311        let db = self.as_dyn();
312        crate::lower::type_alias_bounds_with_diagnostics(db, type_alias)
313    }
314
315    fn type_alias_bounds<'db>(
316        &'db self,
317        type_alias: TypeAliasId,
318    ) -> EarlyBinder<'db, &'db [Clause<'db>]> {
319        let db = self.as_dyn();
320        crate::lower::type_alias_bounds(db, type_alias)
321    }
322
323    fn type_alias_self_bounds<'db>(
324        &'db self,
325        type_alias: TypeAliasId,
326    ) -> EarlyBinder<'db, &'db [Clause<'db>]> {
327        let db = self.as_dyn();
328        crate::lower::type_alias_self_bounds(db, type_alias)
329    }
330
331    fn variances_of<'db>(&'db self, def: GenericDefId) -> VariancesOf<'db> {
332        let db = self.as_dyn();
333        crate::variance::variances_of(db, def)
334    }
335}
336
337#[salsa::db]
338impl<T: SourceDatabase> HirDatabase for T {
339    fn as_dyn(&self) -> &dyn HirDatabase {
340        self
341    }
342}
343
344#[test]
345fn hir_database_is_dyn_compatible() {
346    fn _assert_dyn_compatible(_: &dyn HirDatabase) {}
347}
348
349#[salsa::interned(debug, revisions = usize::MAX)]
350#[derive(PartialOrd, Ord)]
351pub struct InternedOpaqueTyId {
352    pub loc: ImplTraitId,
353}
354
355#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Update)]
356pub struct InternedClosure<'db> {
357    pub owner: InferBodyId<'db>,
358    pub expr: ExprId,
359    pub kind: ClosureKind,
360}
361
362#[salsa::interned(constructor = new_impl, debug, revisions = usize::MAX)]
363#[derive(PartialOrd, Ord)]
364pub struct InternedClosureId<'db> {
365    pub loc: InternedClosure<'db>,
366}
367
368impl<'db> InternedClosureId<'db> {
369    #[inline]
370    pub fn new(db: &'db dyn HirDatabase, loc: InternedClosure<'db>) -> Self {
371        if cfg!(debug_assertions) {
372            let store = ExpressionStore::of(db, loc.owner.expression_store_owner(db));
373            let expr = &store[loc.expr];
374            assert!(
375                matches!(
376                    expr,
377                    hir_def::hir::Expr::Closure {
378                        closure_kind: hir_def::hir::ClosureKind::Closure,
379                        ..
380                    }
381                ),
382                "expected a closure, found {expr:?}"
383            );
384        }
385
386        Self::new_impl(db, loc)
387    }
388}
389
390#[salsa::interned(constructor = new_impl, debug, revisions = usize::MAX)]
391#[derive(PartialOrd, Ord)]
392pub struct InternedCoroutineId<'db> {
393    pub loc: InternedClosure<'db>,
394}
395
396impl<'db> InternedCoroutineId<'db> {
397    #[inline]
398    pub fn new(db: &'db dyn HirDatabase, loc: InternedClosure<'db>) -> Self {
399        if cfg!(debug_assertions) {
400            let store = ExpressionStore::of(db, loc.owner.expression_store_owner(db));
401            let expr = &store[loc.expr];
402            assert!(
403                matches!(
404                    expr,
405                    hir_def::hir::Expr::Closure {
406                        closure_kind: hir_def::hir::ClosureKind::OldCoroutine(_)
407                            | hir_def::hir::ClosureKind::Coroutine { .. },
408                        ..
409                    }
410                ),
411                "expected a coroutine, found {expr:?}"
412            );
413        }
414
415        Self::new_impl(db, loc)
416    }
417}
418
419#[salsa::interned(constructor = new_impl, debug, revisions = usize::MAX)]
420#[derive(PartialOrd, Ord)]
421pub struct InternedCoroutineClosureId<'db> {
422    pub loc: InternedClosure<'db>,
423}
424
425impl<'db> InternedCoroutineClosureId<'db> {
426    #[inline]
427    pub fn new(db: &'db dyn HirDatabase, loc: InternedClosure<'db>) -> Self {
428        if cfg!(debug_assertions) {
429            let store = ExpressionStore::of(db, loc.owner.expression_store_owner(db));
430            let expr = &store[loc.expr];
431            assert!(
432                matches!(
433                    expr,
434                    hir_def::hir::Expr::Closure {
435                        closure_kind: hir_def::hir::ClosureKind::CoroutineClosure(_),
436                        ..
437                    }
438                ),
439                "expected a coroutine closure, found {expr:?}"
440            );
441        }
442
443        Self::new_impl(db, loc)
444    }
445}
446
447/// An anonymous const expression that appears in a type position (e.g., array lengths,
448/// const generic arguments like `{ N + 1 }`, or const param defaults). Unlike named constants,
449/// these don't have their own `Body` — their expressions live in the parent's signature `ExpressionStore`.
450#[derive(Debug, Hash, PartialEq, Eq, Clone)]
451pub struct AnonConstLoc {
452    /// The owner store containing this expression.
453    pub owner: ExpressionStoreOwnerId,
454    /// The ExprId within the owner's ExpressionStore that is the root
455    /// of this anonymous const expression.
456    pub expr: ExprId,
457    pub ty: StoredEarlyBinder<StoredTy>,
458    /// Whether to allow using generic params from the owner.
459    /// true for array repeats, false for everything else.
460    pub(crate) allow_using_generic_params: bool,
461}
462
463#[salsa::interned(debug, revisions = usize::MAX, constructor = new_)]
464#[derive(PartialOrd, Ord)]
465pub struct AnonConstId {
466    #[returns(ref)]
467    pub loc: AnonConstLoc,
468}
469
470impl<'db> AnonConstId<'db> {
471    pub(crate) fn new(
472        db: &'db dyn SourceDatabase,
473        loc: AnonConstLoc,
474        token: TrackedStructToken,
475    ) -> Self {
476        _ = token;
477        AnonConstId::new_(db, loc)
478    }
479}
480
481impl HasModule for AnonConstId<'_> {
482    fn module(&self, db: &dyn SourceDatabase) -> ModuleId {
483        self.loc(db).owner.module(db)
484    }
485}
486
487impl HasResolver for AnonConstId<'_> {
488    fn resolver(self, db: &dyn SourceDatabase) -> Resolver<'_> {
489        self.loc(db).owner.resolver(db)
490    }
491}
492
493impl<'db> AnonConstId<'db> {
494    pub fn all_from_signature(
495        db: &'db dyn HirDatabase,
496        def: GenericDefId,
497    ) -> ArrayVec<&'db [Self], 5> {
498        let mut result = ArrayVec::new();
499
500        // Queries common to all generic defs:
501        result.push(db.generic_defaults_with_diagnostics(def).defined_anon_consts());
502        result.push(GenericPredicates::query_with_diagnostics(db, def).defined_anon_consts());
503        result.push(db.const_param_types_with_diagnostics(def).defined_anon_consts());
504
505        match def {
506            GenericDefId::ImplId(id) => {
507                result.push(db.impl_self_ty_with_diagnostics(id).defined_anon_consts());
508                if let Some(trait_ref) = db.impl_trait_with_diagnostics(id) {
509                    result.push(trait_ref.defined_anon_consts());
510                }
511            }
512            GenericDefId::TypeAliasId(id) => {
513                result.push(db.type_for_type_alias_with_diagnostics(id).defined_anon_consts());
514                result.push(db.type_alias_bounds_with_diagnostics(id).defined_anon_consts());
515            }
516            GenericDefId::FunctionId(id) => result
517                .push(db.callable_item_signature_with_diagnostics(id.into()).defined_anon_consts()),
518            GenericDefId::ConstId(def) => {
519                result.push(db.type_for_const_with_diagnostics(def).defined_anon_consts())
520            }
521            GenericDefId::StaticId(def) => {
522                result.push(db.type_for_static_with_diagnostics(def).defined_anon_consts())
523            }
524            GenericDefId::TraitId(_) | GenericDefId::AdtId(_) => {}
525        }
526
527        result
528    }
529}
530
531/// A constant, which might appears as a const item, an anonymous const block in expressions
532/// or patterns, or as a constant in types with const generics.
533#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, salsa::Supertype)]
534pub enum GeneralConstId<'db> {
535    ConstId(ConstId),
536    StaticId(StaticId),
537    AnonConstId(AnonConstId<'db>),
538}
539
540impl_from!(impl<'db> ConstId, StaticId, AnonConstId<'db> for GeneralConstId<'db>);
541
542impl<'db> GeneralConstId<'db> {
543    pub fn generic_def(self, db: &'db dyn HirDatabase) -> Option<GenericDefId> {
544        match self {
545            GeneralConstId::ConstId(it) => Some(it.into()),
546            GeneralConstId::StaticId(it) => Some(it.into()),
547            GeneralConstId::AnonConstId(it) => Some(it.loc(db).owner.generic_def(db)),
548        }
549    }
550
551    pub fn name(self, db: &'db dyn SourceDatabase) -> String {
552        match self {
553            GeneralConstId::StaticId(it) => {
554                StaticSignature::of(db, it).name.display(db, Edition::CURRENT).to_string()
555            }
556            GeneralConstId::ConstId(const_id) => {
557                ConstSignature::of(db, const_id).name.as_ref().map_or_else(
558                    || "_".to_owned(),
559                    |name| name.display(db, Edition::CURRENT).to_string(),
560                )
561            }
562            GeneralConstId::AnonConstId(_) => "{const}".to_owned(),
563        }
564    }
565}