Dune rule generation improvements

Signed-off-by: Edwin Török <[email protected]>

Author: edwintorok

.gitignore

@@ -1,3 +1,4 @@
 _build/
 _opam/
-*.install
+*.install
+compile_commands.json

dune-project

@@ -32,20 +32,9 @@
   (lintcstubs-gen (= :version))
   (goblint (>= 2.1.0))
   goblint-cil
+  dune-compiledb
   fpath
   (fmt (>= 0.9.0))
+  sexplib
  )
-)
-
-(package
- (name lintcstubs-rules)
- (synopsis "Generate dune rules for lintcstubs integration")
- (description "Generates dune rules for running the static analyzer")
- (depends
-  (ocaml (>= 4.14))
-  (lintcstubs-arity (>= 0.2.2))
-  (lintcstubs-gen (= :version))
-  (lintcstubs (= :version))
- )
-)
-
+)

example/dune/dune

@@ -14,27 +14,6 @@
    foo.h
    (run %{bin:lintcstubs_arity_cmt} %{dep:.foo.objs/byte/foo.cmt}))))
 
-(rule
- ; editor integration: generate include paths for LSPs such as clangd
- (target compile_flags.txt)
- (mode promote)
- (enabled_if
-  (= %{system} linux))
- (action
-  (with-stdout-to
-   compile_flags.txt
-   (pipe-stdout
-    (progn
-     (echo "-Wall -Wextra -Wstrict-prototypes -D_FORTIFY_SOURCE=2 ")
-     (echo
-      %{ocaml-config:ocamlc_cppflags}
-      %{ocaml-config:ocamlc_cflags}
-      -I%{ocaml_where}
-      -I)
-     (system pwd))
-    (system "xargs -n1 echo") ; the format is a single flag per line
-    ))))
-
 (rule
  (enabled_if %{bin-available:lintcstubs})
  (action

example/dune2/README.md

@@ -1,36 +1,25 @@
 Given a file `foo.ml` that contains a C stub and a 'foostubs.c' that implements.
 
 Generate some dune rules, for example by doing this:
-```
-(include dune.analysis.inc)
-(rule
- (deps
-  (:mlfiles (glob_files_rec *.ml))
-  (:cfiles (glob_files_rec *.c))
- )
- (action (with-stdout-to dune.analysis.inc.gen
-  (run %{bin:lintcstubs-dune-rules} %{mlfiles} %{cfiles})
- ))
-)
-
-(rule
- (alias runtest)
- (action
-  (diff dune.analysis.inc dune.analysis.inc.gen)))
+```sh
+$ lintcstubs-dune-rules >dune.analysis.inc
 ```
 
-And then running:
+And then adding this snippet to your dune file:
 ```
-rm -f dune.analysis.inc; touch dune.analysis.inc && dune runtest --auto-promote
+(include dune.analysis.inc)
 ```
 
-You will have to create a `compile_commands.json`, e.g. by using `bear`:
-```
-bear -- dune build @cstubs
+The generated file can be kept up-to-date by running:
+```sh
+dune runtest --auto-promote
 ```
 
-(where `@cstubs` is an alias generated by the above tool).
+You will have to create a `compile_commands.json`, e.g. by using [`dune-compiledb`](https://github.com/edwintorok/dune-compiledb/):
+```sh
+dune rules | dune-compiledb
+```
 
 Now you can run `dune build @analyze` to trigger a static analysis.
 
-TODO: this is very experimental.
+TODO: this is very experimental.

example/dune2/dune

@@ -6,22 +6,3 @@
   (names foostubs)))
 
 (include dune.analysis.inc)
-
-(rule
- (enabled_if %{bin-available:lintcstubs})
- (deps
-  (:mlfiles
-   (glob_files_rec *.ml))
-  (:cfiles
-   (glob_files_rec *.c)))
- (action
-  (with-stdout-to
-   dune.analysis.inc.gen
-   (run %{bin:lintcstubs-dune-rules} %{mlfiles} %{cfiles}))))
-
-(rule
- (alias runtest)
- (package lintcstubs-rules)
- (enabled_if %{bin-available:lintcstubs})
- (action
-  (diff dune.analysis.inc dune.analysis.inc.gen)))

example/dune2/dune.analysis.inc

@@ -1,3 +1,17 @@
+; AUTO-GENERATED by ../../../install/default/bin/lintcstubs-dune-rules foo2.ml foo2.model.c foostubs.c
+; DO NOT EDIT
+(rule
+ (enabled_if
+  (and %{bin-available:lintcstubs-dune-rules} %{bin-available:lintcstubs}))
+ (deps (:mlfiles (glob_files_rec *.ml)) (:cfiles (glob_files_rec *.c)))
+ (action
+  (with-stdout-to dune.analysis.inc.gen
+   (run %{bin:lintcstubs-dune-rules} %{mlfiles} %{cfiles}))))
+(rule (alias runtest) (package lintcstubs)
+ (enabled_if %{bin-available:lintcstubs})
+ (action (diff dune.analysis.inc dune.analysis.inc.gen)))
+(rule (target compile_commands.json)
+ (action (pipe-stdout (run dune rules) (run %{bin:dune-compiledb}))))
 (rule (enabled_if %{bin-available:lintcstubs_genmain})
  (targets foo2.model.c ./primitives.h)
  (deps (:cmt ./.foo2.objs/byte/foo2.cmt) %{bin:lintcstubs_arity_cmt}
@@ -8,8 +22,6 @@
    (with-stdout-to foo2.model.c
     (progn (run %{bin:lintcstubs_genwrap} %{cmt})
      (run %{bin:lintcstubs_genmain} %{cmt}))))))
-(rule (alias cstubs) (deps (:ofiles foo2.model.o foostubs.o))
- (action (echo "for BEAR")))
 (rule (enabled_if %{bin-available:lintcstubs})
  (targets ./lintcstubs.log ./lintcstubs.sarif)
  (deps compile_commands.json (:primitives ./primitives.h)

lintcstubs-rules.opam

@@ -14,8 +14,10 @@ depends: [
   "lintcstubs-gen" {= version}
   "goblint" {>= "2.1.0"}
   "goblint-cil"
+  "dune-compiledb"
   "fpath"
   "fmt" {>= "0.9.0"}
+  "sexplib"
   "odoc" {with-doc}
 ]
 build: [

lintcstubs.opam

@@ -1,12 +1,12 @@
 (library
- (package lintcstubs-rules)
+ (package lintcstubs)
  (name filter_primitives)
  (modules filter_primitives)
  (libraries compiler-libs.common fpath))
 
 (executable
  (public_name lintcstubs-dune-rules)
- (package lintcstubs-rules)
+ (package lintcstubs)
  (name main)
  (modules main)
  (libraries filter_primitives sexplib fpath))

rules/dune

@@ -37,11 +37,6 @@ let cmt_rule =
     )
   |}
 
-let cstubs_alias_rule =
-  (* for BEAR *)
-  Sexplib.Sexp.of_string
-    {| (rule (alias cstubs) (deps (:ofiles)) (action (echo "for BEAR"))) |}
-
 (* can be long running, ensure we see something when running dune with '--no-buffer',
     add a 2nd debug target
 
@@ -72,6 +67,39 @@ let analyze_alias_rule =
     )
   |}
 
+let incgen_rule =
+  Sexplib.Sexp.of_string_many
+    {|
+(rule
+ (enabled_if (and %{bin-available:lintcstubs-dune-rules} %{bin-available:lintcstubs}))
+ (deps
+  (:mlfiles
+   (glob_files_rec *.ml))
+  (:cfiles
+   (glob_files_rec *.c)))
+ (action
+  (with-stdout-to
+   dune.analysis.inc.gen
+   (run %{bin:lintcstubs-dune-rules} %{mlfiles} %{cfiles}))))
+
+(rule
+ (alias runtest)
+ (package lintcstubs)
+ (enabled_if %{bin-available:lintcstubs})
+ (action
+  (diff dune.analysis.inc dune.analysis.inc.gen)))
+
+(rule
+  (target compile_commands.json)
+  (action
+    (pipe-stdout
+      (run dune rules)
+      (run %{bin:dune-compiledb})
+    )
+  )
+)
+|}
+
 let group_by_dirs paths =
   Seq.fold_left
     (fun acc path ->
@@ -101,17 +129,15 @@ let () =
     f x |> Result.get_ok
   in
   let files_seq = List.to_seq files in
-  let o_files =
-    files_seq
-    |> Seq.filter Fpath.(has_ext "c")
-    |> Seq.map (Fpath.set_ext "o")
-    |> group_by_dirs
-  in
   let ml_files_primitives =
     files_seq
     |> Seq.filter Fpath.(has_ext "ml")
     |> Seq.filter (filter Filter_primitives.has_primitives)
   in
+  Format.printf "@[<h>; AUTO-GENERATED by %a@]@,; DO NOT EDIT@."
+    (Format.pp_print_list ~pp_sep:Format.pp_print_space Format.pp_print_string)
+    (Array.to_list Sys.argv) ;
+  List.iter (Format.printf "%a@." Sexplib.Sexp.pp_hum) incgen_rule ;
   group_by_dirs ml_files_primitives
   |> Fpath.Map.iter @@ fun dir mls ->
      let to_cmtfile mlfile =
@@ -135,14 +161,6 @@ let () =
             |> apply_template' "%{model}" model_file
          )
      in
-     let o_files_in_dir =
-       Fpath.Map.find dir o_files |> Option.value ~default:Fpath.Set.empty
-     in
-     let cstubs_alias_rules =
-       cstubs_alias_rule
-       |> apply_template ":ofiles"
-            (Fpath.Set.to_seq o_files_in_dir |> List.of_seq)
-     in
      let log_file = Fpath.(dir / "lintcstubs.log") in
      let sarif_file = Fpath.set_ext ".sarif" log_file in
      let analyze_rule =
@@ -158,7 +176,5 @@ let () =
      cmt_rules
      |> List.iter @@ fun cmt_rule ->
         Format.printf "%a@." Sexplib.Sexp.pp_hum cmt_rule ;
-        if not (Fpath.Set.is_empty o_files_in_dir) then
-          Format.printf "%a@." Sexplib.Sexp.pp_hum cstubs_alias_rules ;
         Format.printf "%a@." Sexplib.Sexp.pp_hum analyze_rule ;
         Format.printf "%a@." Sexplib.Sexp.pp_hum analyze_alias_rule