コグノスケ


link 未来から過去へ表示  link 過去から未来へ表示(*)

link もっと前
2022年10月31日 >>> 2022年10月31日
link もっと後

2022年10月31日

Killできるpopenが欲しい

会社でpopenで作った子プロセスが残ってしまうが何とかならないか?という相談を受けて、面白そうだったので取り組んでみました。日記でも残しておきます。コード的には特に機密情報はありません。

popenて何ですか

マニュアルを読みましょう(Manpage of popen)。少しだけ解説するなら、子プロセスの入出力をパイプ経由で送ったり受け取ったりできるライブラリ関数です。

例えばyesコマンドをpopenで実行すると、出力パイプからはy y y y ... という文字列が読みだせます。

popenの困ったところ

非常に便利なpopenですが、子プロセスが終了するかどうかは子プロセス次第、言い換えれば子プロセスを強制的に終了させる方法がないことが欠点です。

例えば、先ほど挙げたyesコマンドは勝手に終了しないコマンドの代表例です。popen関数を呼んだ親プロセスが終了しても、子プロセスのyesコマンドは終了しないまま残ります。

改良popenを作る

実はpopen関数は既存のライブラリ関数やシステムコールの組み合わせで実現できます。先にコードを載せましょうか。

killできるpopenのコード

/* SPDX-License-Identifier: Apache-2.0 */

#define _GNU_SOURCE

#include <stdio.h>
#include <string.h>
#include <fcntl.h>
#include <signal.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/wait.h>

void usage(int argc, char *argv[])
{
	printf("usage:\n"
		"  %s cmdline\n", argv[0]);
}

int main(int argc, char *argv[])
{
	const char *cmdline;
	pid_t pid, pgrp;
	int pipefd[2];
	FILE *fp;
	int r;

	if (argc <= 1) {
		usage(argc, argv);
		return -1;
	}
	
	cmdline = argv[1];
	
	printf("cmdline: %s\n", cmdline);

	// パイプを作成します。パイプに読み書きするファイルディスクリプタ(pipefd)2つが返されます。
	// pipefd[0] が読み出し用、pipefd[1] が書き込み用です。
	r = pipe2(pipefd, 0);
	if (r == -1) {
		perror("pipe2");
		return -1;
	}

	// ファイルディスクリプタをFILE * でラップします。
	// popenはFILE * を返すインタフェースなので、それに合わせるためです。
	fp = fdopen(pipefd[0], "r");
	if (fp == NULL) {
		perror("fdopen");
		return -1;
	}

	// 子プロセスを生成します。
	//    pidには子プロセスの場合は0、親プロセスの場合は子プロセスのプロセスIDが返されます。
	pid = fork();
	if (pid == -1) {
		perror("fork");
		return -1;
	} else if (pid == 0) {
		// child

		// 子プロセスを新たなプロセスグループに移します。
		// 理由はあとでkillを呼ぶときに親プロセスまで巻き添えにしないようにするためです。
		// setpgidを呼ばない場合
		//    プロセスグループA: 親、子、指定したコマンド
		//    kill(プロセスグループA): 親も子もコマンドも全て強制終了してしまう
		// setpgidを呼んだ場合
		//    プロセスグループA: 親
		//    プロセスグループB: 子、指定したコマンド
		//    kill(プロセスグループB): 子とコマンドのみ強制終了
		r = setpgid(0, getpid());
		if (r == -1) {
			perror("setpgrp");
			return -1;
		}

		// 子プロセスの標準出力を閉じ、パイプの書き込み用ファイルディスクリプタを代わりに使います。
		// つまり子プロセスの出力がパイプに書き込まれます。
		r = dup2(pipefd[1], 1);
		if (r == -1) {
			perror("dup(child)");
			return -1;
		}

		// シェルを利用して引数に指定されたコマンドを実行します。
		// シェルを利用する理由はpopenと同じ仕様(コマンド引数を1つの文字列で渡す)にしたいからです。
		// シェルを挟まない場合は、複数の文字列に分割して渡す必要があります。
		r = execl("/bin/sh", "sh", "-c", cmdline, (char *)NULL);
		if (r == -1) {
			perror("execl(child)");
			return -1;
		}

		// not reach here
		return -1;
	}

	// parent

	// パイプから読みだすと子プロセスが標準出力に出そうとした文字列が読める
	char buf[10];
	memset(buf, 0, sizeof(buf));
	fread(buf, 1, sizeof(buf) - 1, fp);

	printf("read from pipe: %s\n", buf);

	printf("sleep 5\n");
	sleep(5);

	// 子プロセスのプロセスグループを取得します。
	//    pidには子プロセスのプロセスIDが返されます。
	//    forkの部分も参照してください。
	printf("getpgid() pid:%d\n", (int)pid);
	pgrp = getpgid(pid);
	if (pgrp == -1) {
		perror("getpgid");
		return -1;
	}

	// 子プロセスのプロセスグループを強制終了します。
	printf("kill(SIGTERM) pgrp:%d\n", (int)pgrp);
	r = kill(-pgrp, SIGTERM);
	if (r == -1) {
		perror("killpg");
		return -1;
	}

	// 子プロセスが終了するまで待ちます。
	printf("wait child pid:%d\n", (int)pid);
	int wstat;
	r = waitpid(-pid, &wstat, 0);
	if (r == -1) {
		perror("waitpid");
		return -1;
	}
	if (r != pid) {
		fprintf(stderr, "kill %d but terminated pid %d, why?\n", (int)pid, (int)r);
	}

	printf("done!!\n");

	return 0;
}

そこそこ長いですね。

簡単な解説

コードを見ると目がチカチカする方向けにコメントだけ抜き出しました。動きが分かりやすいと思います。

  • pipe2: パイプを作成します。パイプに読み書きするファイルディスクリプタ(pipefd)2つが返されます。pipefd[0] が読み出し用、pipefd[1] が書き込み用です。
  • fdopen: ファイルディスクリプタをFILE * でラップします。popenはFILE * を返すインタフェースなので、それに合わせるためです。
  • fork: 子プロセスを生成します。

子プロセスはこんな動きです。

  • setpgid: 子プロセスを新たなプロセスグループに移します。理由はあとでkillを呼ぶときに親プロセスまで巻き添えにしないようにするためです。
  • dup2: 子プロセスの標準出力を閉じ、パイプの書き込み用ファイルディスクリプタを代わりに使います。つまり子プロセスの出力がパイプに書き込まれます。
  • execl: シェルを利用して引数に指定されたコマンドを実行します。シェルを利用する理由はpopenと同じ仕様(コマンド引数を1つの文字列で渡す)にしたいからです。シェルを挟まない場合は、複数の文字列に分割して渡す必要があります。

親プロセスはこんな動きです。

  • getpgid: 子プロセスのプロセスグループを取得します。
  • kill: 子プロセスのプロセスグループを強制終了します。
  • waitpid: 子プロセスが終了するまで待ちます。

プロセスの親子関係はこうなります。

プロセスの親子関係
|-a.out,536208 yes
|   `-sh,536209 -c yes
|       `-yes,536210

もしコマンドがさらに孫、ひ孫プロセスを生成しても、プロセスグループが一緒である限りkillが効くはずです。

残っている改善点

今回紹介した実装はpopenの完全な上位互換ではありません。理由としては入力側を扱えないこと、popenのようなAPIとして使えないこと、が挙げられますが、拡張は容易だと思います。

編集者:すずき(2023/08/10 01:48)

コメント一覧

  • コメントはありません。
open/close この記事にコメントする



link もっと前
2022年10月31日 >>> 2022年10月31日
link もっと後

管理用メニュー

link 記事を新規作成

<2022>
<<<10>>>
------1
2345678
9101112131415
16171819202122
23242526272829
3031-----

最近のコメント5件

  • link 24年10月1日
    すずきさん (10/06 03:41)
    「xrdpで十分動作しているので、Wayl...」
  • link 24年10月1日
    hdkさん (10/03 19:05)
    「GNOMEをお使いでしたら今はWayla...」
  • link 24年10月1日
    すずきさん (10/03 10:12)
    「私は逆にVNCサーバーに繋ぐ使い方をした...」
  • link 24年10月1日
    hdkさん (10/03 08:30)
    「おー、面白いですね。xrdpはすでに立ち...」
  • link 14年6月13日
    2048player...さん (09/26 01:04)
    「最後に、この式を出すのに紙4枚(A4)も...」

最近の記事3件

  • link 24年10月28日
    すずき (10/30 23:49)
    「[Linuxからリモートデスクトップ] 目次: Linux開発用のLinuxマシンの画面を見るにはいろいろな手段がありますが、...」
  • link 23年4月10日
    すずき (10/30 23:46)
    「[Linux - まとめリンク] 目次: Linux関係の深いまとめリンク。目次: RISC-V目次: ROCK64/ROCK...」
  • link 24年10月24日
    すずき (10/25 02:35)
    「[ONKYOからM-AUDIOのUSB DACへ] 目次: PCかれこれ10年以上(2013年3月16日の日記参照)活躍してく...」
link もっとみる

こんてんつ

open/close wiki
open/close Linux JM
open/close Java API

過去の日記

open/close 2002年
open/close 2003年
open/close 2004年
open/close 2005年
open/close 2006年
open/close 2007年
open/close 2008年
open/close 2009年
open/close 2010年
open/close 2011年
open/close 2012年
open/close 2013年
open/close 2014年
open/close 2015年
open/close 2016年
open/close 2017年
open/close 2018年
open/close 2019年
open/close 2020年
open/close 2021年
open/close 2022年
open/close 2023年
open/close 2024年
open/close 過去日記について

その他の情報

open/close アクセス統計
open/close サーバ一覧
open/close サイトの情報

合計:  counter total
本日:  counter today

link About www.katsuster.net
RDFファイル RSS 1.0

最終更新: 10/30 23:49