ghc/docs/users_guide/bugs.sgml

   1 <Chapter id="bugs-and-infelicities">
   2   <title>Known bugs and infelicities
   3 </title>
   4
   5 <sect1 id="vs-Haskell-defn">
   6   <title>Haskell&nbsp;98 vs.&nbsp;Glasgow Haskell: language non-compliance
   7 </title>
   8
   9   <indexterm><primary>GHC vs the Haskell 98 language</primary></indexterm>
  10   <indexterm><primary>Haskell 98 language vs GHC</primary></indexterm>
  11
  12   <para>This section lists Glasgow Haskell infelicities in its
  13   implementation of Haskell&nbsp;98.  See also the &ldquo;when things
  14   go wrong&rdquo; section (<XRef LinkEnd="wrong">) for information
  15   about crashes, space leaks, and other undesirable phenomena.</para>
  16
  17   <para>The limitations here are listed in Haskell Report order
  18   (roughly).</para>
  19
  20   <sect2 id="haskell98-divergence">
  21     <title>Divergence from Haskell&nbsp;98</title>
  22
  23
  24     <sect3 id="infelicities-lexical">
  25       <title>Lexical syntax</title>
  26
  27       <itemizedlist>
  28         <listitem>
  29           <para>The Haskell report specifies that programs may be
  30           written using Unicode.  GHC only accepts the ISO-8859-1
  31           character set at the moment.</para>
  32         </listitem>
  33
  34         <listitem>
  35           <para>Certain lexical rules regarding qualified identifiers
  36           are slightly different in GHC compared to the Haskell
  37           report.  When you have
  38           <replaceable>module</replaceable><literal>.</literal><replaceable>reservedop</replaceable>,
  39           such as <literal>M.\</literal>, GHC will interpret it as a
  40           single qualified operator rather than the two lexemes
  41           <literal>M</literal> and <literal>.\</literal>.</para>
  42         </listitem>
  43
  44         <listitem>
  45           <para>When <option>-fglasgow-exts</option> is on, GHC
  46           reserves several keywords beginning with two underscores.
  47           This is due to the fact that GHC uses the same lexical
  48           analyser for interface file parsing as it does for source
  49           file parsing, and these keywords are used in interface
  50           files.  Do not use any identifiers beginning with a double
  51           underscore in <option>-fglasgow-exts</option> mode.</para>
  52         </listitem>
  53       </itemizedlist>
  54     </sect3>
  55
  56       <sect3 id="infelicities-syntax">
  57         <title>Context-free syntax</title>
  58
  59       <itemizedlist>
  60         <listitem>
  61           <para>GHC doesn't do fixity resolution in expressions during
  62           parsing.  For example, according to the Haskell report, the
  63           following expression is legal Haskell:
  64 <programlisting>
  65     let x = 42 in x == 42 == True</programlisting>
  66         and parses as:
  67 <programlisting>
  68     (let x = 42 in x == 42) == True</programlisting>
  69
  70           because according to the report, the <literal>let</literal>
  71           expression <quote>extends as far to the right as
  72           possible</quote>.  Since it can't extend past the second
  73           equals sign without causing a parse error
  74           (<literal>==</literal> is non-fix), the
  75           <literal>let</literal>-expression must terminate there.  GHC
  76           simply gobbles up the whole expression, parsing like this:
  77 <programlisting>
  78     (let x = 42 in x == 42 == True)</programlisting>
  79
  80           The Haskell report is arguably wrong here, but nevertheless
  81           it's a difference between GHC & Haskell 98.</para>
  82         </listitem>
  83       </itemizedlist>
  84     </sect3>
  85
  86   <sect3 id="infelicities-exprs-pats">
  87       <title>Expressions and patterns</title>
  88
  89       <variablelist>
  90         <varlistentry>
  91           <term>Very long <literal>String</literal> constants:</term>
  92           <listitem>
  93             <para>May not go through.  If you add a &ldquo;string
  94             gap&rdquo; every few thousand characters, then the strings
  95             can be as long as you like.</para>
  96
  97             <para>Bear in mind that string gaps and the
  98             <option>-cpp</option><indexterm><primary><option>-cpp</option>
  99             </primary></indexterm> option don't mix very well (see
 100             <xref linkend="c-pre-processor">).</para>
 101           </listitem>
 102         </varlistentry>
 103       </variablelist>
 104
 105     </sect3>
 106
 107     <sect3 id="infelicities-decls">
 108       <title>Declarations and bindings</title>
 109
 110       <para>None known.</para>
 111
 112     </sect3>
 113
 114     <sect3 id="infelicities-Modules">
 115       <title>Module system and interface files</title>
 116
 117       <variablelist>
 118
 119         <varlistentry>
 120           <term> Namespace pollution </term>
 121           <listitem>
 122             <para>Several modules internal to GHC are visible in the
 123             standard namespace.  All of these modules begin with
 124             <literal>Prel</literal>, so the rule is: don't use any
 125             modules beginning with <literal>Prel</literal> in your
 126             program, or you may be comprehensively screwed.</para>
 127           </listitem>
 128         </varlistentry>
 129       </variablelist>
 130
 131     </sect3>
 132
 133     <sect3 id="infelicities-numbers">
 134       <title>Numbers, basic types, and built-in classes</title>
 135
 136       <variablelist>
 137         <varlistentry>
 138           <term>Multiply-defined array elements&mdash;not checked:</term>
 139           <listitem>
 140             <para>This code fragment <emphasis>should</emphasis>
 141             elicit a fatal error, but it does not:
 142
 143 <programlisting>
 144 main = print (array (1,1) [(1,2), (1,3)])</programlisting>
 145
 146             </para>
 147           </listitem>
 148         </varlistentry>
 149       </variablelist>
 150
 151     </sect3>
 152
 153       <sect3 id="infelicities-Prelude">
 154         <title>In Prelude support</title>
 155
 156       <variablelist>
 157         <varlistentry>
 158           <term>The <literal>Char</literal> type</term>
 159           <indexterm><primary><literal>Char</literal></primary><secondary>size
 160           of</secondary></indexterm>
 161           <listitem>
 162             <para>The Haskell report says that the
 163             <literal>Char</literal> type holds 16 bits.  GHC follows
 164             the ISO-10646 standard a little more closely:
 165             <literal>maxBound :: Char</literal> in GHC is
 166             <literal>0x10FFFF</literal>.</para>
 167           </listitem>
 168         </varlistentry>
 169
 170         <varlistentry>
 171           <term>Arbitrary-sized tuples</term>
 172           <listitem>
 173             <para>Tuples are currently limited to size 61.  HOWEVER:
 174             standard instances for tuples (<literal>Eq</literal>,
 175             <literal>Ord</literal>, <literal>Bounded</literal>,
 176             <literal>Ix</literal> <literal>Read</literal>, and
 177             <literal>Show</literal>) are available
 178             <emphasis>only</emphasis> up to 5-tuples.</para>
 179
 180             <para>This limitation is easily subvertible, so please ask
 181             if you get stuck on it.</para>
 182             </listitem>
 183           </varlistentry>
 184
 185           <varlistentry>
 186             <term><literal>Read</literal>ing integers</term>
 187             <listitem>
 188               <para>GHC's implementation of the
 189               <literal>Read</literal> class for integral types accepts
 190               hexadeciaml and octal literals (the code in the Haskell
 191               98 report doesn't).  So, for example,
 192 <programlisting>read "0xf00" :: Int</programlisting>
 193               works in GHC.</para>
 194             </listitem>
 195           </varlistentry>
 196         </variablelist>
 197     </sect3>
 198   </sect2>
 199
 200   <sect2 id="haskell98-undefined">
 201     <title>GHC's interpretation of undefined behaviour in
 202     Haskell&nbsp;98</title>
 203
 204     <para>This section documents GHC's take on various issues that are
 205     left undefined or implementation specific in Haskell 98.</para>
 206
 207     <variablelist>
 208       <varlistentry>
 209         <term>Sized integral types</term>
 210         <indexterm><primary><literal>Int</literal></primary><secondary>size of</secondary>
 211         </indexterm>
 212
 213         <listitem>
 214           <para>In GHC the <literal>Int</literal> type follows the
 215           size of an address on the host architecture; in other words
 216           it holds 32 bits on a 32-bit machine, and 64-bits on a
 217           64-bit machine.</para>
 218
 219           <para>Arithmetic on <literal>Int</literal> is unchecked for
 220           overflow<indexterm><primary>overflow</primary><secondary><literal>Int</literal></secondary>
 221             </indexterm>, so all operations on <literal>Int</literal> happen
 222           modulo
 223           2<superscript><replaceable>n</replaceable></superscript>
 224           where <replaceable>n</replaceable> is the size in bits of
 225           the <literal>Int</literal> type.</para>
 226
 227           <para>The <literal>fromInteger</literal><indexterm><primary><literal>fromInteger</literal></primary>
 228             </indexterm>function (and hence
 229           also <literal>fromIntegral</literal><indexterm><primary><literal>fromIntegral</literal></primary>
 230             </indexterm>) is a special case when
 231           converting to <literal>Int</literal>.  The value of
 232           <literal>fromIntegral x :: Int</literal> is given by taking
 233           the lower <replaceable>n</replaceable> bits of <literal>(abs
 234           x)</literal>, multiplied by the sign of <literal>x</literal>
 235           (in 2's complement <replaceable>n</replaceable>-bit
 236           arithmetic).  This behaviour was chosen so that for example
 237           writing <literal>0xffffffff :: Int</literal> preserves the
 238           bit-pattern in the resulting <literal>Int</literal>.</para>
 239
 240
 241            <para>Negative literals, such as <literal>-3</literal>, are
 242              specified by (a careful reading of) the Haskell Report as
 243              meaning <literal>Prelude.negate (Prelude.fromInteger 3)</literal>.
 244              So <literal>-2147483648</literal> means <literal>negate (fromInteger 2147483648)</literal>.
 245              Since <literal>fromInteger</literal> takes the lower 32 bits of the representation,
 246              <literal>fromInteger (2147483648::Integer)</literal>, computed at type <literal>Int</literal> is
 247              <literal>-2147483648::Int</literal>.  The <literal>negate</literal> operation then
 248              overflows, but it is unchecked, so <literal>negate (-2147483648::Int)</literal> is just
 249              <literal>-2147483648</literal>.  In short, one can write <literal>minBound::Int</literal> as
 250              a literal with the expected meaning (but that is not in general guaranteed.
 251              </para>
 252
 253           <para>The <literal>fromIntegral</literal> function also
 254           preserves bit-patterns when converting between the sized
 255           integral types (<literal>Int8</literal>,
 256           <literal>Int16</literal>, <literal>Int32</literal>,
 257           <literal>Int64</literal> and the unsigned
 258           <literal>Word</literal> variants), see the modules
 259           <literal>Data.Int</literal> and <literal>Data.Word</literal>
 260           in the library documentation.</para>
 261         </listitem>
 262       </varlistentry>
 263
 264       <varlistentry>
 265         <term>Unchecked float arithmetic</term>
 266         <listitem>
 267           <para>Operations on <literal>Float</literal> and
 268           <literal>Double</literal> numbers are
 269           <emphasis>unchecked</emphasis> for overflow, underflow, and
 270           other sad occurrences.  (note, however that some
 271           architectures trap floating-point overflow and
 272           loss-of-precision and report a floating-point exception,
 273           probably terminating the
 274           program)<indexterm><primary>floating-point
 275           exceptions</primary></indexterm>.</para>
 276         </listitem>
 277       </varlistentry>
 278     </variablelist>
 279
 280   </sect2>
 281
 282 </sect1>
 283
 284
 285 <sect1 id="bugs">
 286   <title>Known bugs or infelicities</title>
 287
 288 <para>GHC has the following known bugs or infelicities:
 289 <itemizedlist>
 290
 291 <listitem><para>
 292 GHC only provides tuples up to size 62, and derived tuple instances (for
 293 Eq, Ord, etc) up to size 15.
 294 </para></listitem>
 295
 296 <listitem><para>
 297 GHC can warn about non-exhaustive or overlapping patterns, and usually does so correctly.
 298 But not always.  It gets confused by string patterns, and by guards, and can then
 299 emit bogus warnings.  The entire overlap-check code needs an overhaul really.
 300 </para></listitem>
 301
 302
 303
 304 <listitem><para>Dangers with multiple Main modules.</para>
 305
 306         <para>
 307         GHC does not insist that module <literal>Main</literal> lives in a file called <filename>Main.hs</filename>.
 308         This is useful if you want multiple versions of <literal>Main</literal>.  But there's a danger: when
 309         compiling module  <literal>Main</literal> (regardless of what file it comes from), GHC looks for
 310         the interface <filename>Main.hi</filename>; it uses this to get version information from the last
 311         time it recompiled <literal>Main</literal>.   The trouble is that this  <filename>Main.hi</filename>
 312         may not correspond to the source file being compiled.
 313           </para>
 314         <para>
 315           Solution: remove <filename>Main.hi</filename> first.  A better solution would be for GHC to
 316             record the source-file filename in the interface file, or even an MD5 checksum.
 317             </para>
 318      </listitem>
 319
 320
 321 <listitem><para>
 322 GHCi does not respect the <literal>default</literal> declaration in the module whose
 323 scope you are in.  Instead, for expressions typed at the command line, you always
 324 get the default default-type behaviour; that is, <literal>default(Int,Double)</literal>.
 325 </para>
 326 <para>
 327 It would be better for GHCi to record what the default settings in each module are, and
 328 use those of the 'current' module (whatever that is).
 329 </para></listitem>
 330
 331 <listitem><para>
 332 GHCi does not keep careful track of what instance declarations are 'in scope' if they
 333 come from other packages.
 334 Instead, all instance declarations that GHC has seen in other packages are all in scope
 335 everywhere, whether or not the module from that package is used by the command-line expression.
 336 </para></listitem>
 337
 338 <listitem><para>
 339 GHC's inliner can be persuaded into non-termination using the standard way to encode
 340 recursion via a data type:
 341 <programlisting>
 342   data U = MkU (U -> Bool)
 343
 344   russel :: U -> Bool
 345   russel u@(MkU p) = not $ p u
 346
 347   x :: Bool
 348   x = russel (MkU russel)
 349 </programlisting>
 350 We have never found another class of programs, other than this contrived one, that makes GHC
 351 diverge, and fixing the problem would impose an extra overhead on every compilation.  So the
 352 bug remains un-fixed.  There is more background in
 353 <ulink
 354 url="http://research.microsoft.com/~simonpj/Papers/inlining">
 355 Secrets of the GHC inliner</ulink>.
 356 </para></listitem>
 357 </itemizedlist></para>
 358 </sect1>
 359
 360 </Chapter>
 361
 362 <!-- Emacs stuff:
 363      ;;; Local Variables: ***
 364      ;;; mode: sgml ***
 365      ;;; sgml-parent-document: ("users_guide.sgml" "book" "chapter" "sect1") ***
 366      ;;; End: ***
 367  -->