C言語 popen()でコマンドの入力に書き込む

このドキュメントの内容は、以下の通りです。

• はじめに
• パイプがプログラムをつなぐ
• コマンドの実行方法
• サンプルソース popen.c
• コンパイル方法
• 実行方法
• 参考

はじめに

プログラムは、ほかのプログラムと組み合わせることで、単体のプログラムではできないことを実現することができます。なんでもできるプログラムを書くのは、非情に困難なことです。普段利用する機能を思い浮かべてください。たとえば、ファイルを探す機能、テキストを探す機能、数字で並べ替える機能、アルファベットで並べ替える機能、重複を省く機能、重複を数える機能、といった機能を利用しています。どれも、１つ１つは大したことはない機能かもしれませんが、それらが全部必要だとしたら、プログラムはそれなりに大きくなるでしょう。

１つ１つのプログラムに、上記に例で挙げたようなさまざまな機能を実装するのは、大変なことです。しかしながら、上記の１つ１つの機能は、いろいろなプログラムで必要とされます。
１つ１つの単機能のプログラムを組み合わせて、うまくやろうとした１つの答えが、Unix（ユニックス）だと思います。
Unixのカーネル(OSの核)がプログラムを実行する機能や、プログラムの入出力をつなぐためにパイプの機能を提供しています。

ここでは、C言語でプログラムを実行する方法を紹介しますが、似たような関数がそれぞれのスクリプト言語などでも実装されていますので、各言語のマニュアルを見れば、考え方は応用できると思います。

パイプがプログラムをつなぐ

Unix(LinuxやFreeBSDなど)では、コマンドをパイプでつなぐことで、単体のプログラムだけでは実現できないことを実現します。bashやcsh,zshといったシェルたちは、コマンドをパイプでつなぐことで、それぞれのコマンドの入出力をつなぎ合わせ、並列にコマンドを実行します。このシェルがパイプでコマンドをつなぐ仕組みは、 fork , exec, pipe, dup といったシステムコールで実現されます。

コマンドの実行方法

C言語 で外部コマンド(プログラム)を実行する方法は、いくつかあります。

• system関数を利用する
• popen関数を利用する
• exec系関数を利用する

コマンドにデータを渡して、処理させたいときには、システムコールの pipe()とdup()を使って、fork()する方法もありますが、libcで提供される popen()を使うとより簡単に書けます。popenの実装は、fork,pipe,dup2,execvといったシステムコールを利用して実装されています。 FreeBSD の popen.c を参考にすると実装がわかります。

サンプルソース popen.c

popen関数を利用したサンプルソースです。この例は、特に何か意味があるプログラムではありません。この例では、catコマンドにデータをfputs()で書き込んでいます。cat -nは、行頭に行番号を追加します。

#include <stdio.h>
#include <stdlib.h>
#include <err.h>
#define BUF 256
int
main (int argc, char *argv[])
{
	FILE	*fp = NULL;
	char	*cmdline = "/bin/cat -n";
	if ( (fp=popen(cmdline,"w")) == NULL) {
		err(EXIT_FAILURE, "%s", cmdline);
	}

	(void) fputs("one\n", fp);
	(void) fputs("two\n", fp);
	(void) fputs("three\n", fp);
	(void) pclose(fp);

	exit (EXIT_SUCCESS);
}

popen()でコマンドをオープンしたら、pclose()でクローズします。

FreeBSD の実装では、pclose は fclose を呼び出して、入出力をクローズし、実行したプログラムの終了を wait4 で待ちます。fcloseでファイルポインタに紐づいている、ファイルディスクリプタがクローズされると、入力を受けていたプログラムは、入力が終了することを検知して、プログラムが終了します。

コンパイル方法

プログラムをコンパイルします。

$ cc popen.c

実行方法

実行方法は、以下の通りです。

$ ./a.out

実行結果は、以下の通りです。

     1	one
     2	two
     3	three

上記の実行結果からわかる通り、プログラムに書き込んだ文字列の行頭に、 cat コマンドが、行番号をつけてくれました。このように、行頭に行番号をつけるプログラムを作らなくても、popenで外部コマンドを利用することで、行番号付きで出力できるわけです。

popen()のこの使い方だと、メールコマンドにデータを流し込んで、メールを送信するといったことするかな、と思います。

参考

[2008-05-03-2] では、この記事とは、入出力が逆のことをやっていますので、興味がありましたら、ご参照ください。

• [2008-05-03-2] C言語 popen()でコマンドを実行して出力を読み込む
• /c/popenでコマンドの出力を読み込む
• /c/プロセスの作成_fork
• /c/複数の子プロセスをforkする

---