python/invirt/config.py

   1 import json
   2 import os
   3 import re
   4
   5 import yaml
   6 import invirt.common
   7
   8
   9 SRC_PATH    = '/etc/invirt/master.yaml'
  10 SRC_DIRPATH = '/etc/invirt/conf.d'
  11 CACHE_PATH  = '/var/lib/invirt/cache.json'
  12 LOCK_PATH   = '/var/lib/invirt/cache.lock'
  13
  14 def augment(d1, d2):
  15     """
  16     Splice dict-tree d2 into d1.  Return d1.
  17
  18     d2 may be None for an empty dict-tree, because yaml.load produces that.
  19
  20     Example:
  21     >>> d = {'a': {'b': 1}, 'c': 2}
  22     >>> augment(d, {'a': {'d': 3}})
  23     {'a': {'b', 1, 'd': 3}, 'c': 2}
  24     >>> d
  25     {'a': {'b', 1, 'd': 3}, 'c': 2}
  26     """
  27
  28     if d2 is None:
  29         return d1
  30     for k in d2:
  31         if k in d1 and isinstance(d1[k], dict):
  32             augment(d1[k], d2[k])
  33         else:
  34             d1[k] = d2[k]
  35     return d1
  36
  37 def run_parts_list(dirname):
  38     """
  39     Reimplements Debian's run-parts --list.
  40
  41     One difference from run-parts's behavior: run-parts --list /foo/
  42     will give output like /foo//bar, but run_parts_list('/foo/') gives
  43     /foo/bar in deference to Python conventions.
  44
  45     Matches documented behavior of run-parts in debianutils v2.28.2, dated 2007.
  46     """
  47
  48     # From run-parts(8).
  49     lanana_re   = re.compile('^[a-z0-9]+$')
  50     lsb_re      = re.compile('^_?([a-z0-9_.]+-)+[a-z0-9]+$')
  51     deb_cron_re = re.compile('^[a-z0-9][a-z0-9-]*$')
  52     for name in os.listdir(dirname):
  53         if lanana_re.match(name) or lsb_re.match(name) or deb_cron_re.match(name):
  54             yield os.path.join(dirname, name)
  55
  56 def list_files():
  57     yield SRC_PATH
  58     yield from run_parts_list(SRC_DIRPATH)
  59
  60 def load_master():
  61     config = dict()
  62     for filename in list_files():
  63         with open(filename) as f:
  64             augment(config, yaml.load(f, yaml.CSafeLoader))
  65     return config
  66
  67 def get_src_mtime():
  68     return max(max(os.path.getmtime(filename) for filename in list_files()),
  69                os.path.getmtime(SRC_DIRPATH))
  70
  71 def load(force_refresh=False):
  72     """
  73     Try loading the configuration from the faster-to-load JSON cache at
  74     CACHE_PATH.  If it doesn't exist or is outdated, load the configuration
  75     instead from the original YAML file at SRC_PATH and regenerate the cache.
  76     I assume I have the permissions to write to the cache directory.
  77     """
  78
  79     # Namespace container for state variables, so that they can be updated by
  80     # closures.
  81     ns = struct()
  82
  83     if force_refresh:
  84         do_refresh = True
  85     else:
  86         src_mtime = get_src_mtime()
  87         try:
  88             cache_mtime = os.path.getmtime(CACHE_PATH)
  89         except OSError:
  90             do_refresh  = True
  91         else:
  92             do_refresh  = src_mtime + 1 >= cache_mtime
  93
  94         # We chose not to simply say
  95         #
  96         #   do_refresh = src_mtime >= cache_time
  97         #
  98         # because between the getmtime(SRC_PATH) and the time the cache is
  99         # rewritten, the master configuration may have been updated, so future
 100         # checks here would find a cache with a newer mtime than the master
 101         # (and thus treat the cache as containing the latest version of the
 102         # master).  The +1 means that for at least a full second following the
 103         # update to the master, this function will refresh the cache, giving us
 104         # 1 second to write the cache.  Note that if it takes longer than 1
 105         # second to write the cache, then this situation could still arise.
 106         #
 107         # The getmtime calls should logically be part of the same transaction
 108         # as the rest of this function (cache read + conditional cache
 109         # refresh), but to wrap everything in an flock would cause the
 110         # following cache read to be less streamlined.
 111
 112     if not do_refresh:
 113         # Try reading from the cache first.  This must be transactionally
 114         # isolated from concurrent writes to prevent reading an incomplete
 115         # (changing) version of the data (but the transaction can share the
 116         # lock with other concurrent reads).  This isolation is accomplished
 117         # using an atomic filesystem rename in the refreshing stage.
 118         try:
 119             with open(CACHE_PATH) as f:
 120                 ns.cfg = json.read(f.read())
 121         except:
 122             do_refresh = True
 123
 124     if do_refresh:
 125         # Atomically reload the source and regenerate the cache.  The read and
 126         # write must be a single transaction, or a stale version may be
 127         # written (if another read/write of a more recent configuration
 128         # is interleaved).  The final atomic rename is to keep this
 129         # transactionally isolated from the above cache read.  If we fail to
 130         # acquire the lock, just try to load the master configuration.
 131         try:
 132             with invirt.common.open_locked(LOCK_PATH):
 133                 ns.cfg = load_master()
 134                 try:
 135                     with open(CACHE_PATH + '.tmp', 'w') as f:
 136                         f.write(json.write(ns.cfg))
 137                 except:
 138                     pass # silent failure
 139                 else:
 140                     os.rename(CACHE_PATH + '.tmp', CACHE_PATH)
 141         except IOError:
 142             ns.cfg = load_master()
 143     return ns.cfg
 144
 145 dicts = load()
 146 structs = dicts2struct(dicts, '')