Merge pull request #80 from lindig/coverage

CP-17268 add support for coverage profiling

Author: euanh

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-<binary>-*.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
+
+
+
+

INSTALL

@@ -1,7 +1,20 @@
+
+# Installation
+
 The easiest way to install is via opam:
 
     opam init
     opam remote add xen-org git://github.com/xen-org/opam-repo-dev
     opam install xcp-networkd
 
+# Coverage Profiling
+
+This code can be instrumented for coverage profiling:
+
+    make coverage
+    make
+
+See [COVERAGE.md](./COVERAGE.md) for details and
+[profiling/](./profiling/) for supporting code.
+
 

Makefile

@@ -47,4 +47,21 @@ clean:
 	@ocamlbuild -clean
 	@rm -f setup.data setup.log setup.bin
 	rm networkd/version.ml
-	rm xcp-networkd xcp-networkd.1
+	rm xcp-networkd.1
+
+
+# make coverage - prepares for building with coverage analysis
+# make uncover  - reverses the setup from "make coverage"
+# make report   - create coverage/index.html 
+
+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
+
+report:
+	bisect-ppx-report -I _build -html coverage /tmp/bisect-network*out
+
+.PHONY: report coverage uncover

README.markdown

@@ -1,8 +1,11 @@
+
+# XCP Networkd
+
 Xen API (or xapi) is a management stack that configures and controls
 Xen-enabled hosts and resource pools, and co-ordinates resources
 within the pool.  Xapi exposes the Xen API interface for many
 languages and is a component of the Xen Cloud Platform (XCP) project.
-Xen API is written mostly in [Ocaml](http://caml.inria.fr/ocaml/) 3.12.
+Xen API is written mostly in [OCaml](http://ocaml.org/) 3.12.
 
 Xen Cloud Platform (XCP) is an open source enterprise-ready server
 virtualization and cloud computing platform.  XCP builds on the Xen
@@ -22,3 +25,5 @@ Links:
 
 You can usually find the developers hanging out in #xen-api on
 freenode.
+
+

_oasis

@@ -7,12 +7,26 @@ License:     LGPL-2.1 with OCaml linking exception
 Plugins:     META (0.2)
 BuildTools:  ocamlbuild
 
+Library profiling
+  CompiledObject:     best
+  Path:               profiling
+  Install:            false
+  Modules:            Coverage
+  BuildDepends: 
+
 Library networklibs
   CompiledObject:     best
   Path:               lib
   Findlibname:        network-libs
   Modules:            Network_config, Network_utils
-  BuildDepends:       forkexec, stdext, threads, rpclib, stdext, xcp-inventory, xcp.network
+  BuildDepends:       
+    forkexec,
+    stdext,
+    threads,
+    rpclib,
+    stdext,
+    xcp-inventory,
+    xcp.network
   CSources:           link_stubs.c, netdev.h
   CCOpt:              -Wno-unused-function -g -ggdb
 
@@ -22,22 +36,43 @@ Executable xcp_networkd
   MainIs:             networkd.ml
   Custom:             true
   Install:            false
-  BuildDepends:       threads, rpclib, rpclib.unix, forkexec, stdext, xcp-inventory, network-libs, xen-api-client, xcp, xcp.network, netlink
+  BuildDepends:       
+    profiling,
+    threads,
+    rpclib,
+    rpclib.unix,
+    forkexec,
+    stdext,
+    xcp-inventory,
+    network-libs,
+    xen-api-client,
+    xcp,
+    xcp.network,
+    netlink
 
 Executable networkd_db
   CompiledObject:     best
   Path:               networkd_db
   MainIs:             networkd_db.ml
   Custom:             true
   Install:            false
-  BuildDepends:       network-libs, stdext, threads, xcp.network
+  BuildDepends:       
+    profiling,
+    network-libs,
+    stdext,
+    threads,
+    xcp.network
 
 Executable network_test
   CompiledObject:     best
   Path:               test
   MainIs:             network_test.ml
   Install:            false
-  BuildDepends:       stdext, oUnit, network-libs
+  BuildDepends:       
+    profiling,
+    stdext,
+    oUnit,
+    network-libs
 
 Test test_networkd
   Run$: flag(tests)
@@ -48,5 +83,11 @@ Executable cli
   CompiledObject:     best
   Path:               cli
   MainIs:             network_cli.ml
-  BuildDepends:       cmdliner, stdext, network-libs, xcp, xcp.network
+  BuildDepends:       
+    profiling,
+    cmdliner,
+    stdext,
+    network-libs,
+    xcp,
+    xcp.network
 

_tags

@@ -1,5 +1,5 @@
 # OASIS_START
-# DO NOT EDIT (digest: 24d382d63f193063ab9b3c2a825d1463)
+# DO NOT EDIT (digest: 6a8937157d81341f64a601d75a86be7f)
 # 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
@@ -14,6 +14,8 @@ true: annot, bin_annot
 ".git": not_hygienic
 "_darcs": -traverse
 "_darcs": not_hygienic
+# Library profiling
+"profiling/profiling.cmxs": use_profiling
 # Library networklibs
 "lib/networklibs.cmxs": use_networklibs
 <lib/*.ml{,i,y}>: oasis_library_networklibs_ccopt
@@ -43,6 +45,7 @@ true: annot, bin_annot
 <networkd/networkd.{native,byte}>: pkg_xcp.network
 <networkd/networkd.{native,byte}>: pkg_xen-api-client
 <networkd/networkd.{native,byte}>: use_networklibs
+<networkd/networkd.{native,byte}>: use_profiling
 <networkd/*.ml{,i,y}>: pkg_forkexec
 <networkd/*.ml{,i,y}>: pkg_netlink
 <networkd/*.ml{,i,y}>: pkg_rpclib
@@ -54,6 +57,7 @@ true: annot, bin_annot
 <networkd/*.ml{,i,y}>: pkg_xcp.network
 <networkd/*.ml{,i,y}>: pkg_xen-api-client
 <networkd/*.ml{,i,y}>: use_networklibs
+<networkd/*.ml{,i,y}>: use_profiling
 <networkd/networkd.{native,byte}>: custom
 # Executable networkd_db
 <networkd_db/networkd_db.{native,byte}>: pkg_forkexec
@@ -63,13 +67,15 @@ true: annot, bin_annot
 <networkd_db/networkd_db.{native,byte}>: pkg_xcp-inventory
 <networkd_db/networkd_db.{native,byte}>: pkg_xcp.network
 <networkd_db/networkd_db.{native,byte}>: use_networklibs
+<networkd_db/networkd_db.{native,byte}>: use_profiling
 <networkd_db/*.ml{,i,y}>: pkg_forkexec
 <networkd_db/*.ml{,i,y}>: pkg_rpclib
 <networkd_db/*.ml{,i,y}>: pkg_stdext
 <networkd_db/*.ml{,i,y}>: pkg_threads
 <networkd_db/*.ml{,i,y}>: pkg_xcp-inventory
 <networkd_db/*.ml{,i,y}>: pkg_xcp.network
 <networkd_db/*.ml{,i,y}>: use_networklibs
+<networkd_db/*.ml{,i,y}>: use_profiling
 <networkd_db/networkd_db.{native,byte}>: custom
 # Executable network_test
 <test/network_test.{native,byte}>: pkg_forkexec
@@ -80,6 +86,7 @@ true: annot, bin_annot
 <test/network_test.{native,byte}>: pkg_xcp-inventory
 <test/network_test.{native,byte}>: pkg_xcp.network
 <test/network_test.{native,byte}>: use_networklibs
+<test/network_test.{native,byte}>: use_profiling
 <test/*.ml{,i,y}>: pkg_forkexec
 <test/*.ml{,i,y}>: pkg_oUnit
 <test/*.ml{,i,y}>: pkg_rpclib
@@ -88,6 +95,7 @@ true: annot, bin_annot
 <test/*.ml{,i,y}>: pkg_xcp-inventory
 <test/*.ml{,i,y}>: pkg_xcp.network
 <test/*.ml{,i,y}>: use_networklibs
+<test/*.ml{,i,y}>: use_profiling
 # Executable cli
 <cli/network_cli.{native,byte}>: pkg_cmdliner
 <cli/network_cli.{native,byte}>: pkg_forkexec
@@ -98,6 +106,7 @@ true: annot, bin_annot
 <cli/network_cli.{native,byte}>: pkg_xcp-inventory
 <cli/network_cli.{native,byte}>: pkg_xcp.network
 <cli/network_cli.{native,byte}>: use_networklibs
+<cli/network_cli.{native,byte}>: use_profiling
 <cli/*.ml{,i,y}>: pkg_cmdliner
 <cli/*.ml{,i,y}>: pkg_forkexec
 <cli/*.ml{,i,y}>: pkg_rpclib
@@ -107,5 +116,6 @@ true: annot, bin_annot
 <cli/*.ml{,i,y}>: pkg_xcp-inventory
 <cli/*.ml{,i,y}>: pkg_xcp.network
 <cli/*.ml{,i,y}>: use_networklibs
+<cli/*.ml{,i,y}>: use_profiling
 # OASIS_STOP
 

_tags.coverage

@@ -0,0 +1,6 @@
+# START_COVERAGE
+# coverage analysis with bisect_ppx
+# compile and link with package bisect_ppx
+<**/*.ml{,i,y}>: pkg_bisect_ppx
+<**/*.native>:   pkg_bisect_ppx
+# END_COVERAGE

cli/network_cli.ml

@@ -350,5 +350,6 @@ let cmds = [
 	config_cmd]
 
 let _ =
+	Coverage.init "network_cli";
 	match Term.eval_choice default_cmd cmds with
 	| `Error _ -> exit 1 | _ -> exit 0

myocamlbuild.ml

@@ -1,5 +1,5 @@
 (* OASIS_START *)
-(* DO NOT EDIT (digest: 4ff56aec2dfea165b1692e299cedba7e) *)
+(* DO NOT EDIT (digest: cda025dade953b8f1e9b18cca6f3e0fb) *)
 module OASISGettext = struct
 (* # 22 "src/oasis/OASISGettext.ml" *)
 
@@ -607,7 +607,8 @@ end
 open Ocamlbuild_plugin;;
 let package_default =
   {
-     MyOCamlbuildBase.lib_ocaml = [("networklibs", ["lib"], [])];
+     MyOCamlbuildBase.lib_ocaml =
+       [("profiling", ["profiling"], []); ("networklibs", ["lib"], [])];
      lib_c = [("networklibs", "lib", ["lib/netdev.h"])];
      flags =
        [
@@ -627,10 +628,10 @@ let package_default =
        ];
      includes =
        [
-          ("test", ["lib"]);
-          ("networkd_db", ["lib"]);
-          ("networkd", ["lib"]);
-          ("cli", ["lib"])
+          ("test", ["lib"; "profiling"]);
+          ("networkd_db", ["lib"; "profiling"]);
+          ("networkd", ["lib"; "profiling"]);
+          ("cli", ["lib"; "profiling"])
        ]
   }
   ;;
@@ -639,6 +640,6 @@ let conf = {MyOCamlbuildFindlib.no_automatic_syntax = false}
 
 let dispatch_default = MyOCamlbuildBase.dispatch_default conf package_default;;
 
-# 643 "myocamlbuild.ml"
+# 644 "myocamlbuild.ml"
 (* OASIS_STOP *)
 Ocamlbuild_plugin.dispatch dispatch_default;;

networkd/networkd.ml

@@ -54,6 +54,7 @@ let options = [
 	"mac-table-size", Arg.Set_int Network_utils.mac_table_size, (fun () -> string_of_int !Network_utils.mac_table_size), "Default value for the mac-table-size openvswitch parameter (see ovs-vswitchd.conf.db.5)";
 ]
 
+
 let start server =
 	Network_monitor_thread.start ();
 	Network_server.on_startup ();
@@ -79,6 +80,7 @@ let doc = String.concat "\n" [
 ]
 
 let _ =
+	Coverage.init "networkd";
 	begin match Xcp_service.configure2
 		~name:Sys.argv.(0)
 		~version:Version.version