确保只有一个 Bash 脚本实例正在运行的最佳方法是什么？ [复制]

Question

确保给定脚本只有一个实例正在运行的最简单/最佳方法是什么 - 假设它是 Linux 上的 Bash？

目前我正在做：

ps -C script.name.sh > /dev/null 2>&1 || ./script.name.sh

但它有几个问题：

1. 它将检查置于脚本之外
2. 它不允许我从不同的帐户运行相同的脚本 - 我有时会这样做。
3. -C 只检查进程名称的前 14 个字符

当然，我可以编写自己的 pidfile 处理，但我觉得应该有一个简单的方法来做到这一点。

Answer 1

建议锁定已经使用了很长时间，并且可以在 bash 脚本中使用。我更喜欢简单的flock（来自util-linux[-ng]）而不是lockfile（来自procmail）。并且永远记住那些脚本中的退出陷阱（sigspec == EXIT 或 0，捕获特定信号是多余的）。

2009 年，我发布了我的可锁定脚本样板（最初可在我的 wiki 页面上找到，现在以 gist 的形式提供）。将其转换为每个用户一个实例是微不足道的。使用它，您还可以轻松地为需要锁定或同步的其他场景编写脚本。

为了您的方便，这里是提到的样板。

#!/bin/bash
# SPDX-License-Identifier: MIT

## Copyright (C) 2009 Przemyslaw Pawelczyk <przemoc@gmail.com>
##
## This script is licensed under the terms of the MIT license.
## https://opensource.org/licenses/MIT
#
# Lockable script boilerplate

### HEADER ###

LOCKFILE="/var/lock/`basename $0`"
LOCKFD=99

# PRIVATE
_lock()             { flock -$1 $LOCKFD; }
_no_more_locking()  { _lock u; _lock xn && rm -f $LOCKFILE; }
_prepare_locking()  { eval "exec $LOCKFD>\"$LOCKFILE\""; trap _no_more_locking EXIT; }

# ON START
_prepare_locking

# PUBLIC
exlock_now()        { _lock xn; }  # obtain an exclusive lock immediately or fail
exlock()            { _lock x; }   # obtain an exclusive lock
shlock()            { _lock s; }   # obtain a shared lock
unlock()            { _lock u; }   # drop a lock

### BEGIN OF SCRIPT ###

# Simplest example is avoiding running multiple instances of script.
exlock_now || exit 1

# Remember! Lock file is removed when one of the scripts exits and it is
#           the only script holding the lock or lock is not acquired at all.

Answer 2

如果所有用户的脚本都相同，您可以使用lockfile 方法。如果您获得了锁，则继续，否则显示一条消息并退出。

举个例子：

[Terminal #1] $ lockfile -r 0 /tmp/the.lock
[Terminal #1] $ 

[Terminal #2] $ lockfile -r 0 /tmp/the.lock
[Terminal #2] lockfile: Sorry, giving up on "/tmp/the.lock"

[Terminal #1] $ rm -f /tmp/the.lock
[Terminal #1] $ 

[Terminal #2] $ lockfile -r 0 /tmp/the.lock
[Terminal #2] $ 

在获得/tmp/the.lock 后，您的脚本将是唯一有权执行的脚本。完成后，只需卸下锁即可。在脚本形式中，这可能看起来像：

#!/bin/bash

lockfile -r 0 /tmp/the.lock || exit 1

# Do stuff here

rm -f /tmp/the.lock

Answer 3

我认为flock 可能是最简单（也是最令人难忘）的变体。我在 cron 作业中使用它来自动编码 dvds 和 cds

# try to run a command, but fail immediately if it's already running
flock -n /var/lock/myjob.lock   my_bash_command

使用-w 进行超时或省略选项以等待锁定被释放。最后，手册页显示了一个很好的多命令示例：

   (
     flock -n 9 || exit 1
     # ... commands executed under lock ...
   ) 9>/var/lock/mylockfile

Answer 4

使用 bash set -o noclobber 选项并尝试覆盖公共文件。

当flock 不可用或不适用时，这种“bash 友好”技术将很有用。

一个简短的例子

if ! (set -o noclobber ; echo > /tmp/global.lock) ; then
    exit 1  # the global.lock already exists
fi

# ... remainder of script ...

---

一个更长的例子

此示例将等待global.lock 文件，但时间过长后超时。

 function lockfile_waithold()
 {
    declare -ir time_beg=$(date '+%s')
    declare -ir time_max=7140  # 7140 s = 1 hour 59 min.
 
    # poll for lock file up to ${time_max}s
    # put debugging info in lock file in case of issues ...
    while ! \
       (set -o noclobber ; \
        echo -e "DATE:$(date)\nUSER:$(whoami)\nPID:$$" > /tmp/global.lock \ 
       ) 2>/dev/null
    do
        if [ $(($(date '+%s') - ${time_beg})) -gt ${time_max} ] ; then
            echo "Error: waited too long for lock file /tmp/global.lock" 1>&2
            return 1
        fi
        sleep 1
    done
 
    return 0
 }
 
 function lockfile_release()
 {
    rm -f /tmp/global.lock
 }
 
 if ! lockfile_waithold ; then
      exit 1
 fi
 trap lockfile_release EXIT
 
 # ... remainder of script ...

这在 Ubuntu 16 主机上可靠地为我工作，该主机具有多个使用相同系统范围“锁定”文件的 bash 脚本实例。

（这类似于@Barry Kelly 的this post，后来才注意到。）

Answer 5

我在 procmail 包依赖项中找到了这个：

apt install liblockfile-bin

运行： dotlockfile -l file.lock

file.lock 将被创建。

解锁： dotlockfile -u file.lock

使用它来列出这个包文件/命令： dpkg-query -L liblockfile-bin

Answer 6

我不确定是否有任何可靠的单行解决方案， 所以你最终可能会自己动手。

锁文件并不完美，但不如使用 'ps | grep | grep -v' 管道。

话虽如此，您可能会考虑保持过程控制 与您的脚本分开 - 有一个启动脚本。 或者，至少将其分解为保存在单独文件中的函数， 所以你可能在调用者脚本中有：

. my_script_control.ksh

# Function exits if cannot start due to lockfile or prior running instance.
my_start_me_up lockfile_name;
trap "rm -f $lockfile_name; exit" 0 2 3 15

在每个需要控制逻辑的脚本中。 trap 确保在调用者退出时删除锁定文件， 因此您不必在脚本中的每个退出点都编写此代码。

使用单独的控制脚本意味着您可以对边缘情况进行健全性检查： 删除过时的日志文件，验证锁定文件是否正确关联 当前正在运行的脚本实例，提供终止正在运行的进程的选项，等等。 这也意味着您有更好的机会在ps 输出上成功使用grep。 ps-grep 可用于验证锁定文件是否有与之关联的正在运行的进程。 也许您可以以某种方式命名您的锁定文件以包含有关该过程的信息： user、pid等，后面的脚本调用可以使用这些来决定进程是否 创建锁文件的那个还在。

Answer 7

第一个测试示例

[[ $(lsof -t $0| wc -l) > 1 ]] && echo "At least one of $0 is running"

第二个测试示例

currsh=$0
currpid=$$
runpid=$(lsof -t $currsh| paste -s -d " ")
if [[ $runpid == $currpid ]]
then
  sleep 11111111111111111
else
  echo -e "\nPID($runpid)($currpid) ::: At least one of \"$currsh\" is running !!!\n"
  false
  exit 1
fi

解释

“lsof -t”列出当前运行的名为“$0”的脚本的所有pid。

命令“lsof”有两个好处。

1. 忽略 vim 等编辑器正在编辑的 pid，因为 vim 会编辑其映射文件，例如“.file.swp”。
2. 忽略当前运行的 shell 脚本派生的 pid，这是大多数“grep”衍生命令无法实现的。使用“pstree -pH pidnum”命令查看当前进程分叉状态的详细信息。

Answer 8

我还建议查看chpst（runit 的一部分）：

chpst -L /tmp/your-lockfile.loc ./script.name.sh

Answer 9

Ubuntu/Debian 发行版具有 start-stop-daemon 工具，其用途与您描述的相同。另请参阅 /etc/init.d/skeleton，了解它如何用于编写启动/停止脚本。

-- 诺亚

Answer 10

一线终极解决方案：

[ "$(pgrep -fn $0)" -ne "$(pgrep -fo $0)" ] && echo "At least 2 copies of $0 are running"

Answer 11

我遇到了同样的问题，并提出了一个使用 lockfile 的 template、一个保存进程 ID 号的 pid 文件和一个 kill -0 $(cat $pid_file) 检查以使中止的脚本不会停止下一次运行。 这会在 /tmp 中创建一个 foobar-$USERID 文件夹，锁定文件和 pid 文件所在的位置。

您仍然可以调用脚本并执行其他操作，只要将这些操作保留在 alertRunningPS 中即可。

#!/bin/bash

user_id_num=$(id -u)
pid_file="/tmp/foobar-$user_id_num/foobar-$user_id_num.pid"
lock_file="/tmp/foobar-$user_id_num/running.lock"
ps_id=$$

function alertRunningPS () {
    local PID=$(cat "$pid_file" 2> /dev/null)
    echo "Lockfile present. ps id file: $PID"
    echo "Checking if process is actually running or something left over from crash..."
    if kill -0 $PID 2> /dev/null; then
        echo "Already running, exiting"
        exit 1
    else
        echo "Not running, removing lock and continuing"
        rm -f "$lock_file"
        lockfile -r 0 "$lock_file"
    fi
}

echo "Hello, checking some stuff before locking stuff"

# Lock further operations to one process
mkdir -p /tmp/foobar-$user_id_num
lockfile -r 0 "$lock_file" || alertRunningPS

# Do stuff here
echo -n $ps_id > "$pid_file"
echo "Running stuff in ONE ps"

sleep 30s

rm -f "$lock_file"
rm -f "$pid_file"
exit 0

Answer 12

我找到了一种非常简单的方法来处理“每个系统一个脚本副本”。 它不允许我从多个帐户运行脚本的多个副本（在标准 Linux 上）。

解决方案：

在脚本的开头，我给出了：

pidof -s -o '%PPID' -x $( basename $0 ) > /dev/null 2>&1 && exit

显然pidof 在以下方面表现出色：

• 它没有像ps -C ...这样的程序名称限制
• 不需要我做grep -v grep（或类似的事情）

而且它不依赖于锁文件，这对我来说是一个很大的胜利，因为对它们进行中继意味着您必须添加对陈旧锁文件的处理——这并不复杂，但如果可以避免的话——为什么不呢？

至于检查“每个正在运行的用户一个脚本副本”，我写了这个，但我对此并不太满意：

(
    pidof -s -o '%PPID' -x $( basename $0 ) | tr ' ' '\n'
    ps xo pid= | tr -cd '[0-9\n]'
) | sort | uniq -d

然后我检查它的输出 - 如果它是空的 - 没有来自同一用户的脚本副本。

Answer 13

来自您的脚本：

ps -ef | grep $0 | grep $(whoami)

Answer 14

这是我们的标准位。它可以从脚本以某种方式死亡而无需清理它的锁定文件来恢复。

如果正常运行，它将进程ID写入锁定文件。如果它在开始运行时发现一个锁定文件，它将从锁定文件中读取进程 ID 并检查该进程是否存在。如果该进程不存在，它将删除陈旧的锁定文件并继续。只有当锁定文件存在并且进程仍在运行时，它才会退出。它在退出时会写一条消息。

# lock to ensure we don't get two copies of the same job
script_name="myscript.sh"
lock="/var/run/${script_name}.pid"
if [[ -e "${lock}" ]]; then
    pid=$(cat ${lock})
    if [[ -e /proc/${pid} ]]; then
        echo "${script_name}: Process ${pid} is still running, exiting."
        exit 1
    else
        # Clean up previous lock file
        rm -f ${lock}
   fi
fi
trap "rm -f ${lock}; exit $?" INT TERM EXIT
# write $$ (PID) to the lock file
echo "$$" > ${lock}