Update README and Config.py for dune-built CodeHawk

Author: brk

README.md

@@ -25,15 +25,19 @@ requires a Java runtime environment.
 
 Build instructions for the CodeHawk Binary Analyzer are available
 [here](https://github.com/static-analysis-engineering/codehawk/tree/master/CodeHawk).
-Upon completion copy the analyzer, `chx86_analyze`, from the `CodeHawk/CHB/bchcmdline`
-directory to the appropriate directory in `chb/bin/binaries`, or point the Config.py
-(or ConfigLocal.py) in `chb/util/` to its location. You can check the configuration
-with
+
+If this repository is placed within, or next to, the `codehawk` checkout,
+you should be ready to proceed. Otherwise, copy
+`chb/util/ConfigLocal.template` to `chb/util/ConfigLocal.py` in this
+repository, and edit the latter file to set `config.codehawkdir` to
+the location of the `codehawk` checkout.
+
+You can check the configuration with
 ```
 > chkx info
 Analyzer configuration:
 -----------------------
-  analyzer : /home/myname/codehawk/CodeHawk/CHB/bchcmdline/chx86_analyze (found)
+  analyzer : /home/myname/codehawk/CodeHawk/_build/default/CHB/bchcmdline/bCHXBinaryAnalyzer.exe (found)
   summaries: /home/myname/codehawk/CodeHawk/CHB/bchsummaries/bchsummaries.jar (found)
 ```
 

chb/util/Config.py

@@ -30,7 +30,7 @@
 
 import os
 
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 localconfig = False
 
@@ -43,6 +43,12 @@
 class Config():
 
     def __init__(self) -> None:
+        self.codehawkdir: Optional[str] = None
+
+        # initial personalization, in particular for self.codehawkdir
+        if localconfig:
+            ConfigLocal.getLocals(self)
+
         # platform settings
         if os.uname()[0] == 'Linux':
             self.platform = 'linux'
@@ -55,21 +61,35 @@ def __init__(self) -> None:
         self.rootdir = os.path.dirname(self.chbdir)
         self.testsdir = os.path.join(self.rootdir, "tests")
         self.projects = os.path.join(self.testsdir, "projects.json")
-        self.bindir = os.path.join(self.chbdir, "bin")
-        self.binariesdir = os.path.join(self.bindir, "binaries")
         self.summariesdir = os.path.join(self.chbdir, "summaries")
         self.summaries = os.path.join(self.summariesdir, "bchsummaries.jar")
         self.stdchheader = os.path.join(self.summariesdir, "bch_header.c")
 
-        # analyzer location
-        if self.platform == 'linux':
-            self.linuxdir = os.path.join(self.binariesdir, "linux")
-            self.chx86_analyze = os.path.join(self.linuxdir, "chx86_analyze")
-            self.cparser = os.path.join(self.linuxdir, "parseFile")
-
-        elif self.platform == "macOS":
-            self.macOSdir = os.path.join(self.binariesdir, "macOS")
-            self.chx86_analyze = os.path.join(self.macOSdir, "chx86_analyze")
+        if self.codehawkdir is None:
+            # CodeHawk directory -- assumption is it will be either the
+            # parent directory of the rootdir, or a sibling in the parent.
+            def looks_like_codehawk(path: str) -> bool:
+                chb = os.path.join(path, "CodeHawk", "CHB")
+                chc = os.path.join(path, "CodeHawk", "CHC")
+                return os.path.isdir(chb) and os.path.isdir(chc)
+            topparent = os.path.dirname(self.rootdir)
+            alts = [topparent,
+                    os.path.join(topparent, "codehawk"),
+                    os.path.join(topparent, "CodeHawk")]
+            viable_alts = [alt for alt in alts if looks_like_codehawk(alt)]
+            if viable_alts:
+                self.codehawkdir = viable_alts[0]
+
+        ## analyzer executables
+        if self.codehawkdir is not None:
+            # Look for non-installed binaries by default
+            self.cparser = os.path.join(self.codehawkdir, "CodeHawk",
+                "_build", "default", "CHC", "cchcil", "cCHXParseFile.exe")
+            self.chx86_analyze = os.path.join(self.codehawkdir, "CodeHawk",
+                "_build", "default", "CHB", "bchcmdline", "bCHXBinaryAnalyzer.exe")
+        else:
+            self.cparser = "<no codehawkdir!>"
+            self.chx86_analyze = "<no codehawkdir!>"
 
         # instruction support
         self.armdir = os.path.join(self.chbdir, "arm")

chb/util/ConfigLocal.template

@@ -45,8 +45,8 @@ def getLocals(config: 'Config') -> None:
     '''Set local configuration variables here if they differ from the defaults in Config.py
 
     # Example :
-    config.chx86_analyze =  '/home/username/my-analyzer/chx86_analyze'
-    config.chx86_gui =  '/home/username/my-analyzer/chx86_gui
+    config.codehawkdir = '/home/username/codehawk'
+    config.chx86_gui =  '/home/username/my-analyzer/chx86_gui'
     config.summaries = '/home/username/my-analyzer/bchsummaries.jar'
 
     # Set locations of analysis targets