_ unsafePerformIO の使用は限定されています。ご利用は計画的に。
いたるところで、 unsafePerformIO を見かけるようになったのでひとこと言うといたるわ。「Unsafe やって書いてある」やろ。おっと、地が出てしもた。
unsafePeformIO はもともと Haskell の規格 Haskell98 にはありません。初めて現れたのは、 "The Haskell 98 Foreign Function Interface 1.0 An Addendum to the Haskell 98 Report" の 5節 Marshalling についての、5.1 節 Foreign モジュールが提供するインターフェースについてです。
unsafePerformIO :: IO a -> a
-
Return the value resulting from executing the IO action. This value should be independent of the environment; otherwise, the system behaviour is undefined.
If the IO computation wrapped in unsafePerformIO performs side effects, then the relative order in which those side effects take place (relative to the main IO trunk, or other calls to unsafePerformIO) is indeterminate. Moreover, the side effects may be performed several times or not at all, depending on lazy evaluation and whether the compiler unfolds an enclosing definition.
Great care should be exercised in the use of this primitive. Not only because of the danger of introducing side effects, but also because unsafePerformIO may compromise typing; to avoid this, the programmer should ensure that the result of unsafePerformIO has a monomorphic type.
[5.1 Foreign - The Haskell 98 Foreign Function Interface 1.0 An Addendum to the Haskell 98 Reportより引用]
ね、めったなことじゃ使っちゃダメだって書いてあるでしょ。ただ、型があまりにも便利そうなので、初心者は使いがちである(特に IO モナドを理解していない人)。unsafePerformIO は Foreign Function Interface (FFI) のために必要になったのであって、IO を外すために作られたわけじゃないんだ。
Haskell では、main :: IO ()なので、プログラムを書くときはいつも IO モナドの中に閉じ込められることになる。これが、慣れないときは気持ちが悪い。つい、IO a から a を取り出したくなって unsafePerformIO :: IO a -> a を使いたくなる気持ちはとてもよくわかるんだ。でも使ってはならない。
まず、ほかの言語から Haskell に入ってきた人は、グローバル変数が欲しくなる。関数の引数に付け回して獄門！というのが気持ちが悪い。もちろん、Haskell プログラマはそんなことはしない。初心者が触りやすいインターフェースを持つ、Data.IORefというのが用意されている。
別の目的でグローバル変数が必要になることもある。並行プログラミングにおいて、複数のプロセスが同じ変数を参照するときである。これについても、Data.IORef の atomicModifyIORef :: IORef a -> (a -> (a, b)) -> IO b を使えばよい。
初心者から脱却して、State モナドの意味がわかってくると、グローバル変数を使う目的で IORef はむしろ邪悪だということがわかる。変数をよりローカルに安全に参照・更新するために Reader/Writer State モナドを使うようになる。
さて、こういった、Haskell ライブラリ固有の事情はともかく、まず最初に関数型言語Haskell の特徴のひとつを思い出して欲しい。 Haskell には、代数的データ型がある。これはグローバルに参照することもできるし、スコープを制限することもできる。
たとえば、プログラムに与えられた引数のリストを知りたいときを考えてみよう。System.Environment ライブラリの関数 getArgs :: IO [String] がそれである。ここで、安易に unsafePerformIO をかまして [String] を得たくなる気持ちはわかるが、それは危険なうえに、Haskell的ではない。
以下、プログラムに与えられた一番目の引数 n が "-" で始まってなければ、"Hello, " ++ n を表示し、さもなければ usage を表示するプログラムを Haskell で書いてみよう。読者の Haskell 歴はまちまちであろうから、ソースコードを全て書いてから説明に移ろう。
module Main where
import System.Environment(getArgs)
main :: IO ()
main = do args <- getArgs
case args of
[x] -> printHello x
_ -> showUsage
printHello :: String -> IO ()
printHello x = do if null x || head x == '-'
then showUsage
else putStrLn ("Hello, " ++ x)
showUsage :: IO ()
showUsage = putStrLn "Give a name after the command name, please."
これについては、まあ、異論はないと思う。unsafePerformIO の入る余地はない。
次に、これと同じ事をするプログラムを getArgs の代わりに System.Console.GetOpt ライブラリを使って実装してみる(overweight だが比較のために)。こいつは GNU getopt ライブラリを使ったことがある人はすぐに使えるし、そうでない人でも各関数の型と説明を見れば使い方がわかる。 getOpt は IO モナドな関数ではないので、これまた unsafePerformIO を使いたくなるが、使ってはいけない。
module Main where
import System.Console.GetOpt(ArgOrder(..), getOpt)
import System.Environment(getArgs)
main :: IO ()
main = do args <- getArgs
let (_, n, e) = getOpt RequireOrder [] args
if null e then printHello n
else showUsage
printHello :: [String] -> IO ()
printHello x = do if null x
then showUsage
else putStrLn ("Hello, " ++ head x)
showUsage :: IO ()
showUsage = putStrLn "Give a name after the command name, please."
今回の例では、作成したプログラムのオプションに引数が出てこなかったので、unsafePerformIO が必要ないのは当然である。そこで、引数があってすら unsafePerformIO が必要ないことを言おう。オプション "-q (or --quit) name" を付けたときは、"Hello, " の代わりに "See you, " と言おうではないか。さあどうするか。引数を下位の関数に次々と回さなければならないのだろうか。そんなことはない、ということを以下に具体例で示す。
module Main where
import System.Environment(getArgs)
import System.Console.GetOpt
(ArgDescr(..), ArgOrder(..), OptDescr(..),
getOpt)
data Greeting = Hello
| SeeYou
greet :: Greeting -> [String] -> IO ()
greet _ [] = showUsage
greet Hello x = putStrLn ("Hello, " ++ head x)
greet SeeYou x = putStrLn ("See you, " ++ head x)
data Action = Quit { seeYou :: [String] -> IO () }
options :: [OptDescr String]
options = [Option ['q'] ["quit"] (NoArg ' ') "Say bye."]
getAction :: Char -> Action
getAction c
= case c of
'q' -> Quit { seeYou = greet SeeYou }
_ -> undefined
main :: IO ()
main = do args <- getArgs
let (c, n, e) = getOpt RequireOrder options args
if null c
then if null e
then greet Hello n
else showUsage
else seeYou (getAction (head c)) n
showUsage :: IO ()
showUsage = putStrLn "Give a name after the command name, please."
まとめ：unsafePerformIO を用いずにオプションと引数を使いまわすコツは、代数的データ型に IO アクションを持たせることです。代数的データ型はモジュールの中ではグローバルに参照することができ、モジュールの外にエクスポートすることも可能です。getArgs から getOpt 経由で IO アクションを渡す関数を書いてあげればよいのです。
[補足 1.]Simon PEYTON JONES, "Tackling the Awkward Squad: monadic input/output, concurrency, exceptions, and foreign-language calls in Haskell", Tech. Rep. the 2000 Marktoberdorf Summer School, Feb. 5, 2008.[PDF] 2.6 Leaving the safety belt at home 節に書いてあるように、処理系によっては unsafePerformIO をいろいろな用途で用いることができる(該当チュートリアルのAbstract)。しかし、こういうことは ghc の中身に詳しい Simon だから言えるのであって、真似をしてはいけない。unsafePerformIO は Haskell 処理系の実装に依存する。
[補足 2.] その他 unsafePerformIO の濫用を警告している記事リンク
[どうでもいい補足 3.]
「unsafePerformIO について、詳しく説明しているとこない？」って freenode#Haskell で聞いたら、「お前がそれを聞くのは初めてかもしれないが、俺たちがそれに答えるのはこれで１００回目だ！」って言われた。これは冗談で、いろいろなことをきちんと教えてもらえましたけどね。
BSD /bin/testの Haskell による実装例。オプションが猛烈にあるのはご存知の通り。
今回紹介した Simon PEYTON JONES のチュートリアルが行われた Marktoberdorf Summer School というのは大変すばらしいところなので、行く機会があったらぜひ行くことをお勧めする。
Real World Haskell (第一版)では、適切に unsafePerformIO を説明している。それは、Chapter 17. Interfacing with C - the FFI p.424 である。前に述べたように、unsafePerformIO は主に FFI のためにある。
While it is possible to do IO in Haskell, this is only spoken of in whispers, and there is only one function to do IO: System.IO.Unsafe.Really.IMeanIt.reallyReallyAbsurdlyUnsafePerformIOShameOnYou.
[Haskell(en.Uncyclopedia)より引用]
リンクをたどると元画像を得ることができます。
この本には、様々な事柄について簡潔かつ必要十分な情報がつまっているので、お勧めします。査読を依頼されたときについて、Krantz 先生がおっしゃっていることをまとめてみました:
