debugging.rst 10.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
.. _options-debugging:

Debugging the compiler
======================

.. index::
   single: debugging options (for GHC)

HACKER TERRITORY. HACKER TERRITORY. (You were warned.)

.. _dumping-output:

Dumping out compiler intermediate structures
--------------------------------------------

.. index::
   single: dumping GHC intermediates
   single: intermediate passes, output

``-ddump-`` ⟨pass⟩
    .. index::
       single: -ddump options

    Make a debugging dump after pass ``<pass>`` (may be common enough to
    need a short form…). You can get all of these at once (*lots* of
    output) by using ``-v5``, or most of them with ``-v4``. You can
    prevent them from clogging up your standard output by passing
28
    :ghc-flag:`-ddump-to-file`. Some of the most useful ones are:
29

30
31
32
33
34
35
36
37
    .. ghc-flag:: -ddump-to-file

        Causes the output from all of the flags listed below to be dumped
        to a file. The file name depends upon the output produced; for instance,
        output from :ghc-flag:`-ddump-simpl` will end up in
        :file:`{module}.dump-simpl`.

    .. ghc-flag:: -ddump-parsed
38
39
40

        Dump parser output

41
    .. ghc-flag:: -ddump-rn
42
43
44

        Dump renamer output

45
    .. ghc-flag:: -ddump-tc
46
47
48

        Dump typechecker output

49
    .. ghc-flag:: -ddump-splices
50
51
52
53

        Dump Template Haskell expressions that we splice in, and what
        Haskell code the expression evaluates to.

54
55
56
57
    .. ghc-flag:: -dth-dec-file=<file>

        Dump expansions of all top-level Template Haskell splices into ⟨file⟩.

58
    .. ghc-flag:: -ddump-types
59
60
61

        Dump a type signature for each value defined at the top level of
        the module. The list is sorted alphabetically. Using
62
        :ghc-flag:`-dppr-debug` dumps a type signature for all the imported and
63
64
65
        system-defined things as well; useful for debugging the
        compiler.

66
    .. ghc-flag:: -ddump-deriv
67
68
69

        Dump derived instances

70
    .. ghc-flag:: -ddump-ds
71
72
73

        Dump desugarer output

74
    .. ghc-flag:: -ddump-spec
75
76
77

        Dump output of specialisation pass

78
    .. ghc-flag:: -ddump-rules
79
80
81
82

        Dumps all rewrite rules specified in this module; see
        :ref:`controlling-rules`.

83
    .. ghc-flag:: -ddump-rule-firings
84
85
86

        Dumps the names of all rules that fired in this module

87
    .. ghc-flag:: -ddump-rule-rewrites
88
89
90
91

        Dumps detailed information about all rules that fired in this
        module

92
    .. ghc-flag:: -ddump-vect
93
94
95

        Dumps the output of the vectoriser.

96
    .. ghc-flag:: -ddump-simpl
97
98
99

        Dump simplifier output (Core-to-Core passes)

100
    .. ghc-flag:: -ddump-inlinings
101
102
103

        Dumps inlining info from the simplifier

104
    .. ghc-flag:: -ddump-stranal
105
106
107

        Dump strictness analyser output

manav's avatar
manav committed
108
    .. ghc-flag:: -ddump-str-signatures
109
110
111

        Dump strictness signatures

112
    .. ghc-flag:: -ddump-cse
113
114
115

        Dump common subexpression elimination (CSE) pass output

116
    .. ghc-flag:: -ddump-worker-wrapper
117
118
119

        Dump worker/wrapper split output

120
    .. ghc-flag:: -ddump-occur-anal
121
122
123

        Dump "occurrence analysis" output

124
    .. ghc-flag:: -ddump-prep
125
126
127

        Dump output of Core preparation pass

128
    .. ghc-flag:: -ddump-stg
129
130
131

        Dump output of STG-to-STG passes

132
    .. ghc-flag:: -ddump-cmm
133

134
135
136
137
138
139
140
141
142
143
144
        Dump the result of the C-- pipeline processing

    .. ghc-flag:: -ddump-cmm-from-stg

        Dump the result of STG-to-C-- conversion

    .. ghc-flag:: -ddump-cmm-verbose

        Dump output from all C-- pipeline stages. In case of
        ``.cmm`` compilation this also dumps the result of
        file parsing.
145

146
    .. ghc-flag:: -ddump-opt-cmm
147
148
149

        Dump the results of C-- to C-- optimising passes.

150
    .. ghc-flag:: -ddump-asm
151
152
153
154

        Dump assembly language produced by the :ref:`native code
        generator <native-code-gen>`

155
    .. ghc-flag:: -ddump-llvm
156

157
158
        :implies: :ghc-flag:`-fllvm`

159
160
        LLVM code from the :ref:`LLVM code generator <llvm-code-gen>`

161
    .. ghc-flag:: -ddump-bcos
162
163
164

        Dump byte-code compiler output

165
    .. ghc-flag:: -ddump-foreign
166
167
168

        dump foreign export stubs

169
.. ghc-flag:: -ddump-simpl-iterations
170
171
172
173
174

    Show the output of each *iteration* of the simplifier (each run of
    the simplifier has a maximum number of iterations, normally 4). This
    outputs even more information than ``-ddump-simpl-phases``.

175
.. ghc-flag:: -ddump-simpl-stats
176
177
178
179

    Dump statistics about how many of each kind of transformation too
    place. If you add ``-dppr-debug`` you get more detailed information.

180
.. ghc-flag:: -ddump-if-trace
181
182
183

    Make the interface loader be *real* chatty about what it is up to.

184
.. ghc-flag:: -ddump-tc-trace
185
186
187

    Make the type checker be *real* chatty about what it is up to.

188
.. ghc-flag:: -ddump-vt-trace
189
190
191

    Make the vectoriser be *real* chatty about what it is up to.

192
.. ghc-flag:: -ddump-rn-trace
193
194
195

    Make the renamer be *real* chatty about what it is up to.

196
197
198
199
200
.. ghc-flag:: -ddump-ec-trace

    Make the pattern match exhaustiveness checker be *real* chatty about
    what it is up to.

201
.. ghc-flag:: -ddump-rn-stats
202
203
204
205

    Print out summary of what kind of information the renamer had to
    bring in.

206
207
.. ghc-flag:: -dverbose-core2core
              -dverbose-stg2stg
208
209
210
211
212

    Show the output of the intermediate Core-to-Core and STG-to-STG
    passes, respectively. (*lots* of output!) So: when we're really
    desperate:

213
    .. code-block:: sh
214
215
216

        % ghc -noC -O -ddump-simpl -dverbose-core2core -dcore-lint Foo.hs

217
.. ghc-flag:: -dshow-passes
218

219
220
221
222
223
224
225
226
227
    Print out each pass name, its runtime and heap allocations as it happens.
    Note that this may come at a slight performance cost as the compiler will
    be a bit more eager in forcing pass results to more accurately account for
    their costs.

    Two types of messages are produced: Those beginning with ``***`` are
    denote the beginning of a compilation phase whereas those starting with
    ``!!!`` mark the end of a pass and are accompanied by allocation and
    runtime statistics.
228

229
.. ghc-flag:: -ddump-core-stats
230
231
232
233

    Print a one-line summary of the size of the Core program at the end
    of the optimisation pipeline.

234
.. ghc-flag:: -dfaststring-stats
235
236
237

    Show statistics on the usage of fast strings by the compiler.

238
.. ghc-flag:: -dppr-debug
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257

    Debugging output is in one of several "styles." Take the printing of
    types, for example. In the "user" style (the default), the
    compiler's internal ideas about types are presented in Haskell
    source-level syntax, insofar as possible. In the "debug" style
    (which is the default for debugging output), the types are printed
    in with explicit foralls, and variables have their unique-id
    attached (so you can check for things that look the same but
    aren't). This flag makes debugging output appear in the more verbose
    debug style.

.. _formatting dumps:

Formatting dumps
----------------

.. index::
   single: formatting dumps

258
.. ghc-flag:: -dppr-user-length
259
260
261
262
263

    In error messages, expressions are printed to a certain "depth",
    with subexpressions beyond the depth replaced by ellipses. This flag
    sets the depth. Its default value is 5.

264
.. ghc-flag:: -dppr-cols=N
265
266

    Set the width of debugging output. Use this if your code is wrapping
267
    too much. For example: ``-dppr-cols=200``.
268

269
.. ghc-flag:: -dppr-case-as-let
270
271
272
273
274

    Print single alternative case expressions as though they were strict
    let expressions. This is helpful when your code does a lot of
    unboxing.

275
.. ghc-flag:: -dno-debug-output
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294

    Suppress any unsolicited debugging output. When GHC has been built
    with the ``DEBUG`` option it occasionally emits debug output of
    interest to developers. The extra output can confuse the testing
    framework and cause bogus test failures, so this flag is provided to
    turn it off.

.. _suppression:

Suppressing unwanted information
--------------------------------

.. index::
   single: suppression; of unwanted dump output

Core dumps contain a large amount of information. Depending on what you
are doing, not all of it will be useful. Use these flags to suppress the
parts that you are not interested in.

295
.. ghc-flag:: -dsuppress-all
296
297
298
299
300

    Suppress everything that can be suppressed, except for unique ids as
    this often makes the printout ambiguous. If you just want to see the
    overall structure of the code, then start here.

301
.. ghc-flag:: -dsuppress-uniques
302
303
304
305
306
307

    Suppress the printing of uniques. This may make the printout
    ambiguous (e.g. unclear where an occurrence of 'x' is bound), but it
    makes the output of two compiler runs have many fewer gratuitous
    differences, so you can realistically apply ``diff``. Once ``diff``
    has shown you where to look, you can try again without
308
    :ghc-flag:`-dsuppress-uniques`
309

310
.. ghc-flag:: -dsuppress-idinfo
311
312
313
314
315
316

    Suppress extended information about identifiers where they are
    bound. This includes strictness information and inliner templates.
    Using this flag can cut the size of the core dump in half, due to
    the lack of inliner templates

317
.. ghc-flag:: -dsuppress-unfoldings
318
319
320
321

    Suppress the printing of the stable unfolding of a variable at its
    binding site.

322
.. ghc-flag:: -dsuppress-module-prefixes
323
324
325
326

    Suppress the printing of module qualification prefixes. This is the
    ``Data.List`` in ``Data.List.length``.

327
.. ghc-flag:: -dsuppress-type-signatures
328
329
330

    Suppress the printing of type signatures.

331
.. ghc-flag:: -dsuppress-type-applications
332
333
334

    Suppress the printing of type applications.

335
.. ghc-flag:: -dsuppress-coercions
336
337
338
339
340
341
342
343
344
345
346
347

    Suppress the printing of type coercions.

.. _checking-consistency:

Checking for consistency
------------------------

.. index::
   single: consistency checks
   single: lint

348
.. ghc-flag:: -dcore-lint
349
350
351
352

    Turn on heavyweight intra-pass sanity-checking within GHC, at Core
    level. (It checks GHC's sanity, not yours.)

353
.. ghc-flag:: -dstg-lint
354
355
356

    Ditto for STG level. (note: currently doesn't work).

357
.. ghc-flag:: -dcmm-lint
358
359

    Ditto for C-- level.
360

361
362
363
364
365
366
.. ghc-flag:: -fllvm-fill-undef-with-garbage

    Instructs the LLVM code generator to fill dead STG registers with garbage
    instead of ``undef`` in calls. This makes it easier to catch subtle
    code generator and runtime system bugs (e.g. see :ghc-ticket:`11487`).

367
368
369
370
371
372
373
374
.. _checking-determinism:

Checking for determinism
------------------------

.. index::
   single: deterministic builds

375
.. ghc-flag:: -dinitial-unique=⟨s⟩
376
377
378

    Start ``UniqSupply`` allocation from ⟨s⟩.

379
.. ghc-flag:: -dunique-increment=⟨i⟩
380
381
382

    Set the increment for the generated ``Unique``'s to ⟨i⟩.

383
    This is useful in combination with :ghc-flag:`-dinitial-unique` to test if the
384
385
386
387
388
389
390
391
392
393
    generated files depend on the order of ``Unique``'s.

    Some interesting values:

    * ``-dinitial-unique=0 -dunique-increment=1`` - current sequential
      ``UniqSupply``
    * ``-dinitial-unique=16777215 -dunique-increment=-1`` - ``UniqSupply`` that
      generates in decreasing order
    * ``-dinitial-unique=1 -dunique-increment=PRIME`` - where PRIME big enough
      to overflow often - nonsequential order