SEXYHOOKの実装部
とある関数の接合部（2）

関数、クラスメソッド、APIをフックする方法

　テストを書いていると、一時的に関数の挙動を書き換えたいときがあります。time()がハードコートされている関数をデバッグしたい時や、まれにしか失敗しないAPIの失敗をエミュレーションしたい時などです。本稿では、テスト用の接合部を作成するライブラリ「SEXYHOOK」がいかにして関数、APIフックを処理しているかを説明します。

はじめに

　SEXYHOOKは、関数やAPIの挙動を一時的に書き換え、テスト用の接合部を強引に作成するライブラリです。

　本稿では、SEXYHOOKがいかにして関数、APIフックを行っているかを説明します。SEXYHOOKの使い方については、SEXYHOOKで始めるテスト　とある関数の接合部（1）をご覧ください。

対象読者

• C++、アセンブラを利用している開発者（ハカー）。

　言語仕様の限界ぎりぎり？ を説明しているので初心者は読まないほうがいいと思います。

必要な環境

• Windows

　Microsoft Visual C++ 6／2003／2005／2008

• Linux

　GCC 4.x（推奨） / 3.x

　現状では32bitバージョンのみのサポートになります。SEXYHOOKはデバッグビルドのみで利用できます。

gccのバージョンについて

• gcc 4.x系では問題なく動作します（動作確認 4.3.2/Debian Lenny）。
• gcc 3.x系では一部警告が表示されます。動作は可能です（動作確認:3.2.3/CentOS3）。
• gcc 2.x系では動作しません。

SEXYHOOK本体

• SEXYHOOK

　ご自由にご利用ください。

コンパイルオプションの注意

Microsoft Visual C++ 6～2003

　このバージョンには、LINEの展開バグがあるため、デバッグ情報に標準のエディットコンティニュ（/ZI）オプションが利用できません。

　エディットコンティニュ（/ZI）オプションの代わりにプログラムデータベースを使用（/Zi）オプションを指定してください。

　詳しくは、マイクロソフトのナレッジをご覧ください。

gcc

　デバッグビルド、最適化なしで実行してください。

-g -O0

　ソースコードはSJISで記述しているため、--input-charset=cp932オプションを推奨します。

マクロ展開

　SEXYHOOKでは、まずマクロを利用しユーザーが書いた構文をcppのインラインクラスに置換します。

//一時的にtime 関数をフックする。
SEXYHOOK_FUNC_HOOK_1_BEGIN(time_t,SEXYHOOK_CDECL,time,time_t * a)
{
        //time が呼ばれたらここがコールされる。
        //昔の時刻を返すようにする。
        return 915116400;//1999-01-01 00:00:00
}
SEXYHOOK_FUNC_END();

↓

//プリプロセッサによりこのように展開されます。
class SEXYHOOKFunc72 : public SEXYHOOKFuncBase
{
public:
        SEXYHOOKFunc72()
        {
        }
        void Hook(void* inVCallThisPointer)
        {
                FunctionHookFunction(
                        SEXYHOOK_DARKCAST((gccCastHackDef)&time),
                        SEXYHOOK_DARKCAST(  &SEXYHOOKFunc72::HookFunction),
                        inVCallThisPointer);
        }
        virtual ~SEXYHOOKFunc72()
        {
                FunctionUnHookFunction();
        }
        typedef time_t (__cdecl * HookDef)(time_t * a);
        static time_t __cdecl HookFunction(time_t * a)
        {
                return 915116400;
        }
        typedef HookDef gccCastHackDef;
}
objectFUNCHook76;
objectFUNCHook76.Hook(0);;

　自分で確認されたい方は、コンパイラに/E（マクロを展開したものを画面に表示）オプションでコンパイルしてください。

※注意

　膨大な行数が出力されます。

　さきほどのソースに、コメントをつけながら解説していきます。

//クラスに置換されます。
//72 は __LINE__ で置換された行番号です。
//これにより、複数回定義されてもぶつからない名前を作っています。
class SEXYHOOKFunc72 : public SEXYHOOKFuncBase //実際のフックは下位ライブラリが行います。
{
        //SEXYHOOKFuncBaseは、クラスと関数のフックを担当します。
        //APIフックは別の SEXYHOOKAPIBaseが行います。
public:
        SEXYHOOKFunc72()
        {
        }
        //フックを行う関数です。
        //引数のinVCallThisPointer は、仮想関数をフックする時に渡されるクラスインスタンスです。
        void Hook(void* inVCallThisPointer)
        {
                FunctionHookFunction(
                        //フックされる関数のポインタ
                        SEXYHOOK_DARKCAST((gccCastHackDef)&time),
                        //フックした後制御を飛ばす関数
                        SEXYHOOK_DARKCAST(  &SEXYHOOKFunc72::HookFunction),
                        inVCallThisPointer);
                       
                        //SEXYHOOK_DARKCAST は、どんな型でも void* にキャストする不思議な関数です。
                        //後で説明します。
        }
        //デストラクタでフックを元に戻します。
        virtual ~SEXYHOOKFunc72()
        {
                FunctionUnHookFunction();
        }
        //フック数関数の型です。
        typedef time_t (__cdecl * HookDef)(time_t * a);
        //フックルーチンです。フックしたときに飛んでくる関数です。
        //呼出規約をフックする関数とまったく同じにします。
        //そうすることで ret したときのスタックのずれを考える必要がなくなります。
        static time_t __cdecl HookFunction(time_t * a)
        {
                //ここをユーザーが自由に記述できます。
                return 915116400;
        }
        //仮想関数のアドレスを取得するとき、gccの仕様？に対応するために定義しています。
        //仮想関数のアドレス取得の時に説明します。
        typedef HookDef gccCastHackDef;
}
//クラスインスタンスを作成します。
//フックを開始します。
objectFUNCHook76;
//0を渡しているのは、仮想関数でないからです。
//仮想関数であれば、クラスのインスタンスが渡されます。
objectFUNCHook76.Hook(0);;