X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/19c43cebdfa1b701b031577f62c2a7b060dc8b0e..fcdaf1cedc195d3835a96d89471837ae321c5063:/services/fuse/bin/arv-mount diff --git a/services/fuse/bin/arv-mount b/services/fuse/bin/arv-mount index c3f4ab01ff..a6799051bb 100755 --- a/services/fuse/bin/arv-mount +++ b/services/fuse/bin/arv-mount @@ -7,6 +7,7 @@ import logging import os import signal import subprocess +import sys import time import arvados.commands._util as arv_cmd @@ -16,6 +17,66 @@ import arvados.keep logger = logging.getLogger('arvados.arv-mount') +class Stat(object): + def __init__(self, prefix, interval, + egr_name, ing_name, + egr_func, ing_func): + self.prefix = prefix + self.interval = interval + self.egr_name = egr_name + self.ing_name = ing_name + self.egress = egr_func + self.ingress = ing_func + self.egr_prev = self.egress() + self.ing_prev = self.ingress() + + def update(self): + egr = self.egress() + ing = self.ingress() + + delta = " -- interval %.4f seconds %d %s %d %s" % (self.interval, + egr - self.egr_prev, + self.egr_name, + ing - self.ing_prev, + self.ing_name) + + sys.stderr.write("crunchstat: %s %d %s %d %s%s\n" % (self.prefix, + egr, + self.egr_name, + ing, + self.ing_name, + delta)) + + self.egr_prev = egr + self.ing_prev = ing + + +def statlogger(interval, keep, ops): + calls = Stat("keepcalls", interval, "put", "get", + keep.put_counter.get, + keep.get_counter.get) + net = Stat("net:keep0", interval, "tx", "rx", + keep.upload_counter.get, + keep.download_counter.get) + cache = Stat("keepcache", interval, "hit", "miss", + keep.hits_counter.get, + keep.misses_counter.get) + fuseops = Stat("fuseops", interval,"write", "read", + ops.write_ops_counter.get, + ops.read_ops_counter.get) + blk = Stat("blkio:0:0", interval, "write", "read", + ops.write_counter.get, + ops.read_counter.get) + + while True: + time.sleep(interval) + calls.update() + net.update() + cache.update() + fuseops.update() + blk.update() + + if __name__ == '__main__': # Handle command line parameters parser = argparse.ArgumentParser( @@ -32,15 +93,44 @@ with "--". mount_mode = parser.add_mutually_exclusive_group() - mount_mode.add_argument('--all', action='store_true', help="""Mount a subdirectory for each mode: home, shared, by_tag, by_id (default).""") - mount_mode.add_argument('--home', action='store_true', help="""Mount only the user's home project.""") - mount_mode.add_argument('--shared', action='store_true', help="""Mount only list of projects shared with the user.""") - mount_mode.add_argument('--by-tag', action='store_true', + mount_mode.add_argument('--all', action='store_const', const='all', dest='mode', + help="""Mount a subdirectory for each mode: home, shared, by_tag, by_id (default if no --mount-* arguments are given).""") + mount_mode.add_argument('--custom', action='store_const', const=None, dest='mode', + help="""Mount a top level meta-directory with subdirectories as specified by additional --mount-* arguments (default if any --mount-* arguments are given).""") + mount_mode.add_argument('--home', action='store_const', const='home', dest='mode', + help="""Mount only the user's home project.""") + mount_mode.add_argument('--shared', action='store_const', const='shared', dest='mode', + help="""Mount only list of projects shared with the user.""") + mount_mode.add_argument('--by-tag', action='store_const', const='by_tag', dest='mode', help="""Mount subdirectories listed by tag.""") - mount_mode.add_argument('--by-id', action='store_true', + mount_mode.add_argument('--by-id', action='store_const', const='by_id', dest='mode', help="""Mount subdirectories listed by portable data hash or uuid.""") - mount_mode.add_argument('--project', type=str, help="""Mount a specific project.""") - mount_mode.add_argument('--collection', type=str, help="""Mount only the specified collection.""") + mount_mode.add_argument('--by-pdh', action='store_const', const='by_pdh', dest='mode', + help="""Mount subdirectories listed by portable data hash.""") + mount_mode.add_argument('--project', type=str, metavar='UUID', + help="""Mount the specified project.""") + mount_mode.add_argument('--collection', type=str, metavar='UUID_or_PDH', + help="""Mount only the specified collection.""") + + mounts = parser.add_argument_group('Custom mount options') + mounts.add_argument('--mount-by-pdh', + type=str, metavar='PATH', action='append', default=[], + help="Mount each readable collection at mountpoint/PATH/P where P is the collection's portable data hash.") + mounts.add_argument('--mount-by-id', + type=str, metavar='PATH', action='append', default=[], + 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.") + mounts.add_argument('--mount-by-tag', + type=str, metavar='PATH', action='append', default=[], + help="Mount all collections with tag TAG at mountpoint/PATH/TAG/UUID.") + mounts.add_argument('--mount-home', + type=str, metavar='PATH', action='append', default=[], + help="Mount the current user's home project at mountpoint/PATH.") + mounts.add_argument('--mount-shared', + type=str, metavar='PATH', action='append', default=[], + help="Mount projects shared with the current user at mountpoint/PATH.") + mounts.add_argument('--mount-tmp', + type=str, metavar='PATH', action='append', default=[], + help="Create a new collection, mount it in read/write mode at mountpoint/PATH, and delete it when unmounting.") parser.add_argument('--debug', action='store_true', help="""Debug mode""") parser.add_argument('--logfile', help="""Write debug logs and errors to the specified file (default stderr).""") @@ -50,6 +140,11 @@ with "--". parser.add_argument('--file-cache', type=int, help="File data cache size, in bytes (default 256MiB)", default=256*1024*1024) parser.add_argument('--directory-cache', type=int, help="Directory data cache size, in bytes (default 128MiB)", default=128*1024*1024) + parser.add_argument('--read-only', action='store_false', help="Mount will be read only (default)", dest="enable_write", default=False) + parser.add_argument('--read-write', action='store_true', help="Mount will be read-write", dest="enable_write", default=False) + + parser.add_argument('--crunchstat-interval', type=float, help="Write stats to stderr every N seconds (default disabled)", default=0) + parser.add_argument('--exec', type=str, nargs=argparse.REMAINDER, dest="exec_args", metavar=('command', 'args', '...', '--'), help="""Mount, run a command, then unmount and exit""") @@ -84,31 +179,61 @@ with "--". arvados.logger.setLevel(logging.DEBUG) logger.debug("arv-mount debugging enabled") + logger.info("enable write is %s", args.enable_write) + try: + api = ThreadSafeApiCache(apiconfig=arvados.config.settings(), + keep_params={"block_cache": arvados.keep.KeepBlockCache(args.file_cache)}) + # Create the request handler operations = Operations(os.getuid(), os.getgid(), + api_client=api, encoding=args.encoding, - inode_cache=InodeCache(cap=args.directory_cache)) - api = ThreadSafeApiCache(apiconfig=arvados.config.settings(), - keep_params={"block_cache": arvados.keep.KeepBlockCache(args.file_cache)}) + inode_cache=InodeCache(cap=args.directory_cache), + enable_write=args.enable_write) + + if args.crunchstat_interval: + statsthread = threading.Thread(target=statlogger, args=(args.crunchstat_interval, api.keep, operations)) + statsthread.daemon = True + statsthread.start() usr = api.users().current().execute(num_retries=args.retries) now = time.time() dir_class = None dir_args = [llfuse.ROOT_INODE, operations.inodes, api, args.retries] - if args.by_id: + mount_readme = False + + if args.mode is not None and ( + args.mount_by_id or + args.mount_by_pdh or + args.mount_by_tag or + args.mount_home or + args.mount_shared or + args.mount_tmp or + args.mount_collection): + sys.exit("Cannot combine '{}' mode with custom --mount-* options.". + format(args.mode)) + + if args.mode in ['by_id', 'by_pdh']: # Set up the request handler with the 'magic directory' at the root dir_class = MagicDirectory - elif args.by_tag: + dir_args.append(args.mode == 'by_pdh') + elif args.mode == 'by_tag': dir_class = TagsDirectory - elif args.shared: + elif args.mode == 'shared': dir_class = SharedDirectory dir_args.append(usr) - elif args.home: + elif args.mode == 'home': dir_class = ProjectDirectory dir_args.append(usr) dir_args.append(True) + elif args.mode == 'all': + args.mount_by_id = ['by_id'] + args.mount_by_tag = ['by_tag'] + args.mount_home = ['home'] + args.mount_shared = ['shared'] + mount_readme = True elif args.collection is not None: # Set up the request handler with the collection at the root dir_class = CollectionDirectory @@ -124,18 +249,29 @@ with "--". e = operations.inodes.add_entry(Directory(llfuse.ROOT_INODE, operations.inodes)) dir_args[0] = e.inode - e._entries['by_id'] = operations.inodes.add_entry(MagicDirectory(*dir_args)) - e._entries['by_tag'] = operations.inodes.add_entry(TagsDirectory(*dir_args)) - - dir_args.append(usr) - dir_args.append(True) - e._entries['home'] = operations.inodes.add_entry(ProjectDirectory(*dir_args)) - e._entries['shared'] = operations.inodes.add_entry(SharedDirectory(*dir_args)) - - text = ''' -Welcome to Arvados! This directory provides file system access to files and objects -available on the Arvados installation located at '{}' -using credentials for user '{}'. + def addMount(tld, name, ent): + if name in ['', '.', '..'] or '/' in name: + sys.exit("Mount point '{}' is not supported.".format(name)) + tld._entries[name] = operations.inodes.add_entry(ent) + + for name in args.mount_by_id: + addMount(e, name, MagicDirectory(*dir_args, pdh_only=False)) + for name in args.mount_by_pdh: + addMount(e, name, MagicDirectory(*dir_args, pdh_only=True)) + for name in args.mount_by_tag: + addMount(e, name, TagsDirectory(*dir_args)) + for name in args.mount_home: + addMount(e, name, ProjectDirectory(*dir_args, project_object=usr, poll=True)) + for name in args.mount_shared: + addMount(e, name, SharedDirectory(*dir_args, exclude=usr, poll=True)) + for name in args.mount_tmp: + addMount(e, name, TmpCollectionDirectory(*dir_args)) + + if mount_readme: + text = ''' +Welcome to Arvados! This directory provides file system access to +files and objects available on the Arvados installation located at +'{}' using credentials for user '{}'. From here, the following directories are available: @@ -144,9 +280,7 @@ From here, the following directories are available: home/ The contents of your home project. shared/ Projects shared with you. '''.format(arvados.config.get('ARVADOS_API_HOST'), usr['email']) - - e._entries["README"] = operations.inodes.add_entry(StringFile(e.inode, text, now)) - + addMount(e, StringFile(e.inode, text, now)) except Exception: logger.exception("arv-mount: exception during API setup") @@ -164,7 +298,8 @@ From here, the following directories are available: llfuse.init(operations, args.mountpoint, opts) # Subscribe to change events from API server - operations.listen_for_events(api) + if args.mode != 'by_pdh': + operations.listen_for_events() t = threading.Thread(None, lambda: llfuse.main()) t.start() @@ -197,6 +332,7 @@ From here, the following directories are available: pass finally: subprocess.call(["fusermount", "-u", "-z", args.mountpoint]) + operations.destroy() exit(rc) else: @@ -204,9 +340,11 @@ From here, the following directories are available: llfuse.init(operations, args.mountpoint, opts) # Subscribe to change events from API server - operations.listen_for_events(api) + operations.listen_for_events() llfuse.main() except Exception as e: logger.exception('arv-mount: exception during mount') exit(getattr(e, 'errno', 1)) + finally: + operations.destroy()