Khelp モジュール開発者への情報

struct helper { 
 int (*mod_init) (void); 
 int (*mod_destroy) (void); 
#define HELPER_NAME_MAXLEN 16 
 char   h_name[HELPER_NAME_MAXLEN]; 
 uma_zone_t  h_zone; 
 struct hookinfo  *h_hooks; 
 uint32_t  h_nhooks; 
 uint32_t  h_classes; 
 int32_t   h_id; 
 volatile uint32_t h_refcount; 
 uint16_t  h_flags; 
 TAILQ_ENTRY(helper) h_next; 
};

モジュールは、 struct helper のインスタンスを作成しなければなりませんが、 h_classes フィールドのみ設定する必要があり、必要なところに h_flags, mod_init と mod_destroy フィールドをオプションで設定します。フレームワークは、他のすべてのフィールドを管理し、モジュールは、それらの操作を控えるべきです。フィールドを設定する初期化子の機能で指定された C99 を使用することは、奨励されます。

指定されるなら、 mod_init 関数は、登録プロセスを完了する前に、 khelp フレームワークによって実行されます。 mod_init 関数から 0 以外の値を返すことは、登録プロセスを中止し、モジュールのロードを失敗します。指定されるなら、 mod_destroy 関数は、モジュールが khelp フレームワークによって登録取り消しされた後に、登録取り消しプロセスの間に khelp フレームワークによって実行されます。返り値は、現在、無視されます。有効な khelp のクラスは、 < sys/khelp.h> で定義されます。有効なフラグは、 < sys/module_khelp.h> で定義されます。 HELPER_NEEDS_OSD フラグは、 khelp モジュールが永続的なオブジェクト毎のデータ記憶域を必要とするなら、 h_flags フィールドに設定されるべきです。 khelp クラスが永続的なオブジェクト毎のデータを関連づけるために khelp モジュールのための能力を提供するかどうか調べるプログラム的な方法が (まだ) ないので、手動のチェックが必要とされます。

KHELP_DECLARE_MOD() と KHELP_DECLARE_MOD_UMA() マクロは、 DECLARE_MODULE(9) マクロの周りの便利なラッパを提供し、 khelp フレームワークで khelp モジュールを登録するために使用されます。 KHELP_DECLARE_MOD_UMA() は、永続的なオブジェクト毎の記憶域の使用を必要とするモジュールによってのみ使用されるべきです、すなわち、それらの struct helper's の h_flags フィールドで HELPER_NEEDS_OSD フラグを設定するモジュールです。

両方のマクロに共通の最初の 4 つの引数は、次の通りです: hname 引数は、 khelp モジュールのためのユニークな ascii(7) 名前を指定します。それは、HELPER_NAME_MAXLEN-1 文字より長くない長さであるべきです。 hdata 引数は、モジュールの struct helper へのポインタです。 hhooks 引数は、 struct hookinfo 構造体の静的配列を指します。異なった hhook(9) ポイントのために複数回、同じフック関数を使用さえするときでさえ、配列は、モジュールがフックする必要があるそれぞれの hhook(9) ポイントに対して struct hookinfo を含むべきです。 version 引数は、 MODULE_VERSION(9) に渡されるモジュールのためのバージョン番号を指定します。 KHELP_DECLARE_MOD_UMA() マクロは、オプションの uma(9) コンストラクタとデコンストラクタ関数を指定する、追加の ctor と dtor 引数を取ります。 NULL は、機能性が必要でないところで渡されるべきです。

khelp_get_id() 関数は、名前 hname で khelp モジュールのための数値識別子を返します。

khelp_get_osd() 関数は、指定された khelp モジュールのためのオブジェクト毎のデータポインタを取得するために使用されます。 hosd 引数は、基本的なサブシステムオブジェクトの struct osd へのポインタです。これは、 khelp モジュールのフック関数に呼び出されるとき、 hhook(9) フレームワークによって提供されます。 id 引数は、 hosd からデータポインタを抽出するために khelp モジュールのための数値識別子を指定します。 id は、 khelp_get_id() 関数を使用して取得されます。

khelp_add_hhook() と khelp_remove_hhook() 関数によって、 khelp モジュールは、実行時に hhook(9) ポイントに動的にフックするが、またはアンフックすることができます。 hki 引数は、操作される hhook(9) ポイントとフック関数に関する必要な情報を要約する struct hookinfo へのポインタを指定します。 HHOOK_WAITOK フラグは、 malloc(9) が、メモリが利用可能になるのをウェートしてスリープすることができるなら、 khelp_add_hhook() の flags 引数を通して渡されます

Khelp をカーネルサブシステムに統合する

• オブジェクトのための構造体の定義に struct osd ポインタを埋め込みます。
• それぞれ、オブジェクトを初期化して、破壊することに責任があるサブシステムコードパスに khelp_init_osd() と khelp_destroy_osd() への呼び出しを追加します。

khelp_init_osd() 関数は、それらの h_flags フィールドに HELPER_NEEDS_OSD フラグを設定する適切なクラスのすべての現在ロードされた khelp モジュールのためのオブジェクト毎のデータ記憶域を初期化します。 classes 引数は、このサブシステムが関連づける khelp クラスのビットマスクを指定します。 khelp モジュールがビットマスクでクラスのどれかにマッチするなら、そのモジュールは、オブジェクトに関連付けられます。 hosd 引数は、 khelp モジュールによって使用のための永続的な記憶域を提供するためにに使用されるオブジェクトの struct osd へのポインタを指定します。

khelp_destroy_osd() 関数は、 khelp_init_osd() への以前の呼び出しによってオブジェクトの struct osd に関連したすべてのメモリを解放します。 hosd 引数は、破壊の準備で消去されるオブジェクトの struct osd へのポインタを指定します。