guix: added a procedure to automatically build wfmash and invoke the …

…profiler wfmash-gcc-profile-git

doc:  documented this procedure

doc/performance-tuning.md

@@ -234,6 +234,38 @@ Total: 52257 samples
 
 which is not that different from all2all.
 
+# Automatically running the profiler
+
+If you use Guix you can simply run the profiler for all2all from a checked out git repo with the command:
+
+```
+guix build -L . wfmash-gcc-profile-git
+```
+
+This will build wfmash with optimization flags and run the profiler automatically.
+The tests run for a minute or two.
+If you scroll a bit up in the output you can see
+
+```
+[wfmash] Performing all-vs-all mapping including self mappings.
+1/1 Test #7: wfmash-all2all ...................   Passed  121.70 sec
+(...)
+Total: 45863 samples
+   11809  25.7%  25.7%    11814  25.8% align::Aligner::single_reader_thread
+   11529  25.1%  50.9%    11529  25.1% wavefront_bialign_breakpoint_indel2indel
+    6363  13.9%  64.8%     6363  13.9% wavefront_extend_matches_packed_end2end_max
+    2837   6.2%  70.9%     2837   6.2% wavefront_compute_affine2p_idm
+    2040   4.4%  75.4%     2040   4.4% wavefront_bialign_breakpoint_m2m
+    1275   2.8%  78.2%     1275   2.8% wavefront_extend_matches_packed_end2end
+    1186   2.6%  80.8%     1485   3.2% skch::CommonFunc::addMinmers
+     784   1.7%  82.5%      784   1.7% wavefront_compute_trim_ends
+     627   1.4%  83.8%      627   1.4% inflateBackEnd@@ZLIB_1.2.0
+```
+
+Update the sources and simply run again! It is the coolest thing.
+
+For more information on installing and running Guix see the header of [guix.scm](../guix.scm). Guix is distribution agnostic and runs on, for example, Debian. That is what we do.
+
 # Conclusion
 
 With a bit of tweaking a 10-20% speed gain is easily possible on my Ryzen. Native compilation, openmp, lto and the static build appears to have the largest impact. PGO is, somewhat surprisingly, detrimental. Running outside a container is faster than running inside a container.

guix.scm

@@ -1,10 +1,11 @@
 ;; To use this file to build a version of wfmash using git HEAD:
 ;;
-;;  guix build -f guix.scm                # default build
-;;  guix build -L . wfmash-gcc-git        # stanard gcc build
-;;  guix build -L . wfmash-gcc-debug-git  # gcc build with debug and ASAN
-;;  guix build -L . wfmash-static-gcc-git # gcc static build (default)
-;;  guix build -L . wfmash-clang-git      # clang build
+;;   guix build -f guix.scm                  # default build
+;;   guix build -L . wfmash-gcc-git          # stanard gcc build
+;;   guix build -L . wfmash-gcc-debug-git    # gcc build with debug and ASAN
+;;   guix build -L . wfmash-gcc-profile-git  # run the profiler!
+;;   guix build -L . wfmash-static-gcc-git   # gcc static build (default)
+;;   guix build -L . wfmash-clang-git        # clang build
 ;;
 ;; To get a development container using a recent guix (see `guix pull`)
 ;;
@@ -135,7 +136,7 @@ obtain base-level alignments.")
     (name "wfmash-gcc-debug-git")
     (version (git-version "0.21" "HEAD" %git-commit))
     (arguments
-     `(;; #:tests? #f
+     `(;; #:tests? #f ;; skip tests, this is mostly to run a shell
        #:configure-flags
        ,#~(list
            "-DASAN=ON"
@@ -145,7 +146,6 @@ obtain base-level alignments.")
      (modify-inputs (package-inputs wfmash-gcc-git)
          (append gperftools
                  )))
-
     ))
 
 (define-public wfmash-clang-git
@@ -162,6 +162,35 @@ obtain base-level alignments.")
                  )))
     ))
 
+(define-public wfmash-gcc-profile-git
+  "Build wfmash optimally and automatically run profiler on all tests"
+  (package
+    (inherit wfmash-gcc-git)
+    (name "wfmash-gcc-profile-git")
+    (version (git-version "0.21" "HEAD" %git-commit))
+    (arguments
+     `(#:tests? #f ;; running tests as profiler
+       #:configure-flags
+         ,#~(list
+             "-DCMAKE_BUILD_TYPE=Release"
+             "-DBUILD_OPTIMIZED=ON"
+             "-DPROFILER=ON")
+       #:phases
+         ,#~(modify-phases %standard-phases
+            (add-after 'install 'run-profiler-on-all2all
+                       (lambda* (#:key outputs #:allow-other-keys)
+                         (invoke "ctest" "--verbose" "-R" "all2all") ; only run all2all test
+                         (invoke "ls" "-l" "bin/wfmash")
+                         (invoke "ls" "-l")
+                         (invoke "pprof" "--text" "bin/wfmash" "wfmash.prof")
+                         (mkdir-p (string-append #$output:doc "/share")))))))
+    (inputs
+     (modify-inputs (package-inputs wfmash-gcc-git)
+                    (append gperftools
+                            coreutils ;; for ls
+                 )))
+    ))
+
 ;; ==== The following is for static binary builds using gcc - used mostly for deployment ===
 
 ;; Guix does not come with a static version of libdeflate