cairo_lang_semantic/items/
constant.rs

1use std::iter::zip;
2use std::sync::Arc;
3
4use cairo_lang_debug::DebugWithDb;
5use cairo_lang_defs::db::DefsGroup;
6use cairo_lang_defs::ids::{
7    ConstantId, ExternFunctionId, GenericParamId, LanguageElementId, LookupItemId, ModuleItemId,
8    NamedLanguageElementId, TopLevelLanguageElementId, TraitConstantId, TraitId, VarId,
9};
10use cairo_lang_diagnostics::{
11    DiagnosticAdded, DiagnosticEntry, DiagnosticNote, Diagnostics, Maybe, MaybeAsRef,
12    skip_diagnostic,
13};
14use cairo_lang_proc_macros::{DebugWithDb, SemanticObject};
15use cairo_lang_syntax::node::ast::ItemConstant;
16use cairo_lang_syntax::node::ids::SyntaxStablePtrId;
17use cairo_lang_syntax::node::{TypedStablePtr, TypedSyntaxNode};
18use cairo_lang_utils::ordered_hash_map::OrderedHashMap;
19use cairo_lang_utils::unordered_hash_map::UnorderedHashMap;
20use cairo_lang_utils::unordered_hash_set::UnorderedHashSet;
21use cairo_lang_utils::{Intern, define_short_id, extract_matches, require, try_extract_matches};
22use itertools::Itertools;
23use num_bigint::BigInt;
24use num_traits::{ToPrimitive, Zero};
25use salsa::Database;
26use starknet_types_core::felt::{CAIRO_PRIME_BIGINT, Felt as Felt252};
27
28use super::functions::{GenericFunctionId, GenericFunctionWithBodyId};
29use super::imp::{ImplId, ImplLongId};
30use crate::corelib::{
31    CoreInfo, CorelibSemantic, core_nonzero_ty, false_variant, true_variant,
32    try_extract_bounded_int_type_ranges, try_extract_nz_wrapped_type, unit_ty, validate_literal,
33};
34use crate::diagnostic::{SemanticDiagnosticKind, SemanticDiagnostics, SemanticDiagnosticsBuilder};
35use crate::expr::compute::{ComputationContext, ExprAndId, compute_expr_semantic};
36use crate::expr::inference::conform::InferenceConform;
37use crate::expr::inference::{ConstVar, InferenceId};
38use crate::helper::ModuleHelper;
39use crate::items::enm::SemanticEnumEx;
40use crate::items::extern_function::ExternFunctionSemantic;
41use crate::items::free_function::FreeFunctionSemantic;
42use crate::items::function_with_body::FunctionWithBodySemantic;
43use crate::items::generics::GenericParamSemantic;
44use crate::items::imp::ImplSemantic;
45use crate::items::structure::StructSemantic;
46use crate::items::trt::TraitSemantic;
47use crate::resolve::{Resolver, ResolverData};
48use crate::substitution::{GenericSubstitution, SemanticRewriter};
49use crate::types::resolve_type;
50use crate::{
51    Arenas, ConcreteFunction, ConcreteTypeId, ConcreteVariant, Condition, Expr, ExprBlock,
52    ExprConstant, ExprFunctionCall, ExprFunctionCallArg, ExprId, ExprMemberAccess, ExprStructCtor,
53    FunctionId, GenericParam, LogicalOperator, Pattern, PatternId, SemanticDiagnostic, Statement,
54    TypeId, TypeLongId, semantic_object_for_id,
55};
56
57#[derive(Clone, Debug, PartialEq, Eq, DebugWithDb)]
58#[debug_db(dyn Database)]
59pub struct Constant<'db> {
60    /// The actual id of the const expression value.
61    pub value: ExprId,
62    /// The arena of all the expressions for the const calculation.
63    pub arenas: Arc<Arenas<'db>>,
64}
65
66// TODO: Review this well.
67unsafe impl<'db> salsa::Update for Constant<'db> {
68    unsafe fn maybe_update(old_pointer: *mut Self, new_value: Self) -> bool {
69        let old_constant: &mut Constant<'db> = unsafe { &mut *old_pointer };
70
71        if old_constant.value != new_value.value {
72            *old_constant = new_value;
73            return true;
74        }
75
76        false
77    }
78}
79
80impl<'db> Constant<'db> {
81    pub fn ty(&self) -> TypeId<'db> {
82        self.arenas.exprs[self.value].ty()
83    }
84}
85
86/// Information about a constant definition.
87///
88/// Helper struct for the data returned by [ConstantSemantic::constant_semantic_data].
89#[derive(Clone, Debug, PartialEq, Eq, DebugWithDb, salsa::Update)]
90#[debug_db(dyn Database)]
91pub struct ConstantData<'db> {
92    pub diagnostics: Diagnostics<'db, SemanticDiagnostic<'db>>,
93    pub constant: Maybe<Constant<'db>>,
94    pub const_value: ConstValueId<'db>,
95    pub resolver_data: Arc<ResolverData<'db>>,
96}
97
98define_short_id!(ConstValueId, ConstValue<'db>);
99semantic_object_for_id!(ConstValueId, ConstValue<'a>);
100impl<'db> ConstValueId<'db> {
101    /// Creates a new const value from a BigInt.
102    pub fn from_int(db: &'db dyn Database, ty: TypeId<'db>, value: &BigInt) -> Self {
103        let get_basic_const_value = |ty| {
104            let info = db.const_calc_info();
105            if ty != info.u256 {
106                ConstValue::Int(value.clone(), ty).intern(db)
107            } else {
108                let mask128 = BigInt::from(u128::MAX);
109                let low = value & mask128;
110                let high = value >> 128;
111                ConstValue::Struct(
112                    vec![
113                        (ConstValue::Int(low, info.u128).intern(db)),
114                        (ConstValue::Int(high, info.u128).intern(db)),
115                    ],
116                    ty,
117                )
118                .intern(db)
119            }
120        };
121        if let Some(inner) = try_extract_nz_wrapped_type(db, ty) {
122            ConstValue::NonZero(get_basic_const_value(inner)).intern(db)
123        } else {
124            get_basic_const_value(ty)
125        }
126    }
127    /// Returns a formatted string of the const value.
128    pub fn format(&self, db: &dyn Database) -> String {
129        format!("{:?}", self.long(db).debug(db))
130    }
131
132    /// Returns true if the const does not depend on any generics.
133    pub fn is_fully_concrete(&self, db: &dyn Database) -> bool {
134        self.long(db).is_fully_concrete(db)
135    }
136
137    /// Returns true if the const does not contain any inference variables.
138    pub fn is_var_free(&self, db: &dyn Database) -> bool {
139        self.long(db).is_var_free(db)
140    }
141
142    /// Returns the type of the const.
143    pub fn ty(&self, db: &'db dyn Database) -> Maybe<TypeId<'db>> {
144        self.long(db).ty(db)
145    }
146}
147
148/// Moves the value of a felt252, to the range of `[range_min, range_min + PRIME)`.
149pub fn felt252_for_downcast(value: &BigInt, range_min: &BigInt) -> BigInt {
150    Felt252::from(value - range_min).to_bigint() + range_min
151}
152
153/// Canonicalize the value of a felt252, to the range of `(-PRIME, PRIME)`.
154pub fn canonical_felt252(value: &BigInt) -> BigInt {
155    value % &*CAIRO_PRIME_BIGINT
156}
157
158/// A constant value.
159#[derive(Clone, Debug, Hash, PartialEq, Eq, SemanticObject, salsa::Update)]
160pub enum ConstValue<'db> {
161    Int(#[dont_rewrite] BigInt, TypeId<'db>),
162    Struct(Vec<ConstValueId<'db>>, TypeId<'db>),
163    Enum(ConcreteVariant<'db>, ConstValueId<'db>),
164    NonZero(ConstValueId<'db>),
165    Generic(#[dont_rewrite] GenericParamId<'db>),
166    ImplConstant(ImplConstantId<'db>),
167    Var(ConstVar<'db>, TypeId<'db>),
168    /// A missing value, used in cases where the value is not known due to diagnostics.
169    Missing(#[dont_rewrite] DiagnosticAdded),
170}
171impl<'db> ConstValue<'db> {
172    /// Returns true if the const does not depend on any generics.
173    pub fn is_fully_concrete(&self, db: &dyn Database) -> bool {
174        self.ty(db).unwrap().is_fully_concrete(db)
175            && match self {
176                ConstValue::Int(_, _) => true,
177                ConstValue::Struct(members, _) => {
178                    members.iter().all(|member| member.is_fully_concrete(db))
179                }
180                ConstValue::Enum(_, val) | ConstValue::NonZero(val) => val.is_fully_concrete(db),
181                ConstValue::Generic(_)
182                | ConstValue::Var(_, _)
183                | ConstValue::Missing(_)
184                | ConstValue::ImplConstant(_) => false,
185            }
186    }
187
188    /// Returns true if the const does not contain any inference variables.
189    pub fn is_var_free(&self, db: &dyn Database) -> bool {
190        self.ty(db).unwrap().is_var_free(db)
191            && match self {
192                ConstValue::Int(_, _) | ConstValue::Generic(_) | ConstValue::Missing(_) => true,
193                ConstValue::Struct(members, _) => {
194                    members.iter().all(|member| member.is_var_free(db))
195                }
196                ConstValue::Enum(_, val) | ConstValue::NonZero(val) => val.is_var_free(db),
197                ConstValue::Var(_, _) => false,
198                ConstValue::ImplConstant(impl_constant) => impl_constant.impl_id().is_var_free(db),
199            }
200    }
201
202    /// Returns the type of the const.
203    pub fn ty(&self, db: &'db dyn Database) -> Maybe<TypeId<'db>> {
204        Ok(match self {
205            ConstValue::Int(_, ty) => *ty,
206            ConstValue::Struct(_, ty) => *ty,
207            ConstValue::Enum(variant, _) => {
208                TypeLongId::Concrete(ConcreteTypeId::Enum(variant.concrete_enum_id)).intern(db)
209            }
210            ConstValue::NonZero(value) => core_nonzero_ty(db, value.ty(db)?),
211            ConstValue::Generic(param) => {
212                extract_matches!(db.generic_param_semantic(*param)?, GenericParam::Const).ty
213            }
214            ConstValue::Var(_, ty) => *ty,
215            ConstValue::Missing(_) => TypeId::missing(db, skip_diagnostic()),
216            ConstValue::ImplConstant(impl_constant_id) => {
217                db.impl_constant_concrete_implized_type(*impl_constant_id)?
218            }
219        })
220    }
221
222    /// Returns the value of an int const as a BigInt.
223    pub fn to_int(&self) -> Option<&BigInt> {
224        match self {
225            ConstValue::Int(value, _) => Some(value),
226            _ => None,
227        }
228    }
229}
230
231/// An impl item of kind const.
232#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, SemanticObject, salsa::Update)]
233pub struct ImplConstantId<'db> {
234    /// The impl the item const is in.
235    impl_id: ImplId<'db>,
236    /// The trait const this impl const "implements".
237    trait_constant_id: TraitConstantId<'db>,
238}
239
240impl<'db> ImplConstantId<'db> {
241    /// Creates a new impl constant id. For an impl constant of a concrete impl, asserts that the
242    /// trait constant belongs to the same trait that the impl implements (panics if not).
243    pub fn new(
244        impl_id: ImplId<'db>,
245        trait_constant_id: TraitConstantId<'db>,
246        db: &dyn Database,
247    ) -> Self {
248        if let ImplLongId::Concrete(concrete_impl) = impl_id.long(db) {
249            let impl_def_id = concrete_impl.impl_def_id(db);
250            assert_eq!(Ok(trait_constant_id.trait_id(db)), db.impl_def_trait(impl_def_id));
251        }
252
253        ImplConstantId { impl_id, trait_constant_id }
254    }
255    pub fn impl_id(&self) -> ImplId<'db> {
256        self.impl_id
257    }
258    pub fn trait_constant_id(&self) -> TraitConstantId<'db> {
259        self.trait_constant_id
260    }
261
262    pub fn format(&self, db: &dyn Database) -> String {
263        format!("{}::{}", self.impl_id.name(db), self.trait_constant_id.name(db).long(db))
264    }
265}
266impl<'db> DebugWithDb<'db> for ImplConstantId<'db> {
267    type Db = dyn Database;
268
269    fn fmt(&self, f: &mut std::fmt::Formatter<'_>, db: &'db dyn Database) -> std::fmt::Result {
270        write!(f, "{}", self.format(db))
271    }
272}
273
274/// Returns the semantic data of a constant.
275#[salsa::tracked(returns(ref), cycle_result=constant_semantic_data_cycle)]
276fn constant_semantic_data<'db>(
277    db: &'db dyn Database,
278    const_id: ConstantId<'db>,
279    in_cycle: bool,
280) -> Maybe<ConstantData<'db>> {
281    let lookup_item_id = LookupItemId::ModuleItem(ModuleItemId::Constant(const_id));
282    if in_cycle {
283        constant_semantic_data_cycle_helper(
284            db,
285            &db.module_constant_by_id(const_id)?,
286            lookup_item_id,
287            None,
288            &const_id,
289        )
290    } else {
291        constant_semantic_data_helper(
292            db,
293            &db.module_constant_by_id(const_id)?,
294            lookup_item_id,
295            None,
296            &const_id,
297        )
298    }
299}
300
301/// Cycle handling for [ConstantSemantic::constant_semantic_data].
302fn constant_semantic_data_cycle<'db>(
303    db: &'db dyn Database,
304    const_id: ConstantId<'db>,
305    _in_cycle: bool,
306) -> Maybe<ConstantData<'db>> {
307    let lookup_item_id = LookupItemId::ModuleItem(ModuleItemId::Constant(const_id));
308    constant_semantic_data_cycle_helper(
309        db,
310        &db.module_constant_by_id(const_id)?,
311        lookup_item_id,
312        None,
313        &const_id,
314    )
315}
316
317/// Returns constant semantic data for the given ItemConstant.
318pub fn constant_semantic_data_helper<'db>(
319    db: &'db dyn Database,
320    constant_ast: &ItemConstant<'db>,
321    lookup_item_id: LookupItemId<'db>,
322    parent_resolver_data: Option<Arc<ResolverData<'db>>>,
323    element_id: &impl LanguageElementId<'db>,
324) -> Maybe<ConstantData<'db>> {
325    let mut diagnostics: SemanticDiagnostics<'_> = SemanticDiagnostics::default();
326    // TODO(spapini): when code changes in a file, all the AST items change (as they contain a path
327    // to the green root that changes. Once ASTs are rooted on items, use a selector that picks only
328    // the item instead of all the module data.
329
330    let inference_id = InferenceId::LookupItemDeclaration(lookup_item_id);
331
332    let mut resolver = match parent_resolver_data {
333        Some(parent_resolver_data) => {
334            Resolver::with_data(db, parent_resolver_data.clone_with_inference_id(db, inference_id))
335        }
336        None => Resolver::new(db, element_id.module_id(db), inference_id),
337    };
338    resolver.set_feature_config(element_id, constant_ast, &mut diagnostics);
339
340    let constant_type =
341        resolve_type(db, &mut diagnostics, &mut resolver, &constant_ast.type_clause(db).ty(db));
342
343    let mut ctx = ComputationContext::new_global(db, &mut diagnostics, &mut resolver);
344
345    let value = compute_expr_semantic(&mut ctx, &constant_ast.value(db));
346    let const_value = resolve_const_expr_and_evaluate(
347        db,
348        &mut ctx,
349        &value,
350        constant_ast.stable_ptr(db).untyped(),
351        constant_type,
352        true,
353    );
354    let constant = Ok(Constant { value: value.id, arenas: Arc::new(ctx.arenas) });
355    let const_value = resolver
356        .inference()
357        .rewrite(const_value)
358        .unwrap_or_else(|_| ConstValue::Missing(skip_diagnostic()).intern(db));
359    let resolver_data = Arc::new(resolver.data);
360    Ok(ConstantData { diagnostics: diagnostics.build(), const_value, constant, resolver_data })
361}
362
363/// Helper for cycle handling of constants.
364pub fn constant_semantic_data_cycle_helper<'db>(
365    db: &'db dyn Database,
366    constant_ast: &ItemConstant<'db>,
367    lookup_item_id: LookupItemId<'db>,
368    parent_resolver_data: Option<Arc<ResolverData<'db>>>,
369    element_id: &impl LanguageElementId<'db>,
370) -> Maybe<ConstantData<'db>> {
371    let mut diagnostics: SemanticDiagnostics<'_> = SemanticDiagnostics::default();
372
373    let inference_id = InferenceId::LookupItemDeclaration(lookup_item_id);
374
375    let resolver = match parent_resolver_data {
376        Some(parent_resolver_data) => {
377            Resolver::with_data(db, parent_resolver_data.clone_with_inference_id(db, inference_id))
378        }
379        None => Resolver::new(db, element_id.module_id(db), inference_id),
380    };
381
382    let resolver_data = Arc::new(resolver.data);
383
384    let diagnostic_added =
385        diagnostics.report(constant_ast.stable_ptr(db), SemanticDiagnosticKind::ConstCycle);
386    Ok(ConstantData {
387        constant: Err(diagnostic_added),
388        const_value: ConstValue::Missing(diagnostic_added).intern(db),
389        diagnostics: diagnostics.build(),
390        resolver_data,
391    })
392}
393
394/// Checks if the given expression only involved constant calculations.
395pub fn validate_const_expr<'db>(ctx: &mut ComputationContext<'db, '_>, expr_id: ExprId) {
396    let info = ctx.db.const_calc_info();
397    let mut eval_ctx = ConstantEvaluateContext {
398        db: ctx.db,
399        info: info.as_ref(),
400        arenas: &ctx.arenas,
401        vars: Default::default(),
402        generic_substitution: Default::default(),
403        depth: 0,
404        diagnostics: ctx.diagnostics,
405    };
406    eval_ctx.validate(expr_id);
407}
408
409/// Resolves the given const expression and evaluates its value.
410pub fn resolve_const_expr_and_evaluate<'db, 'mt>(
411    db: &'db dyn Database,
412    ctx: &'mt mut ComputationContext<'db, '_>,
413    value: &ExprAndId<'db>,
414    const_stable_ptr: SyntaxStablePtrId<'db>,
415    target_type: TypeId<'db>,
416    finalize: bool,
417) -> ConstValueId<'db> {
418    let prev_err_count = ctx.diagnostics.error_count;
419    let mut_ref = &mut ctx.resolver;
420    let mut inference: crate::expr::inference::Inference<'db, '_> = mut_ref.inference();
421    if let Err(err_set) = inference.conform_ty(value.ty(), target_type) {
422        inference.report_on_pending_error(err_set, ctx.diagnostics, const_stable_ptr);
423    }
424
425    if finalize {
426        // Check fully resolved.
427        inference.finalize(ctx.diagnostics, const_stable_ptr);
428    } else if let Err(err_set) = inference.solve() {
429        inference.report_on_pending_error(err_set, ctx.diagnostics, const_stable_ptr);
430    }
431
432    // TODO(orizi): Consider moving this to be called only upon creating const values, other callees
433    // don't necessarily need it.
434    ctx.apply_inference_rewriter_to_exprs();
435
436    match &value.expr {
437        Expr::Constant(ExprConstant { const_value_id, .. }) => *const_value_id,
438        // Check that the expression is a valid constant.
439        _ if ctx.diagnostics.error_count > prev_err_count => {
440            ConstValue::Missing(skip_diagnostic()).intern(db)
441        }
442        _ => {
443            let info = db.const_calc_info();
444            let mut eval_ctx = ConstantEvaluateContext {
445                db,
446                info: info.as_ref(),
447                arenas: &ctx.arenas,
448                vars: Default::default(),
449                generic_substitution: Default::default(),
450                depth: 0,
451                diagnostics: ctx.diagnostics,
452            };
453            eval_ctx.validate(value.id);
454            if eval_ctx.diagnostics.error_count > prev_err_count {
455                ConstValue::Missing(skip_diagnostic()).intern(db)
456            } else {
457                eval_ctx.evaluate(value.id)
458            }
459        }
460    }
461}
462
463/// A context for evaluating constant expressions.
464struct ConstantEvaluateContext<'a, 'r, 'mt> {
465    db: &'a dyn Database,
466    info: &'r ConstCalcInfo<'a>,
467    arenas: &'r Arenas<'a>,
468    vars: OrderedHashMap<VarId<'a>, ConstValueId<'a>>,
469    generic_substitution: GenericSubstitution<'a>,
470    depth: usize,
471    diagnostics: &'mt mut SemanticDiagnostics<'a>,
472}
473impl<'a, 'r, 'mt> ConstantEvaluateContext<'a, 'r, 'mt> {
474    /// Validate the given expression can be used as constant.
475    fn validate(&mut self, expr_id: ExprId) {
476        match &self.arenas.exprs[expr_id] {
477            Expr::Var(_) | Expr::Constant(_) | Expr::Missing(_) => {}
478            Expr::Block(ExprBlock { statements, tail: Some(inner), .. }) => {
479                for statement_id in statements {
480                    match &self.arenas.statements[*statement_id] {
481                        Statement::Let(statement) => {
482                            self.validate(statement.expr);
483                        }
484                        Statement::Expr(expr) => {
485                            self.validate(expr.expr);
486                        }
487                        other => {
488                            self.diagnostics.report(
489                                other.stable_ptr(),
490                                SemanticDiagnosticKind::UnsupportedConstant,
491                            );
492                        }
493                    }
494                }
495                self.validate(*inner);
496            }
497            Expr::FunctionCall(expr) => {
498                for arg in &expr.args {
499                    match arg {
500                        ExprFunctionCallArg::Value(arg) => self.validate(*arg),
501                        ExprFunctionCallArg::Reference(var) => {
502                            self.diagnostics.report(
503                                var.stable_ptr(),
504                                SemanticDiagnosticKind::UnsupportedConstant,
505                            );
506                        }
507                    }
508                    if let ExprFunctionCallArg::Value(arg) = arg {
509                        self.validate(*arg);
510                    }
511                }
512                if !self.is_function_const(expr.function) {
513                    self.diagnostics.report(
514                        expr.stable_ptr.untyped(),
515                        SemanticDiagnosticKind::UnsupportedConstant,
516                    );
517                }
518            }
519            Expr::Literal(expr) => {
520                if let Err(err) = validate_literal(self.db, expr.ty, &expr.value) {
521                    self.diagnostics.report(
522                        expr.stable_ptr.untyped(),
523                        SemanticDiagnosticKind::LiteralError(err),
524                    );
525                }
526            }
527            Expr::Tuple(expr) => {
528                for item in &expr.items {
529                    self.validate(*item);
530                }
531            }
532            Expr::StructCtor(ExprStructCtor { members, base_struct: None, .. }) => {
533                for (expr_id, _) in members {
534                    self.validate(*expr_id);
535                }
536            }
537            Expr::EnumVariantCtor(expr) => self.validate(expr.value_expr),
538            Expr::MemberAccess(expr) => self.validate(expr.expr),
539            Expr::FixedSizeArray(expr) => match &expr.items {
540                crate::FixedSizeArrayItems::Items(items) => {
541                    for item in items {
542                        self.validate(*item);
543                    }
544                }
545                crate::FixedSizeArrayItems::ValueAndSize(value, _) => {
546                    self.validate(*value);
547                }
548            },
549            Expr::Snapshot(expr) => self.validate(expr.inner),
550            Expr::Desnap(expr) => self.validate(expr.inner),
551            Expr::LogicalOperator(expr) => {
552                self.validate(expr.lhs);
553                self.validate(expr.rhs);
554            }
555            Expr::Match(expr) => {
556                self.validate(expr.matched_expr);
557                for arm in &expr.arms {
558                    self.validate(arm.expression);
559                }
560            }
561            Expr::If(expr) => {
562                for condition in &expr.conditions {
563                    self.validate(match condition {
564                        Condition::BoolExpr(id) | Condition::Let(id, _) => *id,
565                    });
566                }
567                self.validate(expr.if_block);
568                if let Some(else_block) = expr.else_block {
569                    self.validate(else_block);
570                }
571            }
572            other => {
573                self.diagnostics.report(
574                    other.stable_ptr().untyped(),
575                    SemanticDiagnosticKind::UnsupportedConstant,
576                );
577            }
578        }
579    }
580
581    /// Returns true if the given function is allowed to be called in constant context.
582    fn is_function_const(&self, function_id: FunctionId<'a>) -> bool {
583        if function_id == self.panic_with_felt252 {
584            return true;
585        }
586        let db = self.db;
587        let concrete_function = function_id.get_concrete(db);
588        let signature = (|| match concrete_function.generic_function {
589            GenericFunctionId::Free(id) => db.free_function_signature(id),
590            GenericFunctionId::Extern(id) => db.extern_function_signature(id),
591            GenericFunctionId::Impl(id) => {
592                if let ImplLongId::Concrete(impl_id) = id.impl_id.long(db)
593                    && let Ok(Some(impl_function_id)) = impl_id.get_impl_function(db, id.function)
594                {
595                    return self.db.impl_function_signature(impl_function_id);
596                }
597                self.db.trait_function_signature(id.function)
598            }
599        })();
600        if signature.map(|s| s.is_const) == Ok(true) {
601            return true;
602        }
603        let Ok(Some(body)) = concrete_function.body(db) else { return false };
604        let GenericFunctionWithBodyId::Impl(imp) = body.generic_function(db) else {
605            return false;
606        };
607        let impl_def = imp.concrete_impl_id.impl_def_id(db);
608        if impl_def.parent_module(db).owning_crate(db) != db.core_crate() {
609            return false;
610        }
611        let Ok(trait_id) = db.impl_def_trait(impl_def) else {
612            return false;
613        };
614        self.const_traits.contains(&trait_id)
615    }
616
617    /// Evaluate the given const expression value.
618    fn evaluate<'ctx>(&'ctx mut self, expr_id: ExprId) -> ConstValueId<'a> {
619        let expr = &self.arenas.exprs[expr_id];
620        let db = self.db;
621        let to_missing = |diag_added| ConstValue::Missing(diag_added).intern(db);
622        match expr {
623            Expr::Var(expr) => self.vars.get(&expr.var).copied().unwrap_or_else(|| {
624                to_missing(
625                    self.diagnostics
626                        .report(expr.stable_ptr, SemanticDiagnosticKind::UnsupportedConstant),
627                )
628            }),
629            Expr::Constant(expr) => self
630                .generic_substitution
631                .substitute(self.db, expr.const_value_id)
632                .unwrap_or_else(to_missing),
633            Expr::Block(ExprBlock { statements, tail: Some(inner), .. }) => {
634                for statement_id in statements {
635                    match &self.arenas.statements[*statement_id] {
636                        Statement::Let(statement) => {
637                            let value = self.evaluate(statement.expr);
638                            self.destructure_pattern(statement.pattern, value);
639                        }
640                        Statement::Expr(expr) => {
641                            self.evaluate(expr.expr);
642                        }
643                        other => {
644                            self.diagnostics.report(
645                                other.stable_ptr(),
646                                SemanticDiagnosticKind::UnsupportedConstant,
647                            );
648                        }
649                    }
650                }
651                self.evaluate(*inner)
652            }
653            Expr::FunctionCall(expr) => self.evaluate_function_call(expr),
654            Expr::Literal(expr) => ConstValueId::from_int(db, expr.ty, &expr.value),
655            Expr::Tuple(expr) => ConstValue::Struct(
656                expr.items.iter().map(|expr_id| self.evaluate(*expr_id)).collect(),
657                expr.ty,
658            )
659            .intern(db),
660            Expr::StructCtor(ExprStructCtor {
661                members,
662                base_struct: None,
663                ty,
664                concrete_struct_id,
665                ..
666            }) => {
667                let member_order = match db.concrete_struct_members(*concrete_struct_id) {
668                    Ok(member_order) => member_order,
669                    Err(diag_add) => return to_missing(diag_add),
670                };
671                ConstValue::Struct(
672                    member_order
673                        .values()
674                        .map(|m| {
675                            members
676                                .iter()
677                                .find(|(_, member_id)| m.id == *member_id)
678                                .map(|(expr_id, _)| self.evaluate(*expr_id))
679                                .expect("Should have been caught by semantic validation")
680                        })
681                        .collect(),
682                    *ty,
683                )
684                .intern(db)
685            }
686            Expr::EnumVariantCtor(expr) => {
687                ConstValue::Enum(expr.variant, self.evaluate(expr.value_expr)).intern(db)
688            }
689            Expr::MemberAccess(expr) => {
690                self.evaluate_member_access(expr).unwrap_or_else(to_missing)
691            }
692            Expr::FixedSizeArray(expr) => ConstValue::Struct(
693                match &expr.items {
694                    crate::FixedSizeArrayItems::Items(items) => {
695                        items.iter().map(|expr_id| self.evaluate(*expr_id)).collect()
696                    }
697                    crate::FixedSizeArrayItems::ValueAndSize(value, count) => {
698                        let value = self.evaluate(*value);
699                        if let Some(count) = count.long(db).to_int() {
700                            vec![value; count.to_usize().unwrap()]
701                        } else {
702                            self.diagnostics.report(
703                                expr.stable_ptr.untyped(),
704                                SemanticDiagnosticKind::UnsupportedConstant,
705                            );
706                            vec![]
707                        }
708                    }
709                },
710                expr.ty,
711            )
712            .intern(db),
713            Expr::Snapshot(expr) => self.evaluate(expr.inner),
714            Expr::Desnap(expr) => self.evaluate(expr.inner),
715            Expr::LogicalOperator(expr) => {
716                let lhs = self.evaluate(expr.lhs);
717                if let ConstValue::Enum(v, _) = lhs.long(db) {
718                    let early_return_variant = match expr.op {
719                        LogicalOperator::AndAnd => false_variant(self.db),
720                        LogicalOperator::OrOr => true_variant(self.db),
721                    };
722                    if *v == early_return_variant { lhs } else { self.evaluate(expr.lhs) }
723                } else {
724                    to_missing(skip_diagnostic())
725                }
726            }
727            Expr::Match(expr) => {
728                let value = self.evaluate(expr.matched_expr);
729                let ConstValue::Enum(variant, value) = value.long(db) else {
730                    return to_missing(skip_diagnostic());
731                };
732                for arm in &expr.arms {
733                    for pattern_id in &arm.patterns {
734                        let pattern = &self.arenas.patterns[*pattern_id];
735                        if matches!(pattern, Pattern::Otherwise(_)) {
736                            return self.evaluate(arm.expression);
737                        }
738                        let Pattern::EnumVariant(pattern) = pattern else {
739                            continue;
740                        };
741                        if pattern.variant.idx != variant.idx {
742                            continue;
743                        }
744                        if let Some(inner_pattern) = pattern.inner_pattern {
745                            self.destructure_pattern(inner_pattern, *value);
746                        }
747                        return self.evaluate(arm.expression);
748                    }
749                }
750                to_missing(
751                    self.diagnostics.report(
752                        expr.stable_ptr.untyped(),
753                        SemanticDiagnosticKind::UnsupportedConstant,
754                    ),
755                )
756            }
757            Expr::If(expr) => {
758                let mut if_condition: bool = true;
759                for condition in &expr.conditions {
760                    match condition {
761                        crate::Condition::BoolExpr(id) => {
762                            let condition = self.evaluate(*id);
763                            let ConstValue::Enum(variant, _) = condition.long(db) else {
764                                return to_missing(skip_diagnostic());
765                            };
766                            if *variant != true_variant(self.db) {
767                                if_condition = false;
768                                break;
769                            }
770                        }
771                        crate::Condition::Let(id, patterns) => {
772                            let value = self.evaluate(*id);
773                            let ConstValue::Enum(variant, value) = value.long(db) else {
774                                return to_missing(skip_diagnostic());
775                            };
776                            let mut found_pattern = false;
777                            for pattern_id in patterns {
778                                let Pattern::EnumVariant(pattern) =
779                                    &self.arenas.patterns[*pattern_id]
780                                else {
781                                    continue;
782                                };
783                                if pattern.variant != *variant {
784                                    // Continue to the next option in the `|` list.
785                                    continue;
786                                }
787                                if let Some(inner_pattern) = pattern.inner_pattern {
788                                    self.destructure_pattern(inner_pattern, *value);
789                                }
790                                found_pattern = true;
791                                break;
792                            }
793                            if !found_pattern {
794                                if_condition = false;
795                                break;
796                            }
797                        }
798                    }
799                }
800
801                if if_condition {
802                    self.evaluate(expr.if_block)
803                } else if let Some(else_block) = expr.else_block {
804                    self.evaluate(else_block)
805                } else {
806                    self.unit_const
807                }
808            }
809            _ => to_missing(skip_diagnostic()),
810        }
811    }
812
813    /// Attempts to evaluate constants from a const function call.
814    fn evaluate_function_call(&mut self, expr: &ExprFunctionCall<'a>) -> ConstValueId<'a> {
815        let db = self.db;
816        let to_missing = |diag_added| ConstValue::Missing(diag_added).intern(db);
817        let args = expr
818            .args
819            .iter()
820            .filter_map(|arg| try_extract_matches!(arg, ExprFunctionCallArg::Value))
821            .map(|arg| self.evaluate(*arg))
822            .collect_vec();
823        if expr.function == self.panic_with_felt252 {
824            return to_missing(self.diagnostics.report(
825                expr.stable_ptr.untyped(),
826                SemanticDiagnosticKind::FailedConstantCalculation,
827            ));
828        }
829        let concrete_function =
830            match self.generic_substitution.substitute(db, expr.function.get_concrete(db)) {
831                Ok(v) => v,
832                Err(err) => return to_missing(err),
833            };
834        if let Some(calc_result) =
835            self.evaluate_const_function_call(&concrete_function, &args, expr)
836        {
837            return calc_result;
838        }
839
840        let imp = extract_matches!(concrete_function.generic_function, GenericFunctionId::Impl);
841        let bool_value = |condition: bool| {
842            if condition { self.true_const } else { self.false_const }
843        };
844
845        if imp.function == self.eq_fn {
846            return bool_value(args[0] == args[1]);
847        } else if imp.function == self.ne_fn {
848            return bool_value(args[0] != args[1]);
849        } else if imp.function == self.not_fn {
850            return bool_value(args[0] == self.false_const);
851        }
852
853        let args = match args
854            .into_iter()
855            .map(|arg| NumericArg::try_new(db, arg))
856            .collect::<Option<Vec<_>>>()
857        {
858            Some(args) => args,
859            // Diagnostic can be skipped as we would either have a semantic error for a bad arg for
860            // the function, or the arg itself couldn't have been calculated.
861            None => return to_missing(skip_diagnostic()),
862        };
863        let value = match imp.function {
864            id if id == self.neg_fn => -&args[0].v,
865            id if id == self.add_fn => &args[0].v + &args[1].v,
866            id if id == self.sub_fn => &args[0].v - &args[1].v,
867            id if id == self.mul_fn => &args[0].v * &args[1].v,
868            id if (id == self.div_fn || id == self.rem_fn) && args[1].v.is_zero() => {
869                return to_missing(
870                    self.diagnostics
871                        .report(expr.stable_ptr.untyped(), SemanticDiagnosticKind::DivisionByZero),
872                );
873            }
874            id if id == self.div_fn => &args[0].v / &args[1].v,
875            id if id == self.rem_fn => &args[0].v % &args[1].v,
876            id if id == self.bitand_fn => &args[0].v & &args[1].v,
877            id if id == self.bitor_fn => &args[0].v | &args[1].v,
878            id if id == self.bitxor_fn => &args[0].v ^ &args[1].v,
879            id if id == self.lt_fn => return bool_value(args[0].v < args[1].v),
880            id if id == self.le_fn => return bool_value(args[0].v <= args[1].v),
881            id if id == self.gt_fn => return bool_value(args[0].v > args[1].v),
882            id if id == self.ge_fn => return bool_value(args[0].v >= args[1].v),
883            id if id == self.div_rem_fn => {
884                // No need for non-zero check as this is type checked to begin with.
885                // Also results are always in the range of the input type, so `unwrap`s are ok.
886                return ConstValue::Struct(
887                    vec![
888                        ConstValueId::from_int(db, args[0].ty, &(&args[0].v / &args[1].v)),
889                        ConstValueId::from_int(db, args[0].ty, &(&args[0].v % &args[1].v)),
890                    ],
891                    expr.ty,
892                )
893                .intern(db);
894            }
895            _ => {
896                unreachable!("Unexpected function call in constant lowering: {:?}", expr)
897            }
898        };
899        if expr.ty == self.felt252 {
900            ConstValue::Int(canonical_felt252(&value), expr.ty).intern(db)
901        } else if let Err(err) = validate_literal(db, expr.ty, &value) {
902            to_missing(
903                self.diagnostics
904                    .report(expr.stable_ptr.untyped(), SemanticDiagnosticKind::LiteralError(err)),
905            )
906        } else {
907            ConstValueId::from_int(db, expr.ty, &value)
908        }
909    }
910
911    /// Attempts to evaluate a constant function call.
912    fn evaluate_const_function_call(
913        &mut self,
914        concrete_function: &ConcreteFunction<'a>,
915        args: &[ConstValueId<'a>],
916        expr: &ExprFunctionCall<'a>,
917    ) -> Option<ConstValueId<'a>> {
918        let db = self.db;
919        if let GenericFunctionId::Extern(extern_fn) = concrete_function.generic_function {
920            let expr_ty = self.generic_substitution.substitute(db, expr.ty).ok()?;
921            if self.upcast_fns.contains(&extern_fn) {
922                let [arg] = args else { return None };
923                return Some(ConstValueId::from_int(db, expr_ty, arg.long(db).to_int()?));
924            } else if self.unwrap_non_zero == extern_fn {
925                let [arg] = args else { return None };
926                return try_extract_matches!(arg.long(db), ConstValue::NonZero).copied();
927            } else if self.u128s_from_felt252 == extern_fn {
928                let [arg] = args else { return None };
929                let TypeLongId::Concrete(ConcreteTypeId::Enum(enm)) = expr_ty.long(db) else {
930                    return None;
931                };
932                let (narrow, wide) =
933                    db.concrete_enum_variants(*enm).ok()?.into_iter().collect_tuple()?;
934                let value = felt252_for_downcast(arg.long(db).to_int()?, &BigInt::ZERO);
935                let mask128 = BigInt::from(u128::MAX);
936                let low = (&value) & mask128;
937                let high: BigInt = (&value) >> 128;
938                return Some(if high.is_zero() {
939                    ConstValue::Enum(narrow, ConstValue::Int(low, narrow.ty).intern(db)).intern(db)
940                } else {
941                    ConstValue::Enum(
942                        wide,
943                        ConstValue::Struct(
944                            vec![
945                                (ConstValue::Int(high, self.u128).intern(db)),
946                                (ConstValue::Int(low, self.u128).intern(db)),
947                            ],
948                            wide.ty,
949                        )
950                        .intern(db),
951                    )
952                    .intern(db)
953                });
954            } else if let Some(reversed) = self.downcast_fns.get(&extern_fn) {
955                let [arg] = args else { return None };
956                let ConstValue::Int(value, input_ty) = arg.long(db) else { return None };
957                let TypeLongId::Concrete(ConcreteTypeId::Enum(enm)) = expr_ty.long(db) else {
958                    return None;
959                };
960                let (variant0, variant1) =
961                    db.concrete_enum_variants(*enm).ok()?.into_iter().collect_tuple()?;
962                let (some, none) =
963                    if *reversed { (variant1, variant0) } else { (variant0, variant1) };
964                let success_ty = some.ty;
965                let out_range = self
966                    .type_value_ranges
967                    .get(&success_ty)
968                    .cloned()
969                    .or_else(|| {
970                        let (min, max) = try_extract_bounded_int_type_ranges(db, success_ty)?;
971                        Some(TypeRange::new(min, max))
972                    })
973                    .unwrap_or_else(|| {
974                        unreachable!(
975                            "`downcast` is only allowed into types that can be literals. Got `{}`.",
976                            success_ty.format(db)
977                        )
978                    });
979                let value = if *input_ty == self.felt252 {
980                    felt252_for_downcast(value, &out_range.min)
981                } else {
982                    value.clone()
983                };
984                return Some(if value >= out_range.min && value <= out_range.max {
985                    ConstValue::Enum(some, ConstValue::Int(value, success_ty).intern(db)).intern(db)
986                } else {
987                    ConstValue::Enum(none, self.unit_const).intern(db)
988                });
989            } else if self.nz_fns.contains(&extern_fn) {
990                let [arg] = args else { return None };
991                let (ty, is_zero) = match arg.long(db) {
992                    ConstValue::Int(val, ty) => (ty, val.is_zero()),
993                    ConstValue::Struct(members, ty) => (
994                        ty,
995                        // For u256 struct with (low, high), check if both are zero
996                        members.iter().all(|member| match member.long(db) {
997                            ConstValue::Int(val, _) => val.is_zero(),
998                            _ => false,
999                        }),
1000                    ),
1001                    _ => unreachable!(
1002                        "`is_zero` is only allowed for integers got `{}`",
1003                        arg.ty(db).unwrap().format(db)
1004                    ),
1005                };
1006
1007                return Some(
1008                    if is_zero {
1009                        ConstValue::Enum(
1010                            crate::corelib::jump_nz_zero_variant(db, *ty),
1011                            self.unit_const,
1012                        )
1013                    } else {
1014                        ConstValue::Enum(
1015                            crate::corelib::jump_nz_nonzero_variant(db, *ty),
1016                            ConstValue::NonZero(*arg).intern(db),
1017                        )
1018                    }
1019                    .intern(db),
1020                );
1021            } else {
1022                unreachable!(
1023                    "Unexpected extern function in constant lowering: `{}`",
1024                    extern_fn.full_path(db)
1025                );
1026            }
1027        }
1028        let body_id = concrete_function.body(db).ok()??;
1029        let concrete_body_id = body_id.function_with_body_id(db);
1030        let signature = db.function_with_body_signature(concrete_body_id).ok()?;
1031        require(signature.is_const)?;
1032        let generic_substitution = body_id.substitution(db).ok()?;
1033        let body = db.function_body(concrete_body_id).ok()?;
1034        const MAX_CONST_EVAL_DEPTH: usize = 100;
1035        if self.depth > MAX_CONST_EVAL_DEPTH {
1036            return Some(
1037                ConstValue::Missing(self.diagnostics.report(
1038                    expr.stable_ptr,
1039                    SemanticDiagnosticKind::ConstantCalculationDepthExceeded,
1040                ))
1041                .intern(db),
1042            );
1043        }
1044        let mut diagnostics = SemanticDiagnostics::default();
1045        let mut inner = ConstantEvaluateContext {
1046            db,
1047            info: self.info,
1048            arenas: &body.arenas,
1049            vars: signature
1050                .params
1051                .iter()
1052                .map(|p| VarId::Param(p.id))
1053                .zip(args.iter().cloned())
1054                .collect(),
1055            generic_substitution,
1056            depth: self.depth + 1,
1057            diagnostics: &mut diagnostics,
1058        };
1059        let value = inner.evaluate(body.body_expr);
1060        for diagnostic in diagnostics.build().get_all() {
1061            let location = diagnostic.location(db);
1062            let (inner_diag, mut notes) = match diagnostic.kind {
1063                SemanticDiagnosticKind::ConstantCalculationDepthExceeded => {
1064                    self.diagnostics.report(
1065                        expr.stable_ptr,
1066                        SemanticDiagnosticKind::ConstantCalculationDepthExceeded,
1067                    );
1068                    continue;
1069                }
1070                SemanticDiagnosticKind::InnerFailedConstantCalculation(inner_diag, notes) => {
1071                    (inner_diag, notes)
1072                }
1073                _ => (diagnostic.into(), vec![]),
1074            };
1075            notes.push(DiagnosticNote::with_location(
1076                format!("In `{}`", concrete_function.full_path(db)),
1077                location,
1078            ));
1079            self.diagnostics.report(
1080                expr.stable_ptr,
1081                SemanticDiagnosticKind::InnerFailedConstantCalculation(inner_diag, notes),
1082            );
1083        }
1084        Some(value)
1085    }
1086
1087    /// Extract const member access from a const value.
1088    fn evaluate_member_access(&mut self, expr: &ExprMemberAccess<'a>) -> Maybe<ConstValueId<'a>> {
1089        let full_struct = self.evaluate(expr.expr);
1090        let ConstValue::Struct(values, _) = full_struct.long(self.db) else {
1091            // A semantic diagnostic should have been reported.
1092            return Err(skip_diagnostic());
1093        };
1094        let members = self.db.concrete_struct_members(expr.concrete_struct_id)?;
1095        let Some(member_idx) = members.iter().position(|(_, member)| member.id == expr.member)
1096        else {
1097            // A semantic diagnostic should have been reported.
1098            return Err(skip_diagnostic());
1099        };
1100        Ok(values[member_idx])
1101    }
1102
1103    /// Destructures the pattern into the const value of the variables in scope.
1104    fn destructure_pattern(&mut self, pattern_id: PatternId, value: ConstValueId<'a>) {
1105        let pattern = &self.arenas.patterns[pattern_id];
1106        let db = self.db;
1107        match pattern {
1108            Pattern::Literal(_)
1109            | Pattern::StringLiteral(_)
1110            | Pattern::Otherwise(_)
1111            | Pattern::Missing(_) => {}
1112            Pattern::Variable(pattern) => {
1113                self.vars.insert(VarId::Local(pattern.var.id), value);
1114            }
1115            Pattern::Struct(pattern) => {
1116                if let ConstValue::Struct(inner_values, _) = value.long(db) {
1117                    let member_order = match db.concrete_struct_members(pattern.concrete_struct_id)
1118                    {
1119                        Ok(member_order) => member_order,
1120                        Err(_) => return,
1121                    };
1122                    for (member, inner_value) in zip(member_order.values(), inner_values) {
1123                        if let Some((inner_pattern, _)) =
1124                            pattern.field_patterns.iter().find(|(_, field)| member.id == field.id)
1125                        {
1126                            self.destructure_pattern(*inner_pattern, *inner_value);
1127                        }
1128                    }
1129                }
1130            }
1131            Pattern::Tuple(pattern) => {
1132                if let ConstValue::Struct(inner_values, _) = value.long(db) {
1133                    for (inner_pattern, inner_value) in zip(&pattern.field_patterns, inner_values) {
1134                        self.destructure_pattern(*inner_pattern, *inner_value);
1135                    }
1136                }
1137            }
1138            Pattern::FixedSizeArray(pattern) => {
1139                if let ConstValue::Struct(inner_values, _) = value.long(db) {
1140                    for (inner_pattern, inner_value) in
1141                        zip(&pattern.elements_patterns, inner_values)
1142                    {
1143                        self.destructure_pattern(*inner_pattern, *inner_value);
1144                    }
1145                }
1146            }
1147            Pattern::EnumVariant(pattern) => {
1148                if let ConstValue::Enum(variant, inner_value) = value.long(db)
1149                    && pattern.variant == *variant
1150                    && let Some(inner_pattern) = pattern.inner_pattern
1151                {
1152                    self.destructure_pattern(inner_pattern, *inner_value);
1153                }
1154            }
1155        }
1156    }
1157}
1158
1159impl<'db, 'r> std::ops::Deref for ConstantEvaluateContext<'db, 'r, '_> {
1160    type Target = ConstCalcInfo<'db>;
1161    fn deref(&self) -> &Self::Target {
1162        self.info
1163    }
1164}
1165
1166/// Helper for the arguments info.
1167struct NumericArg<'db> {
1168    /// The arg's integer value.
1169    v: BigInt,
1170    /// The arg's type.
1171    ty: TypeId<'db>,
1172}
1173impl<'db> NumericArg<'db> {
1174    fn try_new(db: &'db dyn Database, arg: ConstValueId<'db>) -> Option<Self> {
1175        Some(Self { ty: arg.ty(db).ok()?, v: numeric_arg_value(db, arg)? })
1176    }
1177}
1178
1179/// Helper for creating a `NumericArg` value.
1180/// This includes unwrapping of `NonZero` values and struct of 2 values as a `u256`.
1181fn numeric_arg_value<'db>(db: &'db dyn Database, value: ConstValueId<'db>) -> Option<BigInt> {
1182    match value.long(db) {
1183        ConstValue::Int(value, _) => Some(value.clone()),
1184        ConstValue::Struct(v, _) => {
1185            if let [low, high] = &v[..] {
1186                Some(low.long(db).to_int()? + (high.long(db).to_int()? << 128))
1187            } else {
1188                None
1189            }
1190        }
1191        ConstValue::NonZero(const_value) => numeric_arg_value(db, *const_value),
1192        _ => None,
1193    }
1194}
1195
1196/// Query implementation of [ConstantSemantic::const_calc_info].
1197fn const_calc_info<'db>(db: &'db dyn Database) -> Arc<ConstCalcInfo<'db>> {
1198    Arc::new(ConstCalcInfo::new(db))
1199}
1200
1201/// Implementation of [ConstantSemantic::const_calc_info].
1202#[salsa::tracked]
1203fn const_calc_info_tracked<'db>(db: &'db dyn Database) -> Arc<ConstCalcInfo<'db>> {
1204    const_calc_info(db)
1205}
1206
1207/// Holds static information about extern functions required for const calculations.
1208#[derive(Debug, PartialEq, Eq, salsa::Update)]
1209pub struct ConstCalcInfo<'db> {
1210    /// Traits that are allowed for consts if their impls is in the corelib.
1211    const_traits: UnorderedHashSet<TraitId<'db>>,
1212    /// The const value for the unit type `()`.
1213    unit_const: ConstValueId<'db>,
1214    /// The const value for `true`.
1215    true_const: ConstValueId<'db>,
1216    /// The const value for `false`.
1217    false_const: ConstValueId<'db>,
1218    /// The function for panicking with a felt252.
1219    panic_with_felt252: FunctionId<'db>,
1220    /// The integer `upcast` style functions.
1221    pub upcast_fns: UnorderedHashSet<ExternFunctionId<'db>>,
1222    /// The integer `downcast` style functions, mapping to whether it returns a reversed Option
1223    /// enum.
1224    pub downcast_fns: UnorderedHashMap<ExternFunctionId<'db>, bool>,
1225    /// The `felt252` into `u128` words libfunc.
1226    pub u128s_from_felt252: ExternFunctionId<'db>,
1227    /// The `unwrap_non_zero` function.
1228    unwrap_non_zero: ExternFunctionId<'db>,
1229    /// The `is_zero` style functions.
1230    pub nz_fns: UnorderedHashSet<ExternFunctionId<'db>>,
1231    /// The range of values of a numeric type.
1232    pub type_value_ranges: UnorderedHashMap<TypeId<'db>, TypeRange>,
1233
1234    core_info: Arc<CoreInfo<'db>>,
1235}
1236
1237impl<'db> std::ops::Deref for ConstCalcInfo<'db> {
1238    type Target = CoreInfo<'db>;
1239    fn deref(&self) -> &CoreInfo<'db> {
1240        &self.core_info
1241    }
1242}
1243
1244impl<'db> ConstCalcInfo<'db> {
1245    /// Creates a new ConstCalcInfo.
1246    fn new(db: &'db dyn Database) -> Self {
1247        let core_info = db.core_info();
1248        let unit_const = ConstValue::Struct(vec![], unit_ty(db)).intern(db);
1249        let core = ModuleHelper::core(db);
1250        let bounded_int = core.submodule("internal").submodule("bounded_int");
1251        let integer = core.submodule("integer");
1252        let zeroable = core.submodule("zeroable");
1253        let starknet = core.submodule("starknet");
1254        let class_hash_module = starknet.submodule("class_hash");
1255        let class_hash_ty = class_hash_module.ty("ClassHash", vec![]);
1256        let contract_address_module = starknet.submodule("contract_address");
1257        let contract_address_ty = contract_address_module.ty("ContractAddress", vec![]);
1258        Self {
1259            const_traits: FromIterator::from_iter([
1260                core_info.neg_trt,
1261                core_info.add_trt,
1262                core_info.sub_trt,
1263                core_info.mul_trt,
1264                core_info.div_trt,
1265                core_info.rem_trt,
1266                core_info.div_rem_trt,
1267                core_info.bitand_trt,
1268                core_info.bitor_trt,
1269                core_info.bitxor_trt,
1270                core_info.partialeq_trt,
1271                core_info.partialord_trt,
1272                core_info.not_trt,
1273            ]),
1274            true_const: ConstValue::Enum(true_variant(db), unit_const).intern(db),
1275            false_const: ConstValue::Enum(false_variant(db), unit_const).intern(db),
1276            unit_const,
1277            panic_with_felt252: core.function_id("panic_with_felt252", vec![]),
1278            upcast_fns: FromIterator::from_iter([
1279                bounded_int.extern_function_id("upcast"),
1280                integer.extern_function_id("u8_to_felt252"),
1281                integer.extern_function_id("u16_to_felt252"),
1282                integer.extern_function_id("u32_to_felt252"),
1283                integer.extern_function_id("u64_to_felt252"),
1284                integer.extern_function_id("u128_to_felt252"),
1285                integer.extern_function_id("i8_to_felt252"),
1286                integer.extern_function_id("i16_to_felt252"),
1287                integer.extern_function_id("i32_to_felt252"),
1288                integer.extern_function_id("i64_to_felt252"),
1289                integer.extern_function_id("i128_to_felt252"),
1290                class_hash_module.extern_function_id("class_hash_to_felt252"),
1291                contract_address_module.extern_function_id("contract_address_to_felt252"),
1292            ]),
1293            downcast_fns: FromIterator::from_iter([
1294                (bounded_int.extern_function_id("downcast"), false),
1295                (bounded_int.extern_function_id("bounded_int_trim_min"), true),
1296                (bounded_int.extern_function_id("bounded_int_trim_max"), true),
1297                (integer.extern_function_id("u8_try_from_felt252"), false),
1298                (integer.extern_function_id("u16_try_from_felt252"), false),
1299                (integer.extern_function_id("u32_try_from_felt252"), false),
1300                (integer.extern_function_id("u64_try_from_felt252"), false),
1301                (integer.extern_function_id("i8_try_from_felt252"), false),
1302                (integer.extern_function_id("i16_try_from_felt252"), false),
1303                (integer.extern_function_id("i32_try_from_felt252"), false),
1304                (integer.extern_function_id("i64_try_from_felt252"), false),
1305                (integer.extern_function_id("i128_try_from_felt252"), false),
1306                (class_hash_module.extern_function_id("class_hash_try_from_felt252"), false),
1307                (
1308                    contract_address_module.extern_function_id("contract_address_try_from_felt252"),
1309                    false,
1310                ),
1311            ]),
1312            u128s_from_felt252: integer.extern_function_id("u128s_from_felt252"),
1313            unwrap_non_zero: zeroable.extern_function_id("unwrap_non_zero"),
1314            nz_fns: FromIterator::from_iter([
1315                core.extern_function_id("felt252_is_zero"),
1316                bounded_int.extern_function_id("bounded_int_is_zero"),
1317                integer.extern_function_id("u8_is_zero"),
1318                integer.extern_function_id("u16_is_zero"),
1319                integer.extern_function_id("u32_is_zero"),
1320                integer.extern_function_id("u64_is_zero"),
1321                integer.extern_function_id("u128_is_zero"),
1322                integer.extern_function_id("u256_is_zero"),
1323            ]),
1324            type_value_ranges: FromIterator::from_iter([
1325                (core_info.u8, TypeRange::new(u8::MIN, u8::MAX)),
1326                (core_info.u16, TypeRange::new(u16::MIN, u16::MAX)),
1327                (core_info.u32, TypeRange::new(u32::MIN, u32::MAX)),
1328                (core_info.u64, TypeRange::new(u64::MIN, u64::MAX)),
1329                (core_info.u128, TypeRange::new(u128::MIN, u128::MAX)),
1330                (core_info.u256, TypeRange::new(BigInt::ZERO, BigInt::from(1) << 256)),
1331                (core_info.i8, TypeRange::new(i8::MIN, i8::MAX)),
1332                (core_info.i16, TypeRange::new(i16::MIN, i16::MAX)),
1333                (core_info.i32, TypeRange::new(i32::MIN, i32::MAX)),
1334                (core_info.i64, TypeRange::new(i64::MIN, i64::MAX)),
1335                (core_info.i128, TypeRange::new(i128::MIN, i128::MAX)),
1336                (class_hash_ty, TypeRange::new(BigInt::ZERO, BigInt::from(1) << 251)),
1337                (contract_address_ty, TypeRange::new(BigInt::ZERO, BigInt::from(1) << 251)),
1338            ]),
1339            core_info,
1340        }
1341    }
1342}
1343
1344/// Trait for constant-related semantic queries.
1345pub trait ConstantSemantic<'db>: Database {
1346    /// Returns the semantic diagnostics of a constant definition.
1347    fn constant_semantic_diagnostics(
1348        &'db self,
1349        const_id: ConstantId<'db>,
1350    ) -> Diagnostics<'db, SemanticDiagnostic<'db>> {
1351        let db = self.as_dyn_database();
1352        constant_semantic_data(db, const_id, false)
1353            .as_ref()
1354            .map(|data| data.diagnostics.clone())
1355            .unwrap_or_default()
1356    }
1357    /// Returns the semantic data of a constant definition.
1358    fn constant_semantic_data(&'db self, use_id: ConstantId<'db>) -> Maybe<Constant<'db>> {
1359        let db = self.as_dyn_database();
1360        constant_semantic_data(db, use_id, false).maybe_as_ref()?.constant.clone()
1361    }
1362    /// Returns the resolver data of a constant definition.
1363    fn constant_resolver_data(&'db self, use_id: ConstantId<'db>) -> Maybe<Arc<ResolverData<'db>>> {
1364        let db = self.as_dyn_database();
1365        Ok(constant_semantic_data(db, use_id, false).maybe_as_ref()?.resolver_data.clone())
1366    }
1367    /// Returns the const value of a constant definition.
1368    fn constant_const_value(&'db self, const_id: ConstantId<'db>) -> Maybe<ConstValueId<'db>> {
1369        let db = self.as_dyn_database();
1370        Ok(constant_semantic_data(db, const_id, false).maybe_as_ref()?.const_value)
1371    }
1372    /// Returns information required for const calculations.
1373    fn const_calc_info(&'db self) -> Arc<ConstCalcInfo<'db>> {
1374        const_calc_info_tracked(self.as_dyn_database())
1375    }
1376}
1377impl<'db, T: Database + ?Sized> ConstantSemantic<'db> for T {}
1378
1379/// A range of values of a numeric type.
1380#[derive(Clone, Debug, PartialEq, Eq, salsa::Update)]
1381pub struct TypeRange {
1382    /// The minimum value of the range.
1383    pub min: BigInt,
1384    /// The maximum value of the range.
1385    pub max: BigInt,
1386}
1387impl TypeRange {
1388    pub fn new(min: impl Into<BigInt>, max: impl Into<BigInt>) -> Self {
1389        Self { min: min.into(), max: max.into() }
1390    }
1391}