miden_assembly_syntax/parser/
mod.rs

1/// Simple macro used in the grammar definition for constructing spans
2macro_rules! span {
3    ($id:expr, $l:expr, $r:expr) => {
4        ::miden_debug_types::SourceSpan::new($id, $l..$r)
5    };
6    ($id:expr, $i:expr) => {
7        ::miden_debug_types::SourceSpan::at($id, $i)
8    };
9}
10
11lalrpop_util::lalrpop_mod!(
12    #[allow(clippy::all)]
13    grammar,
14    "/parser/grammar.rs"
15);
16
17mod error;
18mod lexer;
19mod scanner;
20mod token;
21
22use alloc::{boxed::Box, collections::BTreeSet, string::ToString, sync::Arc, vec::Vec};
23
24use miden_debug_types::{SourceFile, SourceLanguage, SourceManager, Uri};
25use miden_utils_diagnostics::Report;
26
27pub use self::{
28    error::{BinErrorKind, HexErrorKind, LiteralErrorKind, ParsingError},
29    lexer::Lexer,
30    scanner::Scanner,
31    token::{BinEncodedValue, DocumentationType, IntValue, Token, WordValue},
32};
33use crate::{LibraryPath, ast, sema};
34
35// TYPE ALIASES
36// ================================================================================================
37
38type ParseError<'a> = lalrpop_util::ParseError<u32, Token<'a>, ParsingError>;
39
40// MODULE PARSER
41// ================================================================================================
42
43/// This is a wrapper around the lower-level parser infrastructure which handles orchestrating all
44/// of the pieces needed to parse a [ast::Module] from source, and run semantic analysis on it.
45#[derive(Default)]
46pub struct ModuleParser {
47    /// The kind of module we're parsing.
48    ///
49    /// This is used when performing semantic analysis to detect when various invalid constructions
50    /// are encountered, such as use of the `syscall` instruction in a kernel module.
51    kind: ast::ModuleKind,
52    /// A set of interned strings allocated during parsing/semantic analysis.
53    ///
54    /// This is a very primitive and imprecise way of interning strings, but was the least invasive
55    /// at the time the new parser was implemented. In essence, we avoid duplicating allocations
56    /// for frequently occurring strings, by tracking which strings we've seen before, and
57    /// sharing a reference counted pointer instead.
58    ///
59    /// We may want to replace this eventually with a proper interner, so that we can also gain the
60    /// benefits commonly provided by interned string handles (e.g. cheap equality comparisons, no
61    /// ref- counting overhead, copyable and of smaller size).
62    ///
63    /// Note that [Ident], [ProcedureName], [LibraryPath] and others are all implemented in terms
64    /// of either the actual reference-counted string, e.g. `Arc<str>`, or in terms of [Ident],
65    /// which is essentially the former wrapped in a [SourceSpan]. If we ever replace this with
66    /// a better interner, we will also want to update those types to be in terms of whatever
67    /// the handle type of the interner is.
68    interned: BTreeSet<Arc<str>>,
69    /// When true, all warning diagnostics are promoted to error severity
70    warnings_as_errors: bool,
71}
72
73impl ModuleParser {
74    /// Construct a new parser for the given `kind` of [ast::Module].
75    pub fn new(kind: ast::ModuleKind) -> Self {
76        Self {
77            kind,
78            interned: Default::default(),
79            warnings_as_errors: false,
80        }
81    }
82
83    /// Configure this parser so that any warning diagnostics are promoted to errors.
84    pub fn set_warnings_as_errors(&mut self, yes: bool) {
85        self.warnings_as_errors = yes;
86    }
87
88    /// Parse a [ast::Module] from `source`, and give it the provided `path`.
89    pub fn parse(
90        &mut self,
91        path: LibraryPath,
92        source: Arc<SourceFile>,
93    ) -> Result<Box<ast::Module>, Report> {
94        let forms = parse_forms_internal(source.clone(), &mut self.interned)
95            .map_err(|err| Report::new(err).with_source_code(source.clone()))?;
96        sema::analyze(source, self.kind, path, forms, self.warnings_as_errors).map_err(Report::new)
97    }
98
99    /// Parse a [ast::Module], `name`, from `path`.
100    #[cfg(feature = "std")]
101    pub fn parse_file<P>(
102        &mut self,
103        name: LibraryPath,
104        path: P,
105        source_manager: &dyn SourceManager,
106    ) -> Result<Box<ast::Module>, Report>
107    where
108        P: AsRef<std::path::Path>,
109    {
110        use miden_debug_types::SourceManagerExt;
111        use miden_utils_diagnostics::{IntoDiagnostic, WrapErr};
112
113        let path = path.as_ref();
114        let source_file = source_manager
115            .load_file(path)
116            .into_diagnostic()
117            .wrap_err_with(|| format!("failed to load source file from '{}'", path.display()))?;
118        self.parse(name, source_file)
119    }
120
121    /// Parse a [ast::Module], `name`, from `source`.
122    pub fn parse_str(
123        &mut self,
124        name: LibraryPath,
125        source: impl ToString,
126        source_manager: &dyn SourceManager,
127    ) -> Result<Box<ast::Module>, Report> {
128        use miden_debug_types::SourceContent;
129
130        let uri = Uri::from(name.path().into_owned().into_boxed_str());
131        let content = SourceContent::new(
132            SourceLanguage::Masm,
133            uri.clone(),
134            source.to_string().into_boxed_str(),
135        );
136        let source_file = source_manager.load_from_raw_parts(uri, content);
137        self.parse(name, source_file)
138    }
139}
140
141/// This is used in tests to parse `source` as a set of raw [ast::Form]s rather than as a
142/// [ast::Module].
143///
144/// NOTE: This does _not_ run semantic analysis.
145#[cfg(any(test, feature = "testing"))]
146pub fn parse_forms(source: Arc<SourceFile>) -> Result<Vec<ast::Form>, ParsingError> {
147    let mut interned = BTreeSet::default();
148    parse_forms_internal(source, &mut interned)
149}
150
151/// Parse `source` as a set of [ast::Form]s
152///
153/// Aside from catching syntax errors, this does little validation of the resulting forms, that is
154/// handled by semantic analysis, which the caller is expected to perform next.
155fn parse_forms_internal(
156    source: Arc<SourceFile>,
157    interned: &mut BTreeSet<Arc<str>>,
158) -> Result<Vec<ast::Form>, ParsingError> {
159    let source_id = source.id();
160    let scanner = Scanner::new(source.as_str());
161    let lexer = Lexer::new(source_id, scanner);
162    grammar::FormsParser::new()
163        .parse(&source, interned, core::marker::PhantomData, lexer)
164        .map_err(|err| ParsingError::from_parse_error(source_id, err))
165}
166
167// DIRECTORY PARSER
168// ================================================================================================
169
170/// Read the contents (modules) of this library from `dir`, returning any errors that occur
171/// while traversing the file system.
172///
173/// Errors may also be returned if traversal discovers issues with the modules, such as
174/// invalid names, etc.
175///
176/// Returns an iterator over all parsed modules.
177#[cfg(feature = "std")]
178pub fn read_modules_from_dir(
179    namespace: crate::LibraryNamespace,
180    dir: impl AsRef<std::path::Path>,
181    source_manager: &dyn SourceManager,
182) -> Result<impl Iterator<Item = Box<ast::Module>>, Report> {
183    use std::collections::{BTreeMap, btree_map::Entry};
184
185    use miden_utils_diagnostics::{IntoDiagnostic, WrapErr, report};
186    use module_walker::{ModuleEntry, WalkModules};
187
188    let dir = dir.as_ref();
189    if !dir.is_dir() {
190        return Err(report!("the provided path '{}' is not a valid directory", dir.display()));
191    }
192
193    // mod.masm is not allowed in the root directory
194    if dir.join(ast::Module::ROOT_FILENAME).exists() {
195        return Err(report!("{} is not allowed in the root directory", ast::Module::ROOT_FILENAME));
196    }
197
198    let mut modules = BTreeMap::default();
199
200    let walker = WalkModules::new(namespace.clone(), dir)
201        .into_diagnostic()
202        .wrap_err_with(|| format!("failed to load modules from '{}'", dir.display()))?;
203    for entry in walker {
204        let ModuleEntry { mut name, source_path } = entry?;
205        if name.last() == ast::Module::ROOT {
206            name.pop();
207        }
208
209        // Parse module at the given path
210        let mut parser = ModuleParser::new(ast::ModuleKind::Library);
211        let ast = parser.parse_file(name.clone(), &source_path, source_manager)?;
212        match modules.entry(name) {
213            Entry::Occupied(ref entry) => {
214                return Err(report!("duplicate module '{0}'", entry.key().clone()));
215            },
216            Entry::Vacant(entry) => {
217                entry.insert(ast);
218            },
219        }
220    }
221
222    Ok(modules.into_values())
223}
224
225#[cfg(feature = "std")]
226mod module_walker {
227    use std::{
228        ffi::OsStr,
229        fs::{self, DirEntry, FileType},
230        io,
231        path::{Path, PathBuf},
232    };
233
234    use miden_utils_diagnostics::{IntoDiagnostic, Report, report};
235
236    use crate::{LibraryNamespace, LibraryPath, ast::Module};
237
238    pub struct ModuleEntry {
239        pub name: LibraryPath,
240        pub source_path: PathBuf,
241    }
242
243    pub struct WalkModules<'a> {
244        namespace: LibraryNamespace,
245        root: &'a Path,
246        stack: alloc::collections::VecDeque<io::Result<DirEntry>>,
247    }
248
249    impl<'a> WalkModules<'a> {
250        pub fn new(namespace: LibraryNamespace, path: &'a Path) -> io::Result<Self> {
251            use alloc::collections::VecDeque;
252
253            let stack = VecDeque::from_iter(fs::read_dir(path)?);
254
255            Ok(Self { namespace, root: path, stack })
256        }
257
258        fn next_entry(
259            &mut self,
260            entry: &DirEntry,
261            ty: &FileType,
262        ) -> Result<Option<ModuleEntry>, Report> {
263            if ty.is_dir() {
264                let dir = entry.path();
265                self.stack.extend(fs::read_dir(dir).into_diagnostic()?);
266                return Ok(None);
267            }
268
269            let mut file_path = entry.path();
270            let is_module = file_path
271                .extension()
272                .map(|ext| ext == AsRef::<OsStr>::as_ref(Module::FILE_EXTENSION))
273                .unwrap_or(false);
274            if !is_module {
275                return Ok(None);
276            }
277
278            // Remove the file extension and the root prefix, leaving a namespace-relative path
279            file_path.set_extension("");
280            if file_path.is_dir() {
281                return Err(report!(
282                    "file and directory with same name are not allowed: {}",
283                    file_path.display()
284                ));
285            }
286            let relative_path = file_path
287                .strip_prefix(self.root)
288                .expect("expected path to be a child of the root directory");
289
290            // Construct a [LibraryPath] from the path components, after validating them
291            let mut libpath = LibraryPath::from(self.namespace.clone());
292            for component in relative_path.iter() {
293                let component = component.to_str().ok_or_else(|| {
294                    let p = entry.path();
295                    report!("{} is an invalid directory entry", p.display())
296                })?;
297                libpath.push(component).into_diagnostic()?;
298            }
299            Ok(Some(ModuleEntry { name: libpath, source_path: entry.path() }))
300        }
301    }
302
303    impl Iterator for WalkModules<'_> {
304        type Item = Result<ModuleEntry, Report>;
305
306        fn next(&mut self) -> Option<Self::Item> {
307            loop {
308                let entry = self
309                    .stack
310                    .pop_front()?
311                    .and_then(|entry| entry.file_type().map(|ft| (entry, ft)))
312                    .into_diagnostic();
313
314                match entry {
315                    Ok((ref entry, ref file_type)) => {
316                        match self.next_entry(entry, file_type).transpose() {
317                            None => continue,
318                            result => break result,
319                        }
320                    },
321                    Err(err) => break Some(Err(err)),
322                }
323            }
324        }
325    }
326}
327
328// TESTS
329// ================================================================================================
330
331#[cfg(test)]
332mod tests {
333    use miden_core::assert_matches;
334    use miden_debug_types::SourceId;
335
336    use super::*;
337
338    // This test checks the lexer behavior with regard to tokenizing `exp(.u?[\d]+)?`
339    #[test]
340    fn lex_exp() {
341        let source_id = SourceId::default();
342        let scanner = Scanner::new("begin exp.u9 end");
343        let mut lexer = Lexer::new(source_id, scanner).map(|result| result.map(|(_, t, _)| t));
344        assert_matches!(lexer.next(), Some(Ok(Token::Begin)));
345        assert_matches!(lexer.next(), Some(Ok(Token::ExpU)));
346        assert_matches!(lexer.next(), Some(Ok(Token::Int(n))) if n == 9);
347        assert_matches!(lexer.next(), Some(Ok(Token::End)));
348    }
349
350    #[test]
351    fn lex_block() {
352        let source_id = SourceId::default();
353        let scanner = Scanner::new(
354            "\
355const.ERR1=1
356
357begin
358    u32assertw
359    u32assertw.err=ERR1
360    u32assertw.err=2
361end
362",
363        );
364        let mut lexer = Lexer::new(source_id, scanner).map(|result| result.map(|(_, t, _)| t));
365        assert_matches!(lexer.next(), Some(Ok(Token::Const)));
366        assert_matches!(lexer.next(), Some(Ok(Token::Dot)));
367        assert_matches!(lexer.next(), Some(Ok(Token::ConstantIdent("ERR1"))));
368        assert_matches!(lexer.next(), Some(Ok(Token::Equal)));
369        assert_matches!(lexer.next(), Some(Ok(Token::Int(1))));
370        assert_matches!(lexer.next(), Some(Ok(Token::Begin)));
371        assert_matches!(lexer.next(), Some(Ok(Token::U32Assertw)));
372        assert_matches!(lexer.next(), Some(Ok(Token::U32Assertw)));
373        assert_matches!(lexer.next(), Some(Ok(Token::Dot)));
374        assert_matches!(lexer.next(), Some(Ok(Token::Err)));
375        assert_matches!(lexer.next(), Some(Ok(Token::Equal)));
376        assert_matches!(lexer.next(), Some(Ok(Token::ConstantIdent("ERR1"))));
377        assert_matches!(lexer.next(), Some(Ok(Token::U32Assertw)));
378        assert_matches!(lexer.next(), Some(Ok(Token::Dot)));
379        assert_matches!(lexer.next(), Some(Ok(Token::Err)));
380        assert_matches!(lexer.next(), Some(Ok(Token::Equal)));
381        assert_matches!(lexer.next(), Some(Ok(Token::Int(2))));
382        assert_matches!(lexer.next(), Some(Ok(Token::End)));
383        assert_matches!(lexer.next(), Some(Ok(Token::Eof)));
384    }
385
386    #[test]
387    fn lex_emit() {
388        let source_id = SourceId::default();
389        let scanner = Scanner::new(
390            "\
391begin
392    push.1
393    emit.1
394end
395",
396        );
397        let mut lexer = Lexer::new(source_id, scanner).map(|result| result.map(|(_, t, _)| t));
398        assert_matches!(lexer.next(), Some(Ok(Token::Begin)));
399        assert_matches!(lexer.next(), Some(Ok(Token::Push)));
400        assert_matches!(lexer.next(), Some(Ok(Token::Dot)));
401        assert_matches!(lexer.next(), Some(Ok(Token::Int(1))));
402        assert_matches!(lexer.next(), Some(Ok(Token::Emit)));
403        assert_matches!(lexer.next(), Some(Ok(Token::Dot)));
404        assert_matches!(lexer.next(), Some(Ok(Token::Int(1))));
405        assert_matches!(lexer.next(), Some(Ok(Token::End)));
406        assert_matches!(lexer.next(), Some(Ok(Token::Eof)));
407    }
408}
miden_assembly_syntax/parser/mod.rs

miden_assembly_syntax/parser/
mod.rs
