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()する方法もありますが、 popen()を使うとより簡単に書けます。
popenに実行したいコマンドを渡し、popen()が返したファイルポインタを 読み込むだけで、popenに実行させたコマンドの出力を読み出すことができます。popenの実装は、fork,pipe,dup2,execvといったシステムコールを利用して実装されています。 FreeBSD の popen.c を参考にすると実装がわかります。

サンプルソース popen.c

popen関数を利用したサンプルソース。

この例では、lsコマンドを実行して、/binのリストを取得します。

#include <stdio.h>
#include <stdlib.h>
#include <err.h>
#define BUF 256
int
main (int argc, char *argv[])
{
	FILE	*fp = NULL;
	char	buf[BUF];
	char	*cmdline = "/bin/ls /bin";
	if ( (fp=popen(cmdline,"r")) ==NULL) {
		err(EXIT_FAILURE, "%s", cmdline);
	}
	while(fgets(buf, BUF, fp) != NULL) {
		(void) fputs(buf, stdout);
	}
	(void) pclose(fp);

	exit (EXIT_SUCCESS);
}

popen()でコマンドをオープンしたら、pclose()でクローズします。
FreeBSD の実装では、pclose は fclose を呼び出して、入出力をクローズし、実行したプログラムの終了を wait4 で待ちます。この例では、外部プログラムであるlsの出力をサンプルプログラムで読み込んでますが、ls は /bin の内容を出力すると、lsコマンドの役目を終えて、lsコマンドのプログラム自体が終了します。

コンパイル方法

サンプルプログラムのコンパイル方法は、以下の通りです。

cc popen.c

実行方法

サンプルプログラムの実行方法は以下の通りです。

./a.out

シェルで以下のコマンドを実行した結果と同じ結果が得られるでしょう。

/bin/ls /bin

このように、popenを利用して、外部コマンドを実行し、その結果を読むことができます。

参考

[2008-05-04-1] では、popen()でコマンドの入力に書き込む方法を紹介しています。この記事とは、入出力の方向が逆になります。

• /c/popenでコマンドの出力を読み込む
• /c/プロセスの作成_fork
• /c/複数の子プロセスをforkする

---