feat: add a tool to perf call stack

crates/specs/src/itable.rs

@@ -588,6 +588,7 @@ impl Into<OpcodeClassPlain> for Opcode {
 #[derive(Clone, Debug, Serialize)]
 pub struct InstructionTableEntry {
     pub fid: u32,
+    pub function_name: String,
     pub iid: u32,
     pub opcode: Opcode,
 }
@@ -651,7 +652,12 @@ impl InstructionTable {
         opcodeclass
     }
 
-    pub fn push(&mut self, fid: u32, iid: u32, opcode: Opcode) {
-        self.0.push(InstructionTableEntry { fid, iid, opcode })
+    pub fn push(&mut self, fid: u32, function_name: String, iid: u32, opcode: Opcode) {
+        self.0.push(InstructionTableEntry {
+            fid,
+            function_name,
+            iid,
+            opcode,
+        })
     }
 }

crates/specs/src/jtable.rs

@@ -15,6 +15,7 @@ pub struct StaticFrameEntry {
 pub struct JumpTableEntry {
     // caller eid (unique)
     pub eid: u32,
+    // caller's caller eid. It's used to maintain a caller chain.
     pub last_jump_eid: u32,
     pub callee_fid: u32,
     pub inst: Box<InstructionTableEntry>,

crates/specs/src/step.rs

@@ -58,12 +58,14 @@ pub enum StepInfo {
 
     Call {
         index: u32,
+        function_name: String,
     },
     CallIndirect {
         table_index: u32,
         type_index: u32,
         offset: u32,
         func_index: u32,
+        function_name: String,
     },
     CallHost {
         plugin: HostPlugin,

crates/zkwasm/src/circuits/etable/op_configure/op_call.rs

@@ -75,7 +75,7 @@ impl<F: FieldExt> EventTableOpcodeConfig<F> for CallConfig<F> {
         entry: &EventTableEntryWithMemoryInfo,
     ) -> Result<(), Error> {
         match &entry.eentry.step_info {
-            StepInfo::Call { index } => {
+            StepInfo::Call { index, .. } => {
                 self.index_cell.assign(ctx, F::from(*index as u64))?;
                 self.frame_table_lookup.0.assign(
                     ctx,

crates/zkwasm/src/circuits/etable/op_configure/op_call_indirect.rs

@@ -134,6 +134,7 @@ impl<F: FieldExt> EventTableOpcodeConfig<F> for CallIndirectConfig<F> {
                 type_index,
                 offset,
                 func_index,
+                ..
             } => {
                 self.table_index.assign(ctx, F::from(*table_index as u64))?;
                 self.type_index.assign(ctx, F::from(*type_index as u64))?;

crates/zkwasm/src/loader/mod.rs

@@ -132,7 +132,9 @@ impl<E: MultiMillerLoop> ZkWasmLoader<E> {
     pub fn new(k: u32, image: Vec<u8>, phantom_functions: Vec<String>) -> Result<Self> {
         set_zkwasm_k(k);
 
-        let module = wasmi::Module::from_buffer(&image)?;
+        let mut module = wasmi::Module::from_buffer(&image)?;
+        let parity_module = module.module().clone().parse_names().unwrap();
+        module.module = parity_module;
 
         let loader = Self {
             k,

crates/zkwasm/src/runtime/mod.rs

@@ -417,7 +417,7 @@ pub fn memory_event_of_step(event: &EventTableEntry, emid: &mut u32) -> Vec<Memo
 
             ops
         }
-        StepInfo::Call { index: _ } => {
+        StepInfo::Call { index: _, .. } => {
             vec![]
         }
         StepInfo::CallIndirect { offset, .. } => {

crates/zkwasm/src/runtime/wasmi_interpreter.rs

@@ -123,6 +123,7 @@ impl WasmiRuntime {
 
         let fid_of_entry = {
             let idx_of_entry = instance.lookup_function_by_name(tracer.clone(), entry);
+            let idx_of_start_function = module.module().start_section();
 
             tracer
                 .clone()
@@ -146,7 +147,7 @@ impl WasmiRuntime {
                         enable: true,
                         frame_id: 0,
                         next_frame_id: 0,
-                        callee_fid: 0, // the fid of start function is always 0
+                        callee_fid: idx_of_start_function.unwrap(),
                         fid: idx_of_entry,
                         iid: 0,
                     });

scripts/perf/README

@@ -0,0 +1,5 @@
+# Generate flamegraph for etable
+
+```
+./perf_etable.sh <Path of etable> > <Path of svg output>
+```

scripts/perf/call_stack.py

@@ -0,0 +1,56 @@
+import json
+import copy
+import sys
+
+def analyze_etable(etable):
+    dict = {}
+    frame = []
+
+    for entry in etable:
+        if len(frame) == 0:
+            frame.append(entry["inst"]["function_name"])
+
+        if type(entry["inst"]["opcode"]) == str:
+            opcode = entry["inst"]["opcode"]
+        else:
+            if len(entry["inst"]["opcode"].items()) != 1:
+                print("Panic")
+                exit(1)
+
+            for key, value in entry["inst"]["opcode"].items():
+                opcode = key
+                break
+
+        if tuple(frame) not in dict:
+                dict[tuple(frame)] = 1
+        else:
+                dict[tuple(frame)] = dict[tuple(frame)] + 1
+
+        if opcode == "Call":
+            frame.append(entry["step_info"]["Call"]["function_name"])
+        elif opcode == "CallIndirect":
+            frame.append(entry["step_info"]["CallIndirect"]["function_name"])
+        elif opcode == "Return":
+            frame.pop()
+
+    return dict
+
+def generate_log(dict):
+    for key, value in dict.items():
+        print(*key, sep=";", end="")
+        print(" ", end="")
+        print(value)
+
+def main():
+    if len(sys.argv) != 2:
+        print("Usage: python call_stack.py <Path of etable.json>");
+        exit(1)
+
+    etable_path = sys.argv[1]
+    etable = open(etable_path)
+    etable = json.load(etable)
+
+    dict = analyze_etable(etable)
+    generate_log(dict)
+
+main()