perlipc - Perl のプロセス間通信 (シグナル, fifo, パイプ, 安全な副プロセス, ソケット, セマフォ)
Perl の基本的な IPC 機能は、古きよき UNIX のシグナル、名前付きパイプ、 パイプ、Berkeley ソケットルーチン、 SysV IPC コールから構成されています。 これら各々ははっきりと異なる状況で使われます。
Perl は単純なシグナルハンドリングモデルを使っています: %SIG という ハッシュは、ユーザーがインストールしたシグナルハンドラの名前、 もしくはハンドラに対するリファレンスを保持します。 これらのハンドラは、起動されたシグナルの名前を引数として呼び出されます。 シグナルは control-C や control-Z のような特定のキーボードシーケンスで 意識的に生成することもできますし、他のプロセスがシグナルを送ることも あります; あるいは子プロセスが終了したとか、プロセスがスタックを使いきった、 プロセスのファイルサイズ制限に引っ掛かったといった特殊なイベントが 発生したときに、カーネルが自動的にシグナルを発生させることもあります。
例えば割り込みシグナル(interrupt signal)をトラップするには、 以下の例のようにハンドラを設定します:
our $shucks;
sub catch_zap {
my $signame = shift;
$shucks++;
die "Somebody sent me a SIG$signame";
}
$SIG{INT} = __PACKAGE__ . "::catch_zap";
$SIG{INT} = \&catch_zap; # best strategy
Perl 5.7.3 以前では、自分のハンドラの中を使うことができます; 私たちが認識していることは、グローバル変数に設定した後で例外を 引き起こすということだけであることに注意してください。 これは、ほとんどのシステム上ではライブラリ、とくにメモリ割り付けや 入出力に関するものは再入可能ではないためです。 これは、あなたのハンドラ内のほとんど あらゆること が理論的には メモリフォールトやそれに続くコアダンブを引き起こす可能性が あるということです - 以下の "Deferred Signals (Safe Signals)" を 参照してください。
あなたの使っているシステムにおけるシグナルの名称は kill -l
によって リストアップされます; あるいは CPAN モジュール IPC::Signal から 取得することもできます。
ハンドラとして "IGNORE"
や "DEFAULT"
といった文字列を代入することも 選択できます; これらのハンドラは、perl がシグナルを破棄させるようにしたり デフォルトの動作を行うようにさせるものです。
ほとんどの UNIX プラットフォームでは、CHLD
(CLD
の場合もあり) シグナルは "IGNORE"
の値に対応するような特別な振る舞いをします。 そのようなプラットフォームでは "IGNORE"
に $SIG{CHLD}
を 設定することによって、親プロセスが wait()
に失敗したようなときに ゾンビプロセスができることを防ぎます(子プロセスは自動的に 刈り取られます)。 $SIG{CHLD}
を "IGNORE"
を設定して wait()
を呼び出すことによって、 このようなプラットフォームでは -1
が通常返されます。
KILL シグナルや STOP シグナル(TSTP ではない)のような幾つかのシグナルは、 トラップすることも無視することもできません。 見視されるシグナルはこれを消すことに注意してください。 失うことなく一時的にブロックしたいだけなら、POSIX の sigprocmask を使う 必要があります。
負のプロセス ID に対してシグナルを送ることは、UNIX プロセスグループ 全体にシグナルを送ることになります。 以下のコードは、カレントのプロセスグループに属する全てのプロセスに hang-up シグナルを送出します; そして、$SIG{HUP} に IGNORE を設定するので、 自分自身を kill することはありません:
# block scope for local
{
local $SIG{HUP} = "IGNORE";
kill HUP => -$$;
# snazzy writing of: kill("HUP", -$$)
}
この他の興味深いシグナルは、シグナル番号 0 です。 これは実際には子プロセスに影響を及ぼすことはありませんが、UID が 生きているのか、あるいは変更されたのかのチェックを行います。
unless (kill 0 => $kid_pid) {
warn "something wicked happened to $kid_pid";
}
送り先のプロセスの実または保存 UID が、送り元の実または保存 UID と 同じではない場合、たとえプロセスが生きていても、シグナルを送る権限が ないので、シグナル番号 0 は失敗します。 失敗の原因は、$!
や %!
を使って決定できます。
unless (kill(0 => $pid) || $!{EPERM}) {
warn "$pid looks dead";
}
単純なシグナルハンドラには無名関数を使いたくなるかもしれません:
$SIG{INT} = sub { die "\nOutta here!\n" };
SIGCHLD ハンドラは特別な対応が必要です。 一つ目の子が死んだことによって起動されたシグナルハンドラの実行中に 二つ目の子が死ぬと、もう一つのシグナルは受け取れません。 従ってここでループしなければなりません; さもなければ処理されない子が ゾンビとして残ります。 そして次に二つの子が死ぬともう一つのゾンビが発生します。 以下同様です。
use POSIX ":sys_wait_h";
$SIG{CHLD} = sub {
while ((my $child = waitpid(-1, WNOHANG)) > 0) {
$Kid_Status{$child} = $?;
}
};
# do something that forks...
注意してください: qx(), system() および外部コマンドを呼び出す一部の モジュールは fork() してから結果を wait() します。 従って、シグナルハンドラが呼び出されます。 なぜなら wait() は既に system() や qx() によって呼び出されているので、 シグナルハンドラ内の wait() はゾンビを見ることはなく、従ってブロックします。
この問題を避ける最良の方法は waitpid() を使うことで、以下の例のようにします:
use POSIX ":sys_wait_h"; # for nonblocking read
my %children;
$SIG{CHLD} = sub {
# don't change $! and $? outside handler
local ($!, $?);
my $pid = waitpid(-1, WNOHANG);
return if $pid == -1;
return unless defined $children{$pid};
delete $children{$pid};
cleanup_child($pid, $?);
};
while (1) {
my $pid = fork();
die "cannot fork" unless defined $pid;
if ($pid == 0) {
# ...
exit 0;
} else {
$children{$pid}=1;
# ...
system($command);
# ...
}
}
シグナルハンドリングは Unix でのタイムアウトでも使われます。 eval{}
ブロックの中では安全に保護される一方、シグナルをトラップして、 数秒後に配達されるように予定するためにアラームのシグナルハンドラを設定します。 それからブロックされる処理を試して、それが終了した後 eval{}
ブロックが 終了する前にアラームをクリアします。 停止したときは、ブロックから出るために die() を使います。
例を挙げましょう:
my $ALARM_EXCEPTION = "alarm clock restart";
eval {
local $SIG{ALRM} = sub { die $ALARM_EXCEPTION };
alarm 10;
flock(FH, 2) # blocking write lock
|| die "cannot flock: $!";
alarm 0;
};
if ($@ && $@ !~ quotemeta($ALARM_EXCEPTION)) { die }
時間切れを起こした操作が system() か qx() なら、このテクニックはゾンビを 生成する傾向があります。 もしそれが問題なら、自力で fork() と exec() を行って、エラーの起きた 子プロセスを kill する必要があるでしょう。
より複雑なシグナル処理のためには、標準の POSIX モジュールを確かめると よいかもしれません。 嘆かわしいことにこれはほとんどアンドキュメントな状態ですが、Perl の ソース配布キットにある t/lib/posix.t というファイルには幾つかの サンプルがあります。
普通システムブート時に起動し、システムシャットダウン時に終了するプロセスの ことをデーモン(daemon: Disk And Execution MONitor)と呼びます。 もしデーモンプロセスに設定ファイルがあり、それがプロセスが開始してから 変更された場合、プロセスを止めることなく、プロセスに設定ファイルを 再読み込みすることを知らせる方法があるべきです。 多くのデーモンはこの機構を SIGHUP
シグナルハンドラを使って 提供しています。 デーモンにファイルを再読み込みしてほしい場合、単にデーモンに SIGHUP
シグナルを送ります。
以下の例は、SIGHUP
を受け取る毎に再起動するという単純なデーモンを 実装しています。 実際のコードはサブルーチン code()
に置かれていて、どのように動作するかを 示すために単にデバッグ情報を出力します; これは実際のコードと 置き換えられます。
#!/usr/bin/perl -w
use POSIX ();
use FindBin ();
use File::Basename ();
use File::Spec::Functions;
$| = 1;
# make the daemon cross-platform, so exec always calls the script
# itself with the right path, no matter how the script was invoked.
my $script = File::Basename::basename($0);
my $SELF = catfile($FindBin::Bin, $script);
# POSIX unmasks the sigprocmask properly
$SIG{HUP} = sub {
print "got SIGHUP\n";
exec($SELF, @ARGV) || die "$0: couldn't restart: $!";
};
code();
sub code {
print "PID: $$\n";
print "ARGV: @ARGV\n";
my $count = 0;
while (++$count) {
sleep 2;
print "$count\n";
}
}
Perl 5.7.3 以前では、シグナルを取り扱う Perl プログラムを インストールすることによって、あなたは二つの危険性に直面することに なりました。 第一に、再入可能なライブラリ関数を備えたシステムは数少ないこと。 Perl がある関数(malloc(3) や printf(3) など)を実行中にシグナル割り込みが あったとすると、あなたのシグナルハンドラは同じ関数を 再度呼び出し、結果として予測のつかない動作になる可能性があります。 第二に、Perl 自身も最低レベルにおいては再入可能に なっていないということです。 Perl が自分の内部構造を操作しているときにシグナル割り込みが あったとすると、これもまた予測のつかない動作になるでしょう。
あなたの取りうる手段が二つありました: 偏執狂的になるか現実的になるかです。 偏執狂的アプローチは、あなたのシグナルハンドラの中でできるだけ 少ないことを行うというものでした。 既に値をもって存在している整数変数に値を設定してリターンします。 これは単にリスタートするような遅いシステムコールの中にいるときには 助けになりません。 これはつまり、ハンドラの外に longjmp(3) するには die
する必要が あるということです。 これは本当の偏執狂というのにはちょっとおおげさですが、ハンドラ中で die
を排除します。 現実的なアプローチは「リスクがあるのは分かってるけどさ、便利なら いいじゃない」というもので、シグナルハンドラ中で行いたいことを 全て行い、コアダンプを掃除する準備をしてから再度行うというものでした。
Perl 5.7.3 以降では、「保留」シグナルによってこの問題を回避します。 これは、システムによってシグナルが (Perl を実装している C コードに) 配送されると、フラグをセットして、ハンドラは直ちに返ります。 それから、Perl インタプリタの戦略的に「安全な」地点 (例えば、新しいオペコードを実行しようとしている時点) で、 フラグをチェックして、%SIG の Perl レベルハンドラを実行します。 「保留」スキームは、Perl インタプリタが安全な状態にあって、ハンドラが 呼び出されたときにシステムライブラリの中ではないことが分かっているので、 シグナルハンドラのコーディングが遥かに柔軟になります。 しかし、実装は以下の方向で以前の Perl と異なります:
Perl インタプリタは、もし長時間実行されるオペコード (例えばとても長い文字列での正規表現操作)の途中でシグナルが 到着すると、新しいオペコードを実行しようとする時にのみシグナルフラグを 見るので、シグナルは現在のオペコードが完了するまで現れません。
もしどのような種類のシグナルでも(例えば高精度のタイマーから) 1 つのオペコードの間に複数回発生した場合、そのシグナルのハンドラは オペコードの完了後 1 度しか呼び出されません; その他の実体は破棄されます。 さらに、システムのシグナルキューがあふれたために あるオペコードが完了時に、発生したけれどもまだ捕捉されていない (従ってまだ保留されていない)シグナルがあると これらのシグナルが引き続くオペコードの間捕捉および保留され、時々 驚くべき結果となることがあります。 例えば、alarm(0)
はアラームの発生を止めますが、 発生したけれどもまだ捕捉していないアラームの配達がキャンセルしないので、 alarm(0)
を呼び出した後にもアラームが配送されることがあります。 これは現在の実装の副作用であり、将来のバージョンの Perl では 変更されるかもしれないので、この段落に記述された振る舞いに依存しては いけません。
(例えば control-C からの SIGINT で) シグナルが配送されると、OS は Perl の readline() 関数と <>
演算子の実装で使われている read(2) のような I/O 操作を中断します。 古い Perl ではハンドラをすぐに呼び出します (そして read
は「安全ではない」ことはないので、うまく動きます)。 「保留」スキームではハンドラはすぐには 呼び出されず、 もし Perl がシステムの stdio
ライブラリを使っていると、ライブラリは Perl に返って %SIG ハンドラを呼び出しする機会なしに read
を再起動します。 もしこれが起きた場合、解決法は、I/O を行うときに-- 少なくともシグナルで中断できるようにしたいハンドルで-- :perlio
層を使うことです。 (:perlio
層はシグナルフラグをチェックして、I/O 操作を続行する前に %SIG ハンドラを呼び出します。)
Perl 5.7.3 以降ではデフォルトでは自動的に :perlio
層が使われます。
シグナルがファイルハンドルに対する I/O 操作を中断した場所で、シグナル ハンドラの中のそのハンドラをアクセスするのは勧められません。 perl は少なくともクラッシュはしないように努力する一方、データの 完全性については保証しないので、一部のデータは欠落したり 2 回 書かれたりするかもしれません。
gethostbyname() のようなネットワークライブラリ関数は独自のタイムアウト 実装を持っていることが知られているので、あなたのタイムアウトと 競合するかもしれません。 もしこのような関数で問題が起きた場合は、Perl の安全なシグナルを回避する POSIX sigaction() 関数を試すことができます。 これは上述の、メモリ破壊の可能性があるということに注意してください。
$SIG{ALRM}
をセットする代わりに:
local $SIG{ALRM} = sub { die "alarm" };
以下のようなことを試してみてください:
use POSIX qw(SIGALRM);
POSIX::sigaction(SIGALRM, POSIX::SigAction->new(sub { die "alarm" }))
|| die "Error setting SIGALRM handler: $!\n";
安全なシグナルの振る舞いを局所的に無効にするもう一つの方法は CPAN の Perl::Unsafe::Signals
モジュールを使うことです; これは全てのシグナルに影響を与えます。
これに対応しているシステムでは、より古いバージョンの Perl では %SIG ハンドラを設定するときに SA_RESTART フラグを使います。 これは、再起動可能なシステムコールではシグナルが配送されたときに 戻るのではなく続行することを意味します。 保留シグナルを素早く配送するために、 Perl 5.7.3 以降では SA_RESTART を 使っていません。 結果として、再起動可能なシステムコールは、いままで成功していたところでも ($! に EINTR
をセットして) 失敗することがあります。
デフォルトの :perlio
層では read
, write
, close
は上述したように 再試行します; 中断された wait
と waitpid
の呼び出しは常に 再試行されます。
SEGV, ILL, BUS のようなシグナルは、仮想メモリアドレッシングエラーや 似たような「障害」の結果として生成されます。 これらは普通致命的です: Perl レベルのハンドラができることはほとんど ありません。 なので Perl はこれらを保留しようとせず、直ちに配送します。
OS によっては、ある種のシグナルハンドラは返る前に「何かをする」ことに なっているものもあります。 1 つの例としては CHLD や CLD で、子プロセスが完了したことを示しています。 OS によっては、シグナルハンドルは完了した子プロセスのために wait
することを想定されているものもあります。 このようなシステムでは保留シグナルスキームはこれらのシグナルでは 動作しません: wait
しません。 再び、問題は、まだ wait
していない完了した子プロセスがあるかのように シグナルが再び発生することでループのように見えます。
もし、メモリ破壊の可能性にもかかわらず、古いシグナルの振る舞いが ほしいなら、環境変数 PERL_SIGNALS
を "unsafe"
に設定してください。 この機能は Perl 5.8.1 に現れました。
名前付きパイプ(しばしば FIFO として参照されます)は、同じマシン上での プロセス間通信のための古い UNIX IPC 機構です。 これは通常の無名パイプと同様に動作しますが、ファイル名を使って プロセスのランデブーが行われ、関連づける必要がないという点が異なります。
名前付きパイプを生成するには、POSIX::mkfifo()
関数を使ってください。
use POSIX qw(mkfifo);
mkfifo($path, 0700) || die "mkfifo $path failed: $!";
一部のシステムでは Unix コマンド mknod(1) か、システムによっては mkfifo(1) を使えます。 しかしこれらはあなたの通常パス(normal path)に置くことはできません。
# system return val is backwards, so && not ||
#
$ENV{PATH} .= ":/etc:/usr/etc";
if ( system("mknod", $path, "p")
&& system("mkfifo", $path) )
{
die "mk{nod,fifo} $path failed";
}
fifo は、あるプロセスをそれとは関係ない別のプロセスに接続したいときに 便利です。 fifo をオープンしたとき、プログラムはもう一方の端点に何かが 置かれるまでブロックされます。
たとえば、.signature というファイルを、もう一方の端点に Perl プログラムが置かれている名前付きパイプに接続したいとしましょう。 このとき、任意のプログラムが任意の時点で(メイラー、ニューズリーダー、 finger プログラムなどのように)そのファイルを読み出そうとしますから、 読み出しプログラムはあなたのプログラムから新しいシグネチャを読み込みます。 誰か(もしくは何か)が間違って私たちのfifoを削除したりしないかどうかを 監視するために -p という pipe-cheching ファイルテスト演算子を使用します。
chdir(); # go home
my $FIFO = ".signature";
while (1) {
unless (-p $FIFO) {
unlink $FIFO; # discard any failure, will catch later
require POSIX; # delayed loading of heavy module
POSIX::mkfifo($FIFO, 0700)
|| die "can't mkfifo $FIFO: $!";
}
# next line blocks till there's a reader
open (FIFO, "> $FIFO") || die "can't open $FIFO: $!";
print FIFO "John Smith (smith\@host.org)\n", `fortune -s`;
close(FIFO) || die "can't close $FIFO: $!";
sleep 2; # to avoid dup signals
}
Perlの open() 文は、その第二引数でパイプシンボルを前置するか末尾に 付加することによって、一方向のプロセス間通信のために使うことができます。 以下の例は、書き込みを行いたい子プロセスを起動させるやり方です:
open(SPOOLER, "| cat -v | lpr -h 2>/dev/null")
|| die "can't fork: $!";
local $SIG{PIPE} = sub { die "spooler pipe broke" };
print SPOOLER "stuff\n";
close SPOOLER || die "bad spool: $! $?";
そして以下の例はそこから読み込みを行いたい子プロセスを起動する方法です:
open(STATUS, "netstat -an 2>&1 |")
|| die "can't fork: $!";
while (<STATUS>) {
next if /^(tcp|udp)/;
print;
}
close STATUS || die "bad netstat: $! $?";
特定のプログラムの一つが @ARGV にあるファイル名を期待している Perl スクリプトであっていいのなら、賢いプログラマは以下のように 書くこともできます:
% program f1 "cmd1|" - f2 "cmd2|" f3 < tmpfile
そしてそれを呼んだシェルには関係なく、この Perl プログラムは f1 という ファイル、cmd1 というプロセス、標準入力(この例では tmpfile)、 f2 というファイル、cmd2 というコマンド、f3 というファイルから 読み込みを行います。 すごくいいよね?
読み込みのためのパイプを開くために、逆クォートを使って同じことが できることに気がつくかもしれません:
print grep { !/^(tcp|udp)/ } `netstat -an 2>&1`;
die "bad netstatus ($?)" if $?;
その推測は表面的には正しいことのように見えるかも知れませんが、一度に メモリにすべてを読み込む必要がないので、一度にファイルの一行や 一レコードを処理するには(最初の例のほうが)より効率的なのです。 同様にプロセス全体の制御を与えるので、あなたが望めば早い時期に 子プロセスを kill することができます。
open() と close() の戻り値をチェックするときは注意してください。 パイプに対して 書き込み をしたのなら、SIGPIPE をトラップすべきです。 そうしなければ、存在しないコマンドに対するパイプを起動したときに 起こることについて考え込むことになるでしょう: open() はほとんどの 場合成功すると見込まれるでしょうが(これは fork() の成功だけを 反映します)、あなたの出力はその後で壮観に(spectacularly)失敗するでしょう。 コマンドは、実際には exec() が失敗している別のプロセスで 実行されているので、Perl はコマンドがうまく動いているかどうかを 知ることはできません。 したがって、偽のコマンド(bugus command)の読み手はすぐに EOF を 受け取り、偽のコマンドに対する書き手は事前に取り扱っておくべき シグナルを発生させるでしょう。 以下の例を考えてみましょう:
open(FH, "|bogus") || die "can't fork: $!";
print FH "bang\n"; # neither necessary nor sufficient
# to check print retval!
close(FH) || die "can't close: $!";
print() からの返り値をチェックしない理由は、パイプのバッファリングの ためです; 物理的な書き込みは遅延します。 これはクローズするまで爆発せず、爆発すると SIGPIPE を発生させます。 これを捕らえるには、以下のようにします:
$SIG{PIPE} = "IGNORE";
open(FH, "|bogus") || die "can't fork: $!";
print FH "bang\n";
close(FH) || die "can't close: status=$?";
メインプロセスと子プロセスで同じファイルハンドル STDIN, STDOUT, STDERR を共有します。 両方のプロセスが同時にそれらのハンドルにアクセスしようとした場合、 おかしな事が発生する可能性があります。 あなたは子プロセスのためにファイルハンドルのクローズと再オープンにしたいと 考えるかもしれません。 これは、open() を使ってパイプをオープンすることによって対処することが できますが、一部のシステムにおいては子プロセスはその親プロセスよりも 長生きすることはできません。
以下のようにしてコマンドをバックグラウンドで実行することができます:
system("cmd &");
コマンドの STDOUT と STDERR (とあなたの使うシェルによっては STDIN も)は その親プロセスのものと同一になります。 double-fork の実行によって、SIGCHLD を捕捉する必要はありません; 詳しくは後述します。
一部の場合(例えばサーバープロセスのスタート)、親プロセスと子プロセスを 完全に無関係のものにしたいことがあるでしょう。 これはしばしばデーモン化と呼ばれます。 礼儀正しいデーモンはルートディレクトリに chdir() するので、実行ファイルの あったディレクトリを含むファイルシステムのアンマウントを邪魔することが ありませんし、その標準ファイル記述子を /fdev/null に リダイレクトするので、ユーザの端末にランダムな出力を出しません。
use POSIX "setsid";
sub daemonize {
chdir("/") || die "can't chdir to /: $!";
open(STDIN, "< /dev/null") || die "can't read /dev/null: $!";
open(STDOUT, "> /dev/null") || die "can't write to /dev/null: $!";
defined(my $pid = fork()) || die "can't fork: $!";
exit if $pid; # non-zero now means I am the parent
(setsid() != -1) || die "Can't start a new session: $!"
open(STDERR, ">&STDOUT") || die "can't dup stdout: $!";
}
fork() はプロセスグループリーダーでないことを保証するために setsid() の前になければなりません; もしそうなら setsid() は 失敗します。 あなたの使っているシステムが sesid() 関数を持っていないのであれば、 /dev/tty をオープンして TIONCNOTTY
ioctl() を代わりに使います。 詳しくは tty(4) を参照してください。
非 Unix ユーザはその他の可能性のある解決法のために Your_OS
::Process
モジュールをチェックするべきです。
もう一つの、IPC のための興味深いアプローチはマルチプロセスになって それぞれの間で通信を行う単一のプログラムを作るというものです。 open() 関数は "-|"
や "|-"
といったファイル引数を非常に おもしろいことを行うために受け付けます: これはあなたがオープンした ファイルハンドのための子プロセスをfork()するのです。 その子プロセスは親プロセスと同じプログラムを実行します。 これはたとえば、仮定された UID や GID のもとで実行する際に安全にファイルを オープンするのに便利です。 マイナスに対するパイプをオープンすると、あなたはオープンした ファイルハンドルに書き込みができ、子プロセスはそれを 自分の STDIN に 見いだします。 マイナス からの パイプをオープンした場合には、子プロセスが その STDOUT に書き出したものがオープンしたファイルハンドルから 読みだしすることができるのです。
use English qw[ -no_match_vars ];
my $PRECIOUS = "/path/to/some/safe/file";
my $sleep_count;
my $pid;
do {
$pid = open(KID_TO_WRITE, "|-");
unless (defined $pid) {
warn "cannot fork: $!";
die "bailing out" if $sleep_count++ > 6;
sleep 10;
}
} until defined $pid;
if ($pid) { # I am the parent
print KID_TO_WRITE @some_data;
close(KID_TO_WRITE) || warn "kid exited $?";
} else { # I am the child
# drop permissions in setuid and/or setgid programs:
($EUID, $EGID) = ($UID, $GID);
open (OUTFILE, "> $PRECIOUS")
|| die "can't open $PRECIOUS: $!";
while (<STDIN>) {
print OUTFILE; # child's STDIN is parent's KID_TO_WRITE
}
close(OUTFILE) || die "can't close $PRECIOUS: $!";
exit(0); # don't forget this!!
}
このやり方を行うもう一つの一般的な例は、シェルのインターフェース抜きで 何かを実行する必要があるときでしょう。 system() を使うとそれは直接的なものですが、パイプのオープンや バッククォートを安全に使うことができません。 これはシェルがあなたの引数を触るのを止める方法がないからです。 代わりに、exec() を直接呼び出す低レベルな制御を使います。
以下の例は、読み込み用の安全なバッククォートやパイプオープンのものです:
my $pid = open(KID_TO_READ, "-|");
defined($pid) || die "can't fork: $!";
if ($pid) { # parent
while (<KID_TO_READ>) {
# do something interesting
}
close(KID_TO_READ) || warn "kid exited $?";
} else { # child
($EUID, $EGID) = ($UID, $GID); # suid only
exec($program, @options, @args)
|| die "can't exec program: $!";
# NOTREACHED
}
そして以下の例は、書き込み用の安全なバッククォートや パイプオープンのものです:
my $pid = open(KID_TO_WRITE, "|-");
defined($pid) || die "can't fork: $!";
$SIG{PIPE} = sub { die "whoops, $program pipe broke" };
if ($pid) { # parent
print KID_TO_WRITE @data;
close(KID_TO_WRITE) || warn "kid exited $?";
} else { # child
($EUID, $EGID) = ($UID, $GID);
exec($program, @options, @args)
|| die "can't exec program: $!";
# NOTREACHED
}
この形式の open() を使っているプロセスや、それどころか あらゆる pipe() の使用と複数のサブプロセスをデッドロックさせるのは とても簡単です。 上述の例は、単純で、exec() を呼び出しているので「安全」です。 一般的な安全のための原則については "Avoiding Pipe Deadlocks" を 参照してください; しかし、Safe Pipe Opens については追加のコツがあります。
特に、open FH, "|-"
を使ってパイプを開くと、不要な書き込みを閉じるために 単に親プロセスで close() を使えません。 このコードを考えます:
my $pid = open(WRITER, "|-"); # fork open a kid
defined($pid) || die "first fork failed: $!";
if ($pid) {
if (my $sub_pid = fork()) {
defined($sub_pid) || die "second fork failed: $!";
close(WRITER) || die "couldn't close WRITER: $!";
# now do something else...
}
else {
# first write to WRITER
# ...
# then when finished
close(WRITER) || die "couldn't close WRITER: $!";
exit(0);
}
}
else {
# first do something with STDIN, then
exit(0);
}
上述の例で、真の親は WRITER ファイルハンドルに書き込みたくないので、 閉じます。 しかし、WRITER は open FH, "|-"
を使って開かれているので、 特殊な振る舞いをします: これを閉じると waitpid() ("waitpid" in perlfunc を 参照してください) を呼び出し、サブプロセスが終了するのを待ちます。 もし子プロセスが "do something else" とマークした部分で何かを 待っていると、デッドロックになります。
これはまた、より複雑なコードでの中間のサブプロセスで問題になります; これはグローバルな破壊の間に全ての開いているファイルハンドルに対して waitpid() を呼び出します--順序は予測不能です。
これを解決するために、以下のように、pipe(), fork(), ファイル記述子を 一つずつ設定する open() を手動で使わなければなりません:
pipe(READER, WRITER) || die "pipe failed: $!";
$pid = fork();
defined($pid) || die "first fork failed: $!";
if ($pid) {
close READER;
if (my $sub_pid = fork()) {
defined($sub_pid) || die "first fork failed: $!";
close(WRITER) || die "can't close WRITER: $!";
}
else {
# write to WRITER...
# ...
# then when finished
close(WRITER) || die "can't close WRITER: $!";
exit(0);
}
# write to WRITER...
}
else {
open(STDIN, "<&READER") || die "can't reopen STDIN: $!";
close(WRITER) || die "can't close WRITER: $!";
# do something...
exit(0);
}
Perl 5.8.0 から パイプのために open
のリスト形式を使えます。 これは、コマンド文字列のメタ文字をシェルに解釈させたくないときに 向いています。
例えば、以下のようにする代わりに:
open(PS_PIPE, "ps aux|") || die "can't open ps pipe: $!";
次のいずれかのようにします:
open(PS_PIPE, "-|", "ps", "aux")
|| die "can't open ps pipe: $!";
@ps_args = qw[ ps aux ];
open(PS_PIPE, "-|", @ps_args)
|| die "can't open @ps_args|: $!";
open() に三つを超える引数があるので、シェルを起動 せずに ps(1) を フォークし、PS_PIPE
ファイルハンドル経由で標準出力を読み込みます。 コマンドパイプに write するための対応する文法は "-|"
のところで "|-"
を使うことです。
これは確かにややばかばかしい例です; 内容が完全に安全な文字列リテラルを 使っているからです。 従って、より読みにくいパイプ open() の複数引数形式に頼る理由はありません。 しかし、プログラム引数がシェルメタ文字から解放されていることが保証できない 場合はいつでも、より手の込んだ形式の open() を使うべきです。 例えば:
@grep_args = ("egrep", "-i", $some_pattern, @many_files);
open(GREP_PIPE, "-|", @grep_args)
|| die "can't open @grep_args|: $!";
これは複数引数形式のパイプ open() が望ましいです; パターンや実際には ファイル名自体すらメタ文字を含んでいるかもしれないからです。
これらの操作は UNIX の fork でいっぱいで、その fork が他の全てのシステムでは 適切に実装されていない可能性があるのだということに注意してください。 それに加えて、これらのやり方は本当のマルチスレッドではありません。 スレッドについてより学びたいのであれば、後述する SEE ALSO の章で 言及されている modules ファイルを参照してください。
複数のサブプロセスがある場合はいつでも、プロセス間通信のために作られた パイプの片方が使っていないものを閉じることに周囲しなければなりません。 これはパイプから読み込んで EOF を想定している子プロセスがそれを 受け取ることができず、従って終了しなくなるからです。 一つのプロセスがパイプを閉じるのは閉じるのに十分ではありません; パイプを 開いた最後のプロセスは EOF を読み込むために閉じなければなりません。
一部の組み込みの Unix 機能はこのほとんどの時間を割ける助けになります。 例えば、ファイルハンドルは "close on exec" フラグを持ちます; これは $^F
の支配下で 一斉に 設定されます。 これは、子 プログラム の STDIN, STDOUT, STDERR に明示的に向けていない ファイルハンドルは自動的に閉じられるというものです。
プロセスが実際に書いているのでない限り、全てのパイプの 書き込み側では常に明示的に直ちに close() を呼び出してください。 明示的に close() を呼び出していなくても、Perl は未だにグローバルな 破壊時に全てのファイルハンドルに対して close() を呼び出します。 先に議論したように、これらのファイルハンドルが Safe Pipe Open で 開かれているなら、これらは waitpid() を呼び出して、再びデッドロックの 可能性があります。
これは、片方向通信に対してうまく働きます; では双方向通信は? あなたがやりたいだろうとまず考えることは、うまくいきません:
# THIS DOES NOT WORK!!
open(PROG_FOR_READING_AND_WRITING, "| some program |")
use warnings
を使うのを忘れてしまうと、有用な診断メッセージを得る機会を 完全に逃すことになるでしょう:
Can't do bidirectional pipe at -e line 1.
本当にこういったことをしたいのなら、IPC::Open2
モジュールの open2() というライブラリ関数を使うことで、パイプの両方の端点を 得ることができます。 三方向(tridirectional)の入出力のための IPC::Open3
の open3() もあるので、 子プロセスの STDERR を捕捉することもできるのですが、そのためには 不格好な select() ループが必要となり、Perl の通常の入力操作を行うことが できません。
ソースを見れば、open2() は全ての接続を作成するのに pipe() や exec() システムコールのような低レベルなものを使うことに気付くでしょう。 socketpair() を使うことでより効率的になるかもしれませんが、これは 既にあるものよりも移植性がありません。 open2() と open3() 関数は Unix システム、あるいは少なくとも POSIX 準拠の システム以外では動作しそうにありません。
以下は open2() を使った例です:
use FileHandle;
use IPC::Open2;
$pid = open2(*Reader, *Writer, "cat -un");
print Writer "stuff\n";
$got = <Reader>;
これに関する問題は、バッファリングが実際にはある時点に至るまで 留まるということにあります。 ファイルハンドル Writer
を自動フラッシュにしたとしても、もう一方の 端点にあるプロセスは送られたデータを適当なタイミングで 受け取ることになります; 一般的に言って、同様に即座にデータを返すように 強制することはできません。 この特殊な場合では、バッファリングをしないようにするために -u フラグを cat に与えることができたのでそれができました。 パイプ越しに使われることを想定して設計されたコマンドはほとんどないので、 この例のようなことは、両端のあるパイプのもう一方の端点にある プログラムを自分自身で書かない限りはほとんどできないのです。
この解決策は、あなたのプログラムをより信頼性のあるものとするために 擬似 TTY を使うライブラリを使うことです。 このやり方では、あなたが使おうとしているプログラムのソースコードを いじくりまわすような必要はありません。 CPAN にあるモジュール Expect
はこの問題に対処するものです。 このモジュールは他に IO:Pty
, IO::Stty
という二つの CPAN モジュールを 必要とします。 このモジュールは、ターミナルデバイスドライバと応答するような プログラムと対話するために、擬似端末をセットアップします。 もしあなたの使っているシステムがサポートしているのであれば、 そちらを使った方が良いでしょう。
もし望むのなら、低レベルなシステムコール pipe() や fork() を 手作業で行うために使うことができます。 以下の例は単に説明のためのものですが、STDIN や STDOOUT に対する 適切なハンドルを再オープンすることができ、さらに別のプロセスを 呼び出すことができます。 (以下の例は適切なエラーチェックが欠けています。)
#!/usr/bin/perl -w
# pipe1 - bidirectional communication using two pipe pairs
# designed for the socketpair-challenged
use IO::Handle; # thousands of lines just for autoflush :-(
pipe(PARENT_RDR, CHILD_WTR); # XXX: check failure?
pipe(CHILD_RDR, PARENT_WTR); # XXX: check failure?
CHILD_WTR->autoflush(1);
PARENT_WTR->autoflush(1);
if ($pid = fork()) {
close PARENT_RDR;
close PARENT_WTR;
print CHILD_WTR "Parent Pid $$ is sending this\n";
chomp($line = <CHILD_RDR>);
print "Parent Pid $$ just read this: '$line'\n";
close CHILD_RDR; close CHILD_WTR;
waitpid($pid, 0);
} else {
die "cannot fork: $!" unless defined $pid;
close CHILD_RDR;
close CHILD_WTR;
chomp($line = <PARENT_RDR>);
print "Child Pid $$ just read this: '$line'\n";
print PARENT_WTR "Child Pid $$ is sending this\n";
close PARENT_RDR;
close PARENT_WTR;
exit(0);
}
しかし実際に二つの pipe の呼び出しを行う必要はありません。 あなたの使っているシステムが socketpair() システムコールを サポートしていれば、それがあなたの代わりに作業を行ってくれます。
#!/usr/bin/perl -w
# pipe2 - bidirectional communication using socketpair
# "the best ones always go both ways"
use Socket;
use IO::Handle; # thousands of lines just for autoflush :-(
# We say AF_UNIX because although *_LOCAL is the
# POSIX 1003.1g form of the constant, many machines
# still don't have it.
socketpair(CHILD, PARENT, AF_UNIX, SOCK_STREAM, PF_UNSPEC)
|| die "socketpair: $!";
CHILD->autoflush(1);
PARENT->autoflush(1);
if ($pid = fork()) {
close PARENT;
print CHILD "Parent Pid $$ is sending this\n";
chomp($line = <CHILD>);
print "Parent Pid $$ just read this: '$line'\n";
close CHILD;
waitpid($pid, 0);
} else {
die "cannot fork: $!" unless defined $pid;
close CHILD;
chomp($line = <PARENT>);
print "Child Pid $$ just read this: '$line'\n";
print PARENT "Child Pid $$ is sending this\n";
close PARENT;
exit(0);
}
UNIX から派生したオペレーティングシステムに完全に限定されることはない (例えば PC では WinSock が(幾つかの VMS ライブラリのように) ソケットサポートを提供しています)にも関らず、あなたが使っている システムではソケットが使えないかもしれません; その場合、この項に 書かれていることはあなたの役には立たないでしょう。 ソケットを使えば、TCP ストリームのような仮想回路や UDP パケットのような データグラムの両方が可能になります。 使っているシステムに、より一層依存することになるかもしれません。
ソケットを扱うための Perl の関数は対応する C でのシステムコールと 同じ名前を持っています; しかし、引数に関しては二つの理由によって 異なるものとなっています。 第一に、Perl のファイルハンドルは C のファイル記述子とは 異なる働きをするものである。 第二に、Perl はすでに文字列の長さを知っているので、その情報を渡す 必要がない、というものです。
古代からある大きな問題の一つである、古の Perl のソケットコードは 一部の定数に対してハードコードされた値を使っていて、移植性を大きく損なっています。 明示的に $AF_INET = 2
のようなことをしているコードを見たなら、大きな 問題に遭遇していることになります。 まず最初にとるべき手法は Socket
モジュールで、これにより様々な定数と 必要な関数に、より信頼性のあるアクセスを行います。
NNTP や SMTP のように既に存在しているプロトコルのためにサーバー/ クライアントを書くのでなければ、あなたの作るサーバーがどのようにして クライアントが通話を終えたときを知ったり、その反対のことを 知るのかということを考えておくべきでしょう。 ほとんどのプロトコルは一行のメッセージと返事(片方のプロセスは、 “\n”を受け取ったときにもう一つのプロセスでの処理が終了したことを 知ります)か、空行に置かれたピリオドで終端される("\n.\n" がメッセージ/返事を 終端する)複数行メッセージと返事に基づいています。
インターネットでの行終端子は "\015\012" です。 UNIX で使われる ASCII のバリエーションでは、通常は“\r\n”のように 記述しますが、他のシステムでは、“\r\n”は"\015\015\012" だったり、 "\012\012\015" だったりあるいはまったく違うものであったりします。 “\015\012”は標準的な書き方(あなたが書いたままのものになります)ですが、 入力中にある独立した“\012”を受け付けることも推奨されています (あなたが要求するときにはそれを穏やかなものにしましょう)。 このマニュアルページにあるプログラムについて、常に最善のものを 使ってはいませんが、あなたが Unix 以前の暗黒時代の Mac を 使っているのでなければ気にすることはないでしょう。
自分の使っているシステムの外側にあるもマシンにまでクライアント- サーバーの通信を広げたい場合には Internet-domain ソケットを使います。
以下のプログラムは、Internet-domain ソケットを使った TCP クライアントの 例です:
#!/usr/bin/perl -w
use strict;
use Socket;
my ($remote, $port, $iaddr, $paddr, $proto, $line);
$remote = shift || "localhost";
$port = shift || 2345; # random port
if ($port =~ /\D/) { $port = getservbyname($port, "tcp") }
die "No port" unless $port;
$iaddr = inet_aton($remote) || die "no host: $remote";
$paddr = sockaddr_in($port, $iaddr);
$proto = getprotobyname("tcp");
socket(SOCK, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
connect(SOCK, $paddr) || die "connect: $!";
while ($line = <SOCK>) {
print $line;
}
close (SOCK) || die "close: $!";
exit(0);
そして以下に挙げるのが上記のクライアントと対応するサーバーです。 ここではアドレスを INADDR_ANY
としているので、カーネルは multihomed hosts 上の適切なインターフェースを選択することができます。 (ファイヤーウォールやゲイトウェイの外側のように)特定のインターフェースを 使いたいのであれば、この部分を、自分の使いたい本当のアドレスで 埋めるようにすべきです。
#!/usr/bin/perl -Tw
use strict;
BEGIN { $ENV{PATH} = "/usr/bin:/bin" }
use Socket;
use Carp;
my $EOL = "\015\012";
sub logmsg { print "$0 $$: @_ at ", scalar localtime(), "\n" }
my $port = shift || 2345;
die "invalid port" unless if $port =~ /^ \d+ $/x;
my $proto = getprotobyname("tcp");
socket(Server, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
setsockopt(Server, SOL_SOCKET, SO_REUSEADDR, pack("l", 1))
|| die "setsockopt: $!";
bind(Server, sockaddr_in($port, INADDR_ANY)) || die "bind: $!";
listen(Server, SOMAXCONN) || die "listen: $!";
logmsg "server started on port $port";
my $paddr;
$SIG{CHLD} = \&REAPER;
for ( ; $paddr = accept(Client, Server); close Client) {
my($port, $iaddr) = sockaddr_in($paddr);
my $name = gethostbyaddr($iaddr, AF_INET);
logmsg "connection from $name [",
inet_ntoa($iaddr), "]
at port $port";
print Client "Hello there, $name, it's now ",
scalar localtime(), $EOL;
}
以下の例はマルチスレッドバージョンです。 これはほとんどの典型的なサーバーがそうであるようにマルチスレッドに なっていて、クライアントのリクエストを処理するためにスレイブサーバーを spawn (fork()) します; このため、マスターサーバーは新しいクライアントに 対してサービスするために即座に復帰できます。
#!/usr/bin/perl -Tw
use strict;
BEGIN { $ENV{PATH} = "/usr/bin:/bin" }
use Socket;
use Carp;
my $EOL = "\015\012";
sub spawn; # forward declaration
sub logmsg { print "$0 $$: @_ at ", scalar localtime(), "\n" }
my $port = shift || 2345;
die "invalid port" unless if $port =~ /^ \d+ $/x;
my $proto = getprotobyname("tcp");
socket(Server, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
setsockopt(Server, SOL_SOCKET, SO_REUSEADDR, pack("l", 1))
|| die "setsockopt: $!";
bind(Server, sockaddr_in($port, INADDR_ANY)) || die "bind: $!";
listen(Server, SOMAXCONN) || die "listen: $!";
logmsg "server started on port $port";
my $waitedpid = 0;
my $paddr;
use POSIX ":sys_wait_h";
use Errno;
sub REAPER {
local $!; # don't let waitpid() overwrite current error
while ((my $pid = waitpid(-1, WNOHANG)) > 0 && WIFEXITED($?)) {
logmsg "reaped $waitedpid" . ($? ? " with exit $?" : "");
}
$SIG{CHLD} = \&REAPER; # loathe SysV
}
$SIG{CHLD} = \&REAPER;
while (1) {
$paddr = accept(Client, Server) || do {
# try again if accept() returned because got a signal
next if $!{EINTR};
die "accept: $!";
};
my ($port, $iaddr) = sockaddr_in($paddr);
my $name = gethostbyaddr($iaddr, AF_INET);
logmsg "connection from $name [",
inet_ntoa($iaddr),
"] at port $port";
spawn sub {
$| = 1;
print "Hello there, $name, it's now ", scalar localtime(), $EOL;
exec "/usr/games/fortune" # XXX: "wrong" line terminators
or confess "can't exec fortune: $!";
};
close Client;
}
sub spawn {
my $coderef = shift;
unless (@_ == 0 && $coderef && ref($coderef) eq "CODE") {
confess "usage: spawn CODEREF";
}
my $pid;
unless (defined($pid = fork())) {
logmsg "cannot fork: $!";
return;
}
elsif ($pid) {
logmsg "begat $pid";
return; # I'm the parent
}
# else I'm the child -- go spawn
open(STDIN, "<&Client") || die "can't dup client to stdin";
open(STDOUT, ">&Client") || die "can't dup client to stdout";
## open(STDERR, ">&STDOUT") || die "can't dup stdout to stderr";
exit($coderef->());
}
このサーバーはリクエストがくる度に fork() を使って子バージョンの複製を 行うので、問題を取り除きます。 このやり方は、あなたが常に望んではいないかもしれませんが、一度に多くの リクエストを処理することができます。 fork()を使わなかったとしても、listen() は多くの一時停止した コネクション(pending connections) を扱えます。 サーバーを fork するので、死んだ子供(UNIX 世界ではゾンビと呼ばれるもの)の 後始末に関して注意深くする必要があります; なぜなら、そうしなければ プロセステーブルがすぐに埋めつくされることになるからです。 ここで REAPER サブルーチンは終了した全ての子プロセスのために waitpid() を呼び出すために使われ、従って子プロセスがきれいに終了し、 ゾンビの集団に加わらないことを確実にします。
while ループの中で accept() を呼び出して、偽の値を返すかどうかを チェックします。 これは普通報告する必要のあるシステムエラーを示しています。 しかし、Perl 5.7.3 で導入された安全なシグナル(上述の "Deferred Signals (Safe Signals)" を参照してください) の導入は、 プロセスがシグナルを受信した場合にも accept() が中断されるかもしれないことを 意味します。 これは典型的には、fork した子プロセスの一つが終了して、親プロセスに CHLD シグナルを通知した場合に起こります。
accept() がシグナルによって割り込まれると、$! に EINTR がセットされます。 これが起きると、ループの次の繰り返しと accept() の次の呼び出しを安全に 続けることができます。 シグナルハンドリングのコードは $! の値を修正せず、さもなければこのテストは おそらく失敗するということは重要です。 REAPER サブルーチンの中で、waitpid() を呼び出す前にローカル化された $! を 作成します。 どの子供も待っていない時に必然的に起きるように waitpid() が $! に ECHILD を セットすると、ローカルコピーは更新され元の値は変更されません。
setuid やsetgid をされていない状態で実行されているとしても、汚染検査 (perlsec を参照)を有効にするために -T フラグを使うべきです。 これは、サーバーや、誰かのために実行される(CGI スクリプトのような) プログラムに対しては常に良い考えになります; なぜならそうすることによって、 外部の人間があなたのシステムに入ってくることができる可能性を減らすからです。
もう一つの TCP クライアントを見てみましょう。 これは複数の異なるマシン上の TCP の“time”サービスに接続してクライアントが 走っているシステムと時計がどれくらい違っているのを出力します:
#!/usr/bin/perl -w
use strict;
use Socket;
my $SECS_OF_70_YEARS = 2208988800;
sub ctime { scalar localtime(shift() || time()) }
my $iaddr = gethostbyname("localhost");
my $proto = getprotobyname("tcp");
my $port = getservbyname("time", "tcp");
my $paddr = sockaddr_in(0, $iaddr);
my($host);
$| = 1;
printf "%-24s %8s %s\n", "localhost", 0, ctime();
foreach $host (@ARGV) {
printf "%-24s ", $host;
my $hisiaddr = inet_aton($host) || die "unknown host";
my $hispaddr = sockaddr_in($port, $hisiaddr);
socket(SOCKET, PF_INET, SOCK_STREAM, $proto)
|| die "socket: $!";
connect(SOCKET, $hispaddr) || die "connect: $!";
my $rtime = pack("C4", ());
read(SOCKET, $rtime, 4);
close(SOCKET);
my $histime = unpack("N", $rtime) - $SECS_OF_70_YEARS;
printf "%8d %s\n", $histime - time(), ctime($histime);
}
Internet-domain のサーバーとクライアントは良いものですが、ローカル コミュニケーションに関してはどうでしょうか? 同じようにセットアップすることができますが、同じ様に(通信を)行うことは できません。 UNIX ドメインソケットはカレントホストにローカルで、しばしばパイプを 実装するために内部的に使われています。 Internet ドメインソケットとは異なり、UNIX ドメインソケットは、 ls(1) を使ってファイルシステムの中で見つけることができます。
% ls -l /dev/log
srw-rw-rw- 1 root 0 Oct 31 07:23 /dev/log
これを、Perl のファイルテスト -S を使って行えます:
unless (-S "/dev/log") {
die "something's wicked with the log system";
}
UNIX ドメインクライアントの例です:
#!/usr/bin/perl -w
use Socket;
use strict;
my ($rendezvous, $line);
$rendezvous = shift || "catsock";
socket(SOCK, PF_UNIX, SOCK_STREAM, 0) || die "socket: $!";
connect(SOCK, sockaddr_un($rendezvous)) || die "connect: $!";
while (defined($line = <SOCK>)) {
print $line;
}
exit(0);
そして対応するサーバーです。 ここで、あなたはやっかいなネットワーク終端子について思い煩う必要は ありません; なぜなら、UNIX のドメインソケットはローカルホストにおいて完全に 満たされるものであって、そのため、全てはうまくいくのです。
#!/usr/bin/perl -Tw
use strict;
use Socket;
use Carp;
BEGIN { $ENV{PATH} = "/usr/bin:/bin" }
sub spawn; # forward declaration
sub logmsg { print "$0 $$: @_ at ", scalar localtime(), "\n" }
my $NAME = "catsock";
my $uaddr = sockaddr_un($NAME);
my $proto = getprotobyname("tcp");
socket(Server, PF_UNIX, SOCK_STREAM, 0) || die "socket: $!";
unlink($NAME);
bind (Server, $uaddr) || die "bind: $!";
listen(Server, SOMAXCONN) || die "listen: $!";
logmsg "server started on $NAME";
my $waitedpid;
use POSIX ":sys_wait_h";
sub REAPER {
my $child;
while (($waitedpid = waitpid(-1, WNOHANG)) > 0) {
logmsg "reaped $waitedpid" . ($? ? " with exit $?" : "");
}
$SIG{CHLD} = \&REAPER; # loathe SysV
}
$SIG{CHLD} = \&REAPER;
for ( $waitedpid = 0;
accept(Client, Server) || $waitedpid;
$waitedpid = 0, close Client)
{
next if $waitedpid;
logmsg "connection on $NAME";
spawn sub {
print "Hello there, it's now ", scalar localtime(), "\n";
exec("/usr/games/fortune") || die "can't exec fortune: $!";
};
}
sub spawn {
my $coderef = shift();
unless (@_ == 0 && $coderef && ref($coderef) eq "CODE") {
confess "usage: spawn CODEREF";
}
my $pid;
unless (defined($pid = fork())) {
logmsg "cannot fork: $!";
return;
}
elsif ($pid) {
logmsg "begat $pid";
return; # I'm the parent
}
else {
# I'm the child -- go spawn
}
open(STDIN, "<&Client") || die "can't dup client to stdin";
open(STDOUT, ">&Client") || die "can't dup client to stdout";
## open(STDERR, ">&STDOUT") || die "can't dup stdout to stderr";
exit($coderef->());
}
見てわかるように、Internet domain TCP サーバーとほとんど同じです; 実際には、 変わっていない幾つかの重複した関数 spawn(), logmsg(), ctime(), REAPER() を 取り除いてあります。
ではなぜ、単純な名前付きパイプではなく UNIX ドメインソケットを 使いたがるのでしょうか? その理由は、名前付きパイプがあなたにセッションを与えないからです。 あなたはあるプロセスから来たデータと、それとは別のプロセスからきた データとを区別することができません。 ソケットプログラミングを行うことで、クライアント毎に別々のセッションを 持てるようになります; これが accept() が二つの引数を取る理由です。
例えば、CGI インターフェースを通してのみ Web からアクセスされる、 長時間実行されているデータベースサーバーデーモンを持っているとしましょう。 この場合、あなたの好きなようにチェックやログの記録を実行するような小さく、 単純な CGI プログラムを持って、UNIX ドメインクライアントとして振る舞う プライベートなサーバーに接続させるといったことができるでしょう。
ソケットプログラミングに対する高水準インターフェースのために、IO::Socket モジュールはオブジェクト指向アプローチを提供します。 IO::Socket モジュールはリリース 5.004 の標準 Perl 配布の一部として 含まれています。 あなたが以前のバージョンの Perl を使っているのであれば(この場合、 どうやってこの man ページを読んでるの?) CPAN から IO::Socket を入手します; そこでは、以下に挙げるようなシステムに 対する簡単なインターフェースを提供するシステムも見つけることができるでしょう: DNS, FTP, Ident (RFC 931), NIS, NISPlus, NNTP, Ping, POP3, SMTP, SNMP, SSLeay, Telnet, Time など。
以下の例は“localhost”というホスト名の 13 番ポートにある“dyatime” サービスに対する TCP コネクションを作成するクライアントで、そのサーバーが 提供するデータをすべて出力します。
#!/usr/bin/perl -w
use IO::Socket;
$remote = IO::Socket::INET->new(
Proto => "tcp",
PeerAddr => "localhost",
PeerPort => "daytime(13)",
)
|| die "can't connect to daytime service on localhost";
while (<$remote>) { print }
このプログラムを実行すると、以下のような返事が返ってくるでしょう:
Wed May 14 08:40:46 MDT 1997
new() コンストラクターに対するパラメーターの意味を説明します:
Proto
これは使用するプロトコルです。 この例では、私たちはストリーム指向のコネクション、つまり、昔ながらの普通の ファイルのように振る舞うものを使いたいので、ソケットは TCP ソケットに 接続されたものを扱います。 ソケットにはこれ以外のタイプもあることに注意してください。 たとえば、UDP プロトコルは(メッセージ送信に使われている) データグラムソケットを作成するために使うことができます。
PeerAddr
これはサーバーが実行されているリモートホストの、インターネットアドレス もしくは名前です。 これを "www.perl.com"
のような長い名前で指定することも "207.171.7.72"
のようなアドレスで指定することもできます。 先の例で使った "localhost"
は、常に自分が使用している現在のマシンを 意味する特別なホスト名です。 ローカルホストに対するインターネットアドレスは "127.0.0.1"
で、こちらを 使うこともできます。
PeerPort
これは接続したいサービスの名称、もしくはポート番号です。 私たちは先の例で、きちんと設定されたシステムサービスの使える システムでなら "daytime"
を使うこともできました [FOOTNOTE: Unix 風システムではでは /etc/services にあります]。 しかしここでは括弧でくくって (13) というポート番号の指定を行っていました。 単に番号を使っても同様に動作するのですが、数値リテラルは注意深いプログラマを 神経質にさせてしまいます。
コンストラクター new
の戻り値が、while
ループの中のファイル ハンドルとしてどのように使われているかということに気がつきましたか? これは 間接ファイルハンドル と呼ばれるもので、ファイルハンドルを 保持しているスカラー変数です。 これは、通常のファイルハンドルと同様のやり方で使うことができます。 例えば、以下のようにすれば一行読み込みができます:
$line = <$handle>;
残りの行全ての読み込みは以下のようにします:
@lines = <$handle>;
データを一行送るには以下のようにします:
print $handle "some data\n";
以下の例は、ドキュメントをそこから取るリモートホストと、そのホストから 取得するドキュメントのリストを引数に取る単純なクライアントです。 これは先の例よりも興味深いものです; なぜなら、この例においてはサーバーの 反応をフェッチする前に最初に何かをサーバーに送信するからです。
#!/usr/bin/perl -w
use IO::Socket;
unless (@ARGV > 1) { die "usage: $0 host url ..." }
$host = shift(@ARGV);
$EOL = "\015\012";
$BLANK = $EOL x 2;
for my $document (@ARGV) {
$remote = IO::Socket::INET->new( Proto => "tcp",
PeerAddr => $host,
PeerPort => "http(80)",
) || die "cannot connect to httpd on $host";
$remote->autoflush(1);
print $remote "GET $document HTTP/1.0" . $BLANK;
while ( <$remote> ) { print }
close $remote;
}
ここでは、"http" サービスを提供するサーバーがその標準ポートである 80 番ポートを使っていると仮定しています。 あなたの使っている web サーバーが 1080 や 8080 のような異なるポートを 使用しているのであれば、名前付きパラメータペアにして PeerPort => 8080
のような形式で指定すべきでしょう。 autoflush
メソッドがソケットに対して使われます; そうしなければシステムは 私たちが送信した出力をバッファリングしてしまうでしょう。 (あなたが古い Mac を使っているのであれば、ネットワーク越しにデータを送信する プログラム中にあるすべての "\n"
を "\015\012"
に変更する必要も あります。)
サーバーへの接続は、このプロセスの最初の一部分でしかありません: 一度接続されてしまえば、サーバーの言語を使うべきなのです。 ネットワーク上の各サーバーは、入力として期待しているそれぞれの小さな コマンド言語を持っています。 HTTP 構文において最初にサーバーに送信するのは "GET" です。 この場合、単純に指定されたドキュメントのそれぞれをリクエストします。 そう、私たちは実際には、たとえ同じホストであったとしてもドキュメント毎に 新しいコネクションを作成しています。 これが HTTP を使うときに常にそうしなければならない方法なのです。 最近のwebブラウザーではコネクションを開いたままちょっとの間リモートサーバーを 離れるリクエストをすることができますが、サーバーはそのようなリクエストを 処理しなければならないというわけではありません。
以下に挙げるのは、私たちがwebgetと呼ぶであろうプログラムを 実行した例です。
% webget www.perl.com /guanaco.html
HTTP/1.1 404 File Not Found
Date: Thu, 08 May 1997 18:02:32 GMT
Server: Apache/1.2b6
Connection: close
Content-type: text/html
<HEAD><TITLE>404 File Not Found</TITLE></HEAD>
<BODY><H1>File Not Found</H1>
The requested URL /guanaco.html was not found on this server.<P>
</BODY>
これは特定のドキュメントを見つけられないというものですからあまり 面白いものでもありません。 でも、長いレスポンスをここに載せるわけにもいかないでしょう。
このプログラムのより高機能なバージョンは、CPAN にある LWP モジュール中の lwp-request というプログラムを見るとよいでしょう。
一つのコマンドを送信し、一つの返答を得るというのであれば具合が良いのですが、 完全に対話的な何かを設定し、telnet のように動作するものはどうでしょうか? ここでできるのは、ある一行をタイプして答を得て、別の行をタイプしてそれに 対する答を得て…というやり方です。
このクライアントは既に出てきた二つのものよりも複雑ですが、あなたが 強力な fork
呼び出しをサポートしているシステムを使っているのであれば、 解決策は乱暴なものではありません。 通信したいなんらかのサービスに対してコネクションを作ってしまえば、プロセスの 複製を作るために fork
を呼び出します。 それによる二つのプロセスはそれぞれ、非常に単純なジョブを行います: 親プロセスはソケットから入力されたすべてを標準出力にコピーし、子プロセスは 標準入力をソケットへと同じようにコピーします。 ただ一つのプロセスを使ったときに同じことをするのは 非常に 難しいでしょう; なぜなら、二つのことを行う一つのプロセスのためのプログラムよりも一つのことを 行う二つのプロセスのためのプログラムのほうが簡単だからです。 (この keep-it-simple 法則は UNIX 文化の要石で、良いソフトウェアエンジニアが 使うように、(UNIX が)他のシステムよりも広く使われていることの理由でしょう。)
プログラムの例です:
#!/usr/bin/perl -w
use strict;
use IO::Socket;
my ($host, $port, $kidpid, $handle, $line);
unless (@ARGV == 2) { die "usage: $0 host port" }
($host, $port) = @ARGV;
# create a tcp connection to the specified host and port
$handle = IO::Socket::INET->new(Proto => "tcp",
PeerAddr => $host,
PeerPort => $port)
|| die "can't connect to port $port on $host: $!";
$handle->autoflush(1); # so output gets there right away
print STDERR "[Connected to $host:$port]\n";
# split the program into two processes, identical twins
die "can't fork: $!" unless defined($kidpid = fork());
# the if{} block runs only in the parent process
if ($kidpid) {
# copy the socket to standard output
while (defined ($line = <$handle>)) {
print STDOUT $line;
}
kill("TERM", $kidpid); # send SIGTERM to child
}
# the else{} block runs only in the child process
else {
# copy standard input to the socket
while (defined ($line = <STDIN>)) {
print $handle $line;
}
exit(0); # just in case
}
親プロセスの if
ブロックにある kill
関数は、リモートサーバーが コネクションを終了してクローズしてすぐに else
ブロックを 実行してる子プロセスにシグナルを送るためのものです。
リモートサーバーが一度に一バイト送っていて、そして、あなたが改行を 待つことなしに即座にデータを必要とする(そうそうないことでしょうが)のなら、 while
ループを以下のようなものに置き換えたくなるでしょう:
my $byte;
while (sysread($handle, $byte, 1) == 1) {
print STDOUT $byte;
}
読み出しのために一バイト毎にシステムコールを行うのは実に非効率的ですが、 説明するのに簡単でとりあえずは動くのです:
常にそうであるように、サーバーのセッティングはクライアントを実行するよりも ほんのちょっと手間がかかります。 ここで使うのは、サーバーが特定のポートで接続を待つだけという特殊な種類の ソケットを作成するというモデルです。 これは、IO::Socket::INET->new()
というメソッドをはっきりと異なる 引数を付けて呼び出してからクライアントを実行することで行います。
これは使用するプロトコルです。 クライアントと同様、ここでは "tcp"
を指定します。
LocalPort
引数でローカルポートを指定します; これはクライアントでは していませんでした。 これはサーバーにしたいサービス名かポート番号のいずれかです。 (UNIX では、1024 未満のポートはスーパーユーザー限定です。) 私たちのサンプルでは 9000 番ポートを使いますが、あなたの使っているシステムで 重複しなければ好きな番号を使うことができます。 もし既に使われているポートを使おうとすれば、"Address already in use" の ようなメッセージを得ることとなるでしょう。 UNIX では、netstat -a
コマンドを使ってサービスが現在使っているサーバーを 見ることができます。
Listen
パラメーターは、クライアントを待たせておいて受け付けることのできる コネクションの最大数を設定します。 電話の呼び出しを考えてみてください。 低水準ソケットモジュールは SOMAXCONN というそのシステムの最大値を表す 特殊なシンボルを持っています。
Reuse
パラメーターは、システムがバッファーをクリアするための時間を 掛けずに私たちのサーバーを手作業で再起動するのに必要です。
上で述べたパラメーターを持った汎用のサーバーソケットが生成されれば、 そのサーバーは接続される新たなクライアントを待ちます。 accept
メソッドにあるサーバーブロックはリモートクライアントからの 双方向接続を許可します。 (バッファリングを抑制するためにハンドルに対して autoflush することを忘れないように。)
ユーザーに親切にするために、私たちのサーバーはコマンドの入力のプロンプトを 表示します。 ほとんどのサーバーはこうしたことをしていません。 プロンプトには改行がないので、上の例にあったような対話的な クライアントの類では sysread
を使う必要があるでしょう。
このサーバは五つの異なるコマンドを受け付け、クライアントに出力を返します。 ほとんどのネットワークサーバと違って、これは同時に一つのクライアントからだけの 入力を扱います。 マルチスレッドサーバはラクダ本の 16 章で扱います。
以下プログラムです。 以下のようにします
#!/usr/bin/perl -w
use IO::Socket;
use Net::hostent; # for OOish version of gethostbyaddr
$PORT = 9000; # pick something not in use
$server = IO::Socket::INET->new( Proto => "tcp",
LocalPort => $PORT,
Listen => SOMAXCONN,
Reuse => 1);
die "can't setup server" unless $server;
print "[Server $0 accepting clients]\n";
while ($client = $server->accept()) {
$client->autoflush(1);
print $client "Welcome to $0; type help for command list.\n";
$hostinfo = gethostbyaddr($client->peeraddr);
printf "[Connect from %s]\n", $hostinfo ? $hostinfo->name : $client->peerhost;
print $client "Command? ";
while ( <$client>) {
next unless /\S/; # blank line
if (/quit|exit/i) { last }
elsif (/date|time/i) { printf $client "%s\n", scalar localtime() }
elsif (/who/i ) { print $client `who 2>&1` }
elsif (/cookie/i ) { print $client `/usr/games/fortune 2>&1` }
elsif (/motd/i ) { print $client `cat /etc/motd 2>&1` }
else {
print $client "Commands: quit date who cookie motd\n";
}
} continue {
print $client "Command? ";
}
close $client;
}
クライアント・サーバーをセットアップするもう一つの種類はコネクションではなく メッセージを使うものです。 UDP 通信はオーバーヘッドが低いものの、メッセージがすべて到着するという 保証がなく到着の順序もきちんと保たれていることも保証されてないために 信頼性もまた劣るものになっています。 それでも、UDP には一度に宛て先ホストの塊全体 (通常はローカルサブネット)に対して“ブロードキャスト”、“マルチキャスト”が できるということを含め、TCPに対する幾つかのアドバンテージがあります。 信頼性に関して過度に関心を持ち、作成するメッセージシステムに検査機構を 組み込もうというのであれば、むしろ TCP を使うようにした方がよいでしょう。
UDP はバイトストリーム ではなく 、そのように扱うべきでもありません。 これは stdio(つまり print() やその親戚) のような内部バッファリング付きの I/O 機構を特に扱いにくくします。 以下の例のように、syswrite() か、よりよい send() を使ってください。
以下に挙げた UDP プログラムは先に挙げたインターネット TCP クライアントの 例と似ています。 しかし、一度に一つのホストをチェックするのではなく、マルチキャストを シミュレートし、かつ、select() を入出力のタイムアウト待ちの ために使うことにより非同期的にたくさんのチェックを行います。 TCP でこれと同じことを行うには、ホスト毎に異なるソケットハンドルを 使わなければならないでしょう。
#!/usr/bin/perl -w
use strict;
use Socket;
use Sys::Hostname;
my ( $count, $hisiaddr, $hispaddr, $histime,
$host, $iaddr, $paddr, $port, $proto,
$rin, $rout, $rtime, $SECS_OF_70_YEARS);
$SECS_OF_70_YEARS = 2_208_988_800;
$iaddr = gethostbyname(hostname());
$proto = getprotobyname("udp");
$port = getservbyname("time", "udp");
$paddr = sockaddr_in(0, $iaddr); # 0 means let kernel pick
socket(SOCKET, PF_INET, SOCK_DGRAM, $proto) || die "socket: $!";
bind(SOCKET, $paddr) || die "bind: $!";
$| = 1;
printf "%-12s %8s %s\n", "localhost", 0, scalar localtime();
$count = 0;
for $host (@ARGV) {
$count++;
$hisiaddr = inet_aton($host) || die "unknown host";
$hispaddr = sockaddr_in($port, $hisiaddr);
defined(send(SOCKET, 0, 0, $hispaddr)) || die "send $host: $!";
}
$rin = "";
vec($rin, fileno(SOCKET), 1) = 1;
# timeout after 10.0 seconds
while ($count && select($rout = $rin, undef, undef, 10.0)) {
$rtime = "";
$hispaddr = recv(SOCKET, $rtime, 4, 0) || die "recv: $!";
($port, $hisiaddr) = sockaddr_in($hispaddr);
$host = gethostbyaddr($hisiaddr, AF_INET);
$histime = unpack("N", $rtime) - $SECS_OF_70_YEARS;
printf "%-12s ", $host;
printf "%8d %s\n", $histime - time(), scalar localtime($histime);
$count--;
}
この例では一切再試行を行わないので、到達可能なホストへの接続に 失敗することがあります。 これのもっとも有名な原因は、もし接続するホストの数が十分に大きいと、 送信ホストのキューが混雑することです。
System V IPC はソケットとしてはそれ程広く使われてはいませんが、 幾つかの興味深い使用法があります。 ただし、System V の IPC や Berkley の mmap() を異なる幾つかのプロセスの 間で変数を共有する目的のために使うことはできません。 なぜなら Perl が、あなたが望まないときに文字列の再割り付けをやってしまう 可能性があるからです。 このために、IPC::Shareable
モジュールや threads::shared
モジュールを 調べたいかもしれません。
共有メモリの使い方を例示する小さな例です。
use IPC::SysV qw(IPC_PRIVATE IPC_RMID S_IRUSR S_IWUSR);
$size = 2000;
$id = shmget(IPC_PRIVATE, $size, S_IRUSR | S_IWUSR);
defined($id) || die "shmget: $!";
print "shm key $id\n";
$message = "Message #1";
shmwrite($id, $message, 0, 60) || die "shmwrite: $!";
print "wrote: '$message'\n";
shmread($id, $buff, 0, 60) || die "shmread: $!";
print "read : '$buff'\n";
# the buffer of shmread is zero-character end-padded.
substr($buff, index($buff, "\0")) = "";
print "un" unless $buff eq $message;
print "swell\n";
print "deleting shm $id\n";
shmctl($id, IPC_RMID, 0) || die "shmctl: $!";
以下はセマフォの例です:
use IPC::SysV qw(IPC_CREAT);
$IPC_KEY = 1234;
$id = semget($IPC_KEY, 10, 0666 | IPC_CREAT);
defined($id) || die "shmget: $!";
print "shm key $id\n";
このコードを、二つ以上のプロセスで実行できるように別のファイルに 置きます。 そのファイルを take と呼びます:
# create a semaphore
$IPC_KEY = 1234;
$id = semget($IPC_KEY, 0, 0);
defined($id) || die "shmget: $!";
$semnum = 0;
$semflag = 0;
# "take" semaphore
# wait for semaphore to be zero
$semop = 0;
$opstring1 = pack("s!s!s!", $semnum, $semop, $semflag);
# Increment the semaphore count
$semop = 1;
$opstring2 = pack("s!s!s!", $semnum, $semop, $semflag);
$opstring = $opstring1 . $opstring2;
semop($id, $opstring) || die "semop: $!";
このコードを、二つ以上のプロセスで実行できるように別のファイルに 置きます。 このファイルを give と呼びます。
# "give" the semaphore
# run this in the original process and you will see
# that the second process continues
$IPC_KEY = 1234;
$id = semget($IPC_KEY, 0, 0);
die unless defined($id);
$semnum = 0;
$semflag = 0;
# Decrement the semaphore count
$semop = -1;
$opstring = pack("s!s!s!", $semnum, $semop, $semflag);
semop($id, $opstring) || die "semop: $!";
ここで例示した System V の IPC コードははるかな昔に書かれたもので、 へぼなものに見えます。 より現代的なものについては、Perl 5.005 から含まれている IPC::SysV モジュールを参照してください。
SysV メッセージキューを例示する簡単な例です:
use IPC::SysV qw(IPC_PRIVATE IPC_RMID IPC_CREAT S_IRUSR S_IWUSR);
my $id = msgget(IPC_PRIVATE, IPC_CREAT | S_IRUSR | S_IWUSR);
defined($id) || die "msgget failed: $!";
my $sent = "message";
my $type_sent = 1234;
msgsnd($id, pack("l! a*", $type_sent, $sent), 0)
|| die "msgsnd failed: $!";
msgrcv($id, my $rcvd_buf, 60, 0, 0)
|| die "msgrcv failed: $!";
my($type_rcvd, $rcvd) = unpack("l! a*", $rcvd_buf);
if ($rcvd eq $sent) {
print "okay\n";
} else {
print "not okay\n";
}
msgctl($id, IPC_RMID, 0) || die "msgctl failed: $!\n";
これらのルーチンのほとんどは物静かですが、何かに失敗した場合にはあなたの プログラムを終了させてしまったり捕捉されない例外を引き起こしたりする代わりに undef
を返します。 (実際には、新しい Socket 変換関数の幾つかは不正な引数に対して croak() します。) したがって要点は、これらの関数の戻り値を確認すべきであるということです。 ソケットプログラムは常に最良の成功(optimal success)のためにこのやり方で 始め、そしてサーバーに対して pound-bang line (#!
の行のこと)に 汚染検査フラグ -T を追加することを忘れないようにしてください。
#!/usr/bin/perl -Tw
use strict;
use sigtrap;
use Socket;
これらのルーチンは全て、システム固有の移植性問題を作り出します。 他の場所で説明したように、Perl の振る舞いは使用しているCライブラリに 左右されます。 System V のおかしなシグナルのセマンティクスを仮定することと、単純な TCP および UDP ソケット操作に終始するようにすることがおそらくは最も 安全なものでしょう; たとえば、あなたが自分のプログラムに移植性を 持たせるようにしたいのであれば、ローカルな UDP データグラムのソケットを通して ファイル記述子を渡すようなことをしようとしてはいけないということです。
Tom Christiansen (Larry Wall による元の文書の部分的な名残と、 Perl Porters による示唆と共に)
ネットワークに関する事柄はまだまだたくさんありますが、ここにあることは スタートになります。
W. Richard Stevens による非常に重要な教科書 Unix Network Programming, 2nd Edition, Volume 1 (Prentice-Hall から出版されています)があります。 ネットワークに関するほとんどの本は、C プログラマを対象としています; Perl への変換は、読者の宿題として残しておきます。
IO::Socket(3) マニュアルページにはオブジェクトライブラリの説明があり、 Socket(3) には低水準のソケットに対するインターフェースの説明があります。 perlfunc にある関数の他にも、至近にある CPAN サイト、特に http://www.cpan.org/modules/00modlist.long.html#ID5_Networking_ で modules ファイルをチェックしたほうが良いでしょう。 perlmodlib を参照するか、CPAN とは何かと先のリンクが動作しなかったときに どこを見るかの説明がある Perl FAQ を見るとよいでしょう。
modules ファイルの第 5 章は "Networking, Device Control (modems), and Interprocess Communication" に充てられていて、バンドルされなかった多くのネットワーク関連モジュール、 チャット と Expect operations, CGI プログラミング, DCE, FTP, IPC, NNTP, Proxy, Ptty, RPC, SNMP, SMTP, Telnet, スレッド、 そして ToolTalk を含んでいます。