C MAGAZINE Linux programming Tips
第3回　procファイルシステム調理法

		
/dev/hda1               /                       ext2    defaults        1 1
/dev/hda2               swap                    swap    defaults        0 0
proc                    /proc                   proc    defaults        0 0
     			 

		
1/     127/  3/    623/  979/     fb           ksyms    mtrr        stat
1016/  128/  387/  624/  980/     filesystems  loadavg  net/        swaps
105/   149/  391/  67/   apm      fs/          locks    partitions  sys/
116/   150/  4/    7/    bus/     ide/         mdstat   pci         tty/
123/   151/  448/  77/   cmdline  interrupts   meminfo  rtc         uptime
124/   152/  449/  85/   cpuinfo  ioports      misc     scsi/       version
125/   2/    5/    887/  devices  kcore        modules  self@
126/   209/  6/    95/   dma      kmsg         mounts   slabinfo
     			 

		
#! /bin/sh

#
# This is a simple shell scripts which emulates ps command by parsing
# the process subdirectory in proc filesystem 
#

for status in  /proc/*/status ; do
    if ! echo $stat | grep -q 'self'  ; then

	PID=`cat $status|grep "^Pid:"|cut -f 2`
	STATE=`cat $status|grep "^State:"|cut -f 2`
	PSUID=`cat $status|grep "^Uid:"|cut -f 2`
	PSGID=`cat $status|grep "^Gid:"|cut -f 2`
	NAME=`cat $status|grep "^Name:"|cut -f 2`

	DIRNAME=`dirname $status`
	CMDLINE=`cat $DIRNAME/cmdline`

	echo -e $PID\\t$STATE\\t$PSUID\\t$PSGID\\t$NAME\\t$CMDLINE
    fi
done
     			 

readコール

次は、いきなり shellスクリプトからカーネルモジュールに話しは飛んでしまいます。 もちろんこのプログラムはC言語で記述されます(もちろん他の言語で書けと言われても断りますが)。 既存のprof fsの内容を見ているだけだは物足りない人にお勧めです。

最初に紹介するプログラム(カーネルモジュール)は、 /proc/hogeという名前の読み込み専用ファイルをprocfsに登録するものです(List-2)。 /proc/hogeを catすると"Welcome to hoge"の行と(あの有名な)bogo mipsが表示されたている行を見ることができます。

List-2のプログラムの実行例を以下に示します。コンパイル方法は、 ソースコードの末尾についているコンパイル例を参考にしてください。

# insmod hoge.o
# cat /proc/hoge
Welcome to hoge
bogomips        : 901.12
# rmmod hoge

このコードのきもは、特にございません(簡単なサンプルなので)。手順的には、 create_proc_entry()関数でエントリーを作成し、read要求が入ったときに呼び出される関数を登録するだけです。 最後にモジュールがリムーブされるときは忘れずにremove_proc_entry()関数を呼び出すといったところです。

/proc/hoge に入る read要求を処理するhoge_proc_read()でバッファに関する少しばかりややこしい処理がありますが、 これはoffset指定でのread要求に対する処理です。

またproc fsとは直接関係ありませんが、このコードからも分かるようにカーネルモジュールも一旦ロードされてしまえば、 カーネルが持っている名前空間を共有することになります(だからCPUの情報が取得できる)。モジュールのソースコードの関数は、 必要の無い限り staticで宣言しておくのが無難です。さらに付け加えて言っておくと hoge.c内はすでにカーネル空間です。 コードを書き換える場合はくれぐれも慎重に。

[list-2: hoge.c]

/* * * An exmaple code of read call on procfs * */ #include <linux/config.h> #include <linux/module.h> #include <linux/string.h> #include <linux/proc_fs.h> static int hoge_proc_read(char *buffer, char **start, off_t offset, int length, int *eof, void *data) { int len = 0; #if defined(__i386__) /* get cpu info (it works on x86 arch)*/ struct cpuinfo_x86 *c = cpu_data; len = sprintf(buffer, "Welcome to hoge!\nbogomips\t: %lu.%02lu\n", (c->loops_per_sec+2500)/500000, ((c->loops_per_sec+2500)/5000) % 100) - offset; #else len = sprintf(buffer, "Welcome to hoge!\n") - offset ; #endif if (len < length) { *eof = 1; if (len <= 0) return 0; } else { len = length; } *start = buffer + offset; return len; } #ifdef MODULE int init_module(void) { #ifdef CONFIG_PROC_FS struct proc_dir_entry *ent; #endif printk("hoge: init_module()\n"); #ifdef CONFIG_PROC_FS ent = create_proc_entry("hoge", 0, 0); if( ent ) { ent->read_proc = &hoge_proc_read; } #endif return 0; } void cleanup_module(void) { #ifdef CONFIG_PROC_FS remove_proc_entry("hoge", NULL); #endif printk("hoge: cleanup_module()\n"); } #endif /* Here is an example of compilation. If you are working on SMP machine, please add -D__SMP__ to CFLAGS. # egcs -D__KERNEL__ -I/usr/src/linux/include -Wall -Wstrict-prototypes -O2 -fomit-frame-pointer -fno-strict-aliasing -pipe -fno-strength-reduce -m486 -DCPU=486 -DMODULE -DMODVERSIONS -include /usr/src/linux/include/linux/modversions.h -DEXPORT_SYMTAB -c hoge.c */

writeコール

次に、proc fsのwriteコールのサンプルとしてproc fs経由で10進/16進変換を行うカーネルモジュール(list-3)の例を示します。 このカーネルモジュールをロードすると ディレクトリー/proc/hoge2 の以下にファイルdigitとhexが作成されます。 digitには10進数、hexには16進数がそれぞれ読み書き可能になっておりどちらの値も同じ数値を示すようになっています。例えば、 digitに65535を書き込むとhexからはfffffを得ることができます。

前述のプログラムの処理に加え、proc fsにディレクトリーを作成する処理、 ファイルに書き込み属性を処理などが新しくされています。実際に動作させてみて確認してください。

[list-2: hoge.c]

/* * * An exmaple code of write call on procfs * */ #include <linux/config.h> #include <linux/module.h> #include <linux/string.h> #include <linux/proc_fs.h> static long val=0; static int hoge2_hex_proc_read(char *buffer, char **start, off_t offset, int length, int *eof, void *data) { int len = 0; long *val = (long*)data; len = sprintf(buffer, "%lx\n", *val) - offset; if (len < length) { *eof = 1; if (len <= 0) return 0; } else { len = length; } *start = buffer + offset; return len; } static int hoge2_digit_proc_read(char *buffer, char **start, off_t offset, int length, int *eof, void *data) { int len = 0; long *val = (long*)data; len = sprintf(buffer, "%ld\n", *val) - offset; if (len < length) { *eof = 1; if (len <= 0) return 0; } else { len = length; } *start = buffer + offset; return len; } static int hoge2_digit_proc_write(struct file *file, const char *buffer, unsigned long count, void *data) { long *v = (long *)data; *v = simple_strtoul(buffer, NULL, 10); return count; } static int hoge2_hex_proc_write(struct file *file, const char *buffer, unsigned long count, void *data) { long *v = (long *)data; *v = simple_strtoul(buffer, NULL, 16); return count; } #ifdef MODULE int init_module(void) { #ifdef CONFIG_PROC_FS struct proc_dir_entry *ent; #endif printk("hoge2: init_module()\n"); #ifdef CONFIG_PROC_FS ent = create_proc_entry("hoge2",S_IFDIR, 0); if( ent ) { ent = create_proc_entry("hoge2/digit",S_IFREG|S_IRUGO|S_IWUSR, 0); if( ent ) { ent->read_proc = &hoge2_digit_proc_read; ent->write_proc = &hoge2_digit_proc_write; ent->data = (void*)&val; } ent = create_proc_entry("hoge2/hex",0, 0); if( ent ) { ent->read_proc = &hoge2_hex_proc_read; ent->write_proc = &hoge2_hex_proc_write; ent->data = (void*)&val; } } #endif return 0; } void cleanup_module(void) { #ifdef CONFIG_PROC_FS remove_proc_entry("hoge2/hex", NULL); remove_proc_entry("hoge2/digit", NULL); remove_proc_entry("hoge2", NULL); #endif printk("hoge2: cleanup_module()\n"); } #endif

前述の２つの例では、create_proc_entry()で動的に確保された構造体 proc_dir_entryにread, writeなどを処理する関数を登録するような形を取っていましたが、 以下のように 構造体 proc_dir_entry の実体を宣言し、登録することも可能です。

static int hoge3_proc_read(char *buffer, char **start, off_t offset, int length, int *eof, void *data) { .... } struct proc_dir_entry hoge3_proc_entry = { 0, /* low_ino: the inode--dynamic */ 5, "hoge3", /* length of name, string of name */ S_IFREG|S_IRUGO, /* creation mode */ 1,0,0, /* nlinks, owner, group */ 0, /* unused */ NULL, /* operations--use default */ &hoge3_proc_read,/* function used to read */ }; int init_module(void) { .... proc_register_dynamic( &proc_root, &hoge3_proc_entry ); .... } void cleanup_modue(void) { .... proc_unregister( &proc_root, &hoge3_proc_entry.low_ino ); .... }