services/fuse/arvados_fuse/fresh.py

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 import time
   6 import ciso8601
   7 import calendar
   8 import functools
   9
  10 def convertTime(t):
  11     """Parse Arvados timestamp to unix time."""
  12     if not t:
  13         return 0
  14     try:
  15         return calendar.timegm(ciso8601.parse_datetime_unaware(t).timetuple())
  16     except (TypeError, ValueError):
  17         return 0
  18
  19 def use_counter(orig_func):
  20     @functools.wraps(orig_func)
  21     def use_counter_wrapper(self, *args, **kwargs):
  22         try:
  23             self.inc_use()
  24             return orig_func(self, *args, **kwargs)
  25         finally:
  26             self.dec_use()
  27     return use_counter_wrapper
  28
  29 def check_update(orig_func):
  30     @functools.wraps(orig_func)
  31     def check_update_wrapper(self, *args, **kwargs):
  32         self.checkupdate()
  33         return orig_func(self, *args, **kwargs)
  34     return check_update_wrapper
  35
  36 class FreshBase(object):
  37     """Base class for maintaining object lifecycle.
  38
  39     Functions include:
  40
  41     * Indicate if an object is up to date (stale() == false) or needs to be
  42       updated sets stale() == True).  Use invalidate() to mark the object as
  43       stale.  An object is also automatically stale if it has not been updated
  44       in `_poll_time` seconds.
  45
  46     * Record access time (atime) timestamp
  47
  48     * Manage internal use count used by the inode cache ("inc_use" and
  49       "dec_use").  An object which is in use cannot be cleared by the inode
  50       cache.
  51
  52     * Manage the kernel reference count ("inc_ref" and "dec_ref").  An object
  53       which is referenced by the kernel cannot have its inode entry deleted.
  54
  55     * Record cache footprint, cache priority
  56
  57     * Record Arvados uuid at the time the object is placed in the cache
  58
  59     * Clear the object contents (invalidates the object)
  60
  61     """
  62     def __init__(self):
  63         self._stale = True
  64         self._poll = False
  65         self._last_update = time.time()
  66         self._atime = time.time()
  67         self._poll_time = 60
  68         self.use_count = 0
  69         self.ref_count = 0
  70         self.dead = False
  71         self.cache_size = 0
  72         self.cache_uuid = None
  73
  74         # Can the kernel cache attributes?
  75         self.allow_attr_cache = True
  76
  77     def invalidate(self):
  78         """Indicate that object contents should be refreshed from source."""
  79         self._stale = True
  80
  81     def kernel_invalidate(self):
  82         """Indicate that an invalidation for this object should be sent to the kernel."""
  83         pass
  84
  85     # Test if the entries dict is stale.
  86     def stale(self):
  87         if self._stale:
  88             return True
  89         if self._poll:
  90             return (self._last_update + self._poll_time) < self._atime
  91         return False
  92
  93     def fresh(self):
  94         self._stale = False
  95         self._last_update = time.time()
  96
  97     def atime(self):
  98         return self._atime
  99
 100     def persisted(self):
 101         return False
 102
 103     def clear(self):
 104         pass
 105
 106     def in_use(self):
 107         return self.use_count > 0
 108
 109     def inc_use(self):
 110         self.use_count += 1
 111
 112     def dec_use(self):
 113         self.use_count -= 1
 114
 115     def inc_ref(self):
 116         self.ref_count += 1
 117         return self.ref_count
 118
 119     def dec_ref(self, n):
 120         self.ref_count -= n
 121         return self.ref_count
 122
 123     def has_ref(self, only_children):
 124         """Determine if there are any kernel references to this
 125         object or its children.
 126
 127         If only_children is True, ignore refcount of self and only consider
 128         children.
 129         """
 130         if only_children:
 131             return False
 132         else:
 133             return self.ref_count > 0
 134
 135     def objsize(self):
 136         return 0
 137
 138     def uuid(self):
 139         return None
 140
 141     def finalize(self):
 142         pass
 143
 144     def child_event(self, ev):
 145         pass
 146
 147     def time_to_next_poll(self):
 148         if self._poll:
 149             t = (self._last_update + self._poll_time) - self._atime
 150             if t < 0:
 151                 return 0
 152             else:
 153                 return t
 154         else:
 155             return self._poll_time