{- ICFP referees look away now. -}
Dons recently asked me to look over the StackSet.hs module of XMonad, checking for pattern-match errors, using my Catch tool. This module is the main API for XMonad, and having a proof of pattern-match safety would be a nice result. I performed an initial check of the library, including introducing the necessary infrastructure to allow Catch to execute, then sent them the required patches. After I had given them the Catch tool and the initial results, sjanssen picked up the results and went on to modify the code further - with the end result that now StackSet will never crash with a pattern-match error.
I'm not going to cover the changes that XMonad required to achieve safety - that is a story that sjanssen is much better equiped to tell. What I am going to describe is the process I followed to get to the initial results.
Step 1: Download Catch, Yhc and XMonad
Catch can be obtained from http://www-users.cs.york.ac.uk/~ndm/catch/ - however a word of warning - it is an involved installation procedure. In the next few months I hope to make Catch use Cabal, and then ordinary users will be able to easily install Catch.
Yhc can be obtained from http://www.haskell.org/haskellwiki/Yhc
XMonad can be obtained from http://www.xmonad.org/
Step 2: Make sure StackSet.hs compiles with Yhc
Initially StackSet used pattern guards, one small patch and these were removed. There was also a small issue with defaulting and Yhc, which I was able to paper over with another small patch. With these two minor changes Yhc was able to compile StackSet.
Step 3: Write a test for StackSet
The test for StackSet is based on the Catch library testing framework, and is all available at http://darcs.haskell.org/~sjanssen/xmonad/tests/Catch.hs
The basic idea is to write a main function which is all the functions under test:
--------------------------------------------------------
module Catch where
import StackSet
main = screen ||| peekStack ||| index ||| ...
--------------------------------------------------------
Catch takes care of all the remaining details. The ||| operator says to check that under all circumstances the function will not crash with a pattern-match error. The module is actually slightly more involved, but this is all detail which Catch will shortly hide into a library.
A future intention is to have a tool which automatically generates such a module from a library. This then allows the person performing the checking to simply point at a library, with no additional infrastructure.
Step 4: Test using Catch
This step is the first time we actually invoke Catch - and its as simple as a single line:
> catch Catch.hs -errors -partial
And thats it, now Catch gives you all the necessary information to start fixing your code. I emailed a summary of the results as given by Catch to the XMonad list: http://www.haskell.org/pipermail/xmonad/2007-May/000196.html
At this point I hopped on IRC, and in discussions with sjannsen talked him through installing Catch and the necessary dependencies. Once he had this installed, he was able to modify the StackSet API and implementation to guarantee that no pattern match errors are raised. After all of this, now running Catch over the test script gives success.
A lesson to take away
There were only two sticking points in running Catch over XMonad. The first was that Yhc can't always compile the code, and may require slight tweaks to be made. There are two solutions to fixing this, we can either fix Yhc, or I can make Catch use GHC Core. The GHC Core solution shouldn't be too much work, once GHC has a library for external Core.
The second sticking point is that installing Catch is a lot harder than it should be. A little bit of Cabal magic and a proper release should squash these problems easily.
So what lessons did I learn? Perhaps the thing that surprised me most is how easily someone else was able to get to grips with the Catch tool. This gives me a strong sense of hope that average users may be able to employ the Catch tool upon their programs, either in this version of a future version.
Wednesday, May 09, 2007
Subscribe to:
Post Comments (Atom)
2 comments:
I don't suppose it can handle GADTs?
cinimod: Yhc can't handle GADT's, so they won't compile. However, the underlying checker works on an untyped core language - so it doesn't care about rank-2/n types or GADT's. Once I get the translation from GHC Core, I don't forsee any problems with GADT's or any other type extension.
Post a Comment