feat: replace func string with SourceCode

Each function can contain two kinds of source code.

close #31

Author: zjp-CN

src/functions/serialization.rs

@@ -1,4 +1,4 @@
-use super::utils;
+use super::utils::{self, SourceCode};
 use rustc_middle::ty::TyCtxt;
 use rustc_span::source_map::SourceMap;
 use rustc_stable_hash::{FromStableHash, SipHasher128Hash, StableHasher, hashers::SipHasher128};
@@ -19,7 +19,7 @@ pub struct SerFunction {
     /// and function must be separated to query.
     attrs: Vec<String>,
     /// Raw function string, including name, signature, and body.
-    func: String,
+    func: SourceCode,
     /// Recursive function calls inside the proof.
     callees: Vec<Callee>,
 }
@@ -37,13 +37,13 @@ impl SerFunction {
         // Hash
         let mut hasher = StableHasher::<SipHasher128>::new();
         hasher.write_str(&file);
-        hasher.write_str(&func);
+        func.with_hasher(&mut hasher);
         hasher.write_length_prefix(attrs.len());
         attrs.iter().for_each(|a| hasher.write_str(a));
         hasher.write_length_prefix(callees.len());
         callees.iter().for_each(|c| {
             hasher.write_str(&c.file);
-            hasher.write_str(&c.func);
+            c.func.with_hasher(&mut hasher);
         });
         let Hash128(hash) = hasher.finish();
 
@@ -52,7 +52,7 @@ impl SerFunction {
 
     /// Compare by file and func string.
     pub fn cmp_by_file_and_func(&self, other: &Self) -> Ordering {
-        (&*self.file, &*self.func).cmp(&(&*other.file, &*other.func))
+        (&*self.file, &self.func).cmp(&(&*other.file, &other.func))
     }
 }
 
@@ -76,7 +76,7 @@ fn format_def_id(inst: &Instance) -> String {
 pub struct Callee {
     def_id: String,
     file: String,
-    func: String,
+    func: SourceCode,
 }
 
 impl Callee {

src/functions/utils.rs

@@ -1,23 +1,43 @@
 use rustc_middle::ty::TyCtxt;
 use rustc_smir::rustc_internal::internal;
 use rustc_span::{Span, source_map::SourceMap};
+use rustc_stable_hash::{StableHasher, hashers::SipHasher128};
+use serde::Serialize;
 use stable_mir::{CrateDef, mir::mono::Instance};
-use std::cmp::Ordering;
+use std::{cmp::Ordering, hash::Hasher};
 
-/// Source code for a span.
-fn source_code(span: Span, src_map: &SourceMap) -> String {
-    // println!("{span:?}\n{:?}\n\n", span.find_oldest_ancestor_in_same_ctxt());
-    // _ = src_map.span_to_source(span, |text, x, y| {
-    //     println!("(stable_mir span to internal span) [{span:?}]\n{}", &text[x..y]);
-    //     Ok(())
-    // });
-    // let ancestor_span = span.find_oldest_ancestor_in_same_ctxt();
-    // dbg!(span.from_expansion(), ancestor_span.from_expansion());
-    // _ = src_map.span_to_source(ancestor_span, |text, x, y| {
-    //     println!("(find_oldest_ancestor_in_same_ctxt) [{ancestor_span:?}]\n{}\n\n", &text[x..y]);
-    //     Ok(())
-    // });
+/// Source code and potential source code before expansion.
+///
+/// Refer to
+#[derive(Debug, Serialize, PartialEq, Eq, PartialOrd, Ord, Default)]
+pub struct SourceCode {
+    // TODO:
+    // file: String,
+    //
+    /// Source that a stable_mir span points to.
+    pub src: String,
+    /// Is the stable_mir span from a macro expansion?
+    /// If it is from an expansion, what's the source code before expansion?
+    /// * Some(_) happens when the src (stable_mir) span comes from expansion, and tells
+    ///   the source before the expansion.
+    /// * None if the src is not from a macro expansion.
+    pub before_expansion: Option<String>,
+}
+
+impl SourceCode {
+    pub fn with_hasher(&self, hasher: &mut StableHasher<SipHasher128>) {
+        hasher.write_str(&self.src);
+        match &self.before_expansion {
+            Some(text) => {
+                hasher.write_u8(1);
+                hasher.write_str(text);
+            }
+            None => hasher.write_u8(0),
+        }
+    }
+}
 
+fn span_to_source(span: Span, src_map: &SourceMap) -> String {
     src_map
         .span_to_source(span, |text, x, y| {
             let src = &text[x..y];
@@ -27,17 +47,32 @@ fn source_code(span: Span, src_map: &SourceMap) -> String {
         .unwrap()
 }
 
+/// Source code for a span.
+fn source_code(span: Span, src_map: &SourceMap) -> SourceCode {
+    let src = span_to_source(span, src_map);
+    let before_expansion = span.from_expansion().then(|| {
+        let ancestor_span = span.find_oldest_ancestor_in_same_ctxt();
+        span_to_source(ancestor_span, src_map)
+    });
+    SourceCode { src, before_expansion }
+}
+
 /// Source code for a stable_mir span.
 pub fn source_code_with(
     stable_mir_span: stable_mir::ty::Span,
     tcx: TyCtxt,
     src_map: &SourceMap,
-) -> String {
+) -> SourceCode {
     let span = internal(tcx, stable_mir_span);
     source_code(span, src_map)
 }
 
-pub fn source_code_of_body(inst: &Instance, tcx: TyCtxt, src_map: &SourceMap) -> Option<String> {
+// FIXME: takes body and returns SourceCode
+pub fn source_code_of_body(
+    inst: &Instance,
+    tcx: TyCtxt,
+    src_map: &SourceMap,
+) -> Option<SourceCode> {
     inst.body().map(|body| source_code_with(body.span, tcx, src_map))
 }
 

src/lib.rs

@@ -13,7 +13,7 @@ pub struct SerFunction {
     /// and function must be separated to query.
     pub attrs: Vec<String>,
     /// Raw function string, including name, signature, and body.
-    pub func: String,
+    pub func: SourceCode,
     /// Recursive function calls inside the body.
     pub callees: Vec<Callee>,
 }
@@ -22,7 +22,22 @@ pub struct SerFunction {
 pub struct Callee {
     pub def_id: String,
     pub file: String,
-    pub func: String,
+    pub func: SourceCode,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct SourceCode {
+    // TODO:
+    // file: String,
+    //
+    /// Source that a stable_mir span points to.
+    pub src: String,
+    /// Is the stable_mir span from a macro expansion?
+    /// If it is from an expansion, what's the source code before expansion?
+    /// * Some(_) happens when the src (stable_mir) span comes from expansion, and tells
+    ///   the source before the expansion.
+    /// * None if the src is not from a macro expansion.
+    pub before_expansion: Option<String>,
 }
 
 /// A local path to kani's artifacts.

tests/compare.rs

@@ -7,7 +7,7 @@ use utils::{assert_eq, cmd, expect_file};
 fn get(text: &str, start: &str) -> SerFunction {
     let json = &text[text.find("[\n").unwrap()..];
     let v: Vec<SerFunction> = serde_json::from_str(json).unwrap();
-    v.into_iter().find(|f| f.func.starts_with(start)).unwrap()
+    v.into_iter().find(|f| f.func.src.starts_with(start)).unwrap()
 }
 
 const COMPARE: &str = "tests/compare";