prepare 0.4.3

Author: edwintorok

CHANGES.md

@@ -1,4 +1,4 @@
-## 0.4.2 (2023-09-09)
+## 0.4.3 (2023-09-09)
 
 * helpers tools and examples added
 

example/dune2/.gitignore

@@ -0,0 +1 @@
+compile_flags.txt

example/dune2/README.md

@@ -0,0 +1,36 @@
+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)))
+```
+
+And then running:
+```
+rm -f dune.analysis.inc; touch dune.analysis.inc && dune runtest --auto-promote
+```
+
+You will have to create a `compile_commands.json`, e.g. by using `bear`:
+```
+bear -- dune build @cstubs
+```
+
+(where `@cstubs` is an alias generated by the above tool).
+
+Now you can run `dune build @analyze` to trigger a static analysis.
+
+TODO: this is very experimental.

example/dune2/dune

@@ -0,0 +1,24 @@
+(library
+ (package lintcstubs)
+ (name foo2)
+ (foreign_stubs
+  (language c)
+  (names foostubs)))
+
+(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)))

example/dune2/dune.analysis.inc

@@ -0,0 +1,21 @@
+(rule (targets foo2.model.c ./primitives.h)
+ (deps (:cmt ./.foo2.objs/byte/foo2.cmt) %{bin:lintcstubs_arity_cmt}
+  %{bin:lintcstubs_genwrap} %{bin:lintcstubs_genmain})
+ (action
+  (progn
+   (with-stdout-to ./primitives.h (run %{bin:lintcstubs_arity_cmt} %{cmt}))
+   (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 (targets ./lintcstubs.log ./lintcstubs.sarif)
+ (deps compile_commands.json (:primitives ./primitives.h)
+  (:model foo2.model.c) %{bin:lintcstubs} (package lintcstubs))
+ (action
+  (with-stdout-to ./lintcstubs.log
+   (run %{bin:lintcstubs} --conf lintcstubs.json -o ./lintcstubs.sarif -I
+    %{ocaml_where} --set dbg.solver-stats-interval 0 compile_commands.json
+    %{model}))))
+(rule (alias analyze) (deps (:log ./lintcstubs.log))
+ (action (diff lintcstubs.out.reference %{deps})))

example/dune2/foo2.ml

@@ -0,0 +1,5 @@
+type t
+
+external foo_bad : t -> int = "foo_bad"
+
+external foo_good : t -> int = "foo_good"

example/dune2/foostubs.c

@@ -0,0 +1,24 @@
+
+#include <caml/mlvalues.h>
+#include <caml/memory.h>
+#include <caml/alloc.h>
+#include <caml/threads.h>
+
+value foo_bad (value v)
+ {
+   CAMLparam1(v);
+   int x;
+   caml_enter_blocking_section();
+   x = *(int*)Data_abstract_val(v);
+   caml_leave_blocking_section();
+   CAMLreturn(Val_int(x));
+ }
+
+value foo_good (value v)
+ {
+   CAMLparam1(v);
+   int x = *(int*) Data_abstract_val(v);
+   caml_enter_blocking_section();
+   caml_leave_blocking_section();
+   CAMLreturn(Val_int(x));
+ }

lintcstubs-rules.opam

@@ -0,0 +1,34 @@
+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+synopsis: "Generate dune rules for lintcstubs integration"
+description: "Generates dune rules for running the static analyzer"
+maintainer: ["Edwin Török <[email protected]>"]
+authors: ["Edwin Török <[email protected]>"]
+license: "LGPL-2.1-or-later"
+homepage: "https://github.com/edwintorok/lintcstubs"
+bug-reports: "https://github.com/edwintorok/lintcstubs/issues"
+depends: [
+  "dune" {>= "3.0"}
+  "ocaml" {>= "4.14"}
+  "lintcstubs-arity" {>= "0.2.2"}
+  "lintcstubs-gen" {= version}
+  "lintcstubs" {= version}
+  "odoc" {with-doc}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "--promote-install-files=false"
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+  ["dune" "install" "-p" name "--create-install-files" name]
+]
+dev-repo: "git+https://github.com/edwintorok/lintcstubs.git"