Address PR comments

Author: Carolyn Zech

tests/script-based-pre/tool-scanner/scanner-test.expected

@@ -1,6 +1,7 @@
 5 test_scan_fn_loops.csv
 20 test_scan_functions.csv
 5 test_scan_input_tys.csv
-16 test_scan_overall.csv
+17 test_scan_overall.csv
 3 test_scan_recursion.csv
+9 test_scan_unsafe_distance.csv
 6 test_scan_unsafe_ops.csv

tests/script-based-pre/tool-scanner/scanner-test.sh

@@ -17,4 +17,4 @@ cargo run -p scanner test.rs --crate-type lib
 wc -l *csv
 
 popd
-#rm -rf ${OUT_DIR}
+rm -rf ${OUT_DIR}

tests/script-based-pre/tool-scanner/test.rs

@@ -14,11 +14,6 @@ pub fn generic<T: Default>() -> T {
     T::default()
 }
 
-pub fn blah() {
-    ok();
-    assert_eq!(u8::default(), 0);
-}
-
 pub struct RecursiveType {
     pub inner: Option<*const RecursiveType>,
 }
@@ -112,6 +107,7 @@ extern "C" {
     fn external_function();
 }
 
+/// Ensure scanner finds unsafe calls to external functions.
 pub fn call_external() {
     unsafe { external_function() };
 }

tools/scanner/src/analysis.rs

@@ -1,7 +1,7 @@
 // Copyright Kani Contributors
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
-//! Provide different static analysis to be performed in the crate under compilation
+//! Provide passes that perform intra-function analysis on the crate under compilation
 
 use crate::info;
 use csv::WriterBuilder;
@@ -253,11 +253,11 @@ macro_rules! fn_props {
         }
 
         impl $name {
-            pub const fn num_props() -> usize {
+            $vis const fn num_props() -> usize {
                 [$(stringify!($prop),)+].len()
             }
 
-            pub fn new(fn_name: String) -> Self {
+            $vis fn new(fn_name: String) -> Self {
                 Self { fn_name, $($prop: 0,)+}
             }
         }

tools/scanner/src/call_graph.rs

@@ -1,7 +1,11 @@
 // Copyright Kani Contributors
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
-//! Provide different static analysis to be performed in the call graph
+//! Provide passes that perform inter-function analysis on the crate under compilation.
+//!
+//! This module also includes a `CallGraph` structure to help the analysis.
+//! For now, we build the CallGraph as part of the pass, but as we add more analysis,
+//! the call-graph could be reused by different analysis.
 
 use crate::analysis::{FnCallVisitor, FnUnsafeOperations, OverallStats};
 use stable_mir::mir::{MirVisitor, Safety};