Remove references to -XRelaxedPolyRec
[ghc.git] / docs / users_guide / bugs.rst
1 .. _bugs-and-infelicities:
2
3 Known bugs and infelicities
4 ===========================
5
6 .. _vs-Haskell-defn:
7
8 Haskell standards vs. Glasgow Haskell: language non-compliance
9 --------------------------------------------------------------
10
11 .. index::
12    single: GHC vs the Haskell standards
13    single: Haskell standards vs GHC
14
15 This section lists Glasgow Haskell infelicities in its implementation of
16 Haskell 98 and Haskell 2010. See also the “when things go wrong” section
17 (:ref:`wrong`) for information about crashes, space leaks, and other
18 undesirable phenomena.
19
20 The limitations here are listed in Haskell Report order (roughly).
21
22 .. _haskell-standards-divergence:
23
24 Divergence from Haskell 98 and Haskell 2010
25 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26
27 By default, GHC mainly aims to behave (mostly) like a Haskell 2010
28 compiler, although you can tell it to try to behave like a particular
29 version of the language with the :ghc-flag:`-XHaskell98` and
30 :ghc-flag:`-XHaskell2010` flags. The known deviations from the standards are
31 described below. Unless otherwise stated, the deviation applies in Haskell 98,
32 Haskell 2010 and the default modes.
33
34 .. _infelicities-lexical:
35
36 Lexical syntax
37 ^^^^^^^^^^^^^^
38
39 -  Certain lexical rules regarding qualified identifiers are slightly
40    different in GHC compared to the Haskell report. When you have
41    ⟨module⟩\ ``.``\ ⟨reservedop⟩, such as ``M.\``, GHC will interpret it
42    as a single qualified operator rather than the two lexemes ``M`` and
43    ``.\``.
44
45 .. _infelicities-syntax:
46
47 Context-free syntax
48 ^^^^^^^^^^^^^^^^^^^
49
50 -  In Haskell 98 mode and by default (but not in Haskell 2010 mode), GHC
51    is a little less strict about the layout rule when used in ``do``
52    expressions. Specifically, the restriction that "a nested context
53    must be indented further to the right than the enclosing context" is
54    relaxed to allow the nested context to be at the same level as the
55    enclosing context, if the enclosing context is a ``do`` expression.
56
57    For example, the following code is accepted by GHC: ::
58
59        main = do args <- getArgs
60                  if null args then return [] else do
61                  ps <- mapM process args
62                  mapM print ps
63
64    This behaviour is controlled by the ``NondecreasingIndentation``
65    extension.
66
67 -  GHC doesn't do the fixity resolution in expressions during parsing as
68    required by Haskell 98 (but not by Haskell 2010). For example,
69    according to the Haskell 98 report, the following expression is
70    legal: ::
71
72            let x = 42 in x == 42 == True
73
74    and parses as: ::
75
76            (let x = 42 in x == 42) == True
77
78    because according to the report, the ``let`` expression “extends as
79    far to the right as possible”. Since it can't extend past the second
80    equals sign without causing a parse error (``==`` is non-fix), the
81    ``let``\-expression must terminate there. GHC simply gobbles up the
82    whole expression, parsing like this: ::
83
84            (let x = 42 in x == 42 == True)
85
86 -  The Haskell Report allows you to put a unary ``-`` preceding certain
87    expressions headed by keywords, allowing constructs like ``- case x of ...``
88    or ``- do { ... }``. GHC does not allow this. Instead, unary ``-`` is allowed
89    before only expressions that could potentially be applied as a function.
90
91
92 .. _infelicities-exprs-pats:
93
94 Expressions and patterns
95 ^^^^^^^^^^^^^^^^^^^^^^^^
96
97 In its default mode, GHC makes some programs slightly more defined than
98 they should be. For example, consider ::
99
100     f :: [a] -> b -> b
101     f [] = error "urk"
102     f (x:xs) = \v -> v
103
104     main = print (f [] `seq` True)
105
106 This should call ``error`` but actually prints ``True``. Reason: GHC
107 eta-expands ``f`` to
108
109 ::
110
111     f :: [a] -> b -> b
112     f []     v = error "urk"
113     f (x:xs) v = v
114
115 This improves efficiency slightly but significantly for most programs,
116 and is bad for only a few. To suppress this bogus "optimisation" use
117 ``-fpedantic-bottoms``.
118
119 .. _infelicities-decls:
120
121 Declarations and bindings
122 ^^^^^^^^^^^^^^^^^^^^^^^^^
123
124 In its default mode, GHC does not accept datatype contexts, as it has
125 been decided to remove them from the next version of the language
126 standard. This behaviour can be controlled with the ``DatatypeContexts``
127 extension. See :ref:`datatype-contexts`.
128
129 .. _infelicities-recursive-groups:
130
131 Typechecking of recursive binding groups
132 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
133
134 The Haskell Report specifies that a group of bindings (at top level, or
135 in a ``let`` or ``where``) should be sorted into strongly-connected
136 components, and then type-checked in dependency order
137 (`Haskell Report, Section
138 4.5.1 <http://www.haskell.org/onlinereport/decls.html#sect4.5.1>`__). As
139 each group is type-checked, any binders of the group that have an
140 explicit type signature are put in the type environment with the
141 specified polymorphic type, and all others are monomorphic until the
142 group is generalised (`Haskell Report, Section
143 4.5.2 <http://www.haskell.org/onlinereport/decls.html#sect4.5.2>`__).
144
145 Following a suggestion of Mark Jones, in his paper `Typing Haskell in
146 Haskell <http://citeseer.ist.psu.edu/424440.html>`__, GHC implements a
147 more general scheme. In GHC *the dependency analysis ignores references to
148 variables that have an explicit type signature*. As a result of this refined
149 dependency analysis, the dependency groups are smaller, and more bindings will
150 typecheck. For example, consider: ::
151
152       f :: Eq a => a -> Bool
153       f x = (x == x) || g True || g "Yes"
154
155       g y = (y <= y) || f True
156
157 This is rejected by Haskell 98, but under Jones's scheme the definition
158 for ``g`` is typechecked first, separately from that for ``f``, because
159 the reference to ``f`` in ``g``\'s right hand side is ignored by the
160 dependency analysis. Then ``g``\'s type is generalised, to get ::
161
162       g :: Ord a => a -> Bool
163
164 Now, the definition for ``f`` is typechecked, with this type for ``g``
165 in the type environment.
166
167 The same refined dependency analysis also allows the type signatures of
168 mutually-recursive functions to have different contexts, something that is
169 illegal in Haskell 98 (Section 4.5.2, last sentence). GHC only insists that the
170 type signatures of a *refined* group have identical type signatures; in practice
171 this means that only variables bound by the same pattern binding must have the
172 same context. For example, this is fine: ::
173
174       f :: Eq a => a -> Bool
175       f x = (x == x) || g True
176
177       g :: Ord a => a -> Bool
178       g y = (y <= y) || f True
179
180 .. _infelicities-Modules:
181
182 Module system and interface files
183 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
184
185 GHC requires the use of ``hs-boot`` files to cut the recursive loops
186 among mutually recursive modules as described in
187 :ref:`mutual-recursion`. This more of an infelicity than a bug: the
188 Haskell Report says (`Section
189 5.7 <http://haskell.org/onlinereport/modules.html#sect5.7>`__)
190
191     "Depending on the Haskell implementation used, separate compilation of
192     mutually recursive modules may require that imported modules contain
193     additional information so that they may be referenced before they are
194     compiled. Explicit type signatures for all exported values may be
195     necessary to deal with mutual recursion. The precise details of separate
196     compilation are not defined by this Report."
197
198 .. _infelicities-numbers:
199
200 Numbers, basic types, and built-in classes
201 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202
203 ``Num`` superclasses
204     The ``Num`` class does not have ``Show`` or ``Eq`` superclasses.
205
206
207     You can make code that works with both Haskell98/Haskell2010 and GHC
208     by:
209
210     -  Whenever you make a ``Num`` instance of a type, also make
211         ``Show`` and ``Eq`` instances, and
212
213     -  Whenever you give a function, instance or class a ``Num t``
214         constraint, also give it ``Show t`` and ``Eq t`` constraints.
215
216 ``Bits`` superclasses
217     The ``Bits`` class does not have a ``Num`` superclasses. It
218     therefore does not have default methods for the ``bit``, ``testBit``
219     and ``popCount`` methods.
220
221     You can make code that works with both Haskell 2010 and GHC by:
222
223     -  Whenever you make a ``Bits`` instance of a type, also make a
224         ``Num`` instance, and
225
226     -  Whenever you give a function, instance or class a ``Bits t``
227         constraint, also give it a ``Num t`` constraint, and
228
229     -  Always define the ``bit``, ``testBit`` and ``popCount`` methods
230         in ``Bits`` instances.
231
232 ``Read`` class methods
233     The ``Read`` class has two extra methods, ``readPrec`` and
234     ``readListPrec``, that are not found in the Haskell 2010 since they rely
235     on the ``ReadPrec`` data type, which requires the :ghc-flag:`-XRankNTypes`
236     extension. GHC also derives ``Read`` instances by implementing ``readPrec``
237     instead of ``readsPrec``, and relies on a default implementation of
238     ``readsPrec`` that is defined in terms of ``readPrec``. GHC adds these two
239     extra methods simply because ``ReadPrec`` is more efficient than ``ReadS``
240     (the type on which ``readsPrec`` is based).
241
242 Extra instances
243     The following extra instances are defined: ::
244
245         instance Functor ((->) r)
246         instance Monad ((->) r)
247         instance Functor ((,) a)
248         instance Functor (Either a)
249         instance Monad (Either e)
250
251 Multiply-defined array elements not checked
252     This code fragment should elicit a fatal error, but it does not: ::
253
254         main = print (array (1,1) [(1,2), (1,3)])
255
256     GHC's implementation of ``array`` takes the value of an array slot
257     from the last (index,value) pair in the list, and does no checking
258     for duplicates. The reason for this is efficiency, pure and simple.
259
260 .. _infelicities-Prelude:
261
262 In ``Prelude`` support
263 ^^^^^^^^^^^^^^^^^^^^^^
264
265 Arbitrary-sized tuples
266     Tuples are currently limited to size 100. However, standard
267     instances for tuples (``Eq``, ``Ord``, ``Bounded``, ``Ix``, ``Read``,
268     and ``Show``) are available *only* up to 16-tuples.
269
270     This limitation is easily subvertible, so please ask if you get
271     stuck on it.
272
273 ``splitAt`` semantics
274     ``Data.List.splitAt`` is more strict than specified in the Report.
275     Specifically, the Report specifies that ::
276
277        splitAt n xs = (take n xs, drop n xs)
278
279     which implies that ::
280
281        splitAt undefined undefined = (undefined, undefined)
282
283     but GHC's implementation is strict in its first argument, so ::
284
285        splitAt undefined [] = undefined
286
287 ``Show``\ ing records
288     The Haskell 2010 definition of ``Show`` stipulates that the rendered
289     string should only include parentheses which are necessary to unambiguously
290     parse the result. For historical reasons, ``Show`` instances derived by GHC
291     include parentheses around records despite the fact that record syntax
292     binds more tightly than function application; e.g., ::
293
294         data Hello = Hello { aField :: Int } deriving (Show)
295
296         -- GHC produces...
297         show (Just (Hello {aField=42})) == "Just (Hello {aField=42})"
298
299         -- whereas Haskell 2010 calls for...
300         show (Just (Hello {aField=42})) == "Just Hello {aField=42}"
301
302 ``Read``\ ing integers
303     GHC's implementation of the ``Read`` class for integral types
304     accepts hexadecimal and octal literals (the code in the Haskell 98
305     report doesn't). So, for example, ::
306
307         read "0xf00" :: Int
308
309     works in GHC.
310
311     A possible reason for this is that ``readLitChar`` accepts hex and
312     octal escapes, so it seems inconsistent not to do so for integers
313     too.
314
315 ``isAlpha``
316     The Haskell 98 definition of ``isAlpha`` is: ::
317
318         isAlpha c = isUpper c || isLower c
319
320     GHC's implementation diverges from the Haskell 98 definition in the
321     sense that Unicode alphabetic characters which are neither upper nor
322     lower case will still be identified as alphabetic by ``isAlpha``.
323
324 ``hGetContents``
325     Lazy I/O throws an exception if an error is encountered, in contrast
326     to the Haskell 98 spec which requires that errors are discarded (see
327     Section 21.2.2 of the Haskell 98 report). The exception thrown is
328     the usual IO exception that would be thrown if the failing IO
329     operation was performed in the IO monad, and can be caught by
330     ``System.IO.Error.catch`` or ``Control.Exception.catch``.
331
332 .. _infelicities-ffi:
333
334 The Foreign Function Interface
335 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
336
337 ``hs_init()``, ``hs_exit()``
338     The FFI spec requires the implementation to support re-initialising
339     itself after being shut down with ``hs_exit()``, but GHC does not
340     currently support that.
341
342     .. index::
343         single: hs_init
344         single: hs_exit
345
346 .. _haskell-98-2010-undefined:
347
348 GHC's interpretation of undefined behaviour in Haskell 98 and Haskell 2010
349 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
350
351 This section documents GHC's take on various issues that are left
352 undefined or implementation specific in Haskell 98.
353
354 ``Char``
355     .. index::
356        single: Char; size of
357
358     Following the ISO-10646 standard, ``maxBound :: Char`` in GHC is
359     ``0x10FFFF``.
360
361 ``Int``
362     .. index::
363        single: Int; size of
364        single: fromInteger function
365        single: fromIntegral function
366
367     In GHC the ``Int`` type follows the size of an address on the host
368     architecture; in other words it holds 32 bits on a 32-bit machine,
369     and 64-bits on a 64-bit machine.
370
371     Arithmetic on ``Int`` is unchecked for overflowoverflow\ ``Int``, so
372     all operations on ``Int`` happen modulo 2\ :sup:`⟨n⟩` where ⟨n⟩ is
373     the size in bits of the ``Int`` type.
374
375     The ``fromInteger`` (and hence also ``fromIntegral``) is a special case when
376     converting to ``Int``. The value of ``fromIntegral x :: Int`` is
377     given by taking the lower ⟨n⟩ bits of ``(abs x)``, multiplied by the
378     sign of ``x`` (in 2's complement ⟨n⟩-bit arithmetic). This behaviour
379     was chosen so that for example writing ``0xffffffff :: Int``
380     preserves the bit-pattern in the resulting ``Int``.
381
382     Negative literals, such as ``-3``, are specified by (a careful
383     reading of) the Haskell Report as meaning
384     ``Prelude.negate (Prelude.fromInteger 3)``. So ``-2147483648`` means
385     ``negate (fromInteger 2147483648)``. Since ``fromInteger`` takes the
386     lower 32 bits of the representation,
387     ``fromInteger (2147483648::Integer)``, computed at type ``Int`` is
388     ``-2147483648::Int``. The ``negate`` operation then overflows, but
389     it is unchecked, so ``negate (-2147483648::Int)`` is just
390     ``-2147483648``. In short, one can write ``minBound::Int`` as a
391     literal with the expected meaning (but that is not in general
392     guaranteed).
393
394     The ``fromIntegral`` function also preserves bit-patterns when
395     converting between the sized integral types (``Int8``, ``Int16``,
396     ``Int32``, ``Int64`` and the unsigned ``Word`` variants), see the
397     modules ``Data.Int`` and ``Data.Word`` in the library documentation.
398
399 Unchecked floating-point arithmetic
400     Operations on ``Float`` and ``Double`` numbers are *unchecked* for
401     overflow, underflow, and other sad occurrences. (note, however, that
402     some architectures trap floating-point overflow and
403     loss-of-precision and report a floating-point exception, probably
404     terminating the program)
405
406     .. index::
407         single: floating-point exceptions.
408
409 .. _bugs:
410
411 Known bugs or infelicities
412 --------------------------
413
414 The bug tracker lists bugs that have been reported in GHC but not yet
415 fixed: see the `GHC Trac <http://ghc.haskell.org/trac/ghc/>`__. In
416 addition to those, GHC also has the following known bugs or
417 infelicities. These bugs are more permanent; it is unlikely that any of
418 them will be fixed in the short term.
419
420 .. _bugs-ghc:
421
422 Bugs in GHC
423 ~~~~~~~~~~~
424
425 -  GHC's runtime system implements cooperative multitasking, with
426    context switching potentially occurring only when a program
427    allocates. This means that programs that do not allocate may never
428    context switch. This is especially true of programs using STM, which
429    may deadlock after observing inconsistent state. See :ghc-ticket:`367`
430    for further discussion.
431
432    If you are hit by this, you may want to compile the affected module
433    with :ghc-flag:`-fno-omit-yields <-fomit-yields>` (see :ref:`options-f`).
434    This flag ensures that yield points are inserted at every function entrypoint
435    (at the expense of a bit of performance).
436
437 -  GHC does not allow you to have a data type with a context that
438    mentions type variables that are not data type parameters. For
439    example:
440
441    ::
442
443          data C a b => T a = MkT a
444
445    so that ``MkT``\'s type is
446
447    ::
448
449          MkT :: forall a b. C a b => a -> T a
450
451    In principle, with a suitable class declaration with a functional
452    dependency, it's possible that this type is not ambiguous; but GHC
453    nevertheless rejects it. The type variables mentioned in the context
454    of the data type declaration must be among the type parameters of the
455    data type.
456
457 -  GHC's inliner can be persuaded into non-termination using the
458    standard way to encode recursion via a data type:
459
460    ::
461
462          data U = MkU (U -> Bool)
463
464          russel :: U -> Bool
465          russel u@(MkU p) = not $ p u
466
467          x :: Bool
468          x = russel (MkU russel)
469
470    The non-termination is reported like this:
471
472    .. code-block:: none
473
474        ghc: panic! (the 'impossible' happened)
475          (GHC version 7.10.1 for x86_64-unknown-linux):
476            Simplifier ticks exhausted
477          When trying UnfoldingDone x_alB
478          To increase the limit, use -fsimpl-tick-factor=N (default 100)
479
480    with the panic being reported no matter how high a
481    :ghc-flag:`-fsimpl-tick-factor` you supply.
482
483    We have never found another class of programs, other than this
484    contrived one, that makes GHC diverge, and fixing the problem would
485    impose an extra overhead on every compilation. So the bug remains
486    un-fixed. There is more background in `Secrets of the GHC
487    inliner <http://research.microsoft.com/~simonpj/Papers/inlining/>`__.
488
489 -  On 32-bit x86 platforms when using the native code generator, the
490    :ghc-flag:`-fexcess-precision` option is always on.
491    This means that floating-point calculations are non-deterministic,
492    because depending on how the program is compiled (optimisation
493    settings, for example), certain calculations might be done at 80-bit
494    precision instead of the intended 32-bit or 64-bit precision.
495    Floating-point results may differ when optimisation is turned on. In
496    the worst case, referential transparency is violated, because for
497    example ``let x = E1 in E2`` can evaluate to a different value than
498    ``E2[E1/x]``.
499
500    .. index::
501       single: -msse2 option
502
503    One workaround is to use the :ghc-flag:`-msse2` option (see
504    :ref:`options-platform`), which generates code to use the SSE2
505    instruction set instead of the x87 instruction set. SSE2 code uses
506    the correct precision for all floating-point operations, and so gives
507    deterministic results. However, note that this only works with
508    processors that support SSE2 (Intel Pentium 4 or AMD Athlon 64 and
509    later), which is why the option is not enabled by default. The
510    libraries that come with GHC are probably built without this option,
511    unless you built GHC yourself.
512
513 -  The :ghc-flag:`state hack <-fstate-hack>` optimization can result in
514    non-obvious changes in evaluation ordering which may hide exceptions, even
515    with :ghc-flag:`-fpedantic-bottoms` (see, e.g., :ghc-ticket:`7411`). For
516    instance, ::
517
518      import Control.Exception
519      import Control.DeepSeq
520      main = do
521          evaluate (('a' : undefined) `deepseq` return () :: IO ())
522          putStrLn "Hello"
523
524    Compiling this program with ``-O`` results in ``Hello`` to be printed,
525    despite the fact that ``evaluate`` should have bottomed. Compiling
526    with ``-O -fno-state-hack`` results in the exception one would expect.
527
528 -  Programs compiled with :ghc-flag:`-fdefer-type-errors` may fail a bit
529    more eagerly than one might expect. For instance, ::
530
531      {-# OPTIONS_GHC -fdefer-type-errors #-}
532      main = do
533        putStrLn "Hi there."
534        putStrLn True
535
536    Will emit no output, despite the fact that the ill-typed term appears
537    after the well-typed ``putStrLn "Hi there."``. See :ghc-ticket:`11197`.
538
539 -  Despite appearances ``*`` and ``Constraint`` aren't really distinct kinds
540    in the compiler's internal representation and can be unified producing
541    unexpected results. See :ghc-ticket:`11715` for one example.
542
543 .. _bugs-ghci:
544
545 Bugs in GHCi (the interactive GHC)
546 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
547
548 -  GHCi does not respect the ``default`` declaration in the module whose
549    scope you are in. Instead, for expressions typed at the command line,
550    you always get the default default-type behaviour; that is,
551    ``default(Int,Double)``.
552
553    It would be better for GHCi to record what the default settings in
554    each module are, and use those of the 'current' module (whatever that
555    is).
556
557 -  On Windows, there's a GNU ld/BFD bug whereby it emits bogus PE object
558    files that have more than 0xffff relocations. When GHCi tries to load
559    a package affected by this bug, you get an error message of the form
560
561    .. code-block:: none
562
563        Loading package javavm ... linking ... WARNING: Overflown relocation field (# relocs found: 30765)
564
565    The last time we looked, this bug still wasn't fixed in the BFD
566    codebase, and there wasn't any noticeable interest in fixing it when
567    we reported the bug back in 2001 or so.
568
569    The workaround is to split up the .o files that make up your package
570    into two or more .o's, along the lines of how the ``base`` package does
571    it.