it-swarm-ja.tech

タイムアウト付きのシェル関数を実行する

なぜこれが機能するのか

timeout 10s echo "foo bar" # foo bar

しかし、これはしません

function echoFooBar {
  echo "foo bar"
}

echoFooBar # foo bar

timeout 10s echoFooBar # timeout: failed to run command `echoFooBar': No such file or directory

そして、どうすればそれを機能させることができますか?

53
speendo

timeoutはコマンドであるため、bashシェルのサブプロセスで実行されます。したがって、現在のシェルで定義されている関数にはアクセスできません。

timeoutコマンドは、タイムアウトのサブプロセス(シェルの孫プロセス)として実行されます。

echoはシェル組み込みコマンドであり、別個のコマンドであるため、混乱する可能性があります。

できることは、関数を独自のスクリプトファイルに配置し、chmodを実行可能にして、timeoutで実行することです。

あるいは、サブシェルで関数を実行してフォークし、元のプロセスで進行状況を監視し、時間がかかりすぎる場合はサブプロセスを強制終了します。

43
Douglas Leeder

ダグラス・リーダーが言ったように、シグナルを送るにはタイムアウトのための別のプロセスが必要です。関数をサブシェルにエクスポートし、サブシェルを手動で実行することによる回避策。

export -f echoFooBar
timeout 10s bash -c echoFooBar
38
user3132194

Bashシェルのサブプロセスも起動するインラインの代替手段があります。


timeout 10s bash <<EOT
function echoFooBar {
  echo foo
}

echoFooBar
sleep 20
EOT
22

タイムアウトと同じことを行うことができる関数を作成できますが、他の関数も使用できます。

function run_cmd { 
    cmd="$1"; timeout="$2";
    grep -qP '^\d+$' <<< $timeout || timeout=10

    ( 
        eval "$cmd" &
        child=$!
        trap -- "" SIGTERM 
        (       
                sleep $timeout
                kill $child 2> /dev/null 
        ) &     
        wait $child
    )
}

そして、以下のように実行できます:

run_cmd "echoFooBar" 10

注:ソリューションは私の質問の1つから来ました: bashコマンドおよび関数のタイムアウトを実装するためのエレガントなソリューション

9
Tiago Lopo

既存のスクリプト全体の追加オプションとしてタイムアウトを追加する場合は、timeout-optionのテストを行い、そのオプションなしで自己再帰的に呼び出すことができます。

example.sh:

#!/bin/bash
if [ "$1" == "-t" ]; then
  timeout 1m $0 $2
else
  #the original script
  echo $1
  sleep 2m
  echo YAWN...
fi

タイムアウトなしでこのスクリプトを実行する:

$./example.sh -other_option # -other_option
                            # YAWN...

1分のタイムアウトで実行する:

$./example.sh -t -other_option # -other_option
4
Superole
function foo(){
    for i in {1..100};
    do 
        echo $i;  
        sleep 1;
    done;
}

cat <( foo ) # Will work 
timeout 3 cat <( foo ) # Will Work 
timeout 3 cat <( foo ) | sort # Wont work, As sort will fail 
cat <( timeout 3 cat <( foo ) ) | sort -r # Will Work 
3
Hemant Patel

Tiago Lopoの答えへの私のコメントをより読みやすい形式にする:

最新のサブシェルにタイムアウトを設定する方が読みやすいと思います。この方法では、文字列を評価する必要がなく、お気に入りのエディターでスクリプト全体をシェルとして強調表示できます。 evalを含むサブシェルがシェル関数に生成された後にコマンドを配置します(zshでテスト済みですが、bashで動作するはずです):

timeout_child () {
    trap -- "" SIGTERM
    child=$!
    timeout=$1
    (
            sleep $timeout
            kill $child
    ) &
    wait $child
}

使用例:

( while true; do echo -n .; sleep 0.1; done) & timeout_child 2

そして、この方法は、シェル関数でも動作します(バックグラウンドで実行される場合):

 print_dots () {
     while true
     do
         sleep 0.1
         echo -n .
     done
 }


 > print_dots & timeout_child 2
 [1] 21725
 [3] 21727
 ...................[1]    21725 terminated  print_dots
 [3]  + 21727 done       ( sleep $timeout; kill $child; )
1
TauPan

この1つのライナーは、10秒後にBashセッションを終了します

$ TMOUT=10 && echo "foo bar"
0
Michel Hua

複数の引数を持つコマンドを処理できる@Tiago Lopoの回答を少し変更しています。 TauPanのソリューションもテストしましたが、スクリプトで複数回使用すると動作しませんが、Tiagoのソリューションは動作します。

function timeout_cmd { 
  local arr
  local cmd
  local timeout

  arr=( "[email protected]" )

  # timeout: first arg
  # cmd: the other args
  timeout="${arr[0]}"
  cmd=( "${arr[@]:1}" )

  ( 
    eval "${cmd[@]}" &
    child=$!

    echo "child: $child"
    trap -- "" SIGTERM 
    (       
      sleep "$timeout"
      kill "$child" 2> /dev/null 
    ) &     
    wait "$child"
  )
}

上記の機能をテストするために使用できる完全に機能するスクリプトは次のとおりです。

$ ./test_timeout.sh -h
Usage:
  test_timeout.sh [-n] [-r REPEAT] [-s SLEEP_TIME] [-t TIMEOUT]
  test_timeout.sh -h

Test timeout_cmd function.

Options:
  -n              Dry run, do not actually sleep. 
  -r REPEAT       Reapeat everything multiple times [default: 1].
  -s SLEEP_TIME   Sleep for SLEEP_TIME seconds [default: 5].
  -t TIMEOUT      Timeout after TIMEOUT seconds [default: no timeout].

たとえば、次のように起動します。

$ ./test_timeout.sh -r 2 -s 5 -t 3
Try no: 1
  - Set timeout to: 3
child: 2540
    -> retval: 143
    -> The command timed out
Try no: 2
  - Set timeout to: 3
child: 2593
    -> retval: 143
    -> The command timed out
Done!
#!/usr/bin/env bash

#shellcheck disable=SC2128
SOURCED=false && [ "$0" = "$BASH_SOURCE" ] || SOURCED=true

if ! $SOURCED; then
  set -euo pipefail
  IFS=$'\n\t'
fi

#################### helpers
function check_posint() {
  local re='^[0-9]+$'
  local mynum="$1"
  local option="$2"

  if ! [[ "$mynum" =~ $re ]] ; then
     (echo -n "Error in option '$option': " >&2)
     (echo "must be a positive integer, got $mynum." >&2)
     exit 1
  fi

  if ! [ "$mynum" -gt 0 ] ; then
     (echo "Error in option '$option': must be positive, got $mynum." >&2)
     exit 1
  fi
}
#################### end: helpers

#################### usage
function short_usage() {
  (>&2 echo \
"Usage:
  test_timeout.sh [-n] [-r REPEAT] [-s SLEEP_TIME] [-t TIMEOUT]
  test_timeout.sh -h"
  )
}

function usage() {
  (>&2 short_usage )
  (>&2 echo \
"
Test timeout_cmd function.

Options:
  -n              Dry run, do not actually sleep. 
  -r REPEAT       Reapeat everything multiple times [default: 1].
  -s SLEEP_TIME   Sleep for SLEEP_TIME seconds [default: 5].
  -t TIMEOUT      Timeout after TIMEOUT seconds [default: no timeout].
")
}
#################### end: usage

help_flag=false
dryrun_flag=false
SLEEP_TIME=5
TIMEOUT=-1
REPEAT=1

while getopts ":hnr:s:t:" opt; do
  case $opt in
    h)
      help_flag=true
      ;;    
    n)
      dryrun_flag=true
      ;;
    r)
      check_posint "$OPTARG" '-r'

      REPEAT="$OPTARG"
      ;;
    s)
      check_posint "$OPTARG" '-s'

      SLEEP_TIME="$OPTARG"
      ;;
    t)
      check_posint "$OPTARG" '-t'

      TIMEOUT="$OPTARG"
      ;;
    \?)
      (>&2 echo "Error. Invalid option: -$OPTARG.")
      (>&2 echo "Try -h to get help")
      short_usage
      exit 1
      ;;
    :)
      (>&2 echo "Error.Option -$OPTARG requires an argument.")
      (>&2 echo "Try -h to get help")
      short_usage
      exit 1
      ;;
  esac
done

if $help_flag; then
  usage
  exit 0
fi

#################### utils
if $dryrun_flag; then
  function wrap_run() {
    ( echo -en "[dry run]\\t" )
    ( echo "[email protected]" )
  }
else
  function wrap_run() { "[email protected]"; }
fi

# Execute a Shell function with timeout
# https://stackoverflow.com/a/24416732/2377454
function timeout_cmd { 
  local arr
  local cmd
  local timeout

  arr=( "[email protected]" )

  # timeout: first arg
  # cmd: the other args
  timeout="${arr[0]}"
  cmd=( "${arr[@]:1}" )

  ( 
    eval "${cmd[@]}" &
    child=$!

    echo "child: $child"
    trap -- "" SIGTERM 
    (       
      sleep "$timeout"
      kill "$child" 2> /dev/null 
    ) &     
    wait "$child"
  )
}
####################

function sleep_func() {
  local secs
  local waitsec

  waitsec=1
  secs=$(($1))
  while [ "$secs" -gt 0 ]; do
   echo -ne "$secs\033[0K\r"
   sleep "$waitsec"
   secs=$((secs-waitsec))
  done

}

command=("wrap_run" \
         "sleep_func" "${SLEEP_TIME}"
         )

for i in $(seq 1 "$REPEAT"); do
  echo "Try no: $i"

  if [ "$TIMEOUT" -gt 0 ]; then
    echo "  - Set timeout to: $TIMEOUT"
    set +e
    timeout_cmd "$TIMEOUT" "${command[@]}"
    retval="$?"
    set -e

    echo "    -> retval: $retval"
    # check if (retval % 128) == SIGTERM (== 15)
    if [[ "$((retval % 128))" -eq 15 ]]; then
      echo "    -> The command timed out"
    fi
  else
    echo "  - No timeout"
    "${command[@]}"
    retval="$?"
  fi
done

echo "Done!"

exit 0
0
CristianCantoro