Personal tools

Debugging

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
(Added info about htrace and GHood, added a link to the debug category in Hackage)
(4 intermediate revisions by one user not shown)
Line 15: Line 15:
 
You must keep in mind that due to lazy evaluation your traces will only print if the value they wrap is ever demanded.
 
You must keep in mind that due to lazy evaluation your traces will only print if the value they wrap is ever demanded.
   
The trace function is located in the base package. The package [http://hackage.haskell.org/package/htrace htrace] defines a trace function as in the base package, with indentation for better visual effect. Other tools can be found at [http://hackage.haskell.org/packages/archive/pkg-list.html#cat:debug the debug category in Hackage]
+
The trace function is located in the base package. The package [http://hackage.haskell.org/package/htrace htrace] defines a trace function similar to the one in the base package, but with indentation for better visual effect (see the [http://www.haskell.org/pipermail/haskell-cafe/2012-January/098847.html mailing list thread] for examples). Other tools can be found at [http://hackage.haskell.org/packages/archive/pkg-list.html#cat:debug the debug category in Hackage].
   
   
Line 49: Line 49:
 
I have a handy bogus Hugs.Observe module with no-ops for the observations so that I don't need to remove them manually, expecting that the compiler will optimize them away.
 
I have a handy bogus Hugs.Observe module with no-ops for the observations so that I don't need to remove them manually, expecting that the compiler will optimize them away.
   
The [http://hackage.haskell.org/package/GHood GHood] package adds a graphical back-end to Hood. See also the [http://community.haskell.org/~claus/GHood/ GHood homepage]
+
The [http://hackage.haskell.org/package/GHood GHood] package adds a graphical back-end to Hood. See also the [http://community.haskell.org/~claus/GHood/ GHood homepage].
   
   
 
== The Safe Library ==
 
== The Safe Library ==
   
There is a safe library of functions from the Prelude that can crash, see [http://www-users.cs.york.ac.uk/~ndm/safe/ the safe library]. If you get an error message such as "pattern match failure, head []", you can then use <tt>headNote "extra information"</tt> to get a more detailed error message for that particular call to <tt>head</tt>. The safe library also has functions that return default values and wrap their computation in <tt>Maybe</tt> as required.
+
There is a safe library of functions from the Prelude that can crash, see [http://community.haskell.org/~ndm/safe/ the safe library]. If you get an error message such as "pattern match failure, head []", you can then use <tt>headNote "extra information"</tt> to get a more detailed error message for that particular call to <tt>head</tt>. The safe library also has functions that return default values and wrap their computation in <tt>Maybe</tt> as required.
   
 
== Offline analysis of traces ==
 
== Offline analysis of traces ==
The most advanced debugging tools are based in offline analysis of traces. [http://www.haskell.org/hat Hat] is probably the most up-to-date tool for this, offering a comprehensive set of tools. [[User:NeilMitchell|Neil Mitchell]] has made available a Windows port of Hat at [http://www-users.cs.york.ac.uk/~ndm/projects/windows.php his site].
+
The most advanced debugging tools are based in offline analysis of traces. [http://www.haskell.org/hat Hat] is probably the most up-to-date tool for this, offering a comprehensive set of tools. [[User:NeilMitchell|Neil Mitchell]] has made available a Windows port of Hat at [http://projects.haskell.org/~ndm/hat/ his site].
   
 
The disadvantage of these tools is that they are not always compatible with the latest libraries, so you can put them to use only in some cases.
 
The disadvantage of these tools is that they are not always compatible with the latest libraries, so you can put them to use only in some cases.
Line 93: Line 93:
 
== Source-located errors ==
 
== Source-located errors ==
   
[http://www.cse.unsw.edu.au/~dons/loch.html LocH] provides wrappers over
+
[http://hackage.haskell.org/cgi-bin/hackage-scripts/package/loch LocH] provides wrappers over
 
<hask>assert</hask> for generating source-located exceptions and errors.
 
<hask>assert</hask> for generating source-located exceptions and errors.
   
Line 153: Line 153:
 
== Other tricks ==
 
== Other tricks ==
   
* If you use GHC, you can get a stack trace in the console when your program fails with an error condition. See the [http://www.haskell.org/ghc/docs/latest/html/users_guide/using-ghc.html#rts-options-debugging description of relevant runtime options].
+
* If you use GHC, you can get a stack trace in the console when your program fails with an error condition. See the [http://www.haskell.org/ghc/docs/latest/html/users_guide/runtime-control.html#rts-options-debugging description of relevant runtime options].
 
* Some tips how to use GHCi debugger are also in [http://www.haskell.org/pipermail/glasgow-haskell-users/2009-February/016571.html this message].
 
* Some tips how to use GHCi debugger are also in [http://www.haskell.org/pipermail/glasgow-haskell-users/2009-February/016571.html this message].
   
Line 196: Line 196:
 
of the start and end of an offending statement.
 
of the start and end of an offending statement.
   
[[Category:Tools]]
 
   
 
=== Infinite loops ===
 
=== Infinite loops ===
Line 207: Line 206:
   
 
''(For which versions? ghci >= 6.8?)''
 
''(For which versions? ghci >= 6.8?)''
  +
  +
[[Category:Tools]]
  +
[[Category:Development tools]]

Revision as of 18:42, 19 October 2012

Contents

1 Printf and friends

The simplest approach is to use Debug.Trace.trace:

trace :: String -> a -> a
"When called, trace outputs the string in its first argument, before returning the second argument as its result.'"

A common idiom to trace a function is:

myfun a b | trace ("myfun " ++ show a ++ " " ++ show b) False = undefined
myfun a b = ...

The advantage is that disabling and enabling the trace takes only one line comment.

You must keep in mind that due to lazy evaluation your traces will only print if the value they wrap is ever demanded.

The trace function is located in the base package. The package htrace defines a trace function similar to the one in the base package, but with indentation for better visual effect (see the mailing list thread for examples). Other tools can be found at the debug category in Hackage.


A more powerful alternative for this approach is Hood. Even if it hasn't been updated in some time, Hood works perfectly with the current ghc distribution. Even more, Hugs has it already integrated, see the manual page. Add an import Observe and start inserting observations in your code. For instance:

import Hugs.Observe

f'  = observe "Informative name for f" f 
f x = if odd x then x*2 else 0

And then in hugs:

Main> map f' [1..5]
[2,0,6,0,10]

>>>>>>> Observations <<<<<<

Informative name for f
  { \ 5  -> 10
  , \ 4  -> 0
  , \ 3  -> 6
  , \ 2  -> 0
  , \ 1  -> 2
  }

outputs a report of all the invocations of f and their result.

I have a handy bogus Hugs.Observe module with no-ops for the observations so that I don't need to remove them manually, expecting that the compiler will optimize them away.

The GHood package adds a graphical back-end to Hood. See also the GHood homepage.


2 The Safe Library

There is a safe library of functions from the Prelude that can crash, see the safe library. If you get an error message such as "pattern match failure, head []", you can then use headNote "extra information" to get a more detailed error message for that particular call to head. The safe library also has functions that return default values and wrap their computation in Maybe as required.

3 Offline analysis of traces

The most advanced debugging tools are based in offline analysis of traces. Hat is probably the most up-to-date tool for this, offering a comprehensive set of tools. Neil Mitchell has made available a Windows port of Hat at his site.

The disadvantage of these tools is that they are not always compatible with the latest libraries, so you can put them to use only in some cases.

Some Hat user should complete this section

4 Dynamic breakpoints in GHCi

Finally, the GHCi debugger project aims to bring dynamic breakpoints and intermediate values observation to GHCi in a near future. Right now the tool is only available from the site as a modified version of GHC, so unfortunately you will have to compile it yourself if you want to have it.

This tool allows to set breakpoints in your code, directly from the GHCi command prompt. An example session:

*main:Main> :break add Main 2
Breakpoint set at (2,15)
*main:Main> qsort [10,9..1]
Local bindings in scope:
  x :: a, xs :: [a], left :: [a], right :: [a]
 
qsort2.hs:2:15-46> :sprint x
x = _
qsort2.hs:2:15-46> x
This is an untyped, unevaluated computation. You can use seq to 
force its evaluation and then :print to recover its type
qsort2.hs:2:15-46> seq x ()
() 
qsort2.hs:2:15-46> :p x
x - 10

Once a breakpoint is hit, you can explore the bindings in scope, as well as to evaluate any haskell expression, as you would do in a normal GHCi prompt. The ':print' command can be very useful to explore the lazyness of your code.

5 Source-located errors

LocH provides wrappers over

assert
for generating source-located exceptions and errors. Consider the use of a located
fromJust
:
import Debug.Trace.Location
import qualified Data.Map as M
import Data.Maybe
 
main = do print f
 
f = let m = M.fromList
                [(1,"1")
                ,(2,"2")
                ,(3,"3")]
        s = M.lookup 4 m
    in fromJustSafe assert s
 
fromJustSafe a s = check a (fromJust s)

This will result in:

$ ./a.out
a.out: A.hs:12:20-25: Maybe.fromJust: Nothing

This can be automated, using the 'loch' preprocessor, so a program failing with:

   $ ghc A.hs --make -no-recomp
   [1 of 1] Compiling Main             ( A.hs, A.o )
   Linking A ...
   $ ./A
   A: Maybe.fromJust: Nothing

Can be transformed to a src-located one by adding:

import Debug.Trace.Location

and then recompiling with the preprocessor on:

   $ ghc A.hs --make -pgmF loch -F -no-recomp
   [1 of 1] Compiling Main             ( A.hs, A.o )
   Linking A ...
   $ ./A
   A: A.hs:14:14-19: Maybe.fromJust: Nothing

6 Other tricks

6.1 Locating a failure in a library function

The simplest way to provide locating in the source code a mismatch run-time error in the library functions:

head, tail, fromJust

and others is to avoid these functions and to use explicit matching instead.

For example, consider:

g x = h $ fromJust $ f x,
ghc-6.6 often loses the reference to
g
,
f
, and
h
in its run-time error report, when
f
returns
Nothing
.

But for the program:

g x = let Just y = f x in h y,

GHC reports:

    Main: M1.hs:9:11-22:
    Irrefutable pattern failed for pattern Data.Maybe.Just y

Indicating the source of the failure.

6.2 Mysterious parse errors

GHC provides `-ferror-spans`, which will give you the exactly position of the start and end of an offending statement.


6.3 Infinite loops

On glasgow-haskell-users on 21 Nov 2007, pepe made the following suggestion for detecting the cause infinite loops in GHCi. Assuming the offending function is named `loop`, and takes one argument:

  1. enable the flag -fbreak-on-error (`:set -fbreak-on-error` in GHCi)
  2. run your expression with :trace (`:trace loop 'a'`)
  3. hit Ctrl-C while your program is stuck in the loop to have the debugger break in the loop
  4. use :history and :back to find out where the loop is located and why.

(For which versions? ghci >= 6.8?)