From 6010d7152f42215a72504dfa32e657b900237b1c Mon Sep 17 00:00:00 2001
From: Frederik Hennig <frederik.hennig@fau.de>
Date: Tue, 28 Jan 2025 17:06:51 +0100
Subject: [PATCH] Use a lockfile to restrict concurrent access to the CPU JIT
config file
---
pyproject.toml | 2 +-
src/pystencils/cpu/cpujit.py | 33 ++++++++++++++++++++-------------
2 files changed, 21 insertions(+), 14 deletions(-)
diff --git a/pyproject.toml b/pyproject.toml
index 1f0242786..193253914 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -12,7 +12,7 @@ authors = [
]
license = { file = "COPYING.txt" }
requires-python = ">=3.10"
-dependencies = ["sympy>=1.9,<=1.12.1", "numpy>=1.8.0", "appdirs", "joblib", "pyyaml"]
+dependencies = ["sympy>=1.9,<=1.12.1", "numpy>=1.8.0", "appdirs", "joblib", "pyyaml", "fasteners"]
classifiers = [
"Development Status :: 4 - Beta",
"Framework :: Jupyter",
diff --git a/src/pystencils/cpu/cpujit.py b/src/pystencils/cpu/cpujit.py
index d9a320e76..9d126fee1 100644
--- a/src/pystencils/cpu/cpujit.py
+++ b/src/pystencils/cpu/cpujit.py
@@ -57,6 +57,7 @@ import tempfile
import textwrap
import time
import warnings
+import pathlib
import numpy as np
@@ -122,15 +123,15 @@ def get_configuration_file_path():
# 1) Read path from environment variable if found
if 'PYSTENCILS_CONFIG' in os.environ:
- return os.environ['PYSTENCILS_CONFIG'], True
+ return os.environ['PYSTENCILS_CONFIG']
# 2) Look in current directory for pystencils.json
elif os.path.exists("pystencils.json"):
- return "pystencils.json", True
+ return "pystencils.json"
# 3) Try ~/.pystencils.json
elif os.path.exists(config_path_in_home):
- return config_path_in_home, True
+ return config_path_in_home
else:
- return config_path_in_home, False
+ return config_path_in_home
def create_folder(path, is_file):
@@ -190,16 +191,22 @@ def read_config():
default_config = OrderedDict([('compiler', default_compiler_config),
('cache', default_cache_config)])
- config_path, config_exists = get_configuration_file_path()
+ from fasteners import InterProcessLock
+
+ config_path = pathlib.Path(get_configuration_file_path())
+ config_path.parent.mkdir(parents=True, exist_ok=True)
+
config = default_config.copy()
- if config_exists:
- with open(config_path, 'r') as json_config_file:
- loaded_config = json.load(json_config_file)
- config = recursive_dict_update(config, loaded_config)
- else:
- create_folder(config_path, True)
- with open(config_path, 'w') as f:
- json.dump(config, f, indent=4)
+
+ lockfile = config_path.with_suffix(config_path.suffix + ".lock")
+ with InterProcessLock(lockfile):
+ if config_path.exists():
+ with open(config_path, 'r') as json_config_file:
+ loaded_config = json.load(json_config_file)
+ config = recursive_dict_update(config, loaded_config)
+ else:
+ with open(config_path, 'w') as f:
+ json.dump(config, f, indent=4)
if config['cache']['object_cache'] is not False:
config['cache']['object_cache'] = os.path.expanduser(config['cache']['object_cache']).format(pid=os.getpid())
--
GitLab