Skip to content
GRIN is a compiler back-end for lazy and strict functional languages with whole program optimization support.
Haskell C Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

GRIN

Build Status Coverage Status Gitter chat

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

We presented the core ideas of GRIN at Haskell Exchange 2018. slides video

Read our paper A modern look at GRIN, an optimizing functional language back end (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 and an example from our implementation.

Support

The project is supported by these awesome backers. If you'd like to join them, please consider become a backer or sponsor on Patreon.

GRIN IR

Showcase

Setup

Installing LLVM

Homebrew

Example using Homebrew on macOS:

$ 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 for instructions for adding the correct package database for your OS version, and then:

$ 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 Keep it simple: We follow the fundamentals laid down in HaskellerZ - Feb 2018 - Getting things done in Haskell

Example Front-End

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

Also check the corresponding source code.

i.e.

Simplifying Transformations

Transformation Schema
vectorisation

source code:
Vectorisation2.hs
case simplification

source code:
CaseSimplification.hs
split fetch operation

source code:
SplitFetch.hs
right hoist fetch operation

source code:
RightHoistFetch2.hs
register introduction

source code:
RegisterIntroduction.hs

Optimising Transformations

Transformation Schema
evaluated case elimination

source code:
EvaluatedCaseElimination.hs

test:
EvaluatedCaseEliminationSpec.hs
trivial case elimination

source code:
TrivialCaseElimination.hs

test:
TrivialCaseEliminationSpec.hs
sparse case optimisation

source code:
SparseCaseOptimisation.hs

test:
SparseCaseOptimisationSpec.hs
update elimination

source code:
UpdateElimination.hs

test:
UpdateEliminationSpec.hs
copy propagation

source code:
CopyPropagation.hs

test:
CopyPropagationSpec.hs
late inlining

source code:
Inlining.hs

test:
InliningSpec.hs
generalised unboxing

source code:
GeneralizedUnboxing.hs

test:
GeneralizedUnboxingSpec.hs
arity raising

source code:
ArityRaising.hs

test:
ArityRaisingSpec.hs
case copy propagation

source code:
CaseCopyPropagation.hs

test:
CaseCopyPropagationSpec.hs
case hoisting

source code:
CaseHoisting.hs

test:
CaseHoistingSpec.hs
whnf update elimination

source code:
TODO

test:
TODO
common sub-expression elimination

source code:
CSE.hs

test:
CSESpec.hs
constant propagation

source code:
ConstantPropagation.hs

test:
ConstantPropagationSpec.hs
dead function elimination

source code:
SimpleDeadFunctionElimination.hs

test:
SimpleDeadFunctionEliminationSpec.hs
dead variable elimination

source code:
SimpleDeadVariableElimination.hs

test:
SimpleDeadVariableEliminationSpec.hs
dead parameter elimination

source code:
SimpleDeadParameterElimination.hs

test:
SimpleDeadParameterEliminationSpec.hs
You can’t perform that action at this time.