(partially) fixed the mtime comparison logic + comments

[invirt/packages/invirt-base.git] / files / usr / share / python-support / sipb-xen-base / invirt / config.py

diff --git a/files/usr/share/python-support/sipb-xen-base/invirt/config.py b/files/usr/share/python-support/sipb-xen-base/invirt/config.py
index 6d0ab36..cead926 100644 (file)
--- a/files/usr/share/python-support/sipb-xen-base/invirt/config.py
+++ b/files/usr/share/python-support/sipb-xen-base/invirt/config.py
@@ -16,17 +16,35 @@ def load(src_path = default_src_path,
     I assume I have the permissions to write to the cache directory.
     """
 
     I assume I have the permissions to write to the cache directory.
     """
 

-    # Namespace container for various state variables, so that they can be
-    # updated by closures.
+    # Namespace container for state variables, so that they can be updated by
+    # closures.

     ns = struct()
 
     if force_refresh:
         do_refresh = True
     else:
         src_mtime = getmtime(src_path)
     ns = struct()
 
     if force_refresh:
         do_refresh = True
     else:
         src_mtime = getmtime(src_path)

-        try:            cache_mtime   = getmtime(cache_path)
-        except OSError: do_refresh = True
-        else:           do_refresh = src_mtime > cache_mtime
+        try:            cache_mtime = getmtime(cache_path)
+        except OSError: do_refresh  = True
+        else:           do_refresh  = src_mtime + 1 >= cache_mtime
+
+        # We chose not to simply say
+        #
+        #   do_refresh = src_mtime >= cache_time
+        #
+        # because between the getmtime(src_path) and the time the cache is
+        # rewritten, the master configuration may have been updated, so future
+        # checks here would find a cache with a newer mtime than the master
+        # (and thus treat the cache as containing the latest version of the
+        # master).  The +1 means that for at least a full second following the
+        # update to the master, this function will refresh the cache, giving us
+        # 1 second to write the cache.  Note that if it takes longer than 1
+        # second to write the cache, then this situation could still arise.
+        #
+        # The getmtime calls should logically be part of the same transaction
+        # as the rest of this function (cache read + conditional cache
+        # refresh), but to wrap everything in an flock would cause the
+        # following cache read to be less streamlined.

 
     if not do_refresh:
         # Try reading from the cache first.  This must be transactionally
 
     if not do_refresh:
         # Try reading from the cache first.  This must be transactionally