CoreToDoは実質的に、GHCがCoreに対して行うあらゆる種類の最適化過程を記述するデータ型である。過程には単純化、CSE、ベクトル化などがある。プラグインのためには専用の構築子、CoreDoPluginPass :: String -> PluginPass -> CoreToDoがあり、自分で用意した過程をパイプラインに挿入する場合には常にこれを使うべきである。最初のパラメタはプラグインの名前であり、二番目は挿入したい過程である。

CoreMはモナドであり、全てのCore最適化はその中に生息し、その中で動作する。

プラグインの設置関数(上の例ではinstall)は、CoreToDoのリストを取り、CoreToDoのリストを返す。GHCは、モジュールのコンパイルを開始する前に、ロードするように指示された全てのプラグインを列挙し、全ての設置関数を走らせる。最初のリストはGHCが自分で指定したものである。全てのプラグインについてこれを行なった後、最終的なリストが最適化器に与えられ、単にリストを順番に辿ることで実行される。

設置関数を書く際には注意深くなければならない。なぜなら、執筆時点では、あなたが返したリストは疑われたり再確認されたりしないからである。以下のような設置関数を考える。

install :: [CommandLineOption] -> [CoreToDo] -> CoreM [CoreToDo]
install _ _ = return []

これが正しいのは間違いないが、やりたいことと違うのもまた間違いない。

前の節では、CoreDoPluginPassが名前の他にPluginPass型の過程を取ることを見た。PluginPassは(ModGuts -> CoreM ModGuts)の別名である。ModGutsは、GHCが特定の時点でコンパイルしようとしている一つのモジュールを表現する型である。

ModGutsは、モジュールの最上位の束縛のうち見て確かめられるものを全て保持する。これらの束縛の型はCoreBindであり、実質的に、名前が本体のコードに束縛されるのを表す。最上位の束縛はModGutsのmg_bindsフィールドにある。最上位の束縛を操作する過程は、このフィールドに沿って繰り返しを行い、更新したmg_bindsフィールドを含む新しいModGutsを返すだけで実装できる。これは非常によくあるケースなので、([CoreBind] -> CoreM [CoreBind])型の関数を(ModGuts -> CoreM ModGuts)型に持ち上げるbindsOnlyPassという関数が用意されている。

前節の例を続けて、コンパイル中モジュールの全ての非再帰的束縛の名前を表示するだけの単純なプラグインを書くことができる。

module SayNames.Plugin (plugin) where
import GhcPlugins

plugin :: Plugin
plugin = defaultPlugin {
  installCoreToDos = install
  }

install :: [CommandLineOption] -> [CoreToDo] -> CoreM [CoreToDo]
install _ todo = do
  reinitializeGlobals
  return (CoreDoPluginPass "Say name" pass : todo)

pass :: ModGuts -> CoreM ModGuts
pass = do dflags <- getDynFlags
          bindsOnlyPass (mapM (printBind dflags))
  where printBind :: DynFlags -> CoreBind -> CoreM CoreBind
        printBind dflags bndr@(NonRec b _) = do
          putMsgS $ "Non-recursive binding named " ++ showSDoc dflags (ppr b)
          return bndr 
        printBind _ bndr = return bndr

先に注釈プラグマ(9.1. ソース注釈)について議論した際、コンパイラプラグインに追加の手掛かりや情報を与えるのにこれを使えることに言及した。モジュールの注釈はプラグインから取得できるが、そのためにはモジュールのModGutsを通らなければならない。注釈はDataとTypeableの任意のインスタンスであり得るので、インタフェースから取得するデータの正しい型を指定する型注釈を与える必要がある。また、あなたのユーザが使う注釈型と、あなたのプラグインが使うものが同じであることを保証しなければならない。このため、可能ならば、コンパイラプラグインを提供するパッケージの一部として注釈も配布することを勧める。

あるbinderの注釈を取得するには、`getAnnotations`を使い、適切な型を指定すればよい。SomeAnn注釈の付いた全ての最上位・非再帰的な束縛の名前を表示する例を示す。

{-# LANGUAGE DeriveDataTypeable #-}
module SayAnnNames.Plugin (plugin, SomeAnn(..)) where
import GhcPlugins
import Control.Monad (unless)
import Data.Data

data SomeAnn = SomeAnn deriving (Data, Typeable)

plugin :: Plugin
plugin = defaultPlugin {
  installCoreToDos = install
  }

install :: [CommandLineOption] -> [CoreToDo] -> CoreM [CoreToDo]
install _ todo = do
  reinitializeGlobals
  return (CoreDoPluginPass "Say name" pass : todo)

pass :: ModGuts -> CoreM ModGuts
pass g = do
          dflags <- getDynFlags
          mapM_ (printAnn dflags g) (mg_binds g) >> return g
  where printAnn :: DynFlags -> ModGuts -> CoreBind -> CoreM CoreBind
        printAnn dflags guts bndr@(NonRec b _) = do
          anns <- annotationsOn guts b :: CoreM [SomeAnn]
          unless (null anns) $ putMsgS $ "Annotated binding found: " ++  showSDoc dflags (ppr b)
          return bndr
        printAnn _ _ bndr = return bndr

annotationsOn :: Data a => ModGuts -> CoreBndr -> CoreM [a]
annotationsOn guts bndr = do
  anns <- getAnnotations deserializeWithData guts
  return $ lookupWithDefaultUFM anns [] (varUnique bndr)

これらの内部APIなどの使いかたについて、より詳しくはGHC API説明書を参照のこと。