Vacuum is a library for extracting graph representations of values from the GHC heap at runtime. Those graphs may then be further processed or translated to various representations for visualization -- like Graphviz, or Ubigraph. By itself this library is not of much use to most users, unless you want to use the raw graph data to visualize the heap in some (new) way. Most people will want to translate the graph representation to something like GraphViz format, which can then be rendered to a pretty PNG or SVG file for viewing. See the vacuum-graphviz package for more.


Keywords
ghc, lgpl, library, Propose Tags, Skip to Readme, , Index, GHC.Vacuum, GHC.Vacuum.ClosureType, GHC.Vacuum.ClosureType.V706, GHC.Vacuum.Internal, GHC.Vacuum.Pretty, GHC.Vacuum.Q, GHC.Vacuum.Types, vacuum-2.2.0.0.tar.gz, browse, Package description, Package maintainers, AustinSeipp, ConradParker, DonaldStewart, JohnLato, MattMorrow, edit package information , travis-ci.org, Homepage, Hackage, Results, issue tracker, git repository, BitBucket mirror, AUTHORS.txt
License
LGPL-3.0-only
Install
cabal install vacuum-2.2.0.0

Documentation

Vacuum: visualising the GHC heap

Vacuum is a library for extracting graph representations of values from the GHC heap, at runtime. Those graphs may then be further processed or translated to various representations for visualization -- like Graphviz, or Ubigraph.

travis-ci.org results: Build Status

Homepage.

Installation

It's just a cabal install away on Hackage:

$ cabal install vacuum
# also install the graphviz package, for SVG/PNG rendering:
$ cabal install vacuum-graphviz

Gallery of examples

Want to try before you buy, and see what Vacuum output looks like? Here are some examples:

  • Vacuuming the linked list [1, 2] - Results

More examples will come in the future.

Join in

File bugs in the GitHub issue tracker.

Master git repository:

  • git clone https://github.com/thoughtpolice/vacuum.git

There's also a BitBucket mirror:

  • git clone https://bitbucket.org/thoughtpolice/vacuum.git

Authors

See AUTHORS.txt.

License

LGPLv3. See LICENSE.txt for details.