12 import arvados.commands._util as arv_cmd
13 from arvados_fuse import *
14 from arvados.safeapi import ThreadSafeApiCache
17 logger = logging.getLogger('arvados.arv-mount')
19 if __name__ == '__main__':
20 # Handle command line parameters
21 parser = argparse.ArgumentParser(
22 parents=[arv_cmd.retry_opt],
23 description='''Mount Keep data under the local filesystem. Default mode is --home''',
25 Note: When using the --exec feature, you must either specify the
26 mountpoint before --exec, or mark the end of your --exec arguments
29 parser.add_argument('mountpoint', type=str, help="""Mount point.""")
30 parser.add_argument('--allow-other', action='store_true',
31 help="""Let other users read the mount""")
33 mount_mode = parser.add_mutually_exclusive_group()
35 mount_mode.add_argument('--all', action='store_true', help="""Mount a subdirectory for each mode: home, shared, by_tag, by_id (default).""")
36 mount_mode.add_argument('--home', action='store_true', help="""Mount only the user's home project.""")
37 mount_mode.add_argument('--shared', action='store_true', help="""Mount only list of projects shared with the user.""")
38 mount_mode.add_argument('--by-tag', action='store_true',
39 help="""Mount subdirectories listed by tag.""")
40 mount_mode.add_argument('--by-id', action='store_true',
41 help="""Mount subdirectories listed by portable data hash or uuid.""")
42 mount_mode.add_argument('--by-pdh', action='store_true',
43 help="""Mount subdirectories listed by portable data hash.""")
44 mount_mode.add_argument('--project', type=str, help="""Mount a specific project.""")
45 mount_mode.add_argument('--collection', type=str, help="""Mount only the specified collection.""")
47 parser.add_argument('--debug', action='store_true', help="""Debug mode""")
48 parser.add_argument('--logfile', help="""Write debug logs and errors to the specified file (default stderr).""")
49 parser.add_argument('--foreground', action='store_true', help="""Run in foreground (default is to daemonize unless --exec specified)""", default=False)
50 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")
52 parser.add_argument('--file-cache', type=int, help="File data cache size, in bytes (default 256MiB)", default=256*1024*1024)
53 parser.add_argument('--directory-cache', type=int, help="Directory data cache size, in bytes (default 128MiB)", default=128*1024*1024)
55 parser.add_argument('--read-only', action='store_false', help="Mount will be read only (default)", dest="enable_write", default=False)
56 parser.add_argument('--read-write', action='store_true', help="Mount will be read-write", dest="enable_write", default=False)
58 parser.add_argument('--exec', type=str, nargs=argparse.REMAINDER,
59 dest="exec_args", metavar=('command', 'args', '...', '--'),
60 help="""Mount, run a command, then unmount and exit""")
62 args = parser.parse_args()
63 args.mountpoint = os.path.realpath(args.mountpoint)
65 args.logfile = os.path.realpath(args.logfile)
67 # Daemonize as early as possible, so we don't accidentally close
68 # file descriptors we're using.
69 if not (args.exec_args or args.foreground):
70 os.chdir(args.mountpoint)
71 daemon_ctx = daemon.DaemonContext(working_directory='.')
76 # Configure a log handler based on command-line switches.
78 log_handler = logging.FileHandler(args.logfile)
80 log_handler = logging.NullHandler()
84 if log_handler is not None:
85 arvados.logger.removeHandler(arvados.log_handler)
86 arvados.logger.addHandler(log_handler)
89 arvados.logger.setLevel(logging.DEBUG)
90 logger.debug("arv-mount debugging enabled")
92 logger.info("enable write is %s", args.enable_write)
95 # Create the request handler
96 operations = Operations(os.getuid(),
98 encoding=args.encoding,
99 inode_cache=InodeCache(cap=args.directory_cache),
100 enable_write=args.enable_write)
101 api = ThreadSafeApiCache(apiconfig=arvados.config.settings(),
102 keep_params={"block_cache": arvados.keep.KeepBlockCache(args.file_cache)})
104 usr = api.users().current().execute(num_retries=args.retries)
107 dir_args = [llfuse.ROOT_INODE, operations.inodes, api, args.retries]
108 if args.by_id or args.by_pdh:
109 # Set up the request handler with the 'magic directory' at the root
110 dir_class = MagicDirectory
111 dir_args.append(args.by_pdh)
113 dir_class = TagsDirectory
115 dir_class = SharedDirectory
118 dir_class = ProjectDirectory
120 dir_args.append(True)
121 elif args.collection is not None:
122 # Set up the request handler with the collection at the root
123 dir_class = CollectionDirectory
124 dir_args.append(args.collection)
125 elif args.project is not None:
126 dir_class = ProjectDirectory
127 dir_args.append(api.groups().get(uuid=args.project).execute(
128 num_retries=args.retries))
130 if dir_class is not None:
131 operations.inodes.add_entry(dir_class(*dir_args))
133 e = operations.inodes.add_entry(Directory(llfuse.ROOT_INODE, operations.inodes))
134 dir_args[0] = e.inode
136 e._entries['by_id'] = operations.inodes.add_entry(MagicDirectory(*dir_args))
138 e._entries['by_tag'] = operations.inodes.add_entry(TagsDirectory(*dir_args))
141 dir_args.append(True)
142 e._entries['home'] = operations.inodes.add_entry(ProjectDirectory(*dir_args))
143 e._entries['shared'] = operations.inodes.add_entry(SharedDirectory(*dir_args))
146 Welcome to Arvados! This directory provides file system access to files and objects
147 available on the Arvados installation located at '{}'
148 using credentials for user '{}'.
150 From here, the following directories are available:
152 by_id/ Access to Keep collections by uuid or portable data hash (see by_id/README for details).
153 by_tag/ Access to Keep collections organized by tag.
154 home/ The contents of your home project.
155 shared/ Projects shared with you.
156 '''.format(arvados.config.get('ARVADOS_API_HOST'), usr['email'])
158 e._entries["README"] = operations.inodes.add_entry(StringFile(e.inode, text, now))
162 logger.exception("arv-mount: exception during API setup")
165 # FUSE options, see mount.fuse(8)
166 opts = [optname for optname in ['allow_other', 'debug']
167 if getattr(args, optname)]
169 # Increase default read/write size from 4KiB to 128KiB
170 opts += ["big_writes", "max_read=131072"]
173 # Initialize the fuse connection
174 llfuse.init(operations, args.mountpoint, opts)
176 # Subscribe to change events from API server
178 operations.listen_for_events(api)
180 t = threading.Thread(None, lambda: llfuse.main())
183 # wait until the driver is finished initializing
184 operations.initlock.wait()
188 sp = subprocess.Popen(args.exec_args, shell=False)
190 # forward signals to the process.
191 signal.signal(signal.SIGINT, lambda signum, frame: sp.send_signal(signum))
192 signal.signal(signal.SIGTERM, lambda signum, frame: sp.send_signal(signum))
193 signal.signal(signal.SIGQUIT, lambda signum, frame: sp.send_signal(signum))
195 # wait for process to complete.
198 # restore default signal handlers.
199 signal.signal(signal.SIGINT, signal.SIG_DFL)
200 signal.signal(signal.SIGTERM, signal.SIG_DFL)
201 signal.signal(signal.SIGQUIT, signal.SIG_DFL)
202 except Exception as e:
203 logger.exception('arv-mount: exception during exec %s',
207 except AttributeError:
210 subprocess.call(["fusermount", "-u", "-z", args.mountpoint])
216 llfuse.init(operations, args.mountpoint, opts)
218 # Subscribe to change events from API server
219 operations.listen_for_events(api)
222 except Exception as e:
223 logger.exception('arv-mount: exception during mount')
224 exit(getattr(e, 'errno', 1))