Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/grin-compiler/grin

GRIN is a compiler back-end for lazy and strict functional languages with whole program optimization support.
https://github.com/grin-compiler/grin
compiler data-flow-analysis functional-programming haskell llvm optimisation
Last synced: 2 days ago
JSON representation
GRIN is a compiler back-end for lazy and strict functional languages with whole program optimization support.
Host: GitHub
URL: https://github.com/grin-compiler/grin
Owner: grin-compiler
Created: 2017-06-23T20:18:06.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-04-28T14:15:23.000Z (over 1 year ago)
Last Synced: 2025-01-12T21:02:47.530Z (9 days ago)
Topics: compiler, data-flow-analysis, functional-programming, haskell, llvm, optimisation
Language: Haskell
Homepage: https://grin-compiler.github.io/
Size: 21.8 MB
Stars: 1,030
Watchers: 37
Forks: 38
Open Issues: 30
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project

README

        # 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-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/).

For an overview of the optimizer read



The GRIN Project

 paper. To grasp the details take your time and read Urban Boquist's PhD thesis on



Code Optimisation Techniques for Lazy Functional Languages

.

**Presentations**

- 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)  

- The *Next-gen Haskell Compilation Techniques* (2021) presentation gives a high-level overview of the project motivation. [slides](https://docs.google.com/presentation/d/1g_-bHgeD7lV4AYybnvjgkWa9GKuP6QFUyd26zpqXssQ/edit?usp=sharing) [video](https://www.youtube.com/watch?v=jyaR8E325ok) 

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). Special thanks to our gold sponsors:

### *Sam Griffin*



  



If you'd like to join them, please consider become a backer or sponsor on [Patreon](https://www.patreon.com/csaba_hruska).  







## GRIN IR







## Showcase

![](https://pbs.twimg.com/media/Dpasi9OW4AAxpwi.jpg)

## Setup

### Installing LLVM

#### Homebrew

Example using Homebrew on macOS:

```bash

$ brew install llvm-hs/llvm/llvm-7

```

#### Debian/Ubuntu

For Debian/Ubuntu based Linux distributions, the LLVM.org website provides

binary distribution packages. Check [apt.llvm.org](http://apt.llvm.org/) for

instructions for adding the correct package database for your OS version, and

then:

```bash

$ apt-get install llvm-7-dev

```

#### Nix

To get a nix shell with all the required dependencies do the following in the top level folder.

```

nix-shell

```

To run the example do the following from the top level folder.

```

(cd grin; cabal run grin -- grin/opt-stages-high-level/stage-00.grin)

```

To run a local Hoogle server with Haskell documentation do the following.

```

hoogle server --port 8087 1>/dev/null 2>/dev/null&

```

### Build GRIN

```

stack setup

stack build

```

### Usage

```

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)

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

Read about how to generate GRIN code from a frontend language.

Also check the corresponding [source code](https://github.com/grin-compiler/ghc-grin/tree/master/lambda-grin/src/Lambda).

i.e.

- [Lambda/Syntax.hs](https://github.com/grin-compiler/ghc-grin/tree/master/lambda-grin/src/Lambda/Syntax.hs) - front-end language defintion

- [lambda-grin/test](https://github.com/grin-compiler/ghc-grin/tree/master/lambda-grin/test) - directory including generated Lambda and GRIN code

## Simplifying Transformations

Transformation | Schema

-------------- | ------

[vectorisation][113]                

 _source code:_ 
 [Vectorisation2.hs]       | [][113]

[case simplification][116]          

 _source code:_ 
 [CaseSimplification.hs]   | [][116]

[split fetch operation][118]        

 _source code:_ 
 [SplitFetch.hs]           | [][118]

[right hoist fetch operation][123]  

 _source code:_ 
 [RightHoistFetch2.hs]     | [][123]

[register introduction][126]        

 _source code:_ 
 [RegisterIntroduction.hs] | [][126]

[113]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=113

[116]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=116

[118]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=118

[123]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=123

[126]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=126

[Vectorisation2.hs]:        https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Simplifying/Vectorisation2.hs

[CaseSimplification.hs]:    https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Simplifying/CaseSimplification.hs

[SplitFetch.hs]:            https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Simplifying/SplitFetch.hs

[RightHoistFetch2.hs]:      https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Simplifying/RightHoistFetch2.hs

[RegisterIntroduction.hs]:  https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Simplifying/RegisterIntroduction.hs

## Optimising Transformations

Transformation | Schema

-------------- | ------

[evaluated case elimination][141]         

 _source code:_ 
 [EvaluatedCaseElimination.hs] 

 _test:_ 
 [EvaluatedCaseEliminationSpec.hs]  | [][141]

[trivial case elimination][142]           

 _source code:_ 
 [TrivialCaseElimination.hs]   

 _test:_ 
 [TrivialCaseEliminationSpec.hs]    | [][142]

[sparse case optimisation][143]           

 _source code:_ 
 [SparseCaseOptimisation.hs]   

 _test:_ 
 [SparseCaseOptimisationSpec.hs]    | [][143]

[update elimination][148]                 

 _source code:_ 
 [UpdateElimination.hs]        

 _test:_ 
 [UpdateEliminationSpec.hs]         | [][148]

[copy propagation][129]                   

 _source code:_ 
 [CopyPropagation.hs]          

 _test:_ 
 [CopyPropagationSpec.hs]           | [][129]

[late inlining][151]                      

 _source code:_ 
 [Inlining.hs]                 

 _test:_ 
 [InliningSpec.hs]                  | [][151]

[generalised unboxing][134]               

 _source code:_ 
 [GeneralizedUnboxing.hs]      

 _test:_ 
 [GeneralizedUnboxingSpec.hs]       | [][134]

[arity raising][160]                      

 _source code:_ 
 [ArityRaising.hs]             

 _test:_ 
 [ArityRaisingSpec.hs]              | [][160]

[case copy propagation][144]              

 _source code:_ 
 [CaseCopyPropagation.hs]      

 _test:_ 
 [CaseCopyPropagationSpec.hs]       | [][144]

[case hoisting][153]                      

 _source code:_ 
 [CaseHoisting.hs]             

 _test:_ 
 [CaseHoistingSpec.hs]              | [][153]

[whnf update elimination][149]            

 _source code:_ 
 __TODO__                      

 _test:_ 
 __TODO__                           | [][149]

[common sub-expression elimination][164]  

 _source code:_ 
 [CSE.hs]                      

 _test:_ 
 [CSESpec.hs]                       | [][164]

[constant propagation][159]               

 _source code:_ 
 [ConstantPropagation.hs]      

 _test:_ 
 [ConstantPropagationSpec.hs]       |

[dead function elimination][169]          

 _source code:_ 
 [SimpleDeadFunctionElimination.hs]  

 _test:_ 
 [SimpleDeadFunctionEliminationSpec.hs]   |

[dead variable elimination][170]          

 _source code:_ 
 [SimpleDeadVariableElimination.hs]  

 _test:_ 
 [SimpleDeadVariableEliminationSpec.hs]   |

[dead parameter elimination][171]         

 _source code:_ 
 [SimpleDeadParameterElimination.hs] 

 _test:_ 
 [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

[141]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=141

[142]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=142

[143]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=143

[144]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=144

[148]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=148

[149]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=149

[151]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=151

[153]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=153

[159]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=159

[160]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=160

[164]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=164

[169]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=169

[170]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=170

[171]: http://nbviewer.jupyter.org/github/grin-compiler/grin/blob/master/papers/boquist.pdf#page=171

[ArityRaising.hs]:              https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/ArityRaising.hs

[ConstantPropagation.hs]:       https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/ConstantPropagation.hs

[CopyPropagation.hs]:           https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/CopyPropagation.hs

[CaseCopyPropagation.hs]:       https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/CaseCopyPropagation.hs

[CaseHoisting.hs]:              https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/CaseHoisting.hs

[CSE.hs]:                       https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/CSE.hs

[EvaluatedCaseElimination.hs]:  https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/EvaluatedCaseElimination.hs

[Inlining.hs]:                  https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/Inlining.hs

[SparseCaseOptimisation.hs]:    https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/SparseCaseOptimisation.hs

[TrivialCaseElimination.hs]:    https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/TrivialCaseElimination.hs

[UpdateElimination.hs]:         https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/UpdateElimination.hs

[GeneralizedUnboxing.hs]:       https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/GeneralizedUnboxing.hs

[SimpleDeadFunctionElimination.hs]:   https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/SimpleDeadFunctionElimination.hs

[SimpleDeadVariableElimination.hs]:   https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/SimpleDeadVariableElimination.hs

[SimpleDeadParameterElimination.hs]:  https://github.com/grin-compiler/grin/blob/master/grin/src/Transformations/Optimising/SimpleDeadParameterElimination.hs

[ArityRaisingSpec.hs]:              https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/ArityRaisingSpec.hs

[ConstantPropagationSpec.hs]:       https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/ConstantPropagationSpec.hs

[CopyPropagationSpec.hs]:           https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/CopyPropagationSpec.hs

[CaseCopyPropagationSpec.hs]:       https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/CaseCopyPropagationSpec.hs

[CaseHoistingSpec.hs]:              https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/CaseHoistingSpec.hs

[CSESpec.hs]:                       https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/CSESpec.hs

[EvaluatedCaseEliminationSpec.hs]:  https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/EvaluatedCaseEliminationSpec.hs

[InliningSpec.hs]:                  https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/InliningSpec.hs

[SparseCaseOptimisationSpec.hs]:    https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/SparseCaseOptimisationSpec.hs

[TrivialCaseEliminationSpec.hs]:    https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/TrivialCaseEliminationSpec.hs

[UpdateEliminationSpec.hs]:         https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/UpdateEliminationSpec.hs

[GeneralizedUnboxingSpec.hs]:       https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/GeneralizedUnboxingSpec.hs

[SimpleDeadFunctionEliminationSpec.hs]:   https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/SimpleDeadFunctionEliminationSpec.hs

[SimpleDeadVariableEliminationSpec.hs]:   https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/SimpleDeadVariableEliminationSpec.hs

[SimpleDeadParameterEliminationSpec.hs]:  https://github.com/grin-compiler/grin/blob/master/grin/test/Transformations/Optimising/SimpleDeadParameterEliminationSpec.hs