cairo_lang_compiler/
db.rs

1use std::sync::Arc;
2
3use anyhow::{Result, anyhow, bail};
4use cairo_lang_defs::db::{DefsDatabase, DefsGroup, try_ext_as_virtual_impl};
5use cairo_lang_defs::plugin::{InlineMacroExprPlugin, MacroPlugin};
6use cairo_lang_filesystem::cfg::CfgSet;
7use cairo_lang_filesystem::db::{
8    AsFilesGroupMut, CORELIB_VERSION, ExternalFiles, FilesDatabase, FilesGroup, FilesGroupEx,
9    init_dev_corelib, init_files_group,
10};
11use cairo_lang_filesystem::detect::detect_corelib;
12use cairo_lang_filesystem::flag::Flag;
13use cairo_lang_filesystem::ids::{CrateId, FlagId, VirtualFile};
14use cairo_lang_lowering::db::{LoweringDatabase, LoweringGroup, init_lowering_group};
15use cairo_lang_parser::db::{ParserDatabase, ParserGroup};
16use cairo_lang_project::ProjectConfig;
17use cairo_lang_semantic::db::{SemanticDatabase, SemanticGroup};
18use cairo_lang_semantic::inline_macros::get_default_plugin_suite;
19use cairo_lang_semantic::plugin::{AnalyzerPlugin, PluginSuite};
20use cairo_lang_sierra_generator::db::SierraGenDatabase;
21use cairo_lang_syntax::node::db::{SyntaxDatabase, SyntaxGroup};
22use cairo_lang_utils::Upcast;
23use cairo_lang_utils::ordered_hash_map::OrderedHashMap;
24
25use crate::InliningStrategy;
26use crate::project::update_crate_roots_from_project_config;
27
28#[salsa::database(
29    DefsDatabase,
30    FilesDatabase,
31    LoweringDatabase,
32    ParserDatabase,
33    SemanticDatabase,
34    SierraGenDatabase,
35    SyntaxDatabase
36)]
37pub struct RootDatabase {
38    storage: salsa::Storage<RootDatabase>,
39}
40impl salsa::Database for RootDatabase {}
41impl ExternalFiles for RootDatabase {
42    fn try_ext_as_virtual(&self, external_id: salsa::InternId) -> Option<VirtualFile> {
43        try_ext_as_virtual_impl(self.upcast(), external_id)
44    }
45}
46impl salsa::ParallelDatabase for RootDatabase {
47    fn snapshot(&self) -> salsa::Snapshot<RootDatabase> {
48        salsa::Snapshot::new(RootDatabase { storage: self.storage.snapshot() })
49    }
50}
51impl RootDatabase {
52    fn new(
53        plugins: Vec<Arc<dyn MacroPlugin>>,
54        inline_macro_plugins: OrderedHashMap<String, Arc<dyn InlineMacroExprPlugin>>,
55        analyzer_plugins: Vec<Arc<dyn AnalyzerPlugin>>,
56        inlining_strategy: InliningStrategy,
57    ) -> Self {
58        let mut res = Self { storage: Default::default() };
59        init_files_group(&mut res);
60        init_lowering_group(&mut res, inlining_strategy);
61        res.set_macro_plugins(plugins);
62        res.set_inline_macro_plugins(inline_macro_plugins.into());
63        res.set_analyzer_plugins(analyzer_plugins);
64        res
65    }
66
67    pub fn empty() -> Self {
68        Self::builder().clear_plugins().build().unwrap()
69    }
70
71    pub fn builder() -> RootDatabaseBuilder {
72        RootDatabaseBuilder::new()
73    }
74
75    /// Snapshots the db for read only.
76    pub fn snapshot(&self) -> RootDatabase {
77        RootDatabase { storage: self.storage.snapshot() }
78    }
79}
80
81impl Default for RootDatabase {
82    fn default() -> Self {
83        Self::builder().build().unwrap()
84    }
85}
86
87#[derive(Clone, Debug)]
88pub struct RootDatabaseBuilder {
89    plugin_suite: PluginSuite,
90    detect_corelib: bool,
91    auto_withdraw_gas: bool,
92    project_config: Option<Box<ProjectConfig>>,
93    cfg_set: Option<CfgSet>,
94    inlining_strategy: InliningStrategy,
95}
96
97impl RootDatabaseBuilder {
98    fn new() -> Self {
99        Self {
100            plugin_suite: get_default_plugin_suite(),
101            detect_corelib: false,
102            auto_withdraw_gas: true,
103            project_config: None,
104            cfg_set: None,
105            inlining_strategy: InliningStrategy::Default,
106        }
107    }
108
109    pub fn with_plugin_suite(&mut self, suite: PluginSuite) -> &mut Self {
110        self.plugin_suite.add(suite);
111        self
112    }
113
114    pub fn clear_plugins(&mut self) -> &mut Self {
115        self.plugin_suite = get_default_plugin_suite();
116        self
117    }
118
119    pub fn with_inlining_strategy(&mut self, inlining_strategy: InliningStrategy) -> &mut Self {
120        self.inlining_strategy = inlining_strategy;
121        self
122    }
123
124    pub fn detect_corelib(&mut self) -> &mut Self {
125        self.detect_corelib = true;
126        self
127    }
128
129    pub fn with_project_config(&mut self, config: ProjectConfig) -> &mut Self {
130        self.project_config = Some(Box::new(config));
131        self
132    }
133
134    pub fn with_cfg(&mut self, cfg_set: impl Into<CfgSet>) -> &mut Self {
135        self.cfg_set = Some(cfg_set.into());
136        self
137    }
138
139    pub fn skip_auto_withdraw_gas(&mut self) -> &mut Self {
140        self.auto_withdraw_gas = false;
141        self
142    }
143
144    pub fn build(&mut self) -> Result<RootDatabase> {
145        // NOTE: Order of operations matters here!
146        //   Errors if something is not OK are very subtle, mostly this results in missing
147        //   identifier diagnostics, or panics regarding lack of corelib items.
148
149        let mut db = RootDatabase::new(
150            self.plugin_suite.plugins.clone(),
151            self.plugin_suite.inline_macro_plugins.clone(),
152            self.plugin_suite.analyzer_plugins.clone(),
153            self.inlining_strategy,
154        );
155
156        if let Some(cfg_set) = &self.cfg_set {
157            db.use_cfg(cfg_set);
158        }
159
160        if self.detect_corelib {
161            let path =
162                detect_corelib().ok_or_else(|| anyhow!("Failed to find development corelib."))?;
163            init_dev_corelib(&mut db, path)
164        }
165
166        let add_withdraw_gas_flag_id = FlagId::new(db.upcast(), "add_withdraw_gas");
167        db.set_flag(
168            add_withdraw_gas_flag_id,
169            Some(Arc::new(Flag::AddWithdrawGas(self.auto_withdraw_gas))),
170        );
171
172        if let Some(config) = &self.project_config {
173            update_crate_roots_from_project_config(&mut db, config.as_ref());
174        }
175        validate_corelib(&db)?;
176
177        Ok(db)
178    }
179}
180
181/// Validates that the corelib version matches the expected one.
182pub fn validate_corelib(db: &(dyn FilesGroup + 'static)) -> Result<()> {
183    let Some(config) = db.crate_config(CrateId::core(db)) else {
184        return Ok(());
185    };
186    let Some(found) = config.settings.version else {
187        return Ok(());
188    };
189    let Ok(expected) = semver::Version::parse(CORELIB_VERSION) else {
190        return Ok(());
191    };
192    if found == expected {
193        return Ok(());
194    }
195    let path_part = match config.root {
196        cairo_lang_filesystem::ids::Directory::Real(path) => {
197            format!(" for `{}`", path.to_string_lossy())
198        }
199        cairo_lang_filesystem::ids::Directory::Virtual { .. } => "".to_string(),
200    };
201    bail!("Corelib version mismatch: expected `{expected}`, found `{found}`{path_part}.");
202}
203
204impl AsFilesGroupMut for RootDatabase {
205    fn as_files_group_mut(&mut self) -> &mut (dyn FilesGroup + 'static) {
206        self
207    }
208}
209impl Upcast<dyn FilesGroup> for RootDatabase {
210    fn upcast(&self) -> &(dyn FilesGroup + 'static) {
211        self
212    }
213}
214impl Upcast<dyn SyntaxGroup> for RootDatabase {
215    fn upcast(&self) -> &(dyn SyntaxGroup + 'static) {
216        self
217    }
218}
219impl Upcast<dyn DefsGroup> for RootDatabase {
220    fn upcast(&self) -> &(dyn DefsGroup + 'static) {
221        self
222    }
223}
224impl Upcast<dyn SemanticGroup> for RootDatabase {
225    fn upcast(&self) -> &(dyn SemanticGroup + 'static) {
226        self
227    }
228}
229impl Upcast<dyn LoweringGroup> for RootDatabase {
230    fn upcast(&self) -> &(dyn LoweringGroup + 'static) {
231        self
232    }
233}
234impl Upcast<dyn ParserGroup> for RootDatabase {
235    fn upcast(&self) -> &(dyn ParserGroup + 'static) {
236        self
237    }
238}
cairo_lang_compiler/db.rs

cairo_lang_compiler/
db.rs
