HTML-Heatmap-Generation in futhark profile

docs/man/futhark-profile.rst

@@ -14,9 +14,10 @@ futhark profile JSONFILES
 DESCRIPTION
 ===========
 
-This tool produces human-readable profiling information based on information
-collected with :ref:`futhark bench<futhark-bench(1)>`. Futhark has basic support
-for profiling. The system can collect information about the run-time behaviour
+This tool produces human- and browser-readable profiling information based on 
+information collected with :ref:`futhark bench<futhark-bench(1)>`.
+Futhark has basic support for profiling.
+The system can collect information about the run-time behaviour
 of the program, and connects it as best it is able to the program source code.
 This works best for the GPU backends, and not at all for the sequential
 backends. The collected information can then be used to estimate the source of
@@ -47,7 +48,7 @@ Files produced
 --------------
 
 Supposing a dataset ``foo``, ``futhark profile`` will produce the
-following files in the top level directory.
+following files and directories in the top level directory.
 
 * ``foo.log``: the running log produced during execution. Contains many details
   on dynamic behaviour, depending on the exact backend.
@@ -59,9 +60,22 @@ following files in the top level directory.
   which they occurred, along with their runtime and other available information,
   most importantly the source locations.
 
+* ``foo.html/index.html``: overview file and guide to the other html files.
+  Contains explanations for the concepts, links to other pages.
+
+* ``foo.html/cost-centres.html``: tables of all cost centres along with
+  performance summaries and source location links.
+
+* ``foo.html/source-file.fut.html``: Source-File Heatmap, especially costly
+  source ranges are highlighted and link to detail tables. These tables
+  contain time measurements and hyperlinks to associated cost centres.
+
 The log file is often too verbose to be useful, but the summary and timeline
 should be inspected, even if the latter is sometimes fairly large.
 
+All the other files require a web browser but may provide easier access
+to the timing data, since the source resolution and parsing is done already.
+
 Technicalities
 --------------
 

futhark.cabal

@@ -380,6 +380,10 @@ library
       Futhark.Pkg.Solve
       Futhark.Pkg.Types
       Futhark.Profile
+      Futhark.Profile.Details
+      Futhark.Profile.EventSummary
+      Futhark.Profile.Html
+      Futhark.Profile.SourceRange
       Futhark.Script
       Futhark.Test
       Futhark.Test.Spec
@@ -392,6 +396,7 @@ library
       Futhark.Util
       Futhark.Util.CMath
       Futhark.Util.IntegralExp
+      Futhark.Util.Html
       Futhark.Util.Loc
       Futhark.Util.Log
       Futhark.Util.Options

rts/futhark-profile/style.css

@@ -0,0 +1,15 @@
+a.silent-anchor {
+  text-decoration: inherit;
+  color: inherit;
+}
+
+table, th, td {
+  border: 1px solid black;
+  border-collapse: collapse;
+}
+
+th, td {
+  padding-left: 0.5em;
+  padding-right: 0.5em;
+  text-align: center;
+}