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