services/fuse/arvados_fuse/command.py

   1 import argparse
   2 import arvados
   3 import daemon
   4 import llfuse
   5 import logging
   6 import os
   7 import resource
   8 import signal
   9 import subprocess
  10 import sys
  11 import time
  12
  13 import arvados.commands._util as arv_cmd
  14 from arvados_fuse import crunchstat
  15 from arvados_fuse import *
  16 from arvados_fuse._version import __version__
  17
  18 class ArgumentParser(argparse.ArgumentParser):
  19     def __init__(self):
  20         super(ArgumentParser, self).__init__(
  21             parents=[arv_cmd.retry_opt],
  22             description='''Mount Keep data under the local filesystem.  Default mode is --home''',
  23             epilog="""
  24     Note: When using the --exec feature, you must either specify the
  25     mountpoint before --exec, or mark the end of your --exec arguments
  26     with "--".
  27             """)
  28         self.add_argument('--version', action='version',
  29                           version="%s %s" % (sys.argv[0], __version__),
  30                           help='Print version and exit.')
  31         self.add_argument('mountpoint', type=str, help="""Mount point.""")
  32         self.add_argument('--allow-other', action='store_true',
  33                             help="""Let other users read the mount""")
  34
  35         mode = self.add_mutually_exclusive_group()
  36
  37         mode.add_argument('--all', action='store_const', const='all', dest='mode',
  38                                 help="""Mount a subdirectory for each mode: home, shared, by_tag, by_id (default if no --mount-* arguments are given).""")
  39         mode.add_argument('--custom', action='store_const', const=None, dest='mode',
  40                                 help="""Mount a top level meta-directory with subdirectories as specified by additional --mount-* arguments (default if any --mount-* arguments are given).""")
  41         mode.add_argument('--home', action='store_const', const='home', dest='mode',
  42                                 help="""Mount only the user's home project.""")
  43         mode.add_argument('--shared', action='store_const', const='shared', dest='mode',
  44                                 help="""Mount only list of projects shared with the user.""")
  45         mode.add_argument('--by-tag', action='store_const', const='by_tag', dest='mode',
  46                                 help="""Mount subdirectories listed by tag.""")
  47         mode.add_argument('--by-id', action='store_const', const='by_id', dest='mode',
  48                                 help="""Mount subdirectories listed by portable data hash or uuid.""")
  49         mode.add_argument('--by-pdh', action='store_const', const='by_pdh', dest='mode',
  50                                 help="""Mount subdirectories listed by portable data hash.""")
  51         mode.add_argument('--project', type=str, metavar='UUID',
  52                                 help="""Mount the specified project.""")
  53         mode.add_argument('--collection', type=str, metavar='UUID_or_PDH',
  54                                 help="""Mount only the specified collection.""")
  55
  56         mounts = self.add_argument_group('Custom mount options')
  57         mounts.add_argument('--mount-by-pdh',
  58                             type=str, metavar='PATH', action='append', default=[],
  59                             help="Mount each readable collection at mountpoint/PATH/P where P is the collection's portable data hash.")
  60         mounts.add_argument('--mount-by-id',
  61                             type=str, metavar='PATH', action='append', default=[],
  62                             help="Mount each readable collection at mountpoint/PATH/UUID and mountpoint/PATH/PDH where PDH is the collection's portable data hash and UUID is its UUID.")
  63         mounts.add_argument('--mount-by-tag',
  64                             type=str, metavar='PATH', action='append', default=[],
  65                             help="Mount all collections with tag TAG at mountpoint/PATH/TAG/UUID.")
  66         mounts.add_argument('--mount-home',
  67                             type=str, metavar='PATH', action='append', default=[],
  68                             help="Mount the current user's home project at mountpoint/PATH.")
  69         mounts.add_argument('--mount-shared',
  70                             type=str, metavar='PATH', action='append', default=[],
  71                             help="Mount projects shared with the current user at mountpoint/PATH.")
  72         mounts.add_argument('--mount-tmp',
  73                             type=str, metavar='PATH', action='append', default=[],
  74                             help="Create a new collection, mount it in read/write mode at mountpoint/PATH, and delete it when unmounting.")
  75
  76         self.add_argument('--debug', action='store_true', help="""Debug mode""")
  77         self.add_argument('--logfile', help="""Write debug logs and errors to the specified file (default stderr).""")
  78         self.add_argument('--foreground', action='store_true', help="""Run in foreground (default is to daemonize unless --exec specified)""", default=False)
  79         self.add_argument('--encoding', type=str, help="Character encoding to use for filesystem, default is utf-8 (see Python codec registry for list of available encodings)", default="utf-8")
  80
  81         self.add_argument('--file-cache', type=int, help="File data cache size, in bytes (default 256MiB)", default=256*1024*1024)
  82         self.add_argument('--directory-cache', type=int, help="Directory data cache size, in bytes (default 128MiB)", default=128*1024*1024)
  83
  84         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)
  85
  86         self.add_argument('--read-only', action='store_false', help="Mount will be read only (default)", dest="enable_write", default=False)
  87         self.add_argument('--read-write', action='store_true', help="Mount will be read-write", dest="enable_write", default=False)
  88
  89         self.add_argument('--crunchstat-interval', type=float, help="Write stats to stderr every N seconds (default disabled)", default=0)
  90
  91         self.add_argument('--unmount-timeout',
  92                           type=float, default=2.0,
  93                           help="Time to wait for graceful shutdown after --exec program exits and filesystem is unmounted")
  94
  95         self.add_argument('--exec', type=str, nargs=argparse.REMAINDER,
  96                             dest="exec_args", metavar=('command', 'args', '...', '--'),
  97                             help="""Mount, run a command, then unmount and exit""")
  98
  99
 100 class Mount(object):
 101     def __init__(self, args, logger=logging.getLogger('arvados.arv-mount')):
 102         self.logger = logger
 103         self.args = args
 104         self.listen_for_events = False
 105
 106         self.args.mountpoint = os.path.realpath(self.args.mountpoint)
 107         if self.args.logfile:
 108             self.args.logfile = os.path.realpath(self.args.logfile)
 109
 110         try:
 111             self._setup_logging()
 112             self._setup_api()
 113             self._setup_mount()
 114         except Exception as e:
 115             self.logger.exception("arv-mount: exception during setup: %s", e)
 116             exit(1)
 117
 118     def __enter__(self):
 119         llfuse.init(self.operations, self.args.mountpoint, self._fuse_options())
 120         if self.listen_for_events and not self.args.disable_event_listening:
 121             self.operations.listen_for_events()
 122         self.llfuse_thread = threading.Thread(None, lambda: self._llfuse_main())
 123         self.llfuse_thread.daemon = True
 124         self.llfuse_thread.start()
 125         self.operations.initlock.wait()
 126         return self
 127
 128     def __exit__(self, exc_type, exc_value, traceback):
 129         if self.operations.events:
 130             self.operations.events.close(timeout=self.args.unmount_timeout)
 131         subprocess.call(["fusermount", "-u", "-z", self.args.mountpoint])
 132         self.llfuse_thread.join(timeout=self.args.unmount_timeout)
 133         if self.llfuse_thread.is_alive():
 134             self.logger.warning("Mount.__exit__:"
 135                                 " llfuse thread still alive %fs after umount"
 136                                 " -- abandoning and exiting anyway",
 137                                 self.args.unmount_timeout)
 138
 139     def run(self):
 140         if self.args.exec_args:
 141             self._run_exec()
 142         else:
 143             self._run_standalone()
 144
 145     def _fuse_options(self):
 146         """FUSE mount options; see mount.fuse(8)"""
 147         opts = [optname for optname in ['allow_other', 'debug']
 148                 if getattr(self.args, optname)]
 149         # Increase default read/write size from 4KiB to 128KiB
 150         opts += ["big_writes", "max_read=131072"]
 151         return opts
 152
 153     def _setup_logging(self):
 154         # Configure a log handler based on command-line switches.
 155         if self.args.logfile:
 156             log_handler = logging.FileHandler(self.args.logfile)
 157             log_handler.setFormatter(logging.Formatter(
 158                 '%(asctime)s %(name)s[%(process)d] %(levelname)s: %(message)s',
 159                 '%Y-%m-%d %H:%M:%S'))
 160         else:
 161             log_handler = None
 162
 163         if log_handler is not None:
 164             arvados.logger.removeHandler(arvados.log_handler)
 165             arvados.logger.addHandler(log_handler)
 166
 167         if self.args.debug:
 168             arvados.logger.setLevel(logging.DEBUG)
 169             logging.getLogger('arvados.keep').setLevel(logging.DEBUG)
 170             logging.getLogger('arvados.api').setLevel(logging.DEBUG)
 171             logging.getLogger('arvados.collection').setLevel(logging.DEBUG)
 172             self.logger.debug("arv-mount debugging enabled")
 173
 174         self.logger.info("enable write is %s", self.args.enable_write)
 175
 176     def _setup_api(self):
 177         self.api = arvados.safeapi.ThreadSafeApiCache(
 178             apiconfig=arvados.config.settings(),
 179             keep_params={
 180                 'block_cache': arvados.keep.KeepBlockCache(self.args.file_cache),
 181                 'num_retries': self.args.retries,
 182             })
 183         # Do a sanity check that we have a working arvados host + token.
 184         self.api.users().current().execute()
 185
 186     def _setup_mount(self):
 187         self.operations = Operations(
 188             os.getuid(),
 189             os.getgid(),
 190             api_client=self.api,
 191             encoding=self.args.encoding,
 192             inode_cache=InodeCache(cap=self.args.directory_cache),
 193             enable_write=self.args.enable_write)
 194
 195         if self.args.crunchstat_interval:
 196             statsthread = threading.Thread(
 197                 target=crunchstat.statlogger,
 198                 args=(self.args.crunchstat_interval,
 199                       self.api.keep,
 200                       self.operations))
 201             statsthread.daemon = True
 202             statsthread.start()
 203
 204         usr = self.api.users().current().execute(num_retries=self.args.retries)
 205         now = time.time()
 206         dir_class = None
 207         dir_args = [llfuse.ROOT_INODE, self.operations.inodes, self.api, self.args.retries]
 208         mount_readme = False
 209
 210         if self.args.collection is not None:
 211             # Set up the request handler with the collection at the root
 212             # First check that the collection is readable
 213             self.api.collections().get(uuid=self.args.collection).execute()
 214             self.args.mode = 'collection'
 215             dir_class = CollectionDirectory
 216             dir_args.append(self.args.collection)
 217         elif self.args.project is not None:
 218             self.args.mode = 'project'
 219             dir_class = ProjectDirectory
 220             dir_args.append(
 221                 self.api.groups().get(uuid=self.args.project).execute(
 222                     num_retries=self.args.retries))
 223
 224         if (self.args.mount_by_id or
 225             self.args.mount_by_pdh or
 226             self.args.mount_by_tag or
 227             self.args.mount_home or
 228             self.args.mount_shared or
 229             self.args.mount_tmp):
 230             if self.args.mode is not None:
 231                 sys.exit(
 232                     "Cannot combine '{}' mode with custom --mount-* options.".
 233                     format(self.args.mode))
 234         elif self.args.mode is None:
 235             # If no --mount-custom or custom mount args, --all is the default
 236             self.args.mode = 'all'
 237
 238         if self.args.mode in ['by_id', 'by_pdh']:
 239             # Set up the request handler with the 'magic directory' at the root
 240             dir_class = MagicDirectory
 241             dir_args.append(self.args.mode == 'by_pdh')
 242         elif self.args.mode == 'by_tag':
 243             dir_class = TagsDirectory
 244         elif self.args.mode == 'shared':
 245             dir_class = SharedDirectory
 246             dir_args.append(usr)
 247         elif self.args.mode == 'home':
 248             dir_class = ProjectDirectory
 249             dir_args.append(usr)
 250             dir_args.append(True)
 251         elif self.args.mode == 'all':
 252             self.args.mount_by_id = ['by_id']
 253             self.args.mount_by_tag = ['by_tag']
 254             self.args.mount_home = ['home']
 255             self.args.mount_shared = ['shared']
 256             mount_readme = True
 257
 258         if dir_class is not None:
 259             ent = dir_class(*dir_args)
 260             self.operations.inodes.add_entry(ent)
 261             self.listen_for_events = ent.want_event_subscribe()
 262             return
 263
 264         e = self.operations.inodes.add_entry(Directory(
 265             llfuse.ROOT_INODE, self.operations.inodes))
 266         dir_args[0] = e.inode
 267
 268         for name in self.args.mount_by_id:
 269             self._add_mount(e, name, MagicDirectory(*dir_args, pdh_only=False))
 270         for name in self.args.mount_by_pdh:
 271             self._add_mount(e, name, MagicDirectory(*dir_args, pdh_only=True))
 272         for name in self.args.mount_by_tag:
 273             self._add_mount(e, name, TagsDirectory(*dir_args))
 274         for name in self.args.mount_home:
 275             self._add_mount(e, name, ProjectDirectory(*dir_args, project_object=usr, poll=True))
 276         for name in self.args.mount_shared:
 277             self._add_mount(e, name, SharedDirectory(*dir_args, exclude=usr, poll=True))
 278         for name in self.args.mount_tmp:
 279             self._add_mount(e, name, TmpCollectionDirectory(*dir_args))
 280
 281         if mount_readme:
 282             text = self._readme_text(
 283                 arvados.config.get('ARVADOS_API_HOST'),
 284                 usr['email'])
 285             self._add_mount(e, 'README', StringFile(e.inode, text, now))
 286
 287     def _add_mount(self, tld, name, ent):
 288         if name in ['', '.', '..'] or '/' in name:
 289             sys.exit("Mount point '{}' is not supported.".format(name))
 290         tld._entries[name] = self.operations.inodes.add_entry(ent)
 291         self.listen_for_events = (self.listen_for_events or ent.want_event_subscribe())
 292
 293     def _readme_text(self, api_host, user_email):
 294         return '''
 295 Welcome to Arvados!  This directory provides file system access to
 296 files and objects available on the Arvados installation located at
 297 '{}' using credentials for user '{}'.
 298
 299 From here, the following directories are available:
 300
 301   by_id/     Access to Keep collections by uuid or portable data hash (see by_id/README for details).
 302   by_tag/    Access to Keep collections organized by tag.
 303   home/      The contents of your home project.
 304   shared/    Projects shared with you.
 305
 306 '''.format(api_host, user_email)
 307
 308     def _run_exec(self):
 309         rc = 255
 310         with self:
 311             try:
 312                 sp = subprocess.Popen(self.args.exec_args, shell=False)
 313
 314                 # forward signals to the process.
 315                 signal.signal(signal.SIGINT, lambda signum, frame: sp.send_signal(signum))
 316                 signal.signal(signal.SIGTERM, lambda signum, frame: sp.send_signal(signum))
 317                 signal.signal(signal.SIGQUIT, lambda signum, frame: sp.send_signal(signum))
 318
 319                 # wait for process to complete.
 320                 rc = sp.wait()
 321
 322                 # restore default signal handlers.
 323                 signal.signal(signal.SIGINT, signal.SIG_DFL)
 324                 signal.signal(signal.SIGTERM, signal.SIG_DFL)
 325                 signal.signal(signal.SIGQUIT, signal.SIG_DFL)
 326             except Exception as e:
 327                 self.logger.exception(
 328                     'arv-mount: exception during exec %s', self.args.exec_args)
 329                 try:
 330                     rc = e.errno
 331                 except AttributeError:
 332                     pass
 333         exit(rc)
 334
 335     def _run_standalone(self):
 336         try:
 337             llfuse.init(self.operations, self.args.mountpoint, self._fuse_options())
 338
 339             if not self.args.foreground:
 340                 self.daemon_ctx = daemon.DaemonContext(
 341                     working_directory=os.path.dirname(self.args.mountpoint),
 342                     files_preserve=range(
 343                         3, resource.getrlimit(resource.RLIMIT_NOFILE)[1]))
 344                 self.daemon_ctx.open()
 345
 346             # Subscribe to change events from API server
 347             if self.listen_for_events and not self.args.disable_event_listening:
 348                 self.operations.listen_for_events()
 349
 350             self._llfuse_main()
 351         except Exception as e:
 352             self.logger.exception('arv-mount: exception during mount: %s', e)
 353             exit(getattr(e, 'errno', 1))
 354         exit(0)
 355
 356     def _llfuse_main(self):
 357         try:
 358             llfuse.main()
 359         except:
 360             llfuse.close(unmount=False)
 361             raise
 362         llfuse.close()