Merge branch 'master' into 32-ES-to-master

Author: Anabra

.gitignore

@@ -18,10 +18,16 @@ cabal.sandbox.config
 *.eventlog
 .stack-work/
 cabal.project.local
+cabal.project.local~
 .HTF/
 output/
 *.ibc
 *.agdai
 .output
 .grin-output/
+grin/.end-to-end-test/
 .vscode/
+*.out
+*.out.ll
+*.out.s
+.ghc.environment.*

.travis.yml

@@ -32,13 +32,13 @@ before_install:
 
 install:
   - stack update
-  - travis_wait 120 stack --no-terminal --install-ghc test --only-dependencies
+  - travis_wait 120 stack --no-terminal --install-ghc test --only-dependencies --coverage
 
 script:
   - mkdir .output
-  - stack --no-terminal test --coverage
-  - stack exec grin -- grin/grin/sum_simple.grin
+  - stack test grin:grin-end-to-end-test grin:grin-test --coverage
+  - stack exec grin -- grin/grin/sum_simple.grin --quiet
 
 after_script:
   - travis_retry curl -L https://github.com/rubik/stack-hpc-coveralls/releases/download/v0.0.4.0/shc-linux-x64-8.0.1.tar.bz2 | tar -xj
-  - ./shc grin grin-test
+  - ./shc --repo-token=8QkWaPJlRbej9X5N5AaXSommTtN7uEqRT combined all

BACKERS.md

@@ -8,6 +8,7 @@
 <h2 align="center">Bronze via Patreon</h2>
 
 - Stephen Diehl
+- Christopher Goes
 
 <h2 align="center">Generous Backers via Patreon ($50+)</h2>
 
@@ -17,6 +18,7 @@
 - Peter Kadlot
 - Michael Koloberdin
 - William Harvey
+- Steven Kane
 <!--50 end-->
 
 <h2 align="center">Backers via Patreon</h2>
@@ -40,4 +42,17 @@
 - Kametrixom Tikara
 - Denis Redozubov
 - Andrei Dziahel
+- Oleh Stolyar
+- Alberto Centelles
+- Tom Hunger
+- Mirzhan Irkegulov
+- James MacAulay
+- Adam S E
+- Michael
+- Chai T. Rex
+- Malte Brandy
+- Tanner Doshier
+- Brooklyn Zelenka
+- Jaseem Abid
+- Callan McGill
 <!--10 end-->

README.md

@@ -1,10 +1,10 @@
 # GRIN
 
-[![Build Status](https://travis-ci.org/grin-compiler/grin.svg?branch=master)](https://travis-ci.org/grin-compiler/grin) [![Coverage Status](https://coveralls.io/repos/github/grin-tech/grin/badge.svg?branch=master)](https://coveralls.io/github/grin-tech/grin?branch=master)
+[![Build Status](https://travis-ci.org/grin-compiler/grin.svg?branch=master)](https://travis-ci.org/grin-compiler/grin) [![Coverage Status](https://coveralls.io/repos/github/grin-compiler/grin/badge.svg?branch=master)](https://coveralls.io/github/grin-compiler/grin?branch=master)
 [![Gitter chat](https://badges.gitter.im/grin-compiler/grin.png)](https://gitter.im/Grin-Development/Lobby)
 
 The name GRIN is short for *Graph Reduction Intermediate Notation*, and it is an intermediate language for graph reduction. GRIN is the optimizer and code generator component of the GRIN Compiler project which includes language frontends for *Haskell*, *Idris* and *Agda*.
-To get the big picture of the project check the [project website](https://grin-compiler.github.io/).  
+To get the big picture of the project check the [project website](https://grin-compiler.github.io/).
 For an overview of the optimizer read
 <a href="http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/The GRIN Project.pdf">
 The GRIN Project
@@ -15,13 +15,13 @@ Code Optimisation Techniques for Lazy Functional Languages
 
 We presented the core ideas of GRIN at Haskell Exchange 2018. [slides](https://docs.google.com/presentation/d/1QsZ3Kyy3XIco-qba1biRmzuMzz8o2uCBqA9DMtnqP2c/edit?usp=sharing) [video](https://skillsmatter.com/skillscasts/12390-grin-an-alternative-haskell-compiler-backend)
 
-Read our paper [A modern look at GRIN, an optimizing functional language back end](http://nbviewer.jupyter.org/github/Anabra/grin/blob/fd9de6d3b9c7ec5f4aa7d6be41285359a73494e3/papers/stcs-2019/article/tex/main.pdf) (2019) to get an overview of GRIN related projects and other whole program compilers i.e. *Boquist GRIN, UHC, JHC, LHC, HRC, MLton*
+Read our paper [A modern look at GRIN, an optimizing functional language back end](https://nbviewer.jupyter.org/github/Anabra/grin/blob/65177587f4ea0586801e582f1f3750b2d46351a2/papers/stcs-2019/article/tex/main.pdf) (2019) to get an overview of GRIN related projects and other whole program compilers i.e. *Boquist GRIN, UHC, JHC, LHC, HRC, MLton*
 
 Also check the GRIN transformation [example from Boquist PhD](http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=317) and an [example from our implementation](https://github.com/grin-compiler/grin/tree/master/grin/grin/sum-simple-output).
 
 ## Support
 
-The project is supported by these awesome [backers](https://github.com/grin-compiler/grin/blob/master/BACKERS.md).   
+The project is supported by these awesome [backers](https://github.com/grin-compiler/grin/blob/master/BACKERS.md).
 If you'd like to join them, please consider become a backer or sponsor on [Patreon](https://www.patreon.com/csaba_hruska).
 
 
@@ -49,7 +49,7 @@ If you'd like to join them, please consider become a backer or sponsor on [Patre
 Example using Homebrew on macOS:
 
 ```bash
-$ brew install llvm-hs/llvm/llvm-7.0
+$ brew install llvm-hs/llvm/llvm-7
 ```
 
 #### Debian/Ubuntu
@@ -96,7 +96,7 @@ stack build
 stack exec -- grin grin/grin/opt-stages-high-level/stage-00.grin
 ```
 ## How to Contribute
-See: [Issues / Tasks for new contributors](https://github.com/grin-compiler/grin/issues/3)  
+See: [Issues / Tasks for new contributors](https://github.com/grin-compiler/grin/issues/3)
 Keep it simple: We follow the fundamentals laid down in [HaskellerZ - Feb 2018 - Getting things done in Haskell](https://www.youtube.com/watch?v=-X1vrxQUETM)
 
 ## Example Front-End
@@ -150,10 +150,10 @@ Transformation | Schema
 [case hoisting][153]                      <br><br> _source code:_ <br> [CaseHoisting.hs]             <br><br> _test:_ <br> [CaseHoistingSpec.hs]              | [<img src="images/case-hoisting.png"              width="500">][153]
 [whnf update elimination][149]            <br><br> _source code:_ <br> __TODO__                      <br><br> _test:_ <br> __TODO__                           | [<img src="images/whnf-update-elimination.png"    width="500">][149]
 [common sub-expression elimination][164]  <br><br> _source code:_ <br> [CSE.hs]                      <br><br> _test:_ <br> [CSESpec.hs]                       | [<img src="images/common-sub-expression-elimination-1.png" width="500"><img src="images/common-sub-expression-elimination-2.png" width="500">][164]
-[constant propagation][159]               <br><br> _source code:_ <br> [ConstantPropagation.hs]      <br><br> _test:_ <br> [ConstantPropagationSpec.hs]       | 
-[dead function elimination][169]          <br><br> _source code:_ <br> [SimpleDeadFunctionElimination.hs]  <br><br> _test:_ <br> [SimpleDeadFunctionEliminationSpec.hs]   | 
-[dead variable elimination][170]          <br><br> _source code:_ <br> [SimpleDeadVariableElimination.hs]  <br><br> _test:_ <br> [SimpleDeadVariableEliminationSpec.hs]   | 
-[dead parameter elimination][171]         <br><br> _source code:_ <br> [SimpleDeadParameterElimination.hs] <br><br> _test:_ <br> [SimpleDeadParameterEliminationSpec.hs]  | 
+[constant propagation][159]               <br><br> _source code:_ <br> [ConstantPropagation.hs]      <br><br> _test:_ <br> [ConstantPropagationSpec.hs]       |
+[dead function elimination][169]          <br><br> _source code:_ <br> [SimpleDeadFunctionElimination.hs]  <br><br> _test:_ <br> [SimpleDeadFunctionEliminationSpec.hs]   |
+[dead variable elimination][170]          <br><br> _source code:_ <br> [SimpleDeadVariableElimination.hs]  <br><br> _test:_ <br> [SimpleDeadVariableEliminationSpec.hs]   |
+[dead parameter elimination][171]         <br><br> _source code:_ <br> [SimpleDeadParameterElimination.hs] <br><br> _test:_ <br> [SimpleDeadParameterEliminationSpec.hs]  |
 
 [129]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=129
 [134]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=134

default.nix

@@ -0,0 +1,13 @@
+let
+  haskell = import ./nix/haskell.nix;
+  llvm-overlay = self: super: {
+    llvm-config = self.llvm_7;
+  };
+  extra-overlays = [ llvm-overlay ];
+  pkgs = import ./nix/packages.nix (haskell // {
+    overlays = haskell.overlays ++ extra-overlays;
+  });
+in
+  pkgs.haskell-nix.stackProject {
+    src = pkgs.haskell-nix.haskellLib.cleanGit { src = ./.; };
+  }

docs/MemoryManagement.md

@@ -13,3 +13,6 @@ related: [Dead data elimination](http://nbviewer.jupyter.org/github/grin-compile
 
 ## Sample Project
 [Sample project](https://github.com/robinvd/lang-experiments) for LLVM stack map based GC.
+
+## Readings
+- http://craftinginterpreters.com/garbage-collection.html

grin/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017, Andor Pénzes, Csaba Hruska
+Copyright (c) 2017, Andor Pénzes, Csaba Hruska, Péter Podlovics
 
 All rights reserved.
 
@@ -13,9 +13,10 @@ modification, are permitted provided that the following conditions are met:
       disclaimer in the documentation and/or other materials provided
       with the distribution.
 
-    * Neither the name of Csaba Hruska, Peter Divianszky nor the names of other
-      contributors may be used to endorse or promote products derived
-      from this software without specific prior written permission.
+    * Neither the name of Andor Pénzes, Csaba Hruska, Péter Podlovics
+      nor the names of other contributors may be used to endorse or
+      promote products derived from this software without specific
+      prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

grin/app/GrinCLI.hs renamed to grin/app/CLI/Lib.hs

@@ -1,5 +1,5 @@
 {-# LANGUAGE LambdaCase #-}
-module Main where
+module CLI.Lib where
 
 import Control.Monad
 import Data.Map (Map(..))
@@ -17,10 +17,12 @@ import System.IO
 
 import Grin.Grin
 import Grin.PrimOpsPrelude
-import Grin.Parse hiding (value)
+import Grin.Parse
 import Grin.Nametable as Nametable
 import Pipeline.Pipeline
 
+
+
 data Options = Options
   { optFiles     :: [FilePath]
   , optTrans     :: [PipelineStep]
@@ -29,6 +31,8 @@ data Options = Options
   , optQuiet     :: Bool
   , optLoadBinary :: Bool
   , optSaveBinary :: Bool
+  , optCFiles     :: [FilePath]
+  , optDontFailOnLint :: Bool
   } deriving Show
 
 flg c l h = flag' c (mconcat [long l, help h])
@@ -118,7 +122,8 @@ pipelineOpts =
   <|> flg (Pass [Sharing Compile, Sharing Optimise, Sharing RunPure]) "sharing-opt" "Compiles, optimizes and runs the sharing analysis"
   <|> flg  (Pass [LVA Compile, CBy Compile, RunCByWithLVA]) "cby-with-lva" "Compiles the live variable and created-by analyses, then runs the created-by analysis using the LVA result"
   <|> flg DeadCodeElimination "dce" "Dead Code Elimination"
-  <|> flg PureEval "eval" "Evaluate the grin program (pure)"
+  <|> flg (PureEval False) "eval" "Evaluate the grin program (pure)"
+  <|> (PureEval <$> (option auto (mconcat [long "eval-with-statistics", help "Evaluate the grin program (pure) and render heap statistics."])))
   <|> flg JITLLVM "llvm" "JIT with LLVM"
   <|> flg PrintAST "ast" "Print the Abstract Syntax Tree"
   <|> (SaveExecutable False . Abs <$> (strOption (mconcat [short 'o', long "save-elf", help "Save an executable ELF"])))
@@ -130,6 +135,7 @@ pipelineOpts =
   <|> flg ConfluenceTest "confluence-test" "Checks transformation confluence by generating random two pipelines which reaches the fix points."
   <|> flg PrintErrors "print-errors" "Prints the error log"
 
+
 maybeRenderingOpt :: String -> Maybe RenderingOption
 maybeRenderingOpt = M.parseMaybe renderingOpt
 
@@ -149,14 +155,18 @@ printGrinWithOpt = flip PrintGrin id <$> option (maybeReader maybeRenderingOpt)
   <> help "Print the actual grin code with a given rendering option [simple | with-externals]"
   <> metavar "OPT" )
 
-options :: IO Options
-options = execParser $ info
-  (pipelineArgs <**> helper)
-  (mconcat
-    [ fullDesc
-    , progDesc "grin compiler"
-    , header "grin compiler"
-    ])
+options :: [String] -> IO Options
+options args = do
+  let res = execParserPure defaultPrefs
+              (info
+                (pipelineArgs <**> helper)
+                (mconcat
+                  [ fullDesc
+                  , progDesc "grin compiler"
+                  , header "grin compiler"
+                  ]))
+              args
+  handleParseResult res
   where
     pipelineArgs = Options
       <$> some (argument str (metavar "FILES..."))
@@ -184,20 +194,44 @@ options = execParser $ info
             [ long "save-binary-intermed"
             , help "Save intermediate results in binary format"
             ])
+      <*> many (strOption (mconcat
+            [ short 'C'
+            , long "c-file"
+            , help "The path for the runtime implementation in C"]))
+      <*> switch (mconcat
+            [ long "continue-on-failed-lint"
+            , help "Do not fail on lint errors"
+            ])
 
-main :: IO ()
-main = do
+mainWithArgs :: [String] -> IO ()
+mainWithArgs args = do
   hSetBuffering stdout NoBuffering
-  Options files steps outputDir noPrelude quiet loadBinary saveBinary <- options
+  Options
+    files
+    steps
+    outputDir
+    noPrelude
+    quiet
+    loadBinary
+    saveBinary
+    cFiles
+    continueOnLint
+    <- options args
   forM_ files $ \fname -> do
     (mTypeEnv, program) <- if loadBinary
       then do
         ((,) Nothing . Nametable.restore) <$> Binary.decodeFile fname
       else do
         content <- Text.readFile fname
-        let (typeEnv, program') = either (error . M.parseErrorPretty' content) id $ parseGrinWithTypes fname content
+        let (typeEnv, program') = either (error . M.errorBundlePretty) id $ parseGrinWithTypes fname content
         pure $ (Just typeEnv, if noPrelude then program' else concatPrograms [primPrelude, program'])
-    let opts = defaultOpts { _poOutputDir = outputDir, _poFailOnLint = True, _poLogging = not quiet, _poSaveBinary = saveBinary }
+    let opts = defaultOpts
+                { _poOutputDir = outputDir
+                , _poFailOnLint = not continueOnLint
+                , _poLogging = not quiet
+                , _poSaveBinary = saveBinary
+                , _poCFiles = cFiles
+                }
     case steps of
       [] -> void $ optimize opts program [] postPipeline
       _  -> void $ pipeline opts mTypeEnv program steps

grin/app/CLI/Main.hs

@@ -0,0 +1,10 @@
+module Main where
+
+import System.Environment (getArgs)
+import CLI.Lib (mainWithArgs)
+
+
+main :: IO ()
+main = do
+  args <- getArgs
+  mainWithArgs args