CMD: add option to annotate stats

Author: sipma

chb/app/AppResultFunctionMetrics.py

@@ -6,7 +6,7 @@
 #
 # Copyright (c) 2016-2020 Kestrel Technology LLC
 # Copyright (c) 2020      Henny Sipma
-# Copyright (c) 2021      Aarno Labs LLC
+# Copyright (c) 2021-2025 Aarno Labs LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -28,7 +28,7 @@
 # ------------------------------------------------------------------------------
 import xml.etree.ElementTree as ET
 
-from typing import Dict, Optional, TYPE_CHECKING
+from typing import Dict, List, Optional, TYPE_CHECKING
 
 import chb.util.fileutil as UF
 
@@ -236,22 +236,27 @@ def as_dictionary(self) -> Dict[str, str]:
     def metrics_to_string(
             self,
             shownocallees: bool = False,
-            space: str = "   ") -> str:
+            space: str = "   ",
+            annotations: List[str] = []) -> str:
         callcount = ''
         name = ''
         unrc = ''
+        anns = ""
         if shownocallees and (not self.has_name()):
             if self.call_count == 0:
                 callcount = ' (no callees)'
         if self.has_name():
             name = ' (' + self.name + ')'
         if self.unresolved_call_count > 0:
             unrc = str(self.unresolved_call_count)
+        if len(annotations) > 0:
+            anns = " [" + ", ".join(annotations) + "]"
+
         return (str(self.faddr).ljust(10) + space
                 + '{:6.1f}'.format(self.espp) + space
                 + '{:6.1f}'.format(self.readsp) + space
                 + '{:6.1f}'.format(self.writesp) + space
                 + unrc.rjust(6) + space
                 + str(self.block_count).rjust(6) + space
                 + str(self.instruction_count).rjust(6) + space
-                + '{:8.3f}'.format(self.time) + name + callcount)
+                + '{:8.3f}'.format(self.time) + name + callcount + anns)

chb/app/AppResultMetrics.py

@@ -6,7 +6,7 @@
 #
 # Copyright (c) 2016-2020 Kestrel Technology LLC
 # Copyright (c) 2020      Henny Sipma
-# Copyright (c) 2021-2024 Aarno Labs LLC
+# Copyright (c) 2021-2025 Aarno Labs LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

chb/app/CHVersion.py

@@ -1 +1 @@
-chbversion: str = "0.3.0-20250325"
+chbversion: str = "0.3.0-20250326"

chb/cmdline/chkx

@@ -612,6 +612,9 @@ def parse() -> argparse.Namespace:
         "--opcodes",
         help=("json filename (without extension) to save opcode distribution "
               + "stats (for instructions within analyzed functions)"))
+    resultsstats.add_argument(
+        "--annotationfile",
+        help="name of json file that has function annotations")
     resultsstats.add_argument(
         "--loglevel", "-log",
         choices=UL.LogLevel.options(),

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
+    annotationfile: str = str(args.annotationfile)
     loglevel: str = args.loglevel
     logfilename: Optional[str] = args.logfilename
     logfilemode: str = args.logfilemode
@@ -637,6 +638,15 @@ def results_stats(args: argparse.Namespace) -> NoReturn:
         mode=logfilemode,
         msg="results stats invoked")
 
+    annotations: Dict[str, List[str]] = {}
+    if annotationfile is not None:
+        with open(annotationfile, "r") as fp:
+            annotationdata = json.load(fp)
+        for (key, flist) in annotationdata["keys"].items():
+            for faddr in flist:
+                annotations.setdefault(faddr, [])
+                annotations[faddr].append(key)
+
     xinfo = XI.XInfo()
     xinfo.load(path, xfile)
 
@@ -655,7 +665,12 @@ def results_stats(args: argparse.Namespace) -> NoReturn:
     else:
         sortkey = lambda f: int(f.faddr, 16)
     for f in sorted(stats.get_function_results(), key=sortkey):
-        print(f.metrics_to_string(shownocallees=nocallees))
+        if f.faddr in annotations:
+            fn_annotations = annotations[f.faddr]
+        else:
+            fn_annotations = []
+        print(f.metrics_to_string(shownocallees=nocallees,
+                                  annotations=fn_annotations))
 
     print(stats.disassembly_to_string())
     print(stats.analysis_to_string())