39c657e8ac1a748d2f903a9988e80450d8637628
[ghc-heap-view.git] / ghc-heap-view.cabal
1 Name:                ghc-heap-view
2 Version:             0.5.4
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. As this is tied to the internals
7   of the compiler,it only works with specific versions. Currently, GHC 7.4
8   through 7.10 should be supported.
9   .
10   It has been inspired by (and taken code from) the vacuum package and the GHCi
11   debugger, but also allows to investiage thunks and other closures. 
12   .
13   This package also provides a new GHCi-command, @:printHeap@, which allows you
14   to inspect the current heap representation of a value, including sharing and
15   cyclic references. To enable the command, you need to load the included ghci
16   script or add it to @~/.ghci@, as explained by @cabal install@. Once it is
17   set up, you can do this:
18   .
19   >> let value = "A Value"
20   >> let x = (value, if head value == 'A' then value else "", cycle [True, False])
21   >> :printHeap x
22   >let x1 = _bco
23   >    x21 = []
24   >in (x1,_bco,_bco)
25   >> length (take 100 (show x)) `seq` return () -- evaluate everything
26   >> :printHeap x
27   >let x1 = "A Value"
28   >    x16 = True : False : x16
29   >in (x1,x1,x16)
30   .
31   You can change the maximum recursion depth using @:setPrintHeapDepth@:
32   .
33   >> :setPrintHeapDepth 3
34   >> :printHeap x
35   >let x1 = C# 'A' : ... : ...
36   >in (x1,x1,True : ... : ...)
37   .
38   If the view is impaired by blackholes (written @_bh@), running
39   @System.Mem.performGC@ usually helps.
40   .
41   The work on this package has been supported by the Deutsche Telekom Stiftung
42   (<http://telekom-stiftung.de>).
43 License:             BSD3
44 License-file:        LICENSE
45 Author:              Joachim Breitner, Dennis Felsing
46 Maintainer:          Joachim Breitner <mail@joachim-breitner.de>
47 Copyright:           2012-2014 Joachim Breitner
48 bug-reports:         https://github.com/nomeata/ghc-heap-view
49 Category:            Debug, GHC
50 Build-type:          Custom
51 Cabal-version:       >=1.14
52 Extra-source-files:  Demo.hs
53 data-files:          ghci
54
55 Flag prim-supports-any
56     Description: The used GHC supports Any as an argument to foreign prim functions (GHC ticket #5931)
57     Default: False
58
59 Flag ghc_7_7
60
61 Library
62   Default-Language:    Haskell2010
63   Exposed-modules:
64     GHC.HeapView 
65     GHC.AssertNF 
66     GHC.Disassembler
67     GHC.HeapView.Debug
68   Build-depends:
69     base >= 4.5 && < 4.9,
70     containers,
71     transformers,
72     template-haskell,
73     bytestring >= 0.10,
74     binary
75   if flag(ghc_7_7)
76     build-depends: ghc >= 7.7
77     cc-options: -DGHC_7_7
78     cpp-options: -DGHC_7_7
79   else
80     build-depends: ghc < 7.7
81   C-Sources: cbits/HeapView.c cbits/HeapViewPrim.cmm
82   Hs-source-dirs: src/
83   Ghc-options: -Wall
84   default-language: Haskell2010
85
86   if flag(prim-supports-any)
87     cpp-options: -DPRIM_SUPPORTS_ANY
88  
89 test-suite Test
90   type:           exitcode-stdio-1.0
91   main-is:        Test.hs
92   build-depends:  base, ghc-heap-view, deepseq
93   default-language: Haskell2010
94   Ghc-options:    -O0
95
96   
97 source-repository head
98   type:     git
99   location: git://git.nomeata.de/ghc-heap-view.git
100   subdir:   Cabal