binary: add linux perf chapter

Author: doyougnu

code/lethargy/app/Main.hs

@@ -1,3 +1,4 @@
+{-# OPTIONS_GHC -ddump-asm #-}
 module Main where
 
 main :: IO ()

code/lethargy/lethargy.cabal

@@ -25,6 +25,14 @@ executable lethargy
     hs-source-dirs:   app
     default-language: Haskell2010
 
+executable lethargy-asm
+    import:           warnings
+    main-is:          Main.hs
+    build-depends:    base >=4.15.1.0
+    hs-source-dirs:   app
+    default-language: Haskell2010
+    ghc-options:      -ddump-asm
+
 
 benchmark inlining
   type            : exitcode-stdio-1.0

conf.py

@@ -54,13 +54,25 @@
              ]
 
 # flags
-todo_include_todos = False
+todo_include_todos = True
 todo_link_only     = False
 autosectionlabel_prefix_document = True
 
 # tikz support
 tikz_proc_suite = "pdf2svg"
-tikz_tikzlibraries = "arrows, arrows.meta"
+tikz_tikzlibraries = "arrows, arrows.meta, decorations.pathreplacing"
+tikz_latex_preamble = r"""
+\newcommand{\MemoryLayout}[1]{
+     \draw[thick](0,0)--++(0,3)node[above]{$0$};
+     \foreach \pt/\col/\lab [remember=\pt as \lastpt (initially 0)] in {#1} {
+       \draw[fill=\col]({\lastpt},0) rectangle ++(\pt,2);
+       \if\lab\relax\relax\else
+         \draw[thick,decorate, decoration={brace,amplitude=4mm}]
+            (\pt,-0.4)--node[below=4mm]{\lab} (\lastpt,-0.4);
+       \fi
+     }
+}
+"""
 
 ## global links in the book that share a prefix that we've named.
 extlinks = {'userGuide': ('https://downloads.haskell.org/~ghc/9.2.4/docs/html/users_guide/%s', '%s'),

extensions/sphinx_exec_directive.py

@@ -47,7 +47,7 @@ def execute_code_with_pipe(command, code_in, post_process=[]):
             out = f(out)
 
         # Log any stderr.
-        if err is not None and err.strip() != "":
+        if err is not None and len(err.strip()) > 0:
             print(err)
 
         return out
@@ -71,6 +71,8 @@ def execute_code_with_pipe(command, code_in, post_process=[]):
             runner['with'] = 'runghc' # default is runghc, no hooks
 
         if runner['with'] == 'ghci':
+            # TODO: properly add in an args argument to execute_code_with_pipe
+            runner['with'] = 'ghci -ignore-dot-ghci'.split()
             # if running with ghci then we post process the output to remove
             # ghci specific text
             post_process += [lambda s: s.replace("ghci>",""),
@@ -87,18 +89,26 @@ def execute_code_with_pipe(command, code_in, post_process=[]):
                     out       = comp_proc.stdout
                     err       = comp_proc.stderr
                     code_out = out
-                    found    = False
 
+                    ## control the output
                     out_stream = code_out.splitlines()
+                    linking_index = 0
                     for index, line in enumerate(out_stream):
                         if "Linking" in line:
-                            i = index + 1
-                            code_out = '\n'.join(out_stream[i:])
-                            break # only want first hit, and we are guarenteed
-                                  # that linking is in the list because you
-                                  # cannot run a binary without linking! Log
-
-                if err is not None and err.strip() != "":
+                            linking_index = index
+                            break
+                    if runner['output'] == 'all':
+                        ## then we want the whole of stdout including the program
+                        code_out = '\n'.join(out_stream)
+                    elif runner['output'] == 'comp':
+                        ## then we only want ghc's output and not the program
+                        code_out = '\n'.join(out_stream[:linking_index])
+                    else:
+                        ## the default case, we only want the program output
+                        code_out = '\n'.join(out_stream[linking_index:])
+
+                # Log
+                if err is not None and len(err.strip()) > 0:
                     print(err) # should use sphinx logger
 
             else:
@@ -120,7 +130,7 @@ def execute_code_with_pipe(command, code_in, post_process=[]):
                 out = comp_proc.stdout.decode('utf-8')
                 err = comp_proc.stderr
         # Log any stderr.
-        if err is not None and err.strip() != "":
+        if err is not None and len(err.strip()) > 0:
             print(err)
         code_out = out
 
@@ -164,6 +174,7 @@ class Exec(Directive):
         'context':   _option_boolean,
         'cache':     _option_boolean,
         'process':   _option_process,
+        'output':    _option_str,
         'intertext': _option_str,
         'project_dir': _option_str,
         'with':      _option_str,
@@ -192,6 +203,7 @@ def run(self):
         project_dir = self.options.get('project_dir', '')
         opt_with = self.options.get('with', '')
         args     = self.options.get ('args','').split()
+        output   = self.options.get ('output','')
 
         # A runner is "that which runs the code", i.e., a dictionary that
         # defines the entire external process
@@ -204,7 +216,8 @@ def run(self):
                                                 # the contents of source_file,
                                                 # if not then its the contents
                                                 # of a literal code block
-                  'args':    args}     # args to run with, with
+                  'args':    args,   # args to run with, with
+                  'output': output}  # how much output to display
 
         # Determine whether input is to be read from a file, or directly from
         # the exec block's contents.

hoh.nix

@@ -34,7 +34,9 @@ pkgs.stdenv.mkDerivation {
 
    preBuild = ''
    unset SOURCE_DATE_EPOCH
-  '';
+   export CABAL_DIR=$(mktemp -d)
+   cabal user-config update
+   '';
 
    buildPhase = ''
    runHook preBuild

src/Measurement_Observation/Binary_Profiling/asm.rst

@@ -0,0 +1,16 @@
+.. _Reading Asm:
+
+Reading Asm
+===========
+
+..
+   we must use --no-sandbox with nix or else this will fail
+.. exec::
+   :context: true
+   :process: haskell
+   :project_dir: code/lethargy
+   :with: cabal
+   :args: run lethargy-asm
+   :output: comp
+   :intertext:  Core output (the 0 at the end is the program's result):
+

src/Measurement_Observation/Binary_Profiling/index.rst

@@ -6,6 +6,7 @@ Binary Profiling and Probing
    :glob:
    :name: binary_prof
 
+   asm
    linux_time
    linux_perf
    dtrace