improves bap-configurator key handling, publishes more config (#1570)

Normalized Keys
---------------

1) Keys passed to `ocaml tools/configure.ml` can now use dashes
or underscores interchangeably
2) The keys are case sensitives
3) During rewritign the keys can use either underscores or dashes,
   and can use any registry.

Basically the comparison function makes the following keys equal:
`foo-bar`, `FOO_BAR`, `FOO-bar`, and `foo bar`.

New Configuration Parameters
----------------------------

Publishes several configuration parameters via Bap_main.Configuration
and makes it available via `bap config`, e.g.,
```
$ bap config
version: 2.6.0-alpha
build_id: f4a6c54
datadir: /home/ivg/.local/share/bap
cachedir: /home/ivg/.cache/bap
sysdatadir: /home/ivg/factory/bap-dune/_opam/share/bap-common
libdir: /home/ivg/factory/bap-dune/_opam/lib
confdir: /home/ivg/factory/bap-dune/_opam/etc/bap-common
bindir: /home/ivg/factory/bap-dune/_opam/bin
plugindir: /home/ivg/factory/bap-dune/_opam/lib/bap-common/plugins
```

Updates bapbundle to Hanle dune Plugins
---------------------------------------

```
bapbundle remove foo
```

Will now correctly delete a plugin `foo` even if it a dune
plugin. (Note, that it will only remove the folder from the plugins
directory and wont remove any installed libraries, for that use opam
or your build system)

Author: ivg

.github/workflows/nightly.yml

@@ -26,6 +26,7 @@ jobs:
       - name: Install Extra System Dependencies
         run: |
           sudo add-apt-repository ppa:ivg/ghidra -y
+          sudo apt-get update -y
           sudo apt-get install libghidra-dev -y
           sudo apt-get install libghidra-data -y
           sudo apt-get install dejagnu -y

lib/bap_main/bap_main.mli

@@ -1136,6 +1136,12 @@ module Extension : sig
     (** [version] is the preconfigured application version.*)
     val version : string
 
+    (** [build_id] if bap is built from dev repository, contains
+        the short SHA of the git commit.
+
+        @since 2.6.0   *)
+    val build_id : string
+
 
     (** [datadir] a directory for user-specific BAP readonly data.
 
@@ -1167,9 +1173,7 @@ module Extension : sig
 
     (** [sysdatadir] a directory for system-specific BAP readonly data
 
-        @since 2.3.0 before that version it was named [datadir]
-
-    *)
+        @since 2.3.0 before that version it was named [datadir]  *)
     val sysdatadir : string
 
     (** [libdir] a directory for BAP object files,
@@ -1182,6 +1186,18 @@ module Extension : sig
     val confdir : string
 
 
+    (** [bindir] the preconfigured directory for binaries.
+
+        @since 2.6.0  *)
+    val bindir : string
+
+
+    (** [plugindir] the preconfigured path where to store BAP plugins.
+
+        @since 2.6.0 *)
+    val plugindir : string
+
+
     (** [refine ~provides ~exclude ctxt] refines the context.
 
         Refine the context by excluding from it all parameters of the

lib/bap_main/bap_main_config.ml.ab

@@ -28,4 +28,5 @@ let suffix_program = "$suffix_program"
 let debug = "$debug"
 let profile = "$profile"
 let standard_library = "$standard_library"
-let build_id = "$build_id"
+let build_id = "$build_id"
+let plugindir = "$plugindir"

src/bap_frontend.ml

@@ -318,11 +318,15 @@ let _list_command_declaration : unit =
 
 let _config_command_declaration : unit =
   let entities = Configuration.[
+      "version", version;
+      "build_id", build_id;
       "datadir", datadir;
       "cachedir", cachedir;
       "sysdatadir", sysdatadir;
       "libdir", libdir;
       "confdir", confdir;
+      "bindir", bindir;
+      "plugindir", plugindir;
     ] in
   let entity = Command.argument @@ Type.(some (enum entities)) in
   let doc = "prints BAP configuration" in
@@ -336,9 +340,6 @@ let _config_command_declaration : unit =
         Format.printf "%s: %s@." name value);
     Ok ()
 
-
-
-
 let () =
   let _unused : (module unit) = (module Bap.Std) in
   let () =

tools/bapbundle.ml

@@ -2,6 +2,7 @@ open Core_kernel[@@warning "-D"]
 open Bap_bundle.Std
 open Format
 
+
 module Sys = Caml.Sys
 
 open Manifest.Fields
@@ -11,6 +12,7 @@ exception Target_unspecified
 exception Target_is_directory
 exception Target_doesn't_exist
 exception Destdir_is_not_a_dir
+exception Target_not_installed
 
 let target = ref ""
 let manifest = ref (Manifest.create "")
@@ -221,7 +223,8 @@ module Remove = struct
     if String.is_empty target.contents then raise Target_unspecified;
     let file = normalized @@ Filename.concat !destdir !target in
     if Sys.file_exists file
-    then Sys.remove file
+    then FileUtil.rm ~recurse:true [file]
+    else raise Target_not_installed
 end
 
 
@@ -301,6 +304,8 @@ let () =
     error "The provided bundle file is either malformed or is not a bundle"
   | Destdir_is_not_a_dir ->
     error "The destination should be a directory, not a file"
+  | Target_not_installed ->
+    error "The specified plugin is not installed"
   | Sys_error err ->
     error "%s" err
   | exn ->

tools/rewrite.ml

@@ -14,7 +14,27 @@ type cls =
   | With
   | Comp of bool
 
-type cfg = string Hashtbl.M(String).t [@@deriving sexp]
+module Key = struct
+  type t = string [@@deriving sexp]
+  let normalize =
+    String.map ~f:(function
+        | '_' | ' ' -> '-'
+        | c -> c)
+
+  let sexp_of_t x =
+    sexp_of_string @@ String.lowercase @@ normalize x
+
+  let hash x = String.Caseless.hash @@ normalize x
+  include Comparable.Make(struct
+      type t = string
+      let sexp_of_t = sexp_of_t
+      let compare x y = String.Caseless.compare
+          (normalize x)
+          (normalize y)
+    end)
+end
+
+type cfg = string Hashtbl.M(Key).t [@@deriving sexp]
 
 let filename = ref ""
 let init = ref false
@@ -39,7 +59,7 @@ let () = Cfg.main ~args ~name:"bap-configurator" @@ fun self ->
         "--quiet";
         "--short=7";
         "HEAD"
-      ]
+      ] |> String.strip
     with _ -> "" in
 
   let name = "bap-common" in
@@ -52,7 +72,7 @@ let () = Cfg.main ~args ~name:"bap-configurator" @@ fun self ->
     String.concat ~sep:"; " in
 
   if init.contents then begin
-    let vars = Hashtbl.of_alist_exn (module String) [
+    let vars = Hashtbl.of_alist_exn (module Key) [
         "pkg_name", name;
         "pkg_version", "2.6.0-alpha";
         "prefix", prefix;
@@ -74,7 +94,7 @@ let () = Cfg.main ~args ~name:"bap-configurator" @@ fun self ->
         "dvidir", "$docdir";
         "pdfdir", "$docdir";
         "psdir", "$docdir";
-        "plugindir", "$libdir/bap";
+        "plugindir", "$libdir/$pkg_name/plugins";
         "debug", "true";
         "profile", "false";
         "build_id", build_id;

tools/rewrite.mli

@@ -0,0 +1 @@
+(* rewrites configuration variables *)