mlonmcu 0.3.0.dev0__3-none-any.whl

mlonmcu/context/read_write_filelock.py

@@ -0,0 +1,327 @@
+#
+# Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of MLonMCU.
+# See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""
+This file contains read lock and write lock classes based on filelock
+The locks are non-blocking.
+"""
+
+from filelock import FileLock
+import uuid  # this is used to create a identifier for every ReadFileLock and WriteFileLock instance.
+import datetime  # this is used to track the lock actions
+import os
+import yaml
+from pathlib import Path
+import atexit
+
+
+class RWLockTimeout(TimeoutError):
+    """Raised when the lock could not be acquired."""
+
+    def __init__(self, lock) -> None:
+        #: The Read or Write lock instance.
+        self.lock = lock
+
+    def __str__(self) -> str:
+        return f"The lock with id '{self.lock.id}' in env '{self.lock.filepath.parent}' could not be acquired."
+
+
+class ReadFileLock:
+    def __init__(self, filepath):
+        self.filepath = Path(filepath)
+        self.trackfilepath = self.filepath.parent / (str(self.filepath.stem) + "_track")
+        self.lock = FileLock(self.filepath)
+        self.id = str(uuid.uuid4())
+
+    def acquire(self, raise_exception=True):
+        """
+        This function tried to acquire a ReadFileLock.
+        The process is the following:
+        1. acquire filelock
+        2. read the lock occupation situation
+        3. check if the lock is already occupied by another write process
+        4.1. release filelock and raise exception(or return 0) if the lock is already occupied by another write process
+        4.2. otherwise write the updated lock occupation situation back, release filelock and return
+
+            Parameters:
+                raise_exception (bool): whether an exception should be raised when failed (default: True)
+
+            Returns:
+                success (bool): whether succeeded or not.
+                    True means succeeded, False means failed (if the param raiseException is set to False).
+                    A RWLockTimeout exception will be raised if failed (if the param raiseException is set to True).
+        """
+
+        # 1. acquire filelock
+        self.lock.acquire(timeout=2)
+
+        # 2. read the lock occupation situation
+        if not os.path.exists(self.trackfilepath):
+            # create a file to tack the lock occupation situation
+            with open(self.trackfilepath, "w") as track_file:
+                pass
+
+        with open(self.trackfilepath, "r") as stream:
+            # read the current lock occupation situation
+            try:
+                lock_occupy_info = yaml.safe_load(stream) or {}
+            except yaml.YAMLError as exc:
+                print(exc)
+
+        # 3. check if the lock is already occupied by another write process
+        write_occupied = False
+        for k, v in lock_occupy_info.items():
+            if v["type"] == "write":
+                write_occupied = True
+                break
+
+        # 4
+        if write_occupied:
+            lock_acquire_success = False
+            self.lock.release()
+            if raise_exception:
+                raise RWLockTimeout(self)
+        else:
+            time_info = datetime.datetime.now().replace(microsecond=0).isoformat()
+            lock_occupy_info[self.id] = {"time": f"{time_info}", "type": "read"}
+            with open(self.trackfilepath, "w") as track_file:
+                yaml.dump(lock_occupy_info, track_file, default_flow_style=False)
+            lock_acquire_success = True
+
+        self.lock.release()
+        atexit.register(self.release)
+        return lock_acquire_success
+
+    def release(self):
+        """
+        This function releases a ReadFileLock.
+        the process is the following:
+        1. acquire filelock
+        2. read the lock occupation situation
+        3. delete the record of self.id (no exception will be raised if self.id is not found in the record)
+        4. write the updated lock occupation situation back, release filelock and return
+        """
+
+        # 1. acquire filelock
+        self.lock.acquire(timeout=2)
+
+        # 2. read the lock occupation situation
+        if not os.path.exists(self.trackfilepath):
+            # raise error if file does not exist
+            raise RuntimeError("track file for read write log is missing.")
+
+        with open(self.trackfilepath, "r") as stream:
+            # read the current lock occupation situation
+            try:
+                lock_occupy_info = yaml.safe_load(stream) or {}
+            except yaml.YAMLError as exc:
+                print(exc)
+
+        # 3. delete the record of self.id
+        if self.id in lock_occupy_info.keys():
+            lock_occupy_info.pop(self.id)
+
+        # 4. write the updated lock occupation situation back, release filelock and return
+        with open(self.trackfilepath, "w") as track_file:
+            if lock_occupy_info:
+                yaml.dump(lock_occupy_info, track_file, default_flow_style=False)
+
+        self.lock.release()
+
+    @property
+    def is_locked(self):
+        """
+        This property returns if a lock is occupied(locked) by other processes.
+        the process is the following:
+        1. acquire filelock
+        2. read the lock occupation situation
+        3. check if the lock is already occupied(locked) by another write process
+
+            Returns:
+                is_locked (bool): whether the lock is already occupied(locked) by another write process
+        """
+
+        # 1. acquire filelock
+        self.lock.acquire(timeout=2)
+
+        # 2. read the lock occupation situation
+        if not os.path.exists(self.trackfilepath):
+            # create a file to tack the lock occupation situation
+            with open(self.trackfilepath, "w"):
+                pass
+
+        with open(self.trackfilepath, "r") as stream:
+            # read the current lock occupation situation
+            try:
+                lock_occupy_info = yaml.safe_load(stream) or {}
+            except yaml.YAMLError as exc:
+                print(exc)
+
+        # 3. check if the lock is already occupied by another write process
+        write_occupied = False
+        for k, v in lock_occupy_info.items():
+            if v["type"] == "write":
+                write_occupied = True
+                break
+
+        self.lock.release()
+        return write_occupied
+
+
+class WriteFileLock:
+    def __init__(self, filepath):
+        self.filepath = Path(filepath)
+        self.trackfilepath = self.filepath.parent / (str(self.filepath.stem) + "_track")
+        self.lock = FileLock(self.filepath)
+        self.id = str(uuid.uuid4())
+
+    def acquire(self, raise_exception=True):
+        """
+        This function tried to acquire a WriteFileLock.
+        The process is the following:
+        1. acquire filelock
+        2. read the lock occupation situation
+        3. check if the lock is already occupied by another write process
+        4.1. release filelock and raise exception(or return 0) if the lock is already occupied by another write process
+        4.2. otherwise write the updated lock occupation situation back, release filelock and return
+
+            Parameters:
+                raise_exception (bool): whether raises an exception when failed (default: True)
+
+            Returns:
+                success (bool): whether succeeded or not.
+                    True means succeeded, False means failed (if the param raiseException is set to False).
+                    A RWLockTimeout exception will be raised if failed (if the param raiseException is set to True).
+        """
+
+        # 1. acquire filelock
+        self.lock.acquire(timeout=2)
+
+        # 2. read the lock occupation situation
+        if not os.path.exists(self.trackfilepath):
+            # create a file to tack the lock occupation situation
+            with open(self.trackfilepath, "w") as track_file:
+                pass
+
+        with open(self.trackfilepath, "r") as stream:
+            # read the current lock occupation situation
+            try:
+                lock_occupy_info = yaml.safe_load(stream) or {}
+            except yaml.YAMLError as exc:
+                print(exc)
+
+        # 3. check if the lock is already occupied by another process
+        occupied = False
+        for k, v in lock_occupy_info.items():
+            if v["type"] == "write" or "read":
+                occupied = True
+                break
+
+        # 4
+        if occupied:
+            lock_acquire_success = False
+            self.lock.release()
+            if raise_exception:
+                raise RWLockTimeout(self)
+        else:
+            time_info = datetime.datetime.now().replace(microsecond=0).isoformat()
+            lock_occupy_info[self.id] = {"time": f"{time_info}", "type": "write"}
+            with open(self.trackfilepath, "w") as track_file:
+                yaml.dump(lock_occupy_info, track_file, default_flow_style=False)
+            lock_acquire_success = True
+
+        self.lock.release()
+        atexit.register(self.release)
+        return lock_acquire_success
+
+    def release(self):
+        """
+        This function releases a WriteFileLock.
+        the process is the following:
+        1. acquire filelock
+        2. read the lock occupation situation
+        3. delete the record of self.id (no exception will be raised if self.id is not found in the record)
+        4. write the updated lock occupation situation back, release filelock and return
+        """
+
+        # 1. acquire filelock
+        self.lock.acquire(timeout=2)
+
+        # 2. read the lock occupation situation
+        if not os.path.exists(self.trackfilepath):
+            # raise error if file does not exist
+            raise RuntimeError("track file for read write log is missing.")
+
+        with open(self.trackfilepath, "r") as stream:
+            # read the current lock occupation situation
+            try:
+                lock_occupy_info = yaml.safe_load(stream) or {}
+                if lock_occupy_info is None:
+                    lock_occupy_info = {}
+            except yaml.YAMLError as exc:
+                print(exc)
+
+        # 3. delete the record of self.id
+        if self.id in lock_occupy_info.keys():
+            lock_occupy_info.pop(self.id)
+
+        # 4. write the updated lock occupation situation back, release filelock and return
+        with open(self.trackfilepath, "w") as track_file:
+            if lock_occupy_info:
+                yaml.dump(lock_occupy_info, track_file, default_flow_style=False)
+
+        self.lock.release()
+
+    @property
+    def is_locked(self):
+        """
+        This property returns if a lock is occupied(locked) by other processes.
+        the process is the following:
+        1. acquire filelock
+        2. read the lock occupation situation
+        3. check if the lock is already occupied(locked) by another write process
+
+            Returns:
+                is_locked (bool): whether the lock is already occupied(locked) by another write process
+        """
+
+        # 1. acquire filelock
+        self.lock.acquire(timeout=2)
+
+        # 2. read the lock occupation situation
+        if not os.path.exists(self.trackfilepath):
+            # create a file to tack the lock occupation situation
+            with open(self.trackfilepath, "w"):
+                pass
+
+        with open(self.trackfilepath, "r") as stream:
+            # read the current lock occupation situation
+            try:
+                lock_occupy_info = yaml.safe_load(stream) or {}
+            except yaml.YAMLError as exc:
+                print(exc)
+
+        # 3. check if the lock is already occupied by another write process
+        occupied = False
+        for k, v in lock_occupy_info.items():
+            if v["type"] == "write" or "read":
+                occupied = True
+                break
+
+        self.lock.release()
+        return occupied

mlonmcu/environment/__init__.py

@@ -0,0 +1,18 @@
+#
+# Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of MLonMCU.
+# See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#

mlonmcu/environment/config.py

@@ -0,0 +1,214 @@
+#
+# Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of MLonMCU.
+# See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# TODO: rename to paths.py or user.py?
+
+import os
+import xdg
+import logging
+from enum import Enum
+from pathlib import Path
+
+
+def get_config_dir():
+    config_dir = os.path.join(xdg.xdg_config_home(), "mlonmcu")
+    return config_dir
+
+
+def init_config_dir():
+    config_dir = Path(get_config_dir())
+    config_dir.mkdir(parents=True, exist_ok=True)
+    subdirs = ["environments", "models", "plugins"]
+    files = ["environments.ini"]
+    for subdir in subdirs:
+        environments_dir = config_dir / subdir
+        environments_dir.mkdir(exist_ok=True)
+    for file in files:
+        filepath = config_dir / file
+        filepath.touch(exist_ok=True)
+
+
+def get_environments_dir():
+    environments_dir = os.path.join(get_config_dir(), "environments")
+    return environments_dir
+
+
+def get_environments_file():
+    environments_file = os.path.join(get_config_dir(), "environments.ini")
+    return environments_file
+
+
+def get_plugins_dir():
+    environments_dir = os.path.join(get_config_dir(), "plugins")
+    return environments_dir
+
+
+DEFAULTS = {
+    "environment": "default",
+    "template": "default",
+}
+
+env_subdirs = ["deps", "plugins"]
+
+
+# class LogLevel(Enum):
+#     DEBUG = 0
+#     VERBOSE = 1
+#     INFO = 2
+#     WARNING = 3
+#     ERROR = 4
+
+
+class BaseConfig:
+    def __repr__(self):
+        return self.__class__.__name__ + "(" + str(vars(self)) + ")"
+
+
+class DefaultsConfig(BaseConfig):
+    # TODO: loglevels enum
+
+    def __init__(
+        self,
+        log_level=logging.INFO,
+        log_to_file=False,
+        log_rotate=False,
+        default_framework=None,
+        default_backends={},
+        default_target=None,
+        cleanup_auto=False,
+        cleanup_keep=100,
+    ):
+        self.log_level = log_level
+        self.log_to_file = log_to_file
+        self.log_rotate = log_rotate
+        self.default_framework = default_framework
+        self.default_backends = default_backends
+        self.default_target = default_target
+        self.cleanup_auto = cleanup_auto
+        self.cleanup_keep = cleanup_keep
+
+
+class PathConfig(BaseConfig):
+    def __init__(self, path, base=None):
+        if isinstance(path, str):
+            self.path = Path(path)
+        else:
+            self.path = path
+        if isinstance(base, str):
+            self.base = Path(base)
+        else:
+            self.base = base
+        if base:
+            if not self.path.is_absolute():
+                assert base is not None
+                self.path = self.base / self.path
+        # Resolve symlinks
+        self.path = self.path.resolve()
+
+    def __repr(self):
+        return f"PathConfig({self.path})"
+
+
+class RepoConfig(BaseConfig):
+    def __init__(self, url, ref=None):
+        self.url = url
+        self.ref = ref
+
+
+class BackendConfig(BaseConfig):
+    def __init__(self, name, enabled=True, features={}):
+        self.name = name
+        self.enabled = enabled
+        self.features = features
+
+
+class FeatureKind(Enum):
+    UNKNOWN = 0
+    FRAMEWORK = 1
+    BACKEND = 2
+    TARGET = 3
+    FRONTEND = 4
+
+
+class FeatureConfig:
+    def __init__(self, name, kind=FeatureKind.UNKNOWN, supported=True):
+        self.name = name
+        self.supported = supported
+
+    def __repr__(self):
+        return self.__class__.__name__ + "(" + str(vars(self)) + ")"
+
+
+class FrameworkFeatureConfig(FeatureConfig):
+    def __init__(self, name, framework, supported=True):
+        super().__init__(name=name, kind=FeatureKind.FRONTEND, supported=supported)
+        self.framework = framework
+
+
+class BackendFeatureConfig(FeatureConfig):
+    def __init__(self, name, backend, supported=True):
+        super().__init__(name=name, kind=FeatureKind.FRONTEND, supported=supported)
+        self.backend = backend
+
+
+class PlatformFeatureConfig(FeatureConfig):
+    def __init__(self, name, platform, supported=True):
+        super().__init__(name=name, kind=FeatureKind.TARGET, supported=supported)
+        self.platform = platform
+
+
+class TargetFeatureConfig(FeatureConfig):
+    def __init__(self, name, target, supported=True):
+        super().__init__(name=name, kind=FeatureKind.TARGET, supported=supported)
+        self.target = target
+
+
+class FrontendFeatureConfig(FeatureConfig):
+    def __init__(self, name, frontend, supported=True):
+        super().__init__(name=name, kind=FeatureKind.FRONTEND, supported=supported)
+        self.frontend = frontend
+
+
+class FrameworkConfig(BaseConfig):
+    def __init__(self, name, enabled=True, backends={}, features={}):
+        self.name = name
+        self.enabled = enabled
+        self.backends = backends
+        self.features = features
+
+
+class FrontendConfig(BaseConfig):
+    def __init__(self, name, enabled=True, features={}):
+        self.name = name
+        self.enabled = enabled
+        self.features = features
+
+
+class PlatformConfig(BaseConfig):
+    def __init__(self, name, enabled=True, features={}):
+        self.name = name
+        self.enabled = enabled
+        self.features = features
+
+
+class TargetConfig(BaseConfig):
+    def __init__(self, name, enabled=True, features={}):
+        self.name = name
+        self.enabled = enabled
+        self.features = features