CP-17268 cleaner integrates coverage profiling: make coverage

To set up a build for coverage profiling, use "make coverage" followed
by "make". This should it make possible to interate this code into
the main line. Supporting code lives in profiling/. All other changes to
the code are concerned with better signal handling and should likewise
go into the main line.

Signed-off-by: Christian Lindig <[email protected]>

Author: lindig

COVERAGE.md

@@ -0,0 +1,45 @@
+
+# Coverage Analysis
+
+This project can be compiled for coverage analysis using [bisect_ppx]. By
+default, this is not done. To compile for coverage analysis, do:
+
+    make coverage
+    make 
+
+The `coverage` target adds the rules in `_tags.coverage` to the `_tags`
+file, which in turn causes all code to be compiled for coverage
+analysis. The `_tags.coverage` file could be tweaked to control which
+files get instrumented.
+
+## Support Files
+
+See [profiling/coverage.ml](./profiling/coverage.ml) for the run-time
+setup of coverage profiling. This code has no effect when not profiling
+during execution. Once [bixect_ppx] has better defaults we could get rid
+of it.
+
+## Execution and Logging
+
+During program execution, a binary writes coverage data to
+
+    /tmp/bisect-lunarossa-*.out
+
+This can be overridden by setting the `BISECT_FILE` environment
+variable, which is otherwise set at startup using the code in
+`profiling/coverage.ml`;
+
+## Analysis
+
+See the [bisect_ppx] documentation for details but try from the
+top-level directory:
+
+    bisect-ppx-report -I _build -html coverage /tmp/bisect-*.out
+
+This creates an HTML document in [coverage/](./coverage].
+
+[bisect_ppx]:	https://github.com/aantron/bisect_ppx
+
+
+
+

Makefile

@@ -97,3 +97,19 @@ release:
 	grep -v 'warn-error' _oasis > _oasis.tmp
 	mv _oasis.tmp _oasis
 	oasis setup
+
+# make coverage 
+# prepares for building with coverage analysis
+#
+# make uncover
+# reverses the setup from "make coverage"
+
+coverage: _tags _tags.coverage 
+	test ! -f _tags.orig && mv _tags _tags.orig || true
+	cat _tags.coverage _tags.orig > _tags
+
+uncover: _tags.orig
+	mv _tags.orig _tags
+
+.PHONY: default coverage uncover
+	

README.md

@@ -29,7 +29,7 @@ binaries with an evironment variable pointing to a better place:
 
 Function `Bisect_setup.init name` sets the environment variable if it is
 unset from inside the program such that log data is written to the temp
-directory (repecting TMP and TEMP env vars id set). However, logging to
+directory (respecting TMP and TEMP env vars if set). However, logging to
 $CWD will still work even if the `init` function is not called.
 
 

_oasis

@@ -23,6 +23,16 @@ Flag simulator
   Description:        Build server with simulator support
   Default:            true
 
+
+# Support files for profiling 
+Library profiling
+  CompiledObject:     best
+  Path:               profiling
+  Install:            false
+  Findlibname:        profiling
+  Modules:            Coverage
+  BuildDepends: 
+
 Library xenopsd
   CompiledObject:     best
   Path:               lib
@@ -53,7 +63,6 @@ Library xenopsd
     Xenstore,
     Version
   BuildDepends:
-    bisect_ppx,       
     threads,
     threads.posix,
     uuidm,
@@ -86,10 +95,10 @@ Executable set_domain_uuid
   MainIs:             set_domain_uuid.ml
   Install:            false
   BuildDepends:
-    bisect_ppx, 
     xenctrl, 
     uuidm, 
-    cmdliner
+    cmdliner,
+    profiling
 
 Executable suspend_image_viewer
   CompiledObject:     best
@@ -99,9 +108,9 @@ Executable suspend_image_viewer
   MainIs:             suspend_image_viewer.ml
   Install:            false
   BuildDepends:
-    bisect_ppx,       
     xenopsd, 
-    cmdliner
+    cmdliner,
+    profiling
 
 Executable xenopsd_xc_main
   CompiledObject:     best
@@ -113,7 +122,6 @@ Executable xenopsd_xc_main
   Custom:             true
   Install:            false
   BuildDepends:
-    bisect_ppx,       
     xenctrl,
     xenopsd,
     xenstore,
@@ -128,7 +136,8 @@ Executable xenopsd_xc_main
     xcp.rrd,
     rrd,
     sexplib,
-    xcp-inventory
+    xcp-inventory,
+    profiling
   CSources:           fsync_stubs.c, xenctrlext_stubs.c
 
 Executable watch_test
@@ -139,13 +148,13 @@ Executable watch_test
   MainIs:             watch_test.ml
   Install:            false
   BuildDepends:
-    bisect_ppx,       
     xenopsd,
     xenstore,
     xenstore.unix,
     xenstore_transport,
     xenstore_transport.unix,
-    threads
+    threads,
+    profiling
 
 Executable xenopsd_simulator
   CompiledObject:     best
@@ -157,8 +166,8 @@ Executable xenopsd_simulator
   Custom:             true
   Install:            false
   BuildDepends:
-    bisect_ppx,       
-    xenopsd
+    xenopsd,
+    profiling
 
 Executable xenopsd_libvirt_main
   CompiledObject:     best
@@ -170,14 +179,14 @@ Executable xenopsd_libvirt_main
   Custom:             true
   Install:            false
   BuildDepends:
-    bisect_ppx,       
     xenopsd,
     rpclib,
     forkexec,
     xcp,
     xcp.storage,
     sexplib,
-    libvirt
+    libvirt,
+    profiling
 
 Executable xenopsd_xenlight_main
   CompiledObject:     best
@@ -189,7 +198,6 @@ Executable xenopsd_xenlight_main
   Custom:             true
   Install:            false
   BuildDepends:
-    bisect_ppx,       
     xenlight,
     xentoollog,
     xenctrl,
@@ -205,6 +213,7 @@ Executable xenopsd_xenlight_main
     xcp.memory,
     sexplib,
     xcp-inventory,
-    optcomp
+    optcomp,
+    profiling
   CSources:           fsync_stubs.c, poll_stubs.c