CLI: add stats option to save function info

Author: sipma

chb/app/AppResultFunctionMetrics.py

@@ -28,7 +28,9 @@
 # ------------------------------------------------------------------------------
 import xml.etree.ElementTree as ET
 
-from typing import Dict, List, Optional, TYPE_CHECKING
+from typing import Any, Dict, List, Optional, TYPE_CHECKING
+
+from chb.jsoninterface.JSONResult import JSONResult
 
 import chb.util.fileutil as UF
 
@@ -214,6 +216,20 @@ def name(self) -> str:
     def has_name(self) -> bool:
         return "name" in self.xnode.attrib
 
+    def to_json_result(self) -> JSONResult:
+        content: Dict[str, Any] = {}
+        content["faddr"] = self.faddr
+        if self.has_name():
+            content["name"] = self.name
+        content["instrs"] = self.instruction_count
+        content["blocks"] = self.block_count
+        content["time"] = self.time
+        if self.call_count > 0:
+            content["callcount"] = self.call_count
+        if self.unresolved_call_count > 0:
+            content["unrcalls"] = self.unresolved_call_count
+        return JSONResult("functionmetrics", content, "ok")
+
     def as_dictionary(self) -> Dict[str, str]:
         result: Dict[str, str] = {}
         result['faddr'] = self.faddr

chb/app/AppResultMetrics.py

@@ -401,7 +401,7 @@ def f(fn: AppResultFunctionMetrics) -> None:
         self.iter(f)
         return names
 
-    def to_json_result(self) -> JSONResult:
+    def to_json_result(self, includefns: bool = False) -> JSONResult:
         content: Dict[str, Any] = {}
         content["instructions"] = int(self.instruction_count)
         content["unknowninstrs"] = int(self.unknown_instructions)
@@ -420,6 +420,10 @@ def to_json_result(self) -> JSONResult:
         content["iterations"] = self.run_count
         content["analysisdate"] = self.date_time
         content["fns-excluded"] = self.fns_excluded
+        if includefns:
+            content["functions"] = []
+            for f in self.get_function_results():
+                content["functions"].append(f.to_json_result().content)
         return JSONResult("analysisstats", content, "ok")
 
     def as_dictionary(self) -> Dict[str, Any]:

chb/cmdline/chkx

@@ -623,6 +623,10 @@ def parse() -> argparse.Namespace:
         "--opcodes",
         help=("json filename (without extension) to save opcode distribution "
               + "stats (for instructions within analyzed functions)"))
+    resultsstats.add_argument(
+        "--functionmetrics",
+        help=("json filename (without extension) to save function metrics in "
+              + "json format"))
     resultsstats.add_argument(
         "--tagfile",
         help="name of json file that has function tags")

chb/cmdline/commandutil.py

@@ -619,6 +619,7 @@ def results_stats(args: argparse.Namespace) -> NoReturn:
     sortby: str = args.sortby
     timeshare: int = args.timeshare
     opcodes: str = args.opcodes
+    functionmetrics: str = args.functionmetrics
     hide: List[str] = args.hide
     tagfile: Optional[str] = args.tagfile
     loglevel: str = args.loglevel
@@ -696,6 +697,17 @@ def results_stats(args: argparse.Namespace) -> NoReturn:
         print("-----------------------")
         print("Total".ljust(14) + "{:4.2f}".format(100.0 * toptotal).rjust(6))
 
+    if functionmetrics:
+        filename = functionmetrics + ".json"
+        content: Dict[str, Any] = {}
+        content["filename"] = xname
+        content["functions"] = []
+        for f in sorted(stats.get_function_results(), key=lambda f: f.faddr):
+            content["functions"].append(f.to_json_result().content)
+        jsonok = JU.jsonok("functionmetrics", content)
+        with open(filename, "w") as fp:
+            json.dump(jsonok, fp, indent=4)
+
     if opcodes:
         filename = opcodes + ".json"
         opcstats = app.mnemonic_stats()