debugging.rst 21.6 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
.. _options-debugging:

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

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

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

11
12
.. contents:: Dump flags

13
14
15
16
17
18
19
20
21
.. _dumping-output:

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

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

22
23
24
25
.. ghc-flag:: -ddump-to-file
    :shortdesc: Dump to files instead of stdout
    :type: dynamic
    :category:
26

27
28
29
30
    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`.
31

32
33
34
35
.. ghc-flag:: -ddump-json
    :shortdesc: Dump error messages as JSON documents
    :type: dynamic
    :category:
36

37
38
39
    Dump error messages as JSON documents. This is intended to be consumed
    by external tooling. A good way to use it is in conjunction with
    :ghc-flag:`-ddump-to-file`.
40

41
42
43
44
.. ghc-flag:: -dshow-passes
    :shortdesc: Print out each pass name as it happens
    :type: dynamic
    :category:
45

46
47
48
49
    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.
50

51
52
53
54
    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.
55

56
57
58
59
.. ghc-flag:: -dfaststring-stats
    :shortdesc: Show statistics for fast string usage when finished
    :type: dynamic
    :category:
60

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

63
64
65
66
.. ghc-flag:: -dppr-debug
    :shortdesc: Turn on debug printing (more verbose)
    :type: dynamic
    :category:
67

68
69
70
71
72
73
74
75
76
    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.
77
78


79
80
81
82
83
GHC is a large program consisting of a number of stages. You can tell GHC to
dump information from various stages of compilation using the ``-ddump-⟨pass⟩``
flags listed below. Note that some of these tend to produce a lot of output.
You can prevent them from clogging up your standard output by passing
:ghc-flag:`-ddump-to-file`.
84

85
86
Front-end
~~~~~~~~~
87

88
89
These flags dump various information from GHC's frontend. This includes the
parser and interface file reader.
90

91
92
93
94
.. ghc-flag:: -ddump-parsed
    :shortdesc: Dump parse tree
    :type: dynamic
    :category:
95

96
    Dump parser output
97

98
99
100
101
.. ghc-flag:: -ddump-parsed-ast
    :shortdesc: Dump parser output as a syntax tree
    :type: dynamic
    :category:
102

103
    Dump parser output as a syntax tree
104

105
106
107
108
.. ghc-flag:: -ddump-if-trace
    :shortdesc: Trace interface files
    :type: dynamic
    :category:
109

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


113
114
Type-checking and renaming
~~~~~~~~~~~~~~~~~~~~~~~~~~
115

116
These flags dump various information from GHC's typechecker and renamer.
117

118
119
120
121
.. ghc-flag:: -ddump-tc-trace
    :shortdesc: Trace typechecker
    :type: dynamic
    :category:
122

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

125
126
127
128
.. ghc-flag:: -ddump-rn-trace
    :shortdesc: Trace renamer
    :type: dynamic
    :category:
129

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

132
133
134
135
.. ghc-flag:: -ddump-ec-trace
    :shortdesc: Trace exhaustiveness checker
    :type: dynamic
    :category:
136

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

140
141
142
143
.. ghc-flag:: -ddump-rn-stats
    :shortdesc: Renamer stats
    :type: dynamic
    :category:
144

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

148
149
150
151
.. ghc-flag:: -ddump-rn
    :shortdesc: Dump renamer output
    :type: dynamic
    :category:
152

153
    Dump renamer output
154

155
156
157
158
.. ghc-flag:: -ddump-rn-ast
    :shortdesc: Dump renamer output as a syntax tree
    :type: dynamic
    :category:
159

160
    Dump renamer output as a syntax tree
161

162
163
164
165
.. ghc-flag:: -ddump-tc
    :shortdesc: Dump typechecker output
    :type: dynamic
    :category:
166

167
    Dump typechecker output
168

169
170
171
172
.. ghc-flag:: -ddump-tc-ast
    :shortdesc: Dump typechecker output as a syntax tree
    :type: dynamic
    :category:
173

174
    Dump typechecker output as a syntax tree
175

176
177
178
179
.. ghc-flag:: -ddump-splices
    :shortdesc: Dump TH spliced expressions, and what they evaluate to
    :type: dynamic
    :category:
180

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

184
185
186
187
.. ghc-flag:: -dth-dec-file=⟨file⟩
    :shortdesc: Show evaluated TH declarations in a .th.hs file
    :type: dynamic
    :category:
188

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

191
192
193
194
.. ghc-flag:: -ddump-types
    :shortdesc: Dump type signatures
    :type: dynamic
    :category:
195

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

202
203
204
205
.. ghc-flag:: -ddump-deriv
    :shortdesc: Dump deriving output
    :type: dynamic
    :category:
206

207
    Dump derived instances
208
209


210
211
Core representation and simplification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
212

213
214
215
216
These flags dump various phases of GHC's Core-to-Core pipeline. This begins with
the desugarer and includes the simplifier, worker-wrapper transformation, the
rule engine, the specialiser, the strictness/occurrence analyser, and a common
subexpression elimination pass.
217

218
219
220
221
222
.. ghc-flag:: -ddump-core-stats
    :shortdesc: Print a one-line summary of the size of the Core program at the
        end of the optimisation pipeline
    :type: dynamic
    :category:
223

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

227
228
229
230
.. ghc-flag:: -ddump-ds
    :shortdesc: Dump desugarer output
    :type: dynamic
    :category:
231

232
    Dump desugarer output
233

234
235
236
237
.. ghc-flag:: -ddump-simpl-iterations
    :shortdesc: Dump output from each simplifier iteration
    :type: dynamic
    :category:
238

239
240
241
    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``.
242

243
244
245
246
.. ghc-flag:: -ddump-simpl-stats
    :shortdesc: Dump simplifier stats
    :type: dynamic
    :category:
247

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

251
252
253
254
.. ghc-flag:: -dverbose-core2core
    :shortdesc: Show output from each core-to-core pass
    :type: dynamic
    :category:
255

256
257
    Show the output of the intermediate Core-to-Core pass. (*lots* of output!)
    So: when we're really desperate:
258

259
    .. code-block:: sh
260

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

263
264
265
266
.. ghc-flag:: -ddump-spec
    :shortdesc: Dump specialiser output
    :type: dynamic
    :category:
267

268
    Dump output of specialisation pass
269

270
271
272
273
.. ghc-flag:: -ddump-rules
    :shortdesc: Dump rewrite rules
    :type: dynamic
    :category:
274

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

278
279
280
281
.. ghc-flag:: -ddump-rule-firings
    :shortdesc: Dump rule firing info
    :type: dynamic
    :category:
282

283
    Dumps the names of all rules that fired in this module
284

285
286
287
288
.. ghc-flag:: -ddump-rule-rewrites
    :shortdesc: Dump detailed rule firing info
    :type: dynamic
    :category:
289

290
291
    Dumps detailed information about all rules that fired in this
    module
292

293
294
295
296
.. ghc-flag:: -ddump-vect
    :shortdesc: Dump vectoriser input and output
    :type: dynamic
    :category:
297

298
    Dumps the output of the vectoriser.
299

300
301
.. ghc-flag:: -ddump-simpl
    :shortdesc: Dump final simplifier output
302
303
    :type: dynamic
    :category:
304

305
    Dump simplifier output (Core-to-Core passes)
306

307
308
.. ghc-flag:: -ddump-inlinings
    :shortdesc: Dump inlining info
309
310
    :type: dynamic
    :category:
311

312
313
314
315
    Dumps inlining info from the simplifier. Note that if used in
    conjunction with :ghc-flag:`-dverbose-core2core` the compiler will
    also dump the inlinings that it considers but passes up, along with
    its rationale.
316

317
318
.. ghc-flag:: -ddump-stranal
    :shortdesc: Dump strictness analyser output
319
320
    :type: dynamic
    :category:
321

322
    Dump strictness analyser output
323

324
325
.. ghc-flag:: -ddump-str-signatures
    :shortdesc: Dump strictness signatures
326
327
    :type: dynamic
    :category:
328

329
    Dump strictness signatures
330

331
332
.. ghc-flag:: -ddump-cse
    :shortdesc: Dump CSE output
333
334
    :type: dynamic
    :category:
335

336
    Dump common subexpression elimination (CSE) pass output
337

338
339
.. ghc-flag:: -ddump-worker-wrapper
    :shortdesc: Dump worker-wrapper output
340
341
    :type: dynamic
    :category:
342

343
    Dump worker/wrapper split output
344

345
346
.. ghc-flag:: -ddump-occur-anal
    :shortdesc: Dump occurrence analysis output
347
348
    :type: dynamic
    :category:
349

350
    Dump "occurrence analysis" output
351

352
353
.. ghc-flag:: -ddump-vt-trace
    :shortdesc: Trace vectoriser
354
355
    :type: dynamic
    :category:
356

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

359
360
.. ghc-flag:: -ddump-prep
    :shortdesc: Dump prepared core
361
362
    :type: dynamic
    :category:
363

364
    Dump output of Core preparation pass
365
366


367
368
369
370
371
372
373
374
375
376
377
STG representation
~~~~~~~~~~~~~~~~~~

These flags dump various phases of GHC's STG pipeline.

.. ghc-flag:: -ddump-stg
    :shortdesc: Dump final STG
    :type: dynamic
    :category:

    Dump output of STG-to-STG passes
378

379
380
381
382
383
384
385
.. ghc-flag:: -dverbose-stg2stg
    :shortdesc: Show output from each STG-to-STG pass
    :type: dynamic
    :category:

    Show the output of the intermediate STG-to-STG pass. (*lots* of output!)

386
387
388
389
390
391
392
393

C-- representation
~~~~~~~~~~~~~~~~~~

These flags dump various phases of GHC's C-- pipeline.

.. ghc-flag:: -ddump-cmm-verbose
    :shortdesc: Show output from each C-- pipeline pass
394
395
    :type: dynamic
    :category:
396

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

401
402
403
404
.. ghc-flag:: -ddump-cmm-from-stg
    :shortdesc: Dump STG-to-C-- output
    :type: dynamic
    :category:
405

406
407
408
409
    Dump the result of STG-to-C-- conversion

.. ghc-flag:: -ddump-opt-cmm-cfg
    :shortdesc: Dump the results of the C-- control flow optimisation pass.
410
411
    :type: dynamic
    :category:
412

413
    Dump the results of the C-- control flow optimisation pass.
414

415
416
.. ghc-flag:: -ddump-opt-cmm-cbe
    :shortdesc: Dump the results of common block elimination
417
418
    :type: dynamic
    :category:
419

420
    Dump the results of the C-- Common Block Elimination (CBE) pass.
421

422
423
.. ghc-flag:: -ddump-opt-cmm-switch
    :shortdesc: Dump the results of switch lowering passes
424
425
    :type: dynamic
    :category:
426

427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
    Dump the results of the C-- switch lowering pass.

.. ghc-flag:: -ddump-opt-cmm-proc
    :shortdesc: Dump the results of proc-point analysis
    :type: dynamic
    :category:

    Dump the results of the C-- proc-point analysis pass.

.. ghc-flag:: -ddump-opt-cmm-sp
    :shortdesc: Dump the results of the C-- stack layout pass.
    :type: dynamic
    :category:

    Dump the results of the C-- stack layout pass.

.. ghc-flag:: -ddump-opt-cmm-sink
    :shortdesc: Dump the results of the C-- sinking pass.
    :type: dynamic
    :category:

    Dump the results of the C-- sinking pass.

.. ghc-flag:: -ddump-opt-cmm-caf
    :shortdesc: Dump the results of the C-- CAF analysis pass.
    :type: dynamic
    :category:

    Dump the results of the C-- CAF analysis pass.

.. ghc-flag:: -ddump-opt-cmm-procmap
    :shortdesc: Dump the results of the C-- proc-point map pass.
    :type: dynamic
    :category:

    Dump the results of the C-- proc-point map pass.

.. ghc-flag:: -ddump-opt-cmm-split
    :shortdesc: Dump the results of the C-- proc-point splitting pass.
    :type: dynamic
    :category:

    Dump the results of the C-- proc-point splitting pass.

.. ghc-flag:: -ddump-opt-cmm-info
    :shortdesc: Dump the results of the C-- info table augmentation pass.
    :type: dynamic
    :category:

    Dump the results of the C-- info table augmentation pass.

.. ghc-flag:: -ddump-cmm
    :shortdesc: Dump the final C-- output
    :type: dynamic
    :category:

    Dump the result of the C-- pipeline processing



LLVM code generator
~~~~~~~~~~~~~~~~~~~~~~

.. ghc-flag:: -ddump-llvm
    :shortdesc: Dump LLVM intermediate code.
    :type: dynamic
    :category:

    :implies: :ghc-flag:`-fllvm`

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

Native code generator
~~~~~~~~~~~~~~~~~~~~~

These flags dump various stages of the :ref:`native code generator's
<native-code-gen>` pipeline, which starts with C-- and produces native
assembler.

.. ghc-flag:: -ddump-opt-cmm
    :shortdesc: Dump the results of C-- to C-- optimising passes
    :type: dynamic
    :category:

    Dump the results of C-- to C-- optimising passes performed by the NCG.

.. ghc-flag:: -ddump-asm-native
    :shortdesc: Dump initial assembly
    :type: dynamic
    :category:

    Dump the initial assembler output produced from C--.

.. ghc-flag:: -ddump-asm-liveness
    :shortdesc: Dump assembly augmented with register liveness
    :type: dynamic
    :category:

    Dump the result of the register liveness pass.

.. ghc-flag:: -ddump-asm-regalloc
    :shortdesc: Dump the result of register allocation
    :type: dynamic
    :category:

    Dump the result of the register allocation pass.

.. ghc-flag:: -ddump-asm-regalloc-stages
    :shortdesc: Dump the build/spill stages of the register allocator.
    :type: dynamic
    :category:

    Dump the build/spill stages of the register allocator.

.. ghc-flag:: -ddump-asm-stats
    :shortdesc: Dump statistics from the register allocator.
    :type: dynamic
    :category:

    Dump statistics from the register allocator.

.. ghc-flag:: -ddump-asm-expanded
    :shortdesc: Dump the result of the synthetic instruction expansion pass.
    :type: dynamic
    :category:

    Dump the result of the synthetic instruction expansion pass.

.. ghc-flag:: -ddump-asm
    :shortdesc: Dump final assembly
    :type: dynamic
    :category:

    Dump assembly language produced by the


Miscellaneous backend dumps
~~~~~~~~~~~~~~~~~~~~~~~~~~~

These flags dump various bits of information from other backends.

.. ghc-flag:: -ddump-bcos
    :shortdesc: Dump interpreter byte code
    :type: dynamic
    :category:

    Dump byte-code objects (BCOs) produced for the GHC's byte-code interpreter.

.. ghc-flag:: -ddump-foreign
    :shortdesc: Dump ``foreign export`` stubs
    :type: dynamic
    :category:

    Dump foreign export stubs.

582

Ben Gamari's avatar
Ben Gamari committed
583

584
585
586
587
588
589
590
591
.. _formatting dumps:

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

.. index::
   single: formatting dumps

592
.. ghc-flag:: -dppr-user-length
593
594
595
    :shortdesc: Set the depth for printing expressions in error msgs
    :type: dynamic
    :category:
596
597
598
599
600

    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.

601
.. ghc-flag:: -dppr-cols=⟨n⟩
602
603
604
    :shortdesc: Set the width of debugging output. For example ``-dppr-cols200``
    :type: dynamic
    :category:
605
606

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

609
.. ghc-flag:: -dppr-case-as-let
610
611
612
    :shortdesc: Print single alternative case expressions as strict lets.
    :type: dynamic
    :category:
613
614
615
616
617

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

618
.. ghc-flag:: -dno-debug-output
619
620
    :shortdesc: Suppress unsolicited debugging output
    :type: dynamic
621
    :reverse: -ddebug-output
622
    :category:
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641

    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.

642
.. ghc-flag:: -dsuppress-all
643
644
645
646
    :shortdesc: In core dumps, suppress everything (except for uniques) that is
        suppressible.
    :type: dynamic
    :category:
647
648
649
650
651

    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.

652
.. ghc-flag:: -dsuppress-ticks
653
654
655
    :shortdesc: Suppress "ticks" in the pretty-printer output.
    :type: dynamic
    :category:
656
657
658

    Suppress "ticks" in the pretty-printer output.

659
.. ghc-flag:: -dsuppress-uniques
660
661
662
663
    :shortdesc: Suppress the printing of uniques in debug output (easier to use
        ``diff``)
    :type: dynamic
    :category:
664
665
666
667
668
669

    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
670
    :ghc-flag:`-dsuppress-uniques`
671

672
.. ghc-flag:: -dsuppress-idinfo
673
674
675
676
    :shortdesc: Suppress extended information about identifiers where they
        are bound
    :type: dynamic
    :category:
677
678
679
680
681
682

    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

683
.. ghc-flag:: -dsuppress-unfoldings
684
685
686
687
    :shortdesc: Suppress the printing of the stable unfolding of a variable at
        its binding site
    :type: dynamic
    :category:
688
689
690
691

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

692
.. ghc-flag:: -dsuppress-module-prefixes
693
694
695
    :shortdesc: Suppress the printing of module qualification prefixes
    :type: dynamic
    :category:
696
697
698
699

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

700
.. ghc-flag:: -dsuppress-type-signatures
701
702
703
    :shortdesc: Suppress type signatures
    :type: dynamic
    :category:
704
705
706

    Suppress the printing of type signatures.

707
.. ghc-flag:: -dsuppress-type-applications
708
709
710
    :shortdesc: Suppress type applications
    :type: dynamic
    :category:
711
712
713

    Suppress the printing of type applications.

714
.. ghc-flag:: -dsuppress-coercions
715
716
717
718
    :shortdesc: Suppress the printing of coercions in Core dumps to make them
        shorter
    :type: dynamic
    :category:
719
720
721

    Suppress the printing of type coercions.

722

723
724
725
726
727
728
729
730
731
.. _checking-consistency:

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

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

732
.. ghc-flag:: -dcore-lint
733
734
735
    :shortdesc: Turn on internal sanity checking
    :type: dynamic
    :category:
736
737
738
739

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

740
.. ghc-flag:: -dstg-lint
741
742
743
    :shortdesc: STG pass sanity checking
    :type: dynamic
    :category:
744
745
746

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

747
.. ghc-flag:: -dcmm-lint
748
749
750
    :shortdesc: C-- pass sanity checking
    :type: dynamic
    :category:
751
752

    Ditto for C-- level.
753

754
.. ghc-flag:: -fllvm-fill-undef-with-garbage
755
756
757
    :shortdesc: Intruct LLVM to fill dead STG registers with garbage
    :type: dynamic
    :category:
758
759
760
761
762

    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`).

Ben Gamari's avatar
Ben Gamari committed
763
.. ghc-flag:: -fcatch-bottoms
764
765
766
767
    :shortdesc: Insert ``error`` expressions after bottoming expressions; useful
        when debugging the compiler.
    :type: dynamic
    :category:
Ben Gamari's avatar
Ben Gamari committed
768
769
770
771
772
773

    Instructs the simplifier to emit ``error`` expressions in the continuation
    of empty case analyses (which should bottom and consequently not return).
    This is helpful when debugging demand analysis bugs which can sometimes
    manifest as segmentation faults.

774
775
776
777
778
779
780
781
.. _checking-determinism:

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

.. index::
   single: deterministic builds

782
.. ghc-flag:: -dinitial-unique=⟨s⟩
783
784
785
    :shortdesc: Start ``UniqSupply`` allocation from ⟨s⟩.
    :type: dynamic
    :category:
786
787
788

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

789
.. ghc-flag:: -dunique-increment=⟨i⟩
790
791
792
    :shortdesc: Set the increment for the generated ``Unique``'s to ⟨i⟩.
    :type: dynamic
    :category:
793
794
795

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

796
797
    This is useful in combination with :ghc-flag:`-dinitial-unique=⟨s⟩` to test
    if the generated files depend on the order of ``Unique``'s.
798
799
800
801
802
803
804
805
806

    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