X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d14dd75b263d8f999603b66d23f74667d36a2412..c7e3518e66369b931821b802160bd014cf82b218:/services/fuse/arvados_fuse/__init__.py diff --git a/services/fuse/arvados_fuse/__init__.py b/services/fuse/arvados_fuse/__init__.py index 8d04848792..6ac51f4387 100644 --- a/services/fuse/arvados_fuse/__init__.py +++ b/services/fuse/arvados_fuse/__init__.py @@ -1,6 +1,49 @@ -# -# FUSE driver for Arvados Keep -# +"""FUSE driver for Arvados Keep + +Architecture: + +There is one `Operations` object per mount point. It is the entry point for all +read and write requests from the llfuse module. + +The operations object owns an `Inodes` object. The inodes object stores the +mapping from numeric inode (used throughout the file system API to uniquely +identify files) to the Python objects that implement files and directories. + +The `Inodes` object owns an `InodeCache` object. The inode cache records the +memory footprint of file system objects and when they are last used. When the +cache limit is exceeded, the least recently used objects are cleared. + +File system objects inherit from `fresh.FreshBase` which manages the object lifecycle. + +File objects inherit from `fusefile.File`. Key methods are `readfrom` and `writeto` +which implement actual reads and writes. + +Directory objects inherit from `fusedir.Directory`. The directory object wraps +a Python dict which stores the mapping from filenames to directory entries. +Directory contents can be accessed through the Python operators such as `[]` +and `in`. These methods automatically check if the directory is fresh (up to +date) or stale (needs update) and will call `update` if necessary before +returing a result. + +The general FUSE operation flow is as follows: + +- The request handler is called with either an inode or file handle that is the + subject of the operation. + +- Look up the inode using the Inodes table or the file handle in the + filehandles table to get the file system object. + +- For methods that alter files or directories, check that the operation is + valid and permitted using _check_writable(). + +- Call the relevant method on the file system object. + +- Return the result. + +The FUSE driver supports the Arvados event bus. When an event is received for +an object that is live in the inode cache, that object is immediately updated. + +""" import os import sys @@ -22,44 +65,76 @@ import threading import itertools import ciso8601 import collections +import functools +import arvados.keep -from fusedir import sanitize_filename, Directory, CollectionDirectory, MagicDirectory, TagsDirectory, ProjectDirectory, SharedDirectory -from fusefile import StreamReaderFile, StringFile +import Queue + +# Default _notify_queue has a limit of 1000 items, but it really needs to be +# unlimited to avoid deadlocks, see https://arvados.org/issues/3198#note-43 for +# details. + +llfuse.capi._notify_queue = Queue.Queue() + +from fusedir import sanitize_filename, Directory, CollectionDirectory, TmpCollectionDirectory, MagicDirectory, TagsDirectory, ProjectDirectory, SharedDirectory, CollectionDirectoryBase +from fusefile import StringFile, FuseArvadosFile _logger = logging.getLogger('arvados.arvados_fuse') +# Uncomment this to enable llfuse debug logging. +# log_handler = logging.StreamHandler() +# llogger = logging.getLogger('llfuse') +# llogger.addHandler(log_handler) +# llogger.setLevel(logging.DEBUG) -class FileHandle(object): - """Connects a numeric file handle to a File object that has +class Handle(object): + """Connects a numeric file handle to a File or Directory object that has been opened by the client.""" - def __init__(self, fh, fileobj): + def __init__(self, fh, obj): self.fh = fh - self.fileobj = fileobj - self.fileobj.inc_use() + self.obj = obj + self.obj.inc_use() def release(self): - self.fileobj.dec_use() + self.obj.dec_use() + + def flush(self): + if self.obj.writable(): + return self.obj.flush() + + +class FileHandle(Handle): + """Connects a numeric file handle to a File object that has + been opened by the client.""" + pass -class DirectoryHandle(object): +class DirectoryHandle(Handle): """Connects a numeric file handle to a Directory object that has been opened by the client.""" def __init__(self, fh, dirobj, entries): - self.fh = fh + super(DirectoryHandle, self).__init__(fh, dirobj) self.entries = entries - self.dirobj = dirobj - self.dirobj.inc_use() - - def release(self): - self.dirobj.dec_use() class InodeCache(object): + """Records the memory footprint of objects and when they are last used. + + When the cache limit is exceeded, the least recently used objects are + cleared. Clearing the object means discarding its contents to release + memory. The next time the object is accessed, it must be re-fetched from + the server. Note that the inode cache limit is a soft limit; the cache + limit may be exceeded if necessary to load very large objects, it may also + be exceeded if open file handles prevent objects from being cleared. + + """ + def __init__(self, cap, min_entries=4): self._entries = collections.OrderedDict() - self._counter = itertools.count(1) + self._by_uuid = {} + self._counter = itertools.count(0) self.cap = cap self._total = 0 self.min_entries = min_entries @@ -69,15 +144,20 @@ class InodeCache(object): def _remove(self, obj, clear): if clear and not obj.clear(): - _logger.debug("Could not clear %s in_use %s", obj, obj.in_use()) + _logger.debug("InodeCache could not clear %i in_use %s", obj.inode, obj.in_use()) return False self._total -= obj.cache_size del self._entries[obj.cache_priority] - _logger.debug("Cleared %s total now %i", obj, self._total) + if obj.cache_uuid: + self._by_uuid[obj.cache_uuid].remove(obj) + if not self._by_uuid[obj.cache_uuid]: + del self._by_uuid[obj.cache_uuid] + obj.cache_uuid = None + if clear: + _logger.debug("InodeCache cleared %i total now %i", obj.inode, self._total) return True def cap_cache(self): - _logger.debug("total is %i cap is %i", self._total, self.cap) if self._total > self.cap: for key in list(self._entries.keys()): if self._total < self.cap or len(self._entries) < self.min_entries: @@ -89,29 +169,47 @@ class InodeCache(object): obj.cache_priority = next(self._counter) obj.cache_size = obj.objsize() self._entries[obj.cache_priority] = obj + obj.cache_uuid = obj.uuid() + if obj.cache_uuid: + if obj.cache_uuid not in self._by_uuid: + self._by_uuid[obj.cache_uuid] = [obj] + else: + if obj not in self._by_uuid[obj.cache_uuid]: + self._by_uuid[obj.cache_uuid].append(obj) self._total += obj.objsize() - _logger.debug("Managing %s total now %i", obj, self._total) + _logger.debug("InodeCache touched %i (size %i) (uuid %s) total now %i", obj.inode, obj.objsize(), obj.cache_uuid, self._total) self.cap_cache() + else: + obj.cache_priority = None def touch(self, obj): if obj.persisted(): if obj.cache_priority in self._entries: self._remove(obj, False) self.manage(obj) - _logger.debug("Touched %s (%i) total now %i", obj, obj.objsize(), self._total) def unmanage(self, obj): if obj.persisted() and obj.cache_priority in self._entries: self._remove(obj, True) + def find_by_uuid(self, uuid): + return self._by_uuid.get(uuid, []) + + def clear(self): + self._entries.clear() + self._by_uuid.clear() + self._total = 0 + class Inodes(object): """Manage the set of inodes. This is the mapping from a numeric id to a concrete File or Directory object""" - def __init__(self, inode_cache): + def __init__(self, inode_cache, encoding="utf-8"): self._entries = {} self._counter = itertools.count(llfuse.ROOT_INODE) self.inode_cache = inode_cache + self.encoding = encoding + self.deferred_invalidations = [] def __getitem__(self, item): return self._entries[item] @@ -134,14 +232,64 @@ class Inodes(object): def add_entry(self, entry): entry.inode = next(self._counter) + if entry.inode == llfuse.ROOT_INODE: + entry.inc_ref() self._entries[entry.inode] = entry self.inode_cache.manage(entry) return entry def del_entry(self, entry): - self.inode_cache.unmanage(entry) - llfuse.invalidate_inode(entry.inode) - del self._entries[entry.inode] + if entry.ref_count == 0: + self.inode_cache.unmanage(entry) + del self._entries[entry.inode] + with llfuse.lock_released: + entry.finalize() + self.invalidate_inode(entry.inode) + entry.inode = None + else: + entry.dead = True + _logger.debug("del_entry on inode %i with refcount %i", entry.inode, entry.ref_count) + + def invalidate_inode(self, inode): + llfuse.invalidate_inode(inode) + + def invalidate_entry(self, inode, name): + llfuse.invalidate_entry(inode, name.encode(self.encoding)) + + def clear(self): + self.inode_cache.clear() + + for k,v in self._entries.items(): + try: + v.finalize() + except Exception as e: + _logger.exception("Error during finalize of inode %i", k) + + self._entries.clear() + + +def catch_exceptions(orig_func): + """Catch uncaught exceptions and log them consistently.""" + + @functools.wraps(orig_func) + def catch_exceptions_wrapper(self, *args, **kwargs): + try: + return orig_func(self, *args, **kwargs) + except llfuse.FUSEError: + raise + except EnvironmentError as e: + raise llfuse.FUSEError(e.errno) + except arvados.errors.KeepWriteError as e: + _logger.error("Keep write error: " + str(e)) + raise llfuse.FUSEError(errno.EIO) + except arvados.errors.NotFoundError as e: + _logger.error("Block not found error: " + str(e)) + raise llfuse.FUSEError(errno.EIO) + except: + _logger.exception("Unhandled exception during FUSE operation") + raise llfuse.FUSEError(errno.EIO) + + return catch_exceptions_wrapper class Operations(llfuse.Operations): @@ -156,32 +304,100 @@ class Operations(llfuse.Operations): """ - def __init__(self, uid, gid, encoding="utf-8", inode_cache=None): + def __init__(self, uid, gid, api_client, encoding="utf-8", inode_cache=None, num_retries=4, enable_write=False): super(Operations, self).__init__() + self._api_client = api_client + if not inode_cache: inode_cache = InodeCache(cap=256*1024*1024) - self.inodes = Inodes(inode_cache) + self.inodes = Inodes(inode_cache, encoding=encoding) self.uid = uid self.gid = gid - self.encoding = encoding + self.enable_write = enable_write # dict of inode to filehandle self._filehandles = {} - self._filehandles_counter = 1 + self._filehandles_counter = itertools.count(0) # Other threads that need to wait until the fuse driver # is fully initialized should wait() on this event object. self.initlock = threading.Event() + # If we get overlapping shutdown events (e.g., fusermount -u + # -z and operations.destroy()) llfuse calls forget() on inodes + # that have already been deleted. To avoid this, we make + # forget() a no-op if called after destroy(). + self._shutdown_started = threading.Event() + + self.num_retries = num_retries + + self.read_counter = arvados.keep.Counter() + self.write_counter = arvados.keep.Counter() + self.read_ops_counter = arvados.keep.Counter() + self.write_ops_counter = arvados.keep.Counter() + + self.events = None + def init(self): # Allow threads that are waiting for the driver to be finished # initializing to continue self.initlock.set() + @catch_exceptions + def destroy(self): + with llfuse.lock: + self._shutdown_started.set() + if self.events: + self.events.close() + self.events = None + + self.inodes.clear() + def access(self, inode, mode, ctx): return True + def listen_for_events(self): + self.events = arvados.events.subscribe(self._api_client, + [["event_type", "in", ["create", "update", "delete"]]], + self.on_event) + + @catch_exceptions + def on_event(self, ev): + if 'event_type' not in ev: + return + with llfuse.lock: + for item in self.inodes.inode_cache.find_by_uuid(ev["object_uuid"]): + item.invalidate() + if ev["object_kind"] == "arvados#collection": + new_attr = (ev.get("properties") and + ev["properties"].get("new_attributes") and + ev["properties"]["new_attributes"]) + + # new_attributes.modified_at currently lacks + # subsecond precision (see #6347) so use event_at + # which should always be the same. + record_version = ( + (ev["event_at"], new_attr["portable_data_hash"]) + if new_attr else None) + + item.update(to_record_version=record_version) + else: + item.update() + + oldowner = ( + ev.get("properties") and + ev["properties"].get("old_attributes") and + ev["properties"]["old_attributes"].get("owner_uuid")) + newowner = ev["object_owner_uuid"] + for parent in ( + self.inodes.inode_cache.find_by_uuid(oldowner) + + self.inodes.inode_cache.find_by_uuid(newowner)): + parent.invalidate() + parent.update() + + + @catch_exceptions def getattr(self, inode): if inode not in self.inodes: raise llfuse.FUSEError(errno.ENOENT) @@ -191,16 +407,19 @@ class Operations(llfuse.Operations): entry = llfuse.EntryAttributes() entry.st_ino = inode entry.generation = 0 - entry.entry_timeout = 300 - entry.attr_timeout = 300 + entry.entry_timeout = 60 if e.allow_dirent_cache else 0 + entry.attr_timeout = 60 if e.allow_attr_cache else 0 entry.st_mode = stat.S_IRUSR | stat.S_IRGRP | stat.S_IROTH if isinstance(e, Directory): entry.st_mode |= stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH | stat.S_IFDIR - elif isinstance(e, StreamReaderFile): - entry.st_mode |= stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH | stat.S_IFREG else: entry.st_mode |= stat.S_IFREG + if isinstance(e, FuseArvadosFile): + entry.st_mode |= stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH + + if self.enable_write and e.writable(): + entry.st_mode |= stat.S_IWUSR | stat.S_IWGRP | stat.S_IWOTH entry.st_nlink = 1 entry.st_uid = self.uid @@ -210,17 +429,29 @@ class Operations(llfuse.Operations): entry.st_size = e.size() entry.st_blksize = 512 - entry.st_blocks = (e.size()/512)+1 + entry.st_blocks = (entry.st_size/512)+1 entry.st_atime = int(e.atime()) entry.st_mtime = int(e.mtime()) entry.st_ctime = int(e.mtime()) return entry + @catch_exceptions + def setattr(self, inode, attr): + entry = self.getattr(inode) + + e = self.inodes[inode] + + if attr.st_size is not None and isinstance(e, FuseArvadosFile): + with llfuse.lock_released: + e.arvfile.truncate(attr.st_size) + entry.st_size = e.arvfile.size() + + return entry + + @catch_exceptions def lookup(self, parent_inode, name): - name = unicode(name, self.encoding) - _logger.debug("arv-mount lookup: parent_inode %i name %s", - parent_inode, name) + name = unicode(name, self.inodes.encoding) inode = None if name == '.': @@ -228,62 +459,106 @@ class Operations(llfuse.Operations): else: if parent_inode in self.inodes: p = self.inodes[parent_inode] + self.inodes.touch(p) if name == '..': inode = p.parent_inode elif isinstance(p, Directory) and name in p: inode = p[name].inode if inode != None: + _logger.debug("arv-mount lookup: parent_inode %i name '%s' inode %i", + parent_inode, name, inode) + self.inodes[inode].inc_ref() return self.getattr(inode) else: + _logger.debug("arv-mount lookup: parent_inode %i name '%s' not found", + parent_inode, name) raise llfuse.FUSEError(errno.ENOENT) + @catch_exceptions + def forget(self, inodes): + if self._shutdown_started.is_set(): + return + for inode, nlookup in inodes: + ent = self.inodes[inode] + _logger.debug("arv-mount forget: inode %i nlookup %i ref_count %i", inode, nlookup, ent.ref_count) + if ent.dec_ref(nlookup) == 0 and ent.dead: + self.inodes.del_entry(ent) + + @catch_exceptions def open(self, inode, flags): if inode in self.inodes: p = self.inodes[inode] else: raise llfuse.FUSEError(errno.ENOENT) - if (flags & os.O_WRONLY) or (flags & os.O_RDWR): - raise llfuse.FUSEError(errno.EROFS) - if isinstance(p, Directory): raise llfuse.FUSEError(errno.EISDIR) - fh = self._filehandles_counter - self._filehandles_counter += 1 + if ((flags & os.O_WRONLY) or (flags & os.O_RDWR)) and not p.writable(): + raise llfuse.FUSEError(errno.EPERM) + + fh = next(self._filehandles_counter) self._filehandles[fh] = FileHandle(fh, p) self.inodes.touch(p) + + _logger.debug("arv-mount open inode %i flags %x fh %i", inode, flags, fh) + return fh + @catch_exceptions def read(self, fh, off, size): - _logger.debug("arv-mount read %i %i %i", fh, off, size) + _logger.debug("arv-mount read fh %i off %i size %i", fh, off, size) + self.read_ops_counter.add(1) + if fh in self._filehandles: handle = self._filehandles[fh] else: raise llfuse.FUSEError(errno.EBADF) - self.inodes.touch(handle.fileobj) + self.inodes.touch(handle.obj) - try: - with llfuse.lock_released: - return handle.fileobj.readfrom(off, size) - except arvados.errors.NotFoundError as e: - _logger.warning("Block not found: " + str(e)) - raise llfuse.FUSEError(errno.EIO) - except Exception: - _logger.exception() - raise llfuse.FUSEError(errno.EIO) + r = handle.obj.readfrom(off, size, self.num_retries) + if r: + self.read_counter.add(len(r)) + return r + + @catch_exceptions + def write(self, fh, off, buf): + _logger.debug("arv-mount write %i %i %i", fh, off, len(buf)) + self.write_ops_counter.add(1) + + if fh in self._filehandles: + handle = self._filehandles[fh] + else: + raise llfuse.FUSEError(errno.EBADF) + + if not handle.obj.writable(): + raise llfuse.FUSEError(errno.EPERM) + + self.inodes.touch(handle.obj) + w = handle.obj.writeto(off, buf, self.num_retries) + if w: + self.write_counter.add(w) + return w + + @catch_exceptions def release(self, fh): if fh in self._filehandles: - self._filehandles[fh].release() - del self._filehandles[fh] + try: + self._filehandles[fh].flush() + except Exception: + raise + finally: + self._filehandles[fh].release() + del self._filehandles[fh] self.inodes.inode_cache.cap_cache() def releasedir(self, fh): self.release(fh) + @catch_exceptions def opendir(self, inode): _logger.debug("arv-mount opendir: inode %i", inode) @@ -295,8 +570,7 @@ class Operations(llfuse.Operations): if not isinstance(p, Directory): raise llfuse.FUSEError(errno.ENOTDIR) - fh = self._filehandles_counter - self._filehandles_counter += 1 + fh = next(self._filehandles_counter) if p.parent_inode in self.inodes: parent = self.inodes[p.parent_inode] else: @@ -308,7 +582,7 @@ class Operations(llfuse.Operations): self._filehandles[fh] = DirectoryHandle(fh, p, [('.', p), ('..', parent)] + list(p.items())) return fh - + @catch_exceptions def readdir(self, fh, off): _logger.debug("arv-mount readdir: fh %i off %i", fh, off) @@ -317,20 +591,16 @@ class Operations(llfuse.Operations): else: raise llfuse.FUSEError(errno.EBADF) - _logger.debug("arv-mount handle.dirobj %s", handle.dirobj) - e = off while e < len(handle.entries): if handle.entries[e][1].inode in self.inodes: - try: - yield (handle.entries[e][0].encode(self.encoding), self.getattr(handle.entries[e][1].inode), e+1) - except UnicodeEncodeError: - pass + yield (handle.entries[e][0].encode(self.inodes.encoding), self.getattr(handle.entries[e][1].inode), e+1) e += 1 + @catch_exceptions def statfs(self): st = llfuse.StatvfsData() - st.f_bsize = 64 * 1024 + st.f_bsize = 128 * 1024 st.f_blocks = 0 st.f_files = 0 @@ -343,12 +613,78 @@ class Operations(llfuse.Operations): st.f_frsize = 0 return st - # The llfuse documentation recommends only overloading functions that - # are actually implemented, as the default implementation will raise ENOSYS. - # However, there is a bug in the llfuse default implementation of create() - # "create() takes exactly 5 positional arguments (6 given)" which will crash - # arv-mount. - # The workaround is to implement it with the proper number of parameters, - # and then everything works out. + def _check_writable(self, inode_parent): + if not self.enable_write: + raise llfuse.FUSEError(errno.EROFS) + + if inode_parent in self.inodes: + p = self.inodes[inode_parent] + else: + raise llfuse.FUSEError(errno.ENOENT) + + if not isinstance(p, Directory): + raise llfuse.FUSEError(errno.ENOTDIR) + + if not p.writable(): + raise llfuse.FUSEError(errno.EPERM) + + return p + + @catch_exceptions def create(self, inode_parent, name, mode, flags, ctx): - raise llfuse.FUSEError(errno.EROFS) + _logger.debug("arv-mount create: %i '%s' %o", inode_parent, name, mode) + + p = self._check_writable(inode_parent) + p.create(name) + + # The file entry should have been implicitly created by callback. + f = p[name] + fh = next(self._filehandles_counter) + self._filehandles[fh] = FileHandle(fh, f) + self.inodes.touch(p) + + f.inc_ref() + return (fh, self.getattr(f.inode)) + + @catch_exceptions + def mkdir(self, inode_parent, name, mode, ctx): + _logger.debug("arv-mount mkdir: %i '%s' %o", inode_parent, name, mode) + + p = self._check_writable(inode_parent) + p.mkdir(name) + + # The dir entry should have been implicitly created by callback. + d = p[name] + + d.inc_ref() + return self.getattr(d.inode) + + @catch_exceptions + def unlink(self, inode_parent, name): + _logger.debug("arv-mount unlink: %i '%s'", inode_parent, name) + p = self._check_writable(inode_parent) + p.unlink(name) + + @catch_exceptions + def rmdir(self, inode_parent, name): + _logger.debug("arv-mount rmdir: %i '%s'", inode_parent, name) + p = self._check_writable(inode_parent) + p.rmdir(name) + + @catch_exceptions + def rename(self, inode_parent_old, name_old, inode_parent_new, name_new): + _logger.debug("arv-mount rename: %i '%s' %i '%s'", inode_parent_old, name_old, inode_parent_new, name_new) + src = self._check_writable(inode_parent_old) + dest = self._check_writable(inode_parent_new) + dest.rename(name_old, name_new, src) + + @catch_exceptions + def flush(self, fh): + if fh in self._filehandles: + self._filehandles[fh].flush() + + def fsync(self, fh, datasync): + self.flush(fh) + + def fsyncdir(self, fh, datasync): + self.flush(fh)