initial support for sourcemap

Author: sipma

chb/bctypes/BCFiles.py

@@ -26,7 +26,7 @@
 # ------------------------------------------------------------------------------
 """Contains all global types in a CIL file."""
 
-from typing import Any, cast, Dict, List, Optional, TYPE_CHECKING
+from typing import Any, cast, Dict, List, Optional, Tuple, TYPE_CHECKING
 
 import xml.etree.ElementTree as ET
 
@@ -55,6 +55,7 @@ def __init__(self, app: "AppAccess", xnode: ET.Element) -> None:
         self._gvardecls: List[BCVarInfo] = []
         self._gvardefs: List[BCVarInfo] = []
         self._functions: Dict[str, BCFunctionDefinition] = {}
+        self._srcmap: List[Tuple[str, int, str, str]] = []
         self.initialize(xnode)
 
     @property
@@ -102,6 +103,10 @@ def gvardefs(self) -> List[BCVarInfo]:
     def globalvars(self) -> List[BCVarInfo]:
         return self._gvardefs + self._gvardecls
 
+    @property
+    def srcmap(self) -> List[Tuple[str, int, str, str]]:
+        return self._srcmap
+
     @property
     def functions(self) -> Dict[str, BCFunctionDefinition]:
         return self._functions
@@ -149,6 +154,7 @@ def initialize(self, xnode: ET.Element) -> None:
         self.initialize_vardefs(xnode.find("varinfos"))
         self.initialize_vardecls(xnode.find("varinfodecls"))
         self.initialize_functions(xnode.find("ifuns"))
+        self.initialize_srcmap(xnode.find("srcmap"))
 
     def initialize_compinfos(self, tnode: Optional[ET.Element]) -> None:
         if tnode:
@@ -209,6 +215,18 @@ def initialize_functions(self, tnode: Optional[ET.Element]) -> None:
                     self._functions[svinfo.vname] = BCFunctionDefinition(
                         self, svinfo.vname, xfundef)
 
+    def initialize_srcmap(self, tnode: Optional[ET.Element]) -> None:
+        if tnode is not None:
+            for x in tnode.findall("srcloc"):
+                vix = x.get("vix")
+                lnr = x.get("lnr")
+                ixfn = x.get("ixfn")
+                binloc = x.get("binloc")
+                if vix and lnr and ixfn and binloc:
+                    srcvinfo = self.bcd.varinfo(int(vix))
+                    srcfile = self.bcd.string(int(ixfn))
+                    self._srcmap.append((srcfile, int(lnr), srcvinfo.vname, binloc))
+
     def __str__(self) -> str:
         lines: List[str] = []
         lines.append("\n".join(str(t) for t in self.gtypes))

chb/cmdline/chkx

@@ -584,6 +584,11 @@ def parse() -> argparse.Namespace:
     ddatamd5s.add_argument("xname", help="name of executable")
     ddatamd5s.set_defaults(func=UCC.ddata_md5s)
 
+    # -- ddata srcmap --
+    ddatasrcmap = ddataparsers.add_parser("srcmap")
+    ddatasrcmap.add_argument("xname", help="name of executable")
+    ddatasrcmap.set_defaults(func=UCC.ddata_srcmap)
+
     # ----------------------------------------------------------------- results --
     resultscmd = subparsers.add_parser('results')
     resultscmd.set_defaults(func=resultscommand)

chb/cmdline/commandutil.py

@@ -2561,3 +2561,34 @@ def ddata_md5s(args: argparse.Namespace) -> NoReturn:
             print(md5 + ": " + str(count))
 
     exit(0)
+
+
+def ddata_srcmap(args: argparse.Namespace) -> NoReturn:
+
+    # arguments
+    xname: str = str(args.xname)
+
+    try:
+        (path, xfile) = get_path_filename(xname)
+    except UF.CHBError as e:
+        print(str(e.wrap()))
+        exit(1)
+
+    xinfo = XI.XInfo()
+    xinfo.load(path, xfile)
+
+    app = get_app(path, xfile, xinfo)
+    srcmap = app.bcfiles.srcmap
+
+    result: Dict[str, Dict[int, Tuple[str, str]]] = {}
+
+    for (fname, linenr, vname, binloc) in srcmap:
+        result.setdefault(fname, {})
+        result[fname][linenr] = (vname, binloc)
+
+    for fname in result:
+        print(fname)
+        for (linenr, (vname, binloc)) in sorted(result[fname].items()):
+            print(str(linenr).rjust(6) + ": " + binloc.rjust(10) + "  " + vname)
+
+    exit(0)

chb/cmdline/reportcmds.py

@@ -1149,11 +1149,11 @@ def consider(faddr: str):
                 # heuristics, which (for now) means shared object stubs.
                 if calltgt.is_so_target:
                     opcode = instr.opcode # type: ignore
-                    if "MIPS" in repr(opcode): # ugly but concise!
+                    if app.is_mips:
                         # No support (or need?) for MIPS just yet
                         continue
                     optgt = opcode.opargs[0]
-                    tgtname = cast(StubTarget, calltgt).stub.name
+                    tgtname = cast("StubTarget", calltgt).stub.name
                     if optgt.is_absolute:
                         tgtaddr = optgt.opkind.address.get_hex()
                         consider_pair(tgtaddr, tgtname)