ghc-heap-view.cabal

   1 Name:                ghc-heap-view
   2 Version:             0.5.0.1
   3 Synopsis:            Extract the heap representation of Haskell values and thunks
   4 Description:
   5   This library provides functions to introspect the Haskell heap, for example
   6   to investigate sharing and lazy evaluation.
   7   .
   8   It has been inspired by (and taken code from) the vacuum package and the GHCi
   9   debugger, but also allows to investiage thunks and other closures.
  10   .
  11   This package also provides a new GHCi-command, @:printHeap@, which allows you
  12   to inspect the current heap representation of a value, including sharing and
  13   cyclic references. To enable the command, you need to load the included ghci
  14   script or add it to @~/.ghci@, as explained by @cabal install@. Once it is
  15   set up, you can do this:
  16   .
  17   >> let value = "A Value"
  18   >> let x = (value, if head value == 'A' then value else "", cycle [True, False])
  19   >> :printHeap x
  20   >let x1 = _bco
  21   >    x21 = []
  22   >in (x1,_bco,_bco)
  23   >> length (take 100 (show x)) `seq` return () -- evaluate everything
  24   >> :printHeap x
  25   >let x1 = "A Value"
  26   >    x16 = True : False : x16
  27   >in (x1,x1,x16)
  28   .
  29   You can change the maximum recursion depth using @:setPrintHeapDepth@:
  30   .
  31   >> :setPrintHeapDepth 3
  32   >> :printHeap x
  33   >let x1 = C# 'A' : ... : ...
  34   >in (x1,x1,True : ... : ...)
  35   .
  36   If the view is impaired by blackholes (written @_bh@), running
  37   @System.Mem.performGC@ usually helps.
  38   .
  39   The work on this package has been supported by the Deutsche Telekom Stiftung
  40   (<http://telekom-stiftung.de>).
  41 License:             BSD3
  42 License-file:        LICENSE
  43 Author:              Joachim Breitner, Dennis Felsing
  44 Maintainer:          Joachim Breitner <mail@joachim-breitner.de>
  45 Copyright:           2012-2013 Joachim Breitner
  46 Category:            Debug, GHC
  47 Build-type:          Custom
  48 Cabal-version:       >=1.14
  49 Extra-source-files:  Demo.hs
  50 data-files:          ghci
  51
  52 Flag prim-supports-any
  53     Description: The used GHC supports Any as an argument to foreign prim functions (GHC ticket #5931)
  54     Default: False
  55
  56 Library
  57   Default-Language:    Haskell2010
  58   Exposed-modules:
  59     GHC.HeapView
  60     GHC.AssertNF
  61     GHC.Disassembler
  62     GHC.HeapView.Debug
  63   Build-depends:
  64     base >= 4.5 && < 4.7,
  65     containers,
  66     transformers,
  67     template-haskell,
  68     bytestring >= 0.10,
  69     binary,
  70     ghc
  71   C-Sources: cbits/HeapView.c cbits/HeapViewPrim.cmm
  72   Hs-source-dirs: src/
  73   Ghc-options: -Wall
  74
  75   if flag(prim-supports-any)
  76     cpp-options: -DPRIM_SUPPORTS_ANY
  77
  78 source-repository head
  79   type:     darcs
  80   location: http://darcs.nomeata.de/ghc-heap-view/