add some debug info for includes and library resolution

trailofbits · Apr 4, 2024 · c946bf3 · c946bf3
1 parent c4bb707
commit c946bf3
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 6 deletions.
diff --git a/parser/src/include_logic.rs b/parser/src/include_logic.rs
@@ -1,5 +1,7 @@
 use crate::errors::FileOsError;
 
+use log::debug;
+
 use super::errors::IncludeError;
 use program_structure::ast::Include;
 use program_structure::report::{Report, ReportCollection};
@@ -85,9 +87,10 @@ impl FileStack {
     pub fn add_include(&mut self, include: &Include) -> Result<(), Box<Report>> {
         let mut location = self.current_location.clone().expect("parsing file");
         location.push(include.path.clone());
-        match fs::canonicalize(location) {
+        match fs::canonicalize(&location) {
             Ok(path) => {
                 if !self.black_paths.contains(&path) {
+                    debug!("adding local or absolute include `{}`", location.display());
                     self.stack.push(path);
                 }
                 Ok(())
@@ -108,18 +111,22 @@ impl FileStack {
                 }
 
                 let libpath = lib.path.join(&include.path);
+                debug!("searching for `{}` in `{}`", include.path, lib.path.display());
                 if fs::canonicalize(&libpath).is_ok() {
+                    debug!("adding include `{}` from directory", libpath.display());
                     self.stack.push(libpath);
                     return Ok(());
                 }
             } else {
                 // only match include paths with a single component i.e. lib.circom and not dir/lib.circom or
                 // ./lib.circom
-                if include.path.find(std::path::MAIN_SEPARATOR) == None
-                    && lib.path.file_name().expect("good library file") == pathos
-                {
-                    self.stack.push(lib.path.clone());
-                    return Ok(());
+                if include.path.find(std::path::MAIN_SEPARATOR) == None {
+                    debug!("checking if `{}` matches `{}`", include.path, lib.path.display());
+                    if lib.path.file_name().expect("good library file") == pathos {
+                        debug!("adding include `{}` from file", lib.path.display());
+                        self.stack.push(lib.path.clone());
+                        return Ok(());
+                    }
                 }
             }
         }

diff --git a/parser/src/lib.rs b/parser/src/lib.rs
@@ -52,6 +52,11 @@ pub fn parse_files(
                 if let Some(main_component) = program.main_component {
                     main_components.push((file_id, main_component, program.custom_gates));
                 }
+                debug!(
+                    "adding {} definitions from `{}`",
+                    program.definitions.iter().map(|x| x.name()).collect::<Vec<_>>().join(", "),
+                    file_path.display(),
+                );
                 definitions.insert(file_id, program.definitions);
                 reports.append(&mut warnings);
             }

diff --git a/program_structure/src/abstract_syntax_tree/ast.rs b/program_structure/src/abstract_syntax_tree/ast.rs
@@ -161,6 +161,15 @@ pub fn build_function(
     Definition::Function { meta, name, args, arg_location, body }
 }
 
+impl Definition {
+    pub fn name(&self) -> String {
+        match self {
+            Self::Template { name, .. } => name.clone(),
+            Self::Function { name, .. } => name.clone(),
+        }
+    }
+}
+
 #[derive(Clone)]
 pub enum Statement {
     IfThenElse {