确保一次只运行一个shell脚本实例的快速方法

有什么快速而简单的方法可以确保在给定时间内只有一个shell脚本实例在运行?

当前回答

测试“锁文件”是否存在的简单方法是有缺陷的。

为什么?因为它们不会检查文件是否存在，也不会在单个原子操作中创建文件。因为这个;有一个竞争条件会使你的互斥失败。

相反，您可以使用mkdir。Mkdir创建一个目录，如果它还不存在，如果它存在，它设置一个退出码。更重要的是，它在一个原子动作中完成了所有这些操作，这使得它非常适合这个场景。

if ! mkdir /tmp/myscript.lock 2>/dev/null; then
    echo "Myscript is already running." >&2
    exit 1
fi

有关所有细节，请参阅优秀的BashFAQ: http://mywiki.wooledge.org/BashFAQ/045

如果你想要处理陈旧的锁，fuser(1)会派上用场。唯一的缺点是这个操作大约需要一秒钟，所以它不是即时的。

下面是我曾经写过的一个函数，它使用fuser解决了这个问题:

#       mutex file
#
# Open a mutual exclusion lock on the file, unless another process already owns one.
#
# If the file is already locked by another process, the operation fails.
# This function defines a lock on a file as having a file descriptor open to the file.
# This function uses FD 9 to open a lock on the file.  To release the lock, close FD 9:
# exec 9>&-
#
mutex() {
    local file=$1 pid pids 

    exec 9>>"$file"
    { pids=$(fuser -f "$file"); } 2>&- 9>&- 
    for pid in $pids; do
        [[ $pid = $$ ]] && continue

        exec 9>&- 
        return 1 # Locked by a pid.
    done 
}

你可以像这样在脚本中使用它:

mutex /var/run/myscript.lock || { echo "Already running." >&2; exit 1; }

如果您不关心可移植性(这些解决方案应该适用于几乎任何UNIX机器)，Linux的fuser(1)提供了一些额外的选项，还有flock(1)。

2009-04-08 20:16:28

其他回答

下面这一行的回答来自一个与Ask Ubuntu问答相关的人:

[ "${FLOCKER}" != "$0" ] && exec env FLOCKER="$0" flock -en "$0" "$0" "$@" || :
#     This is useful boilerplate code for shell scripts.  Put it at the top  of
#     the  shell script you want to lock and it'll automatically lock itself on
#     the first run.  If the env var $FLOCKER is not set to  the  shell  script
#     that  is being run, then execute flock and grab an exclusive non-blocking
#     lock (using the script itself as the lock file) before re-execing  itself
#     with  the right arguments.  It also sets the FLOCKER env var to the right
#     value so it doesn't run again.

2018-03-17 15:54:09

if [ 1 -ne $(/bin/fuser "$0" 2>/dev/null | wc -w) ]; then
    exit 1
fi

2015-11-30 13:30:01

现有的答案要么依赖于CLI实用程序群，要么没有正确地保护锁文件。flock实用程序在所有非linux系统(即FreeBSD)上都不可用，在NFS上也不能正常工作。

在我从事系统管理和系统开发的早期，有人告诉我，一种安全且相对可移植的创建锁文件的方法是使用mkemp(3)或mkemp(1)创建临时文件，将标识信息写入临时文件(即PID)，然后将临时文件硬链接到锁文件。如果链接成功，那么您已经成功地获得了锁。

当在shell脚本中使用锁时，我通常会在共享概要文件中放置一个obtain_lock()函数，然后从脚本中获取它。下面是一个lock函数的例子:

obtain_lock()
{
  LOCK="${1}"
  LOCKDIR="$(dirname "${LOCK}")"
  LOCKFILE="$(basename "${LOCK}")"

  # create temp lock file
  TMPLOCK=$(mktemp -p "${LOCKDIR}" "${LOCKFILE}XXXXXX" 2> /dev/null)
  if test "x${TMPLOCK}" == "x";then
     echo "unable to create temporary file with mktemp" 1>&2
     return 1
  fi
  echo "$$" > "${TMPLOCK}"

  # attempt to obtain lock file
  ln "${TMPLOCK}" "${LOCK}" 2> /dev/null
  if test $? -ne 0;then
     rm -f "${TMPLOCK}"
     echo "unable to obtain lockfile" 1>&2
     if test -f "${LOCK}";then
        echo "current lock information held by: $(cat "${LOCK}")" 1>&2
     fi
     return 2
  fi
  rm -f "${TMPLOCK}"

  return 0;
};

lock功能的使用示例如下:

#!/bin/sh

. /path/to/locking/profile.sh
PROG_LOCKFILE="/tmp/myprog.lock"

clean_up()
{
  rm -f "${PROG_LOCKFILE}"
}

obtain_lock "${PROG_LOCKFILE}"
if test $? -ne 0;then
   exit 1
fi
trap clean_up SIGHUP SIGINT SIGTERM

# bulk of script

clean_up
exit 0
# end of script

记住在脚本中的任何退出点调用clean_up。

我在Linux和FreeBSD环境中都使用了上述方法。

2017-05-31 23:11:33

我发现bmdhack的解决方案是最实用的，至少对我的用例来说是这样。使用flock和lockfile依赖于在脚本终止时使用rm删除lockfile，这不能总是得到保证(例如，kill -9)。

关于bmdhack的解决方案，我要改变一件小事:它强调删除锁文件，但没有说明这对于这个信号量的安全工作是不必要的。他使用kill -0来确保死进程的旧锁文件将被忽略/覆盖。

因此，我的简化解决方案是简单地将以下内容添加到单例的顶部:

## Test the lock
LOCKFILE=/tmp/singleton.lock 
if [ -e ${LOCKFILE} ] && kill -0 `cat ${LOCKFILE}`; then
    echo "Script already running. bye!"
    exit 
fi

## Set the lock 
echo $$ > ${LOCKFILE}

当然，这个脚本仍然有一个缺陷，即可能同时启动的进程存在竞争风险，因为锁定测试和设置操作不是单个原子动作。但是lhunath提出的使用mkdir的解决方案有一个缺陷，即被杀死的脚本可能会留下目录，从而阻止其他实例运行。

2011-01-14 08:46:30