services/fuse/bin/arv-mount

   1 #!/usr/bin/env python
   2
   3 import argparse
   4 import arvados
   5 import daemon
   6 import logging
   7 import os
   8 import signal
   9 import subprocess
  10 import time
  11
  12 import arvados.commands._util as arv_cmd
  13 from arvados_fuse import *
  14 from arvados.safeapi import ThreadSafeApiCache
  15
  16 logger = logging.getLogger('arvados.arv-mount')
  17
  18 if __name__ == '__main__':
  19     # Handle command line parameters
  20     parser = argparse.ArgumentParser(
  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     parser.add_argument('mountpoint', type=str, help="""Mount point.""")
  29     parser.add_argument('--allow-other', action='store_true',
  30                         help="""Let other users read the mount""")
  31
  32     mount_mode = parser.add_mutually_exclusive_group()
  33
  34     mount_mode.add_argument('--all', action='store_true', help="""Mount a subdirectory for each mode: home, shared, by_tag, by_id (default).""")
  35     mount_mode.add_argument('--home', action='store_true', help="""Mount only the user's home project.""")
  36     mount_mode.add_argument('--shared', action='store_true', help="""Mount only list of projects shared with the user.""")
  37     mount_mode.add_argument('--by-tag', action='store_true',
  38                             help="""Mount subdirectories listed by tag.""")
  39     mount_mode.add_argument('--by-id', action='store_true',
  40                             help="""Mount subdirectories listed by portable data hash or uuid.""")
  41     mount_mode.add_argument('--project', type=str, help="""Mount a specific project.""")
  42     mount_mode.add_argument('--collection', type=str, help="""Mount only the specified collection.""")
  43
  44     parser.add_argument('--debug', action='store_true', help="""Debug mode""")
  45     parser.add_argument('--logfile', help="""Write debug logs and errors to the specified file (default stderr).""")
  46     parser.add_argument('--foreground', action='store_true', help="""Run in foreground (default is to daemonize unless --exec specified)""", default=False)
  47     parser.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")
  48
  49     parser.add_argument('--inode-cache', type=int, help="Inode cache size", default=1024)
  50
  51     parser.add_argument('--exec', type=str, nargs=argparse.REMAINDER,
  52                         dest="exec_args", metavar=('command', 'args', '...', '--'),
  53                         help="""Mount, run a command, then unmount and exit""")
  54
  55     args = parser.parse_args()
  56     args.mountpoint = os.path.realpath(args.mountpoint)
  57     if args.logfile:
  58         args.logfile = os.path.realpath(args.logfile)
  59
  60     # Daemonize as early as possible, so we don't accidentally close
  61     # file descriptors we're using.
  62     if not (args.exec_args or args.foreground):
  63         os.chdir(args.mountpoint)
  64         daemon_ctx = daemon.DaemonContext(working_directory='.')
  65         daemon_ctx.open()
  66     else:
  67         daemon_ctx = None
  68
  69     # Configure a log handler based on command-line switches.
  70     if args.logfile:
  71         log_handler = logging.FileHandler(args.logfile)
  72     elif daemon_ctx:
  73         log_handler = logging.NullHandler()
  74     else:
  75         log_handler = None
  76
  77     if log_handler is not None:
  78         arvados.logger.removeHandler(arvados.log_handler)
  79         arvados.logger.addHandler(log_handler)
  80
  81     if args.debug:
  82         arvados.logger.setLevel(logging.DEBUG)
  83         logger.debug("arv-mount debugging enabled")
  84
  85     try:
  86         # Create the request handler
  87         operations = Operations(os.getuid(), os.getgid(), args.encoding, args.inode_cache)
  88         api = ThreadSafeApiCache(arvados.config.settings())
  89
  90         usr = api.users().current().execute(num_retries=args.retries)
  91         now = time.time()
  92         dir_class = None
  93         dir_args = [llfuse.ROOT_INODE, operations.inodes, api, args.retries]
  94         if args.by_id:
  95             # Set up the request handler with the 'magic directory' at the root
  96             dir_class = MagicDirectory
  97         elif args.by_tag:
  98             dir_class = TagsDirectory
  99         elif args.shared:
 100             dir_class = SharedDirectory
 101             dir_args.append(usr)
 102         elif args.home:
 103             dir_class = ProjectDirectory
 104             dir_args.append(usr)
 105             dir_args.append(True)
 106         elif args.collection is not None:
 107             # Set up the request handler with the collection at the root
 108             dir_class = CollectionDirectory
 109             dir_args.append(args.collection)
 110         elif args.project is not None:
 111             dir_class = ProjectDirectory
 112             dir_args.append(api.groups().get(uuid=args.project).execute(
 113                     num_retries=args.retries))
 114
 115         if dir_class is not None:
 116             operations.inodes.add_entry(dir_class(*dir_args))
 117         else:
 118             e = operations.inodes.add_entry(Directory(llfuse.ROOT_INODE, operations.inodes))
 119             dir_args[0] = e.inode
 120
 121             e._entries['by_id'] = operations.inodes.add_entry(MagicDirectory(*dir_args))
 122             e._entries['by_tag'] = operations.inodes.add_entry(TagsDirectory(*dir_args))
 123
 124             dir_args.append(usr)
 125             dir_args.append(True)
 126             e._entries['home'] = operations.inodes.add_entry(ProjectDirectory(*dir_args))
 127             e._entries['shared'] = operations.inodes.add_entry(SharedDirectory(*dir_args))
 128
 129             text = '''
 130 Welcome to Arvados!  This directory provides file system access to files and objects
 131 available on the Arvados installation located at '{}'
 132 using credentials for user '{}'.
 133
 134 From here, the following directories are available:
 135
 136   by_id/     Access to Keep collections by uuid or portable data hash (see by_id/README for details).
 137   by_tag/    Access to Keep collections organized by tag.
 138   home/      The contents of your home project.
 139   shared/    Projects shared with you.
 140 '''.format(arvados.config.get('ARVADOS_API_HOST'), usr['email'])
 141
 142             e._entries["README"] = operations.inodes.add_entry(StringFile(e.inode, text, now))
 143
 144
 145     except Exception:
 146         logger.exception("arv-mount: exception during API setup")
 147         exit(1)
 148
 149     # FUSE options, see mount.fuse(8)
 150     opts = [optname for optname in ['allow_other', 'debug']
 151             if getattr(args, optname)]
 152
 153     if args.exec_args:
 154         # Initialize the fuse connection
 155         llfuse.init(operations, args.mountpoint, opts)
 156
 157         t = threading.Thread(None, lambda: llfuse.main())
 158         t.start()
 159
 160         # wait until the driver is finished initializing
 161         operations.initlock.wait()
 162
 163         rc = 255
 164         try:
 165             sp = subprocess.Popen(args.exec_args, shell=False)
 166
 167             # forward signals to the process.
 168             signal.signal(signal.SIGINT, lambda signum, frame: sp.send_signal(signum))
 169             signal.signal(signal.SIGTERM, lambda signum, frame: sp.send_signal(signum))
 170             signal.signal(signal.SIGQUIT, lambda signum, frame: sp.send_signal(signum))
 171
 172             # wait for process to complete.
 173             rc = sp.wait()
 174
 175             # restore default signal handlers.
 176             signal.signal(signal.SIGINT, signal.SIG_DFL)
 177             signal.signal(signal.SIGTERM, signal.SIG_DFL)
 178             signal.signal(signal.SIGQUIT, signal.SIG_DFL)
 179         except Exception as e:
 180             logger.exception('arv-mount: exception during exec %s',
 181                              args.exec_args)
 182             try:
 183                 rc = e.errno
 184             except AttributeError:
 185                 pass
 186         finally:
 187             subprocess.call(["fusermount", "-u", "-z", args.mountpoint])
 188
 189         exit(rc)
 190     else:
 191         try:
 192             llfuse.init(operations, args.mountpoint, opts)
 193             llfuse.main()
 194         except Exception as e:
 195             logger.exception('arv-mount: exception during mount')
 196             exit(getattr(e, 'errno', 1))