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