魔術師見習いのノート

本稿はLinuxデバイスドライバ(モジュール)プログラミングに関するメモ．第1弾．

Linuxは実行中にカーネルの機能の追加や削除できる． それらの処理には次のコマンドを使用する．

insmod

カーネルにモジュールを追加するコマンド．

rmmod

カーネルからモジュールを取り除くコマンド．

modprobe

モジュールをカーネルに追加したりカーネルから取り除いたりする高レベルインタフェースなコマンド．モジュールをロードする場合，多くの点でinsmodと同じだが，ロード対象のモジュールが必要とするモジュールもロードする．ただしmodprobeはインストール済みのモジュールを格納したディレクトリからしか探さないため，作業ディレクトリから依存するモジュールをロードする時はは，insmodを使わなければならない．

Linuxのデバイスやモジュールのクラス

キャラクタ型デバイス

バイトストリームとして扱われるデバイスで，その機能を提供するのがキャラクタ型デバイスドライバ．通常キャラクタ型デバイスドライバには以下のシステムコールが実装される．

• open
• close
• read
• write

テキストコンソールやシリアルポートはキャラクタ型デバイスの一種である．

ブロック型デバイス

ブロック単位でアクセスするデバイス．ブロックとは512バイトあるいはそれ以外の2のべき乗のデータのかたまりのことである．代表的な例にはディスクが挙げられる．

ネットワークインタフェース

ネットワークインタフェースはデータパケットの送受信を担当する．ネットワークインタフェースのほとんどはハードウェアを伴うデバイスであるが，ループバックインタフェースのようにソフトウェアだけのデバイスもある．ネットワークデバイスドライバの通信は他の2つのデバイスドライバとは異なり，ストリーム指向ではない．それゆえ対応するファイルノードを持たない．

デバイスドライバとアプリケーション

デバイスドライバとアプリケーションの違いについて，いくつか例を示す．

• アプリケーションはリソースを大雑把に解放するか全く解放しないが，デバイスドライバは取り除かれる際に全ての資源を解放しないとシステムが再起動されるまでリソースが解放されない．
• アプリケーション(Cのコード)はライブラリをリンクされるのでそこで定義された関数やオブジェクトを呼び出すことができる．しかしデバイスドライバはカーネルだけにリンクされるので，呼び出せる関数らはカーネルが公開しているものに限る．
• 基本的にデバイスドライバはカーネル空間の中で実行され，アプリケーションはユーザ空間の中で実行される．
• デバイスドライバは複数のシステムによって呼び出されることが珍しくない．それゆえデバイスドライバは再投入可能であるべき．
• アプリケーションが利用するスタック領域に比べ，デバイスドライバが利用するスタック領域はわずか．そのため大きな自動変数を宣言するのは望ましくない．

Hello, World

学習に用いた本はオライリーの「LINUX デバイスドライバ」でLinux 2.6を対象としている．

実行環境

カレントディレクトリには後述するhello.cとMakefile，Linuxカーネル3.0.9のソースコードをビルドしたものを配置する．後述する実行中のカーネルはこのビルドしたものである．

1. 設定ファイル(.config)の作成と編集．
2. カーネルのコンパイル
3. コンパイルしたカーネルをインストール
4. ブートローダの設定を書き換える．

hello.c

はじめにモジュールをロードした際と取り除いた際にカーネルメッセージを出力する例を示す．

#include <linux/init.h>
#include <linux/module.h>
MODULE_LICENSE("Dual BSD/GPL");

static int hello_init(void)
{
  printk(KERN_ALERT "Hello, World\n");
  return 0;
}

static void hello_exit(void)
{
  printk(KERN_ALERT "Goodbye, World\n");
}

module_init(hello_init);
module_exit(hello_exit);

[ 7092.616521] hello: module license 'unspecified' taints kernel.
[ 7092.616525] Disabling lock debugging due to kernel taint

printkはカーネルメッセージを出力する関数である．Cの文法と一致しないが，デバイスドライバのコーディングではこのような特殊な記述が多いようだ．KERN_ALERTはログレベル，すなわち重要度を表している．これにより，printkはメッセージの深刻さを分類する．ログレベルを示す文字列は次の8つである．深刻度は次の数字が小さいほど高い．

Makefile

前述のソースコードのコンパイルは一般的なCのコンパイルと異なる．以下にそのために必要な特別なMakefileの文を記述する．

obj-m := hello.o

user% make -C $PWD/linux-3.0.9 M=$PWD modules

実行例

実行例は次の通りである．

user% sudo insmod hello.ko
user% dmesg | tail -1
[ 5947.430306] Hello, World
user% sudo rmmod hello.ko
user% dmesg | tail -1
[ 6088.515992] Goodbye, World

タグ

モジュール引数

パラメータの値はロード時にinsmodかmodprobeによって割り当てられる．modprobeは設定ファイルからパラメータを読み込むことが可能．設定ファイルの名前は，/etc/modprobe.confや/etc/modprobe.d/内の拡張子.confのファイルである．マニュアル"man modprobe.conf"でフォーマットについて確認ができる．

パラメータの取得は，<linux/moduleparam.h>で定義される関数module_paramやmodule_param_arrayで行う．この関数もまたmodule_initらと同様関数の外で使用しないとエラーである．

module_param(variable, type, perm)

variable

代入する変数名を指定する．

type

型を指定する．指定可能な型は次の通り．

bool	論理値
invbool		boolの逆の値
charp	文字列へのポインタ値．
short	整数値	符号付き
int
long
ushort		符号なし
uint
ulong

perm

パーミッション値．誰がsysfsに現れるモジュールパラメータにアクセスできるかを制御する．この引数には<linux/stat.h>にある定義を使用する．例えば，"S_IRUGO|S_IWUSR"はルートがパラメータを変更することを許可する．

module_paramを利用した例を以下に示す．

#include <linux/init.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/stat.h>

static int i;

module_param(i, int, S_IRUGO);

static int __init init()
{
  printk(KERN_INFO "i=%d\n", i);
  return 0;
}
static void __exit fini(){}

module_init(init);
module_exit(fini);

コンパイルは依然の記事の通り．以下がコンパイルと実行結果である．

user% make -C ./linux-3.0.9 M=$PWD modules
user% sudo insmod param.ko i=100 array={1,2,3,4,5}
user% dmesg | tail -1
[41654.053664] name:insmod pid:27744
user% sudo rmmod param.ko

module_param_array(variable, type, num, perm)

モジュールが引数として配列を与えられた時にそれを取得する．variableには配列を記述する．

num

変数の数を指定する．

カレントプロセス

カーネルモジュールの処理はアプリケーションと異なり，順に実行される訳ではなく，個々のプロセスに関連付けられる．現在のプロセスに関する情報は，<asm/current.h>で定義されているcurrentによって取得できる．currentは<linux/sched.h>で定義されるstruct task_struct型へのポインタである．

#include <linux/init.h>
#include <linux/module.h>
#incldue <asm/current.h>
#incldue <linux/sched.h>
MODULE_LICENSE("Dual BSD/GPL")

static void info_proc(void)
{
  printk(KERN_INFO "name:%s pid:%i", 
    current->comm, current->pid);
}
static int __init init(void){ info_proc(); return 0; }
static void __exit fini(void){ info_proc(); }

module_init(init);
module_exit(fini);

エラー

Linuxカーネルのエラーコードは負数で，<linux/errno.h>で定義されている．例えば定数ENOMEMに関連付けたエラーを表す場合，関数は-ENOMEMを返す．