adds the --show-knowledge option to bap mc (#1304)

This option will dump the final state of the knowledge base. Mostly
useful for debugging and writing lifters.

Author: ivg

lib/bap_primus/bap_primus_lisp_semantics.ml

@@ -46,9 +46,6 @@ let program =
     ~empty:Program.empty
     ~equal:Program.equal
     ~join:(fun x y -> Ok (Program.merge x y))
-    ~inspect:(fun p ->
-        let r = Format.asprintf "%a" Program.pp p in
-        Sexp.Atom r)
 
 type program = {
   prog : Program.t;

plugins/mc/mc_main.ml

@@ -119,6 +119,7 @@ type output = [
   | `invalid
   | `addr
   | `memory
+  | `knowledge
 ] [@@deriving compare, enumerate]
 
 type target =
@@ -196,22 +197,24 @@ module Spec = struct
       | `size -> "size"
       | `addr -> "addr"
       | `memory -> "memory"
+      | `knowledge -> "knowledge"
       | `invalid -> "invalid" in
 
     let as_flag = function
       | `insn | `bil | `bir -> ["pretty"]
       | `sema -> ["all-slots"]
-      | `kinds | `size | `invalid | `memory | `addr -> [enabled] in
+      | `kinds | `size | `invalid | `memory | `addr | `knowledge -> [enabled] in
 
     let doc = function
       | `insn -> "Print the decoded instruction."
       | `bil -> "Print the BIL code."
       | `bir -> "Print the IR."
-      | `sema -> "Print the knowledge base."
+      | `sema -> "Print the full semantics of the instruction."
       | `kinds -> "Print semantics tags associated with instruction."
       | `size -> "Print the instruction size."
       | `addr -> "Print the instruction address"
       | `memory -> "Print the instruction memory representation"
+      | `knowledge -> "Print the knowledge base."
       | `invalid -> "Print invalid instructions." in
 
     let name s = "show-" ^ name_of_output s in
@@ -339,6 +342,10 @@ let print_insn_memory formats mem =
   List.iter formats ~f:(fun _enabled ->
       printf "%a@\n" Memory.pp mem)
 
+let print_knowledge formats =
+  List.iter formats ~f:(fun _ ->
+      printf "%a" KB.pp_state (Toplevel.current ()))
+
 let print_insn insn_formats insn =
   List.iter insn_formats ~f:(fun fmt ->
       Insn.with_printer fmt (fun () ->
@@ -383,7 +390,8 @@ let print arch mem code formats =
   print_bil (formats `bil) insn;
   print_bir (formats `bir) insn;
   print_sema (formats `sema) insn;
-  print_kinds (formats `kinds) code
+  print_kinds (formats `kinds) code;
+  print_knowledge (formats `knowledge)
 
 let bits = function
   | Target {name=t} -> Theory.Target.bits t
@@ -428,13 +436,14 @@ let validate_formats formats =
   List.map formats ~f:(function
       | (`insn|`bil|`bir) as kind,fmts ->
         validate_module kind fmts
-      | (`kinds|`size|`invalid|`addr|`memory),[] -> Ok ()
-      | (`kinds|`size|`invalid|`addr|`memory),[opt]
+      | (`kinds|`size|`invalid|`addr|`memory|`knowledge),[] -> Ok ()
+      | (`kinds|`size|`invalid|`addr|`memory|`knowledge),[opt]
         when String.equal enabled opt -> Ok ()
       | `kinds,_ -> Error (No_formats_expected "kinds")
       | `size,_ -> Error (No_formats_expected "size")
       | `addr,_ -> Error (No_formats_expected "addr")
       | `memory,_ -> Error (No_formats_expected "memory")
+      | `knowledge,_ -> Error (No_formats_expected "knowledge")
       | `invalid,_ -> Error (No_formats_expected "invalid")
       | `sema,_ ->
         (* no validation right now, since the knowledge introspection