Skip to main content

Resource lock manager for coordinating shared system resources (GPU VRAM, RAM, CPU) across processes

Project description

reslock

Resource lock manager for coordinating shared system resources (GPU VRAM, RAM, CPU cores) across multiple processes on a single machine.

Problem

Multiple GPU-consuming processes (llama.cpp, whisper, vLLM, training jobs) compete for limited resources — especially VRAM. Without coordination, they OOM or degrade each other.

How it works

  • All coordination happens through a single JSON state file — no daemon required
  • Processes coordinate via file locking (held only during reads/writes, not for lease duration)
  • Dead processes are automatically cleaned up via PID checking
  • Priority queue determines which waiter gets resources next
  • Reclaimable leases allow loaded models to be preempted by higher-priority work

Install

pip install reslock

Python API

from reslock import ResourcePool

pool = ResourcePool()  # uses ~/.reslock/state.json

# Context manager — blocks until resources are available
with pool.acquire(vram_mb=4000, priority=5, label="whisper") as lease:
    run_whisper(audio_file)

# Non-blocking
lease = pool.try_acquire(vram_mb=4000)
if lease:
    try:
        do_work()
    finally:
        lease.release()

# Async
async with pool.acquire_async(vram_mb=4000) as lease:
    await run_inference()

# Reclaimable lease — can be preempted
lease = pool.acquire(vram_mb=4000, reclaimable=True)
load_model()
# ... later:
if lease.reclaim_requested:
    unload_model()
    lease.release()

# Check status
status = pool.status()
print(status.available)  # free resources

CLI

# Initialize (auto-detects GPU)
reslock init

# Set resources manually
reslock set vram_mb 24000
reslock set gpu_slots 2

# Show status
reslock status

# Run a command with reserved resources
reslock run --vram 4G llama-cli --model model.gguf
reslock run --vram 8G --priority 10 --label "llama-70b" llama-cli ...
reslock run --vram 4G --ram 16G --cpu 4 python train.py

# Manage leases
reslock list
reslock release abc-123
reslock release --label whisper
reslock reset

How resources work

Resources are named quantities with a total capacity. Resource names are arbitrary strings — define whatever you need:

reslock set vram_mb 24000
reslock set ram_mb 65536
reslock set gpu_slots 2

Leases reserve amounts from these pools. When a lease is released (or its process dies), the resources become available again.

Priority queue

When resources aren't immediately available, requests enter a priority queue. Higher priority number = more urgent. Ties are broken by arrival time (FIFO).

Reclaimable leases

A process can mark its lease as reclaimable — "I'm using this, but can give it up if needed." When a higher-priority request needs those resources, reclaim_requested is set to True. The lease holder cooperates by releasing.

Docker

Containers need access to the shared state file. Mount it (and its directory) from the host:

docker run --pid=host \
  -v ~/.reslock:/root/.reslock \
  my-gpu-app
  • --pid=host — Required so the host can check container PIDs for dead-process cleanup. Without it, container PIDs are invisible to the host and leases won't be cleaned up when containers exit.
  • -v ~/.reslock:/root/.reslock — Mounts the state file directory. All containers and the host share the same state.json. The mount path inside the container must match the state_path used by reslock (default: ~/.reslock/state.json).

Multi-user: The state directory is created with mode 1777 (world-writable + sticky bit, like /tmp) and the state file with mode 666, so multiple containers running as different UIDs can share it without permission issues.

If your container runs as a non-root user, mount to that user's home directory instead:

docker run --pid=host \
  -v ~/.reslock:/home/appuser/.reslock \
  my-gpu-app

Or use a custom state path shared between host and containers:

# Both host and container code use the same explicit path
pool = ResourcePool(state_path="/shared/reslock/state.json")
docker run --pid=host \
  -v /shared/reslock:/shared/reslock \
  my-gpu-app

Development

uv venv && uv pip install -e ".[dev]"
pytest
ruff check src/ tests/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reslock-0.2.0.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reslock-0.2.0-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file reslock-0.2.0.tar.gz.

File metadata

  • Download URL: reslock-0.2.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for reslock-0.2.0.tar.gz
Algorithm Hash digest
SHA256 664f1827b3e6f83cbf2b4d9496cc56c5e1d02313729050d081b593f7dbcc638a
MD5 3ed0f28195b0dec1e344357c936d1c71
BLAKE2b-256 916bd86d9468500979a4009d5b516d4ffcf79cd74481f33cd73ad09da676baa7

See more details on using hashes here.

Provenance

The following attestation bundles were made for reslock-0.2.0.tar.gz:

Publisher: publish.yml on mo22/reslock

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file reslock-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: reslock-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for reslock-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a94cd75d68b6e0a9f5120d104ec6c066498da8af48c8aec22a0324a9f3b028d
MD5 89591f24c1319d7da86030ecddb26dca
BLAKE2b-256 ffdbb6f7f9299c75a28ffec76f1ad15aa1a40d3f9a74d0b5c80d2eeed0b4d662

See more details on using hashes here.

Provenance

The following attestation bundles were made for reslock-0.2.0-py3-none-any.whl:

Publisher: publish.yml on mo22/reslock

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page