HTML-Heatmap-Generation in futhark profile

CHANGELOG.md

@@ -9,7 +9,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-* Per Cost-Centre Source Location Listings in the `.summary`-file output of `futhark profile`. (By VegOwOtenks)
+* `futhark profile`: Generation of HTML-Files with cost centre and source range
+  analysis, heatmap markup according to source range cost.
+  (#2340, With VegOwOtenks)
+
+* Per Cost-Centre Source Location Listings in the `.summary`-file output of
+  `futhark profile`. (By VegOwOtenks)
 
 ### Removed
 

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
@@ -32,22 +33,25 @@ collected profiling information. If you neglect to pass ``--profile``,
 the profiling information will be missing. The information in the JSON
 file is complete, but it is difficult for humans to read.
 
-The next step is to run ``futhark profile`` on the JSON file.  For a
-JSON file ``prog.json``, this will create a *top level directory*
-``prog.prof`` that contains files with human-readable profiling
-information.  A set of files will be created for each benchmark
-dataset.  If the original invocation of ``futhark bench`` included
-multiple programs, then ``futhark profile`` will create subdirectories
-for each program (although all inside the same top level directory).
+The next step is to run ``futhark profile`` on the JSON file. For a JSON file
+``prog.json``, this will create a *top level directory* ``prog.prof`` that
+contains files with human-readable profiling information. A set of files will be
+created for each benchmark dataset. If the original invocation of ``futhark
+bench`` included multiple programs, then ``futhark profile`` will create
+subdirectories for each program (although all inside the same top level
+directory). If the source files passed to ``futhark bench`` are accessible via
+the original paths, then the directory will also contain HTML files with
+annotated source code.
 
 You can pass multiple JSON files to ``futhark profile``. Each will
 produce a distinct top level directory.
 
 Files produced
 --------------
 
-Supposing a dataset ``foo``, ``futhark profile`` will produce the
-following files in the top level directory.
+Supposing a dataset ``foo`` for an entry point in ``source-file.fut``.
+``futhark profile`` will produce the 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 +63,16 @@ following files in the top level directory.
   which they occurred, along with their runtime and other available information,
   most importantly the source locations.
 
+* ``foo-index.html``: overview file and guide to the other html files.
+  Contains explanations for the concepts, links to other pages.
+  This is the entry file for profile exploration.
+
 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

@@ -67,7 +67,7 @@ extra-source-files:
     rts/c/util.h
     rts/c/server.h
     rts/cuda/prelude.cu
-    rts/futhark-doc/style.css
+    rts/style.css
     rts/javascript/server.js
     rts/javascript/values.js
     rts/javascript/wrapperclasses.js
@@ -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-doc/style.css → rts/style.css

@@ -224,3 +224,19 @@ main {
     color: #5f0220;
     text-decoration: none;
 }
+
+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;
+}

src/Futhark/CLI/Doc.hs

@@ -27,7 +27,7 @@ import System.IO
 import Text.Blaze.Html.Renderer.Text
 
 cssFile :: T.Text
-cssFile = $(embedStringFile "rts/futhark-doc/style.css")
+cssFile = $(embedStringFile "rts/style.css")
 
 data DocConfig = DocConfig
   { docOutput :: Maybe FilePath,