Add -fghci-leak-check to check for space leaks
authorSimon Marlow <marlowsd@gmail.com>
Wed, 2 May 2018 10:01:13 +0000 (11:01 +0100)
committerSimon Marlow <marlowsd@gmail.com>
Wed, 9 May 2018 12:43:32 +0000 (13:43 +0100)
commit5fe6aaa3756cda654374ebfd883fa8f064ff64a4
tree3b667e7100f20864a2133c3330543d74afa88ebf
parentba6e445e1cf31957f2a327a73f9f66cfa7f24e26
Add -fghci-leak-check to check for space leaks

Summary:
Space leaks in GHCi emerge from time to time and tend to come back again
after they get fixed. This is an attempt to limit regressions by

* adding a reliable detection for some classes of space leaks in GHCi
* turning on leak checking for all GHCi tests in the test suite, so that
  we'll notice if the leak appears again.

The idea for detecting space leaks is quite simple:

* find some data that we expect to be GC'd later, make a weak pointer to it
* when we expect the data to be dead, do a `performGC` and then check
  the status of the weak pointer.

It would be nice to apply this trick to lots of things in GHC,
e.g. ensuring that HsSyn is not retained after the desugarer, or
ensuring that CoreSyn from the previous simplifier pass is not retained.

Test Plan: validate

Reviewers: bgamari, simonpj, erikd, niteria

Subscribers: thomie, carter

GHC Trac Issues: #15111

Differential Revision: https://phabricator.haskell.org/D4658
compiler/main/DynFlags.hs
docs/users_guide/ghci.rst
ghc/GHCi/Leak.hs [new file with mode: 0644]
ghc/GHCi/UI.hs
ghc/ghc-bin.cabal.in
testsuite/config/ghc
testsuite/tests/ghci/scripts/T9293.stdout
testsuite/tests/ghci/scripts/ghci057.stdout