X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/1cea943fbc95efdfa1ff9faa8f7c28882560b848..edf37e92f885ed4d5bcf587317cc9c6d90d8ece1:/services/fuse/arvados_fuse/command.py diff --git a/services/fuse/arvados_fuse/command.py b/services/fuse/arvados_fuse/command.py index e12d62a5e2..b3717ff07c 100644 --- a/services/fuse/arvados_fuse/command.py +++ b/services/fuse/arvados_fuse/command.py @@ -1,9 +1,14 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: AGPL-3.0 + import argparse import arvados import daemon import llfuse import logging import os +import resource import signal import subprocess import sys @@ -12,6 +17,8 @@ import time import arvados.commands._util as arv_cmd from arvados_fuse import crunchstat from arvados_fuse import * +from arvados_fuse.unmount import unmount +from arvados_fuse._version import __version__ class ArgumentParser(argparse.ArgumentParser): def __init__(self): @@ -23,9 +30,14 @@ class ArgumentParser(argparse.ArgumentParser): mountpoint before --exec, or mark the end of your --exec arguments with "--". """) + self.add_argument('--version', action='version', + version="%s %s" % (sys.argv[0], __version__), + help='Print version and exit.') self.add_argument('mountpoint', type=str, help="""Mount point.""") self.add_argument('--allow-other', action='store_true', help="""Let other users read the mount""") + self.add_argument('--subtype', type=str, metavar='STRING', + help="""Report mounted filesystem type as "fuse.STRING", instead of just "fuse".""") mode = self.add_mutually_exclusive_group() @@ -76,11 +88,24 @@ class ArgumentParser(argparse.ArgumentParser): self.add_argument('--file-cache', type=int, help="File data cache size, in bytes (default 256MiB)", default=256*1024*1024) self.add_argument('--directory-cache', type=int, help="Directory data cache size, in bytes (default 128MiB)", default=128*1024*1024) + self.add_argument('--disable-event-listening', action='store_true', help="Don't subscribe to events on the API server", dest="disable_event_listening", default=False) + self.add_argument('--read-only', action='store_false', help="Mount will be read only (default)", dest="enable_write", default=False) self.add_argument('--read-write', action='store_true', help="Mount will be read-write", dest="enable_write", default=False) self.add_argument('--crunchstat-interval', type=float, help="Write stats to stderr every N seconds (default disabled)", default=0) + unmount = self.add_mutually_exclusive_group() + unmount.add_argument('--unmount', action='store_true', default=False, + help="Forcefully unmount the specified mountpoint (if it's a fuse mount) and exit. If --subtype is given, unmount only if the mount has the specified subtype. WARNING: This command can affect any kind of fuse mount, not just arv-mount.") + unmount.add_argument('--unmount-all', action='store_true', default=False, + help="Forcefully unmount every fuse mount at or below the specified path and exit. If --subtype is given, unmount only mounts that have the specified subtype. Exit non-zero if any other types of mounts are found at or below the given path. WARNING: This command can affect any kind of fuse mount, not just arv-mount.") + unmount.add_argument('--replace', action='store_true', default=False, + help="If a fuse mount is already present at mountpoint, forcefully unmount it before mounting") + self.add_argument('--unmount-timeout', + type=float, default=2.0, + help="Time to wait for graceful shutdown after --exec program exits and filesystem is unmounted") + self.add_argument('--exec', type=str, nargs=argparse.REMAINDER, dest="exec_args", metavar=('command', 'args', '...', '--'), help="""Mount, run a command, then unmount and exit""") @@ -88,21 +113,15 @@ class ArgumentParser(argparse.ArgumentParser): class Mount(object): def __init__(self, args, logger=logging.getLogger('arvados.arv-mount')): + self.daemon = False self.logger = logger self.args = args + self.listen_for_events = False self.args.mountpoint = os.path.realpath(self.args.mountpoint) if self.args.logfile: self.args.logfile = os.path.realpath(self.args.logfile) - # Daemonize as early as possible, so we don't accidentally close - # file descriptors we're using. - self.daemon_ctx = None - if not (self.args.exec_args or self.args.foreground): - os.chdir(self.args.mountpoint) - self.daemon_ctx = daemon.DaemonContext(working_directory='.') - self.daemon_ctx.open() - try: self._setup_logging() self._setup_api() @@ -112,22 +131,45 @@ class Mount(object): exit(1) def __enter__(self): + if self.args.replace: + unmount(path=self.args.mountpoint, + timeout=self.args.unmount_timeout) llfuse.init(self.operations, self.args.mountpoint, self._fuse_options()) - if self.args.mode != 'by_pdh': + if self.daemon: + daemon.DaemonContext( + working_directory=os.path.dirname(self.args.mountpoint), + files_preserve=range( + 3, resource.getrlimit(resource.RLIMIT_NOFILE)[1]) + ).open() + if self.listen_for_events and not self.args.disable_event_listening: self.operations.listen_for_events() - t = threading.Thread(None, lambda: llfuse.main()) - t.start() + self.llfuse_thread = threading.Thread(None, lambda: self._llfuse_main()) + self.llfuse_thread.daemon = True + self.llfuse_thread.start() self.operations.initlock.wait() + return self def __exit__(self, exc_type, exc_value, traceback): + if self.operations.events: + self.operations.events.close(timeout=self.args.unmount_timeout) subprocess.call(["fusermount", "-u", "-z", self.args.mountpoint]) - self.operations.destroy() + self.llfuse_thread.join(timeout=self.args.unmount_timeout) + if self.llfuse_thread.is_alive(): + self.logger.warning("Mount.__exit__:" + " llfuse thread still alive %fs after umount" + " -- abandoning and exiting anyway", + self.args.unmount_timeout) def run(self): - if self.args.exec_args: - self._run_exec(self.args) + if self.args.unmount or self.args.unmount_all: + unmount(path=self.args.mountpoint, + subtype=self.args.subtype, + timeout=self.args.unmount_timeout, + recursive=self.args.unmount_all) + elif self.args.exec_args: + self._run_exec() else: - self._run_standalone(self.args) + self._run_standalone() def _fuse_options(self): """FUSE mount options; see mount.fuse(8)""" @@ -135,14 +177,17 @@ class Mount(object): if getattr(self.args, optname)] # Increase default read/write size from 4KiB to 128KiB opts += ["big_writes", "max_read=131072"] + if self.args.subtype: + opts += ["subtype="+self.args.subtype] return opts def _setup_logging(self): # Configure a log handler based on command-line switches. if self.args.logfile: log_handler = logging.FileHandler(self.args.logfile) - elif self.daemon_ctx: - log_handler = logging.NullHandler() + log_handler.setFormatter(logging.Formatter( + '%(asctime)s %(name)s[%(process)d] %(levelname)s: %(message)s', + '%Y-%m-%d %H:%M:%S')) else: log_handler = None @@ -152,6 +197,9 @@ class Mount(object): if self.args.debug: arvados.logger.setLevel(logging.DEBUG) + logging.getLogger('arvados.keep').setLevel(logging.DEBUG) + logging.getLogger('arvados.api').setLevel(logging.DEBUG) + logging.getLogger('arvados.collection').setLevel(logging.DEBUG) self.logger.debug("arv-mount debugging enabled") self.logger.info("enable write is %s", self.args.enable_write) @@ -160,8 +208,11 @@ class Mount(object): self.api = arvados.safeapi.ThreadSafeApiCache( apiconfig=arvados.config.settings(), keep_params={ - "block_cache": arvados.keep.KeepBlockCache(self.args.file_cache) + 'block_cache': arvados.keep.KeepBlockCache(self.args.file_cache), + 'num_retries': self.args.retries, }) + # Do a sanity check that we have a working arvados host + token. + self.api.users().current().execute() def _setup_mount(self): self.operations = Operations( @@ -189,6 +240,8 @@ class Mount(object): if self.args.collection is not None: # Set up the request handler with the collection at the root + # First check that the collection is readable + self.api.collections().get(uuid=self.args.collection).execute() self.args.mode = 'collection' dir_class = CollectionDirectory dir_args.append(self.args.collection) @@ -234,7 +287,9 @@ class Mount(object): mount_readme = True if dir_class is not None: - self.operations.inodes.add_entry(dir_class(*dir_args)) + ent = dir_class(*dir_args) + self.operations.inodes.add_entry(ent) + self.listen_for_events = ent.want_event_subscribe() return e = self.operations.inodes.add_entry(Directory( @@ -264,6 +319,7 @@ class Mount(object): if name in ['', '.', '..'] or '/' in name: sys.exit("Mount point '{}' is not supported.".format(name)) tld._entries[name] = self.operations.inodes.add_entry(ent) + self.listen_for_events = (self.listen_for_events or ent.want_event_subscribe()) def _readme_text(self, api_host, user_email): return ''' @@ -281,58 +337,46 @@ From here, the following directories are available: '''.format(api_host, user_email) def _run_exec(self): - # Initialize the fuse connection - llfuse.init(self.operations, self.args.mountpoint, self._fuse_options()) - - # Subscribe to change events from API server - if self.args.mode != 'by_pdh': - self.operations.listen_for_events() - - t = threading.Thread(None, lambda: llfuse.main()) - t.start() - - # wait until the driver is finished initializing - self.operations.initlock.wait() - rc = 255 - try: - sp = subprocess.Popen(self.args.exec_args, shell=False) - - # forward signals to the process. - signal.signal(signal.SIGINT, lambda signum, frame: sp.send_signal(signum)) - signal.signal(signal.SIGTERM, lambda signum, frame: sp.send_signal(signum)) - signal.signal(signal.SIGQUIT, lambda signum, frame: sp.send_signal(signum)) - - # wait for process to complete. - rc = sp.wait() - - # restore default signal handlers. - signal.signal(signal.SIGINT, signal.SIG_DFL) - signal.signal(signal.SIGTERM, signal.SIG_DFL) - signal.signal(signal.SIGQUIT, signal.SIG_DFL) - except Exception as e: - self.logger.exception( - 'arv-mount: exception during exec %s', self.args.exec_args) + with self: try: - rc = e.errno - except AttributeError: - pass - finally: - subprocess.call(["fusermount", "-u", "-z", self.args.mountpoint]) - self.operations.destroy() + sp = subprocess.Popen(self.args.exec_args, shell=False) + + # forward signals to the process. + signal.signal(signal.SIGINT, lambda signum, frame: sp.send_signal(signum)) + signal.signal(signal.SIGTERM, lambda signum, frame: sp.send_signal(signum)) + signal.signal(signal.SIGQUIT, lambda signum, frame: sp.send_signal(signum)) + + # wait for process to complete. + rc = sp.wait() + + # restore default signal handlers. + signal.signal(signal.SIGINT, signal.SIG_DFL) + signal.signal(signal.SIGTERM, signal.SIG_DFL) + signal.signal(signal.SIGQUIT, signal.SIG_DFL) + except Exception as e: + self.logger.exception( + 'arv-mount: exception during exec %s', self.args.exec_args) + try: + rc = e.errno + except AttributeError: + pass exit(rc) def _run_standalone(self): try: - llfuse.init(self.operations, self.args.mountpoint, self._fuse_options()) - - # Subscribe to change events from API server - self.operations.listen_for_events() - - llfuse.main() + self.daemon = not self.args.foreground + with self: + self.llfuse_thread.join(timeout=None) except Exception as e: self.logger.exception('arv-mount: exception during mount: %s', e) exit(getattr(e, 'errno', 1)) - finally: - self.operations.destroy() exit(0) + + def _llfuse_main(self): + try: + llfuse.main() + except: + llfuse.close(unmount=False) + raise + llfuse.close()