edit: fix a bug of "ble/builtin/exit" inside subshells in the EXIT trap

docs/ChangeLog.md

@@ -189,6 +189,7 @@
 - edit (command-help): show source files for functions `#D1779` 7683ab9
 - edit (`ble/builtin/exit`): defer exit in trap handlers (motivated by SuperSandro2000) `#D1782` f62fc04 6fdabf3
   - util (`blehook`): fix a bug that the the hook arguments are lost (reported by SuperSandro2000) `#D1804` 479795d
+  - edit: fix a bug of `ble/builtin/exit` inside subshells in the `EXIT` trap `#D1973` xxxxxxx
 - complete (`source:command/get-desc`): show function location and body `#D1788` 496e798
 - edit (`ble-detach`): prepend a space to `stty sane` for `HISTIGNORE=' *'` `#D1796` 26b532e
 - decode (`bind`): do not treat non-beginning `#` as comments `#D1820` 65c4138

note.txt

@@ -6641,6 +6641,81 @@ bash_tips
     Done (実装ログ)
 -------------------------------------------------------------------------------
 
+2023-02-19
+
+  * edit: EXIT trap の中のサブシェルの中で exit が動作しない [#D1973]
+
+    builtin exit 自体の処理判定が駄目という事。実際に確認してみるとexit 経由で
+    これらの close の処理が呼び出されているので入れ子の exit を実行している事に
+    なっている。入れ子の exit に対する特別の処理を行っている?
+
+    →うーん。これは EXIT の中で exit してしまう駄目な設定を回避する為に使って
+    いる。然し、subshell の中での exit は別に main のシェルを終了させるのに使っ
+    ている物ではないから気にしなくても良い。なので、単に
+    _ble_builtin_trap_processing を確認するだけでなくて BASHPID を記録してそれ
+    から確認する必要がある。もしくは BASH_SUBSHELL の値を確認する。
+
+    a _ble_builtin_trap_processing に BASH_SUBSHELL も一緒に記録する
+
+      _ble_builtin_trap_processing を現在のどの様に使っているか確認する。現在は
+      _ble_builtin_trap_processing には基本的には sig の番号を入れているが、特
+      別に exit:* という値を設定している。値を使っている箇所は実は exit:* かど
+      うかの判定を行っている所しかない様だ (+ 値が "exit:xxx" の時 trap
+      postproc に ble/builtin/exit xxx を設定している)。つまり、sig の値を使っ
+      ている箇所は存在しない?
+
+    取り敢えず _ble_builtin_trap_processing に BASH_SUBSHELL を入れる事にした。
+
+    * exit の判定条件はどの様にするのが良いか
+
+      現在の判定には subshell で実行しているかどうか、attach しているかどうか、
+      trap を処理中かどうかという三要素を使っている。
+
+      attach していない時に関しては、trap 処理中でなければそのまま exit してい
+      る。trap 処理中の時には DEBUG を用いて上まで bubble する様にしている。先
+      ず、何故 trap 処理中には bubble を行うのかという事。いきなり終了では駄目
+      なのだろうか。うーん。でもやはり trap 処理中であれば trap handling の途中
+      で勝手に終了されては困るという事だろう。
+
+      だとすると trap を処理しているサブシェルよりも更に下のサブシェルにいる時
+      には普通に builtin exit して良いという事になる。
+
+      つまり以下で良い様な気がする。
+
+      if (trap processing) {
+        if (trap processing subshell != current subshell)
+          builtin exit
+      } else {
+        if (subshell || unbound)
+          builtin exit
+      }
+
+      % 実は
+      %
+      % if (trap processing subshell != current subshell)
+      %   builtin exit
+      % else if (unbound)
+      %   builtin exit
+      %
+      % で良いのではないか? subshell の中にいて trap の外にいる場合には何れにして
+      % も trap processing subshell ＝ nil ≠ current subshell なので、最初の分岐
+      % に入る。と思ったが、unbound の時には !(trap processing) の時にだけ
+      % builtin exit したい。!(trap processing) かつ unbound の時は最初の分岐に入
+      % るが、(trap processing) かつシェルレベルが同じの時には、やはり強制的に
+      % exit する訳には行かない。
+
+      改めて整理する。builtin exit せずに特別な処理を実行する必要があるのは、
+      (1) trap processing を top レベルで処理する為 (2) 実際に抜けようとする時
+      に job 等のチェックをする為。の二種類がある。(1) の処理に関しては同じサブ
+      シェルの trap でなければ必要ない。(2) の処理に関してはトップレベルのシェ
+      ルでかつ attach しているという事。従来の判定は単に ¬(1)∧¬(2) を書き下
+      しただけの話である。という事で (1) の条件を更新すれば良いだけ。
+
+    実装した。動作確認する。ちゃんとその場で終了している。OK
+
+    histdb/sqlite3.kill の方は実は exit ではなくて単に return を呼び出しておけ
+    ば良いのでその様に修正しておく。
+
 2023-02-18
 
   * 2022-10-02 prompt: 実行直前の rps1 の更新時にカーソル位置がずれる [#D1972]
@@ -6842,6 +6917,28 @@ bash_tips
 
       ここは c の方針で良い気がする。実装した。
 
+    2023-02-19 うーん。プロセスが残る様になってしまっている。また、tty が閉じら
+    れるのに時間がかかる様になっている。これも何れかのプロセスが fd を掴んだま
+    ま残っているのが原因である。
+
+    どうも sqlite3.kill のプロセスがやはり残留してしまっている。
+
+    % * ble/bin/msleep が固まって動かなくなるのが原因のようだ。msleep の実装は
+    %   run/$$.util.msleep.pipe に対する fd を用いた物だが、もしかするとこの
+    %   pipe ファイルが削除されると動かないのかもしれない。或いは、この fd を開
+    %   いているプロセスが2つ以上ないとだめという事なのかもしれない。一応最初の
+    %   msleep は動作しているので、サブシェルでは msleep は使えないとかそういう
+    %   問題ではない筈である。
+    % →これを ble/bin/sleep に変えても元の問題は直らなかったし、逆に本体の問題
+    %   を解決したら別に msleep でもちゃんと動いた。
+
+    然し、msleep を ble/bin/sleep に置き換えてもやはり暫くプロセスが生きている
+    様である。exit を builtin exit に変更したらちゃんと動く様になった。
+
+    これは ble/builtin/exit の問題なので別項目で議論する (#D1973)。そもそも実は
+    ここでは exit よりも return を使うべきなので、ここは単に return に変更する
+    事にする。動作している。
+
 2023-02-14
 
   * make: no-argument return がまたある。make scan でチェックするべき [#D1970]

src/edit.sh

@@ -5926,7 +5926,12 @@ function ble/builtin/exit/.read-arguments {
 }
 function ble/builtin/exit {
   local ext=$?
-  if [[ ! $_ble_builtin_trap_processing ]] && { ble/util/is-running-in-subshell || [[ $_ble_decode_bind_state == none ]]; }; then
+
+  # 現在、同じ(サブ)シェルでの trap 処理実行中かどうか
+  local trap_processing=$_ble_builtin_trap_processing
+  [[ $_ble_builtin_trap_processing != "${BASH_SUBSHELL:-0}"/* ]] && trap_processing=
+
+  if [[ ! $trap_processing ]] && { ble/util/is-running-in-subshell || [[ $_ble_decode_bind_state == none ]]; }; then
     (($#)) || set -- "$ext"
     builtin exit "$@"
     return "$?" # オプションの指定間違いなどで失敗する可能性がある。
@@ -5943,7 +5948,7 @@ function ble/builtin/exit {
   fi
   ((${#opt_args[@]})) || ble/array#push opt_args "$ext"
 
-  if [[ $_ble_builtin_trap_processing ]]; then
+  if [[ $trap_processing ]]; then
     # Note #D1782: trap の中で処理している時は exit は trap の側で処理する。な
     # ので exit は延期して一旦元の呼び出し元まで戻る。これによって細かな動作の
     # 違いが問題になる可能性はある。例えば trap の中で time で時間計測中だった
@@ -6370,10 +6375,12 @@ function ble-edit/exec:gexec/.TRAPDEBUG {
         shopt -q extdebug || postproc='return 0' ;;
       (' blehook/invoke.sandbox blehook/invoke ble/builtin/trap/.handler '*)
 
-        # Rewrite variables declared for the other signal
-        # (_ble_builtin_trap_processing is already removed above).
-        _ble_local_ext=$_ble_edit_exec_TRAPDEBUG_EXIT                    # declared in blehook/invoke for the other signal
-        _ble_builtin_trap_processing=exit:$_ble_edit_exec_TRAPDEBUG_EXIT # declared in ble/builtin/trap/.handler for the other signal
+        # Rewrite variables declared for the other signal (Note: the local
+        # _ble_builtin_trap_processing is already removed above).
+        # The following is declared in "blehook/invoke" for the other signal.
+        _ble_local_ext=$_ble_edit_exec_TRAPDEBUG_EXIT
+        # The following is declared in "ble/builtin/trap/.handler" for the other signal.
+        _ble_builtin_trap_processing=${_ble_builtin_trap_processing%%/*}/exit:$_ble_edit_exec_TRAPDEBUG_EXIT
 
         postproc='ble/util/setexit 2'
         shopt -q extdebug || postproc='return 0' ;;

src/util.hook.sh

@@ -838,7 +838,20 @@ function ble/builtin/trap/invoke {
   return 0
 } 3>&2 2>/dev/null # set -x 対策 #D0930
 
-_ble_builtin_trap_processing= # ble/builtin/trap/.handler 実行中かどうか
+## @var _ble_builtin_trap_processing
+##   ble/builtin/trap/.handler 実行中かどうかを表すローカル変数です。
+##   以下の二つの形式の内のどちらかを取ります。
+##
+##   SUBSHELL/SIG
+##     SUBSHELL は trap 処理の実行元のサブシェルの深さ (呼び出し元にお
+##     ける BASH_SUBSHELL の値) を記録します。SIG はシグナルを表す整数
+##     値です。
+##
+##   SUBSHELL/exit:EXIT
+##     EXIT は ble/builtin/exit に渡された終了ステータスで、これは最終
+##     的な exit で使われる終了ステータスです。
+##
+_ble_builtin_trap_processing=
 _ble_builtin_trap_postproc=()
 _ble_builtin_trap_lastarg=()
 function ble/builtin/trap/install-hook/.compose-trap_command {
@@ -888,7 +901,7 @@ function ble/builtin/trap/.handler {
     fi
   fi
 
-  local _ble_builtin_trap_processing=$_ble_trap_sig
+  local _ble_builtin_trap_processing=${BASH_SUBSHELL:-0}/$_ble_trap_sig
   _ble_builtin_trap_lastarg[_ble_trap_sig]=$_ble_trap_lastarg
   _ble_builtin_trap_postproc[_ble_trap_sig]="ble/util/setexit $_ble_trap_lastexit"
 
@@ -948,8 +961,8 @@ function ble/builtin/trap/.handler {
   fi
 
   # 何処かの時点で exit が要求された場合
-  if [[ $_ble_builtin_trap_processing == exit:* && ${_ble_builtin_trap_postproc[_ble_trap_sig]} != 'ble/builtin/exit '* ]]; then
-    _ble_builtin_trap_postproc[_ble_trap_sig]="ble/builtin/exit ${_ble_builtin_trap_processing#exit:}"
+  if [[ $_ble_builtin_trap_processing == */exit:* && ${_ble_builtin_trap_postproc[_ble_trap_sig]} != 'ble/builtin/exit '* ]]; then
+    _ble_builtin_trap_postproc[_ble_trap_sig]="ble/builtin/exit ${_ble_builtin_trap_processing#*/exit:}"
   fi
 
   # Note #D1757: 現在 eval が終わった後の $_ を設定する為には eval に