fusion-plugin: GHC plugin to make stream fusion more predictable.

[ bsd3, development, library ] [ Propose Tags ]

This plugin provides the programmer with a way to annotate certain types using a Fuse pragma from the fusion-plugin-types package. The programmer would annotate the types that are to be eliminated by fusion. During the simplifier phase the plugin goes through the relevant bindings and if one of these types are found inside a binding then that binding is marked to be inlined irrespective of the size.

This plugin was primarily motivated by streamly but it can be used in general.


[Skip to Readme]
Versions [faq] 0.1.0, 0.1.1, 0.2.0, 0.2.1
Change log CHANGELOG.md
Dependencies base (>=4.0 && <5.0), containers (>=0.5.6.2 && <0.7), directory (>=1.2.2.0 && <1.4), filepath (==1.4.*), fusion-plugin-types (==0.1.*), ghc (>=7.10.3 && <=8.11), syb (==0.7.*), time (>=1.5 && <1.10), transformers (>=0.4 && <0.6) [details]
License BSD-3-Clause
Copyright (c) 2019 Composewell Technologies
Author Pranay Sashank
Maintainer pranaysashank@composewell.com
Category Development
Home page https://github.com/composewell/fusion-plugin
Bug tracker https://github.com/composewell/fusion-plugin/issues
Source repo head: git clone https://github.com/composewell/fusion-plugin
Uploaded by pranaysashank at 2020-04-22T20:12:19Z
Distributions NixOS:0.2.1
Downloads 622 total (46 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-04-22 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for fusion-plugin-0.2.1

[back to package description]

fusion-plugin

Hackage

Motivation

The goal of stream fusion is to eliminate constructors of internal state used in a stream. For example, in case of streamly streams, the constructors of Step type, Yield, Skip and Stop would get eliminated by fusion. Similarly, constructors of any other intermediate state types get eliminated when stream fusion works correctly. See the papers in the reference section for more details on stream fusion.

Stream fusion depends on the GHC case-of-case transformations eliminating intermediate constructors. Case-of-case transformation in turn depends on inlining. During core-to-core transformations GHC may create several internal bindings (e.g. join points) which may not get inlined because their size is too big. Even though we know that after fusion the resulting code would be smaller and more efficient. The programmer cannot force inlining of these bindings as there is no way for the programmer to address these bindings at the source level because they are internal, generated during core-to-core transformations. As a result stream fusion fails unpredictably depending on whether GHC was able to inline the internal bindings or not.

See GHC ticket #17075 for more details.

Solution

This plugin provides the programmer with a way to annotate certain types using a Fuse pragma from the fusion-plugin-types package. The programmer would annotate the types that are to be eliminated by fusion. During the simplifier phase the plugin goes through the relevant bindings and if one of these types are found inside a binding then that binding is marked to be inlined irrespective of the size.

Using the plugin

This plugin was primarily motivated by streamly but it can be used in general.

To use this plugin, add this package to your build-depends and pass the following to your ghc-options: ghc-options: -O2 -fplugin=Fusion.Plugin

To dump core after each core to core transformation, pass the argument -fplugin-opt=Fusion.Plugin:dump-core. Output from each transformation is then printed in a different file.

See also

If you are a library author looking to annotate the types, you need to use the fusion-plugin-types package.

Contributing

All contributions are welcome! The code is available under BSD-3 license on github. In case you have any questions or suggestions please contact Pranay Sashank, the author and maintainer of this plugin.

We would be happy to see this work getting integrated with GHC as a fix for GHC ticket #17075, any help with that would be appreciated.

References