Lock files for single instance in Bash Scripting

Introduction

Lock files help make sure only one copy of a script runs at a time. This stops problems from running duplicates.

When you want to prevent a backup script from running twice at once.

To avoid multiple instances of a data processing script running simultaneously.

When a script updates shared resources and must not overlap.

To ensure a scheduled job does not start if the last run is still active.

Syntax

Bash Scripting

#!/bin/bash
LOCKFILE=/tmp/myscript.lock

if [ -e "$LOCKFILE" ]; then
  echo "Script is already running. Exiting."
  exit 1
fi

touch "$LOCKFILE"

# Your script commands here

rm -f "$LOCKFILE"

The lock file is a simple file that marks the script is running.

Check if the lock file exists before starting work.

Examples

Basic lock file check and removal after work.

Bash Scripting

#!/bin/bash
LOCKFILE=/tmp/myscript.lock

if [ -e "$LOCKFILE" ]; then
  echo "Already running."
  exit 1
fi

touch "$LOCKFILE"

# Do work

rm -f "$LOCKFILE"

Using flock for safer locking with file descriptor.

Bash Scripting

#!/bin/bash
LOCKFILE=/tmp/myscript.lock

exec 200>"$LOCKFILE" || exit 1
flock -n 200 || { echo "Script running, exiting."; exit 1; }

# Do work here

# Lock released automatically on script exit

Sample Program

This script creates a lock file to prevent multiple runs. It simulates work with sleep, then removes the lock.

Bash Scripting

#!/bin/bash
LOCKFILE=/tmp/example.lock

if [ -e "$LOCKFILE" ]; then
  echo "Script is already running. Exiting."
  exit 1
fi

touch "$LOCKFILE"

echo "Script started. Doing work..."
sleep 2

echo "Work done."

rm -f "$LOCKFILE"

Important Notes

Always remove the lock file at the end to allow future runs.

If the script crashes, the lock file might stay. You can add checks for stale locks.

Summary

Lock files stop multiple script instances from running at once.

Check for the lock file before starting work.

Remove the lock file when done to allow new runs.

Practice

1. What is the main purpose of using a lock file in a bash script?

easy

A. To prevent multiple instances of the script from running at the same time

B. To speed up the script execution

C. To store user input temporarily

D. To log errors during script execution

Solution

1. Step 1: Understand the role of a lock file

   A lock file is used to signal that a script is already running, preventing duplicates.

2. Step 2: Identify the main purpose

   This prevents multiple script instances from running simultaneously, avoiding conflicts.

3. Final Answer:

   To prevent multiple instances of the script from running at the same time -> Option A

4. Quick Check:

   Lock file purpose = prevent duplicates [OK]

Hint: Lock files stop duplicate script runs quickly [OK]

Common Mistakes:

• Thinking lock files speed up scripts
• Confusing lock files with log files
• Using lock files to store data

2. Which of the following bash commands correctly creates a lock file only if it does not already exist?

easy

A. touch /tmp/myscript.lock

B. echo $$ > /tmp/myscript.lock

C. mkdir /tmp/myscript.lock

D. if [ ! -e /tmp/myscript.lock ]; then touch /tmp/myscript.lock; fi

Solution

1. Step 1: Check for existence before creating

   The command must create the lock file only if it does not exist, so a test with [ ! -e ] is needed.

2. Step 2: Identify the correct syntax

   if [ ! -e /tmp/myscript.lock ]; then touch /tmp/myscript.lock; fi uses an if statement to check and then create the file, which is correct.

3. Final Answer:

   if [ ! -e /tmp/myscript.lock ]; then touch /tmp/myscript.lock; fi -> Option D

4. Quick Check:

   Check existence before touch = if [ ! -e /tmp/myscript.lock ]; then touch /tmp/myscript.lock; fi [OK]

Hint: Use if with [ ! -e ] to create lock file safely [OK]

Common Mistakes:

• Using touch without checking file existence
• Using mkdir which creates a directory, not a file
• Overwriting lock file without check

3. Given this script snippet:

if [ -e /tmp/myscript.lock ]; then
  echo "Script already running"
  exit 1
else
  touch /tmp/myscript.lock
  echo "Running script"
  rm /tmp/myscript.lock
fi

What will be the output if the lock file exists?

medium

A. Running script

B. Script already running

C. No output

D. Error: lock file missing

Solution

1. Step 1: Check the condition when lock file exists

   If /tmp/myscript.lock exists, the if condition is true and the script echoes "Script already running" and exits.

2. Step 2: Understand the output

   Since the script exits early, it does not run or remove the lock file.

3. Final Answer:

   Script already running -> Option B

4. Quick Check:

   Lock file exists = "Script already running" [OK]

Hint: If lock file exists, script exits with message [OK]

Common Mistakes:

• Assuming script runs even if lock file exists
• Expecting no output when lock file exists
• Confusing lock file presence with absence

4. This script is intended to prevent multiple runs using a lock file:

if [ -e /tmp/myscript.lock ]; then
  echo "Already running"
  exit 1
fi

touch /tmp/myscript.lock
# script work here
rm /tmp/myscript.lock

But sometimes multiple instances run simultaneously. What is the likely problem?

medium

A. The lock file is not checked before creation

B. The script does not remove the lock file

C. The lock file is created after the check, causing a race condition

D. The script uses rm instead of rmdir

Solution

1. Step 1: Analyze the timing of lock file creation

   The script checks for the lock file, then creates it. Between these steps, another instance can start and pass the check.

2. Step 2: Identify the race condition

   This gap causes multiple instances to run simultaneously because the lock file is not created atomically with the check.

3. Final Answer:

   The lock file is created after the check, causing a race condition -> Option C

4. Quick Check:

   Race condition from delayed lock creation = The lock file is created after the check, causing a race condition [OK]

Hint: Create lock file atomically to avoid race conditions [OK]

Common Mistakes:

• Ignoring race conditions in lock file creation
• Forgetting to remove lock file after script ends
• Confusing file removal commands

5. You want to write a bash script that runs only one instance at a time using a lock file. Which approach is best to avoid race conditions?

hard

A. Use 'mkdir /tmp/myscript.lock' and check if it succeeds before running

B. Check if lock file exists, then create it with 'touch' if not

C. Create lock file with 'echo $$ > /tmp/myscript.lock' without checking

D. Remove lock file at script start, then create it

Solution

1. Step 1: Understand atomic operations for locking

   Using 'mkdir' to create a directory as a lock is atomic; it either succeeds or fails immediately.

2. Step 2: Compare with other methods

   Other methods like checking then touching can cause race conditions; removing lock at start is unsafe.

3. Final Answer:

   Use 'mkdir /tmp/myscript.lock' and check if it succeeds before running -> Option A

4. Quick Check:

   Atomic mkdir lock = safest method [OK]

Hint: Use mkdir for atomic lock creation to avoid race [OK]

Common Mistakes:

• Using touch without atomic check
• Removing lock file before checking
• Ignoring race conditions