CP-17268 Integrate bisect_ppx for coverage profiling.

Bisect dumps it report by registering a function through at_exit. This
wasn't called by xenopsd. We added a handler to catch the SIGTERM signal
used by the systemd service framework to stop the service. This leads to
the profiling data being dumped.

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

Author: lindig

_oasis

@@ -29,8 +29,53 @@ Library xenopsd
   Findlibname:        xenopsd
   ByteOpt:            -warn-error +a
   NativeOpt:          -warn-error +a
-  Modules:            Suspend_image, Cancellable_subprocess, Bootloader, Ionice, Mac, Xenops_migrate, Xenops_hooks, Task_server, Xenops_task, Updates, Xenops_utils, Xenops_server, Xenopsd, Xenops_server_plugin, Xenops_server_skeleton, Scheduler, Path, Storage, Interface, Xenctrl_uuid, Xenstore, Version
-  BuildDepends:       threads, threads.posix, uuidm, xmlm, cohttp, uri, rpclib, rpclib.syntax, forkexec, fd-send-recv, xcp, xcp.xen, xcp.storage, sexplib, sexplib.syntax, xcp, uutf, xenstore, xenstore.unix, xenstore_transport, xenstore_transport.unix, oclock
+  Modules:            
+    Suspend_image,
+    Cancellable_subprocess,
+    Bootloader,
+    Ionice,
+    Mac,
+    Xenops_migrate,
+    Xenops_hooks,
+    Task_server,
+    Xenops_task,
+    Updates,
+    Xenops_utils,
+    Xenops_server,
+    Xenopsd,
+    Xenops_server_plugin,
+    Xenops_server_skeleton,
+    Scheduler,
+    Path,
+    Storage,
+    Interface,
+    Xenctrl_uuid,
+    Xenstore,
+    Version
+  BuildDepends:
+    bisect_ppx,       
+    threads,
+    threads.posix,
+    uuidm,
+    xmlm,
+    cohttp,
+    uri,
+    rpclib,
+    rpclib.syntax,
+    forkexec,
+    fd-send-recv,
+    xcp,
+    xcp.xen,
+    xcp.storage,
+    sexplib,
+    sexplib.syntax,
+    xcp,
+    uutf,
+    xenstore,
+    xenstore.unix,
+    xenstore_transport,
+    xenstore_transport.unix,
+    oclock
   CSources:	      sockopt_stubs.c
 
 Executable set_domain_uuid
@@ -40,7 +85,11 @@ Executable set_domain_uuid
   NativeOpt:          -warn-error +a-3
   MainIs:             set_domain_uuid.ml
   Install:            false
-  BuildDepends:       xenctrl, uuidm, cmdliner
+  BuildDepends:
+    bisect_ppx, 
+    xenctrl, 
+    uuidm, 
+    cmdliner
 
 Executable suspend_image_viewer
   CompiledObject:     best
@@ -49,7 +98,10 @@ Executable suspend_image_viewer
   NativeOpt:          -warn-error +a-3
   MainIs:             suspend_image_viewer.ml
   Install:            false
-  BuildDepends:       xenopsd, cmdliner
+  BuildDepends:
+    bisect_ppx,       
+    xenopsd, 
+    cmdliner
 
 Executable xenopsd_xc_main
   CompiledObject:     best
@@ -60,7 +112,23 @@ Executable xenopsd_xc_main
   Build$:             flag(xen)
   Custom:             true
   Install:            false
-  BuildDepends:       xenctrl, xenopsd, xenstore, xenstore.unix, xenstore_transport, xenstore_transport.unix, rpclib, forkexec, xcp, xcp.storage, xcp.memory, xcp.rrd, rrd, sexplib, xcp-inventory
+  BuildDepends:
+    bisect_ppx,       
+    xenctrl,
+    xenopsd,
+    xenstore,
+    xenstore.unix,
+    xenstore_transport,
+    xenstore_transport.unix,
+    rpclib,
+    forkexec,
+    xcp,
+    xcp.storage,
+    xcp.memory,
+    xcp.rrd,
+    rrd,
+    sexplib,
+    xcp-inventory
   CSources:           fsync_stubs.c, xenctrlext_stubs.c
 
 Executable watch_test
@@ -70,7 +138,14 @@ Executable watch_test
   NativeOpt:          -warn-error +a-3
   MainIs:             watch_test.ml
   Install:            false
-  BuildDepends:       xenopsd, xenstore, xenstore.unix, xenstore_transport, xenstore_transport.unix, threads
+  BuildDepends:
+    bisect_ppx,       
+    xenopsd,
+    xenstore,
+    xenstore.unix,
+    xenstore_transport,
+    xenstore_transport.unix,
+    threads
 
 Executable xenopsd_simulator
   CompiledObject:     best
@@ -81,7 +156,9 @@ Executable xenopsd_simulator
   Build$:             flag(simulator)
   Custom:             true
   Install:            false
-  BuildDepends:       xenopsd
+  BuildDepends:
+    bisect_ppx,       
+    xenopsd
 
 Executable xenopsd_libvirt_main
   CompiledObject:     best
@@ -92,7 +169,15 @@ Executable xenopsd_libvirt_main
   Build$:             flag(libvirt)
   Custom:             true
   Install:            false
-  BuildDepends:       xenopsd, rpclib, forkexec, xcp, xcp.storage, sexplib, libvirt
+  BuildDepends:
+    bisect_ppx,       
+    xenopsd,
+    rpclib,
+    forkexec,
+    xcp,
+    xcp.storage,
+    sexplib,
+    libvirt
 
 Executable xenopsd_xenlight_main
   CompiledObject:     best
@@ -103,6 +188,23 @@ Executable xenopsd_xenlight_main
   Build$:             flag(xenlight)
   Custom:             true
   Install:            false
-  BuildDepends:       xenlight, xentoollog, xenctrl, xenopsd, xenstore, xenstore.unix, xenstore_transport, xenstore_transport.unix, rpclib, forkexec, xcp, xcp.storage, xcp.memory, sexplib, xcp-inventory, optcomp
+  BuildDepends:
+    bisect_ppx,       
+    xenlight,
+    xentoollog,
+    xenctrl,
+    xenopsd,
+    xenstore,
+    xenstore.unix,
+    xenstore_transport,
+    xenstore_transport.unix,
+    rpclib,
+    forkexec,
+    xcp,
+    xcp.storage,
+    xcp.memory,
+    sexplib,
+    xcp-inventory,
+    optcomp
   CSources:           fsync_stubs.c, poll_stubs.c
 

_tags

@@ -1,5 +1,5 @@
 # OASIS_START
-# DO NOT EDIT (digest: 76fa96e6edac33c29cf074bb5b0859c0)
+# DO NOT EDIT (digest: bc2d8703604b2841004d3d8041cc1775)
 # Ignore VCS directories, you can use the same kind of rule outside
 # OASIS_START/STOP if you want to exclude directories that contains
 # useless stuff for the build process
@@ -23,6 +23,7 @@ true: annot, bin_annot
 <lib/*.ml{,i,y}>: oasis_library_xenopsd_native
 "lib/sockopt_stubs.c": oasis_library_xenopsd_native
 <lib/xenopsd.{cma,cmxa}>: use_libxenopsd_stubs
+"lib/sockopt_stubs.c": pkg_bisect_ppx
 "lib/sockopt_stubs.c": pkg_cohttp
 "lib/sockopt_stubs.c": pkg_fd-send-recv
 "lib/sockopt_stubs.c": pkg_forkexec
@@ -49,9 +50,11 @@ true: annot, bin_annot
 <tools/*.ml{,i,y}>: oasis_executable_set_domain_uuid_byte
 <tools/set_domain_uuid.{native,byte}>: oasis_executable_set_domain_uuid_native
 <tools/*.ml{,i,y}>: oasis_executable_set_domain_uuid_native
+<tools/set_domain_uuid.{native,byte}>: pkg_bisect_ppx
 <tools/set_domain_uuid.{native,byte}>: pkg_cmdliner
 <tools/set_domain_uuid.{native,byte}>: pkg_uuidm
 <tools/set_domain_uuid.{native,byte}>: pkg_xenctrl
+<tools/*.ml{,i,y}>: pkg_bisect_ppx
 <tools/*.ml{,i,y}>: pkg_cmdliner
 <tools/*.ml{,i,y}>: pkg_uuidm
 <tools/*.ml{,i,y}>: pkg_xenctrl
@@ -60,6 +63,7 @@ true: annot, bin_annot
 <lib/*.ml{,i,y}>: oasis_executable_suspend_image_viewer_byte
 <lib/suspend_image_viewer.{native,byte}>: oasis_executable_suspend_image_viewer_native
 <lib/*.ml{,i,y}>: oasis_executable_suspend_image_viewer_native
+<lib/suspend_image_viewer.{native,byte}>: pkg_bisect_ppx
 <lib/suspend_image_viewer.{native,byte}>: pkg_cmdliner
 <lib/suspend_image_viewer.{native,byte}>: pkg_cohttp
 <lib/suspend_image_viewer.{native,byte}>: pkg_fd-send-recv
@@ -83,6 +87,7 @@ true: annot, bin_annot
 <lib/suspend_image_viewer.{native,byte}>: pkg_xenstore_transport.unix
 <lib/suspend_image_viewer.{native,byte}>: pkg_xmlm
 <lib/suspend_image_viewer.{native,byte}>: use_xenopsd
+<lib/*.ml{,i,y}>: pkg_bisect_ppx
 <lib/*.ml{,i,y}>: pkg_cmdliner
 <lib/*.ml{,i,y}>: pkg_cohttp
 <lib/*.ml{,i,y}>: pkg_fd-send-recv
@@ -116,6 +121,7 @@ true: annot, bin_annot
 "xc/fsync_stubs.c": oasis_executable_xenopsd_xc_main_native
 "xc/xenctrlext_stubs.c": oasis_executable_xenopsd_xc_main_native
 <xc/xenops_xc_main.{native,byte}>: use_libxenopsd_xc_main_stubs
+<xc/xenops_xc_main.{native,byte}>: pkg_bisect_ppx
 <xc/xenops_xc_main.{native,byte}>: pkg_cohttp
 <xc/xenops_xc_main.{native,byte}>: pkg_fd-send-recv
 <xc/xenops_xc_main.{native,byte}>: pkg_forkexec
@@ -148,6 +154,7 @@ true: annot, bin_annot
 <xc/*.ml{,i,y}>: pkg_xcp.memory
 <xc/*.ml{,i,y}>: pkg_xcp.rrd
 <xc/*.ml{,i,y}>: pkg_xenctrl
+"xc/fsync_stubs.c": pkg_bisect_ppx
 "xc/fsync_stubs.c": pkg_cohttp
 "xc/fsync_stubs.c": pkg_fd-send-recv
 "xc/fsync_stubs.c": pkg_forkexec
@@ -175,6 +182,7 @@ true: annot, bin_annot
 "xc/fsync_stubs.c": pkg_xenstore_transport.unix
 "xc/fsync_stubs.c": pkg_xmlm
 "xc/fsync_stubs.c": use_xenopsd
+"xc/xenctrlext_stubs.c": pkg_bisect_ppx
 "xc/xenctrlext_stubs.c": pkg_cohttp
 "xc/xenctrlext_stubs.c": pkg_fd-send-recv
 "xc/xenctrlext_stubs.c": pkg_forkexec
@@ -208,6 +216,7 @@ true: annot, bin_annot
 <xc/*.ml{,i,y}>: oasis_executable_watch_test_byte
 <xc/watch_test.{native,byte}>: oasis_executable_watch_test_native
 <xc/*.ml{,i,y}>: oasis_executable_watch_test_native
+<xc/watch_test.{native,byte}>: pkg_bisect_ppx
 <xc/watch_test.{native,byte}>: pkg_cohttp
 <xc/watch_test.{native,byte}>: pkg_fd-send-recv
 <xc/watch_test.{native,byte}>: pkg_forkexec
@@ -230,6 +239,7 @@ true: annot, bin_annot
 <xc/watch_test.{native,byte}>: pkg_xenstore_transport.unix
 <xc/watch_test.{native,byte}>: pkg_xmlm
 <xc/watch_test.{native,byte}>: use_xenopsd
+<xc/*.ml{,i,y}>: pkg_bisect_ppx
 <xc/*.ml{,i,y}>: pkg_cohttp
 <xc/*.ml{,i,y}>: pkg_fd-send-recv
 <xc/*.ml{,i,y}>: pkg_forkexec
@@ -257,6 +267,7 @@ true: annot, bin_annot
 <simulator/*.ml{,i,y}>: oasis_executable_xenopsd_simulator_byte
 <simulator/xenops_simulator_main.{native,byte}>: oasis_executable_xenopsd_simulator_native
 <simulator/*.ml{,i,y}>: oasis_executable_xenopsd_simulator_native
+<simulator/xenops_simulator_main.{native,byte}>: pkg_bisect_ppx
 <simulator/xenops_simulator_main.{native,byte}>: pkg_cohttp
 <simulator/xenops_simulator_main.{native,byte}>: pkg_fd-send-recv
 <simulator/xenops_simulator_main.{native,byte}>: pkg_forkexec
@@ -279,6 +290,7 @@ true: annot, bin_annot
 <simulator/xenops_simulator_main.{native,byte}>: pkg_xenstore_transport.unix
 <simulator/xenops_simulator_main.{native,byte}>: pkg_xmlm
 <simulator/xenops_simulator_main.{native,byte}>: use_xenopsd
+<simulator/*.ml{,i,y}>: pkg_bisect_ppx
 <simulator/*.ml{,i,y}>: pkg_cohttp
 <simulator/*.ml{,i,y}>: pkg_fd-send-recv
 <simulator/*.ml{,i,y}>: pkg_forkexec
@@ -307,6 +319,7 @@ true: annot, bin_annot
 <libvirt/*.ml{,i,y}>: oasis_executable_xenopsd_libvirt_main_byte
 <libvirt/xenops_libvirt_main.{native,byte}>: oasis_executable_xenopsd_libvirt_main_native
 <libvirt/*.ml{,i,y}>: oasis_executable_xenopsd_libvirt_main_native
+<libvirt/xenops_libvirt_main.{native,byte}>: pkg_bisect_ppx
 <libvirt/xenops_libvirt_main.{native,byte}>: pkg_cohttp
 <libvirt/xenops_libvirt_main.{native,byte}>: pkg_fd-send-recv
 <libvirt/xenops_libvirt_main.{native,byte}>: pkg_forkexec
@@ -330,6 +343,7 @@ true: annot, bin_annot
 <libvirt/xenops_libvirt_main.{native,byte}>: pkg_xenstore_transport.unix
 <libvirt/xenops_libvirt_main.{native,byte}>: pkg_xmlm
 <libvirt/xenops_libvirt_main.{native,byte}>: use_xenopsd
+<libvirt/*.ml{,i,y}>: pkg_bisect_ppx
 <libvirt/*.ml{,i,y}>: pkg_cohttp
 <libvirt/*.ml{,i,y}>: pkg_fd-send-recv
 <libvirt/*.ml{,i,y}>: pkg_forkexec
@@ -364,6 +378,7 @@ true: annot, bin_annot
 "xl/fsync_stubs.c": oasis_executable_xenopsd_xenlight_main_native
 "xl/poll_stubs.c": oasis_executable_xenopsd_xenlight_main_native
 <xl/xenops_xl_main.{native,byte}>: use_libxenopsd_xenlight_main_stubs
+<xl/xenops_xl_main.{native,byte}>: pkg_bisect_ppx
 <xl/xenops_xl_main.{native,byte}>: pkg_cohttp
 <xl/xenops_xl_main.{native,byte}>: pkg_fd-send-recv
 <xl/xenops_xl_main.{native,byte}>: pkg_forkexec
@@ -392,6 +407,7 @@ true: annot, bin_annot
 <xl/xenops_xl_main.{native,byte}>: pkg_xentoollog
 <xl/xenops_xl_main.{native,byte}>: pkg_xmlm
 <xl/xenops_xl_main.{native,byte}>: use_xenopsd
+<xl/*.ml{,i,y}>: pkg_bisect_ppx
 <xl/*.ml{,i,y}>: pkg_cohttp
 <xl/*.ml{,i,y}>: pkg_fd-send-recv
 <xl/*.ml{,i,y}>: pkg_forkexec
@@ -420,6 +436,7 @@ true: annot, bin_annot
 <xl/*.ml{,i,y}>: pkg_xentoollog
 <xl/*.ml{,i,y}>: pkg_xmlm
 <xl/*.ml{,i,y}>: use_xenopsd
+"xl/fsync_stubs.c": pkg_bisect_ppx
 "xl/fsync_stubs.c": pkg_cohttp
 "xl/fsync_stubs.c": pkg_fd-send-recv
 "xl/fsync_stubs.c": pkg_forkexec
@@ -448,6 +465,7 @@ true: annot, bin_annot
 "xl/fsync_stubs.c": pkg_xentoollog
 "xl/fsync_stubs.c": pkg_xmlm
 "xl/fsync_stubs.c": use_xenopsd
+"xl/poll_stubs.c": pkg_bisect_ppx
 "xl/poll_stubs.c": pkg_cohttp
 "xl/poll_stubs.c": pkg_fd-send-recv
 "xl/poll_stubs.c": pkg_forkexec

lib/META

@@ -1,9 +1,9 @@
 # OASIS_START
-# DO NOT EDIT (digest: 5586ee166df30de6e433138bcd3d4222)
+# DO NOT EDIT (digest: 0a7a90b9f68d35d7f16b955e0a87a0b0)
 version = "0.12.0"
 description = "XenServer domain managers"
 requires =
-"threads threads.posix uuidm xmlm cohttp uri rpclib rpclib.syntax forkexec fd-send-recv xcp xcp.xen xcp.storage sexplib sexplib.syntax xcp uutf xenstore xenstore.unix xenstore_transport xenstore_transport.unix oclock"
+"bisect_ppx threads threads.posix uuidm xmlm cohttp uri rpclib rpclib.syntax forkexec fd-send-recv xcp xcp.xen xcp.storage sexplib sexplib.syntax xcp uutf xenstore xenstore.unix xenstore_transport xenstore_transport.unix oclock"
 archive(byte) = "xenopsd.cma"
 archive(byte, plugin) = "xenopsd.cma"
 archive(native) = "xenopsd.cmxa"

lib/xenopsd.ml

@@ -133,9 +133,17 @@ let main backend =
 		~rpc_fn
 	        () in
 
+  (** we need to catch this to make sure at_exit handlers are
+   * triggered. In particuar, triggers for the bisect_ppx coverage
+   * profiling *)
+
+  let signal_handler n =
+    debug "caught signal %d" n; exit 0 in
+
 	Xcp_service.maybe_daemonize ();
 
 	Sys.set_signal Sys.sigpipe Sys.Signal_ignore;
+  Sys.set_signal Sys.sigterm (Sys.Signal_handle signal_handler);
 
 	Xenops_utils.set_fs_backend
 		(Some (if !persist