mmap()'d Ring Space

CHANGELOG

@@ -8,6 +8,7 @@
  * Added set_stream and get_stream to bifrost.device to help control which CUDA stream is used
  * Added bifrost.device.ExternalStream as a context manager to help with mixing Bifrost and cupy/pycuda
  * Fixed a problem calling bifrost.reduce on a slice of an array
+ * Added support for a new 'mapped' ring space which is backed by a file on disk
 
 0.10.0
  * Switched over to an autotools-based build system

codecov.yml

@@ -1,3 +1,5 @@
 # https://docs.codecov.com/docs/fixing-paths
 fixes:
   - "/home/docker/actions-runner/_work/_tool/Python/3.*/x64/lib/python3.*/site-packages/::python/"
+ignore:
+  - "**/libbifrost_generated.py"

configure

@@ -709,6 +709,7 @@ PYBUILDFLAGS
 PYTHON3
 PYTHON
 HAVE_PYTHON
+MAPPED_RING_DIR
 HAVE_MAP_CACHE
 HAVE_CUDA_DEBUG
 enable_native_arch
@@ -862,6 +863,7 @@ enable_debug
 enable_trace
 enable_native_arch
 enable_cuda_debug
+with_mapped_ring_dir
 enable_map_cache
 enable_python
 with_python
@@ -1568,6 +1570,9 @@ Optional Packages:
   --with-alignment=N      default memory alignment in bytes (default=4096)
   --with-logging-dir=DIR  directory for Bifrost proclog logging
                           (default=autodetect)
+  --with-mapped-ring-dir=...
+                          directory to store mapped ring files in
+                          (default=/tmp/bifrost_mapped)
   --with-python=[PATH]  absolute path to python executable
   --with-pybuild-flags    build flags for python (default='')
   --with-pyinstall-flags  install flags for python (default='')
@@ -22075,6 +22080,16 @@ then :
        NVCCFLAGS="$NVCCFLAGS -G"
 fi
 
+# Check whether --with-mapped_ring_dir was given.
+if test ${with_mapped_ring_dir+y}
+then :
+  withval=$with_mapped_ring_dir;
+else $as_nop
+  mapped_ring_dir=/tmp/bifrost_mapped
+fi
+
+MAPPED_RING_DIR=$mapped_ring_dir
+
 # Check whether --enable-map_cache was given.
 if test ${enable_map_cache+y}
 then :
@@ -27057,6 +27072,9 @@ fi
 { printf "%s\n" "$as_me:${as_lineno-$LINENO}: memory alignment: $ALIGNMENT" >&5
 printf "%s\n" "$as_me: memory alignment: $ALIGNMENT" >&6;}
 
+{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: mapped ring directory: $mapped_ring_dir" >&5
+printf "%s\n" "$as_me: mapped ring directory: $mapped_ring_dir" >&6;}
+
 { printf "%s\n" "$as_me:${as_lineno-$LINENO}: logging directory: $HAVE_TMPFS" >&5
 printf "%s\n" "$as_me: logging directory: $HAVE_TMPFS" >&6;}
 

configure.ac

@@ -206,6 +206,13 @@ AS_IF([test x$enable_cuda_debug != xno],
       [AC_SUBST([HAVE_CUDA_DEBUG], [1])
        NVCCFLAGS="$NVCCFLAGS -G"])
 
+AC_ARG_WITH([mapped_ring_dir],
+            [AS_HELP_STRING([--with-mapped-ring-dir=...],
+                            [directory to store mapped ring files in (default=/tmp/bifrost_mapped)])],
+            [],
+            [mapped_ring_dir=/tmp/bifrost_mapped])
+AC_SUBST([MAPPED_RING_DIR], [$mapped_ring_dir])
+
 AC_ARG_ENABLE([map_cache],
               [AS_HELP_STRING([--disable-map-cache],
                               [disable caching bifrost.map kernels (default=no)])],
@@ -375,6 +382,8 @@ AS_IF([test x$HAVE_PYTHON = x1],
       [AC_MSG_NOTICE(python bindings: no)])
 
 AC_MSG_NOTICE(memory alignment: $ALIGNMENT)
+
+AC_MSG_NOTICE(mapped ring directory: $mapped_ring_dir)
 
 AC_MSG_NOTICE(logging directory: $HAVE_TMPFS)
 

python/bifrost/Space.py

@@ -32,20 +32,22 @@
 
 SPACEMAP_TO_STR = {_bf.BF_SPACE_AUTO:         'auto',
                    _bf.BF_SPACE_SYSTEM:       'system',
+                   _bf.BF_SPACE_MAPPED:       'mapped',
                    _bf.BF_SPACE_CUDA:         'cuda',
                    _bf.BF_SPACE_CUDA_HOST:    'cuda_host',
                    _bf.BF_SPACE_CUDA_MANAGED: 'cuda_managed'}
 
 SPACEMAP_FROM_STR = {'auto':         _bf.BF_SPACE_AUTO,
                      'system':       _bf.BF_SPACE_SYSTEM,
+                     'mapped':       _bf.BF_SPACE_MAPPED,
                      'cuda':         _bf.BF_SPACE_CUDA,
                      'cuda_host':    _bf.BF_SPACE_CUDA_HOST,
                      'cuda_managed': _bf.BF_SPACE_CUDA_MANAGED}
 
 class Space(object):
     def __init__(self, s):
         if isinstance(s, str):
-            if s not in set(['auto', 'system',
+            if s not in set(['auto', 'system', 'mapped',
                              'cuda', 'cuda_host', 'cuda_managed']):
                 raise ValueError('Invalid space: %s' % s)
             self._space = s

python/bifrost/libbifrost.py

@@ -181,6 +181,7 @@ def _get(func, *args):
 
 STRING2SPACE = {'auto':         _bf.BF_SPACE_AUTO,
                 'system':       _bf.BF_SPACE_SYSTEM,
+                'mapped':       _bf.BF_SPACE_MAPPED,
                 'cuda':         _bf.BF_SPACE_CUDA,
                 'cuda_host':    _bf.BF_SPACE_CUDA_HOST,
                 'cuda_managed': _bf.BF_SPACE_CUDA_MANAGED}
@@ -192,6 +193,7 @@ def _string2space(s):
 
 SPACE2STRING = {_bf.BF_SPACE_AUTO:         'auto',
                 _bf.BF_SPACE_SYSTEM:       'system',
+                _bf.BF_SPACE_MAPPED:       'mapped',
                 _bf.BF_SPACE_CUDA:         'cuda',
                 _bf.BF_SPACE_CUDA_HOST:    'cuda_host',
                 _bf.BF_SPACE_CUDA_MANAGED: 'cuda_managed'}

python/bifrost/memory.py

@@ -41,10 +41,19 @@ def space_accessible(space, from_spaces):
     from_spaces = set(from_spaces)
     if space in from_spaces:
         return True
+    elif space in ('system', 'mapped'):
+        return 'system' in from_spaces \
+               or 'mapped' in from_spaces \
+               or 'cuda_host' in from_spaces \
+               or 'cuda_managed' in from_spaces
     elif space == 'cuda_host':
-        return 'system' in from_spaces
+        return 'system' in from_spaces \
+               or 'mapped' in from_spaces \
+               or 'cuda_managed' in from_spaces
     elif space == 'cuda_managed':
-        return 'system' in from_spaces or 'cuda' in from_spaces
+        return 'system' in from_spaces \
+               or 'mapped' in from_spaces \
+               or 'cuda' in from_spaces
     else:
         return False
 

python/bifrost/pipeline.py

@@ -190,6 +190,7 @@ def dot_graph(self, parent_graph=None):
                 for oring in block.orings:
                     space_colors = {
                         'system':    'orange',
+                        'mapped':    'goldenrod',
                         'cuda':      'limegreen',
                         'cuda_host': 'deepskyblue'
                     }

python/bifrost/version/__main__.py

@@ -28,6 +28,7 @@
 
 from __future__ import print_function
 
+import os
 import argparse
 
 from bifrost import __version__, __copyright__, __license__
@@ -49,6 +50,9 @@ def _yes_no(value):
     print(" NUMA support %s" % _yes_no(BF_NUMA_ENABLED))
     print(" Hardware locality support: %s" % _yes_no(BF_HWLOC_ENABLED))
     print(" Mellanox messaging accelerator (VMA) support: %s" % _yes_no(BF_VMA_ENABLED))
+    print(" Mapped ring directory: %s" % BF_MAPPED_RING_DIR)
+    if os.getenv('BIFROST_MAPPED_DIR') is not None:
+        print("Mapped ring directory: override - %s" % os.getenv('BIFROST_MAPPED_DIR'))
     print(" Logging directory: %s" % BF_PROCLOG_DIR)
     print(" Debugging: %s" % _yes_no(BF_DEBUG_ENABLED))
     print(" CUDA support: %s" % _yes_no(BF_CUDA_ENABLED))

src/bifrost/config.h.in

@@ -66,6 +66,9 @@ extern "C" {
 #define BF_TRACE_ENABLED @HAVE_TRACE@
 #define BF_CUDA_DEBUG_ENABLED @HAVE_CUDA_DEBUG@
 
+// Mapped ring directory
+#define BF_MAPPED_RING_DIR "@MAPPED_RING_DIR@"
+
 // Logging directory
 #define BF_PROCLOG_DIR "@HAVE_TMPFS@"
 

src/bifrost/memory.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, The Bifrost Authors. All rights reserved.
+ * Copyright (c) 2016-2019, The Bifrost Authors. All rights reserved.
  * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -43,9 +43,10 @@ extern "C" {
 typedef enum BFspace_ {
 	BF_SPACE_AUTO         = 0,
 	BF_SPACE_SYSTEM       = 1, // aligned_alloc
-	BF_SPACE_CUDA         = 2, // cudaMalloc
-	BF_SPACE_CUDA_HOST    = 3, // cudaHostAlloc
-	BF_SPACE_CUDA_MANAGED = 4  // cudaMallocManaged
+	BF_SPACE_MAPPED       = 2, // mmapped to a file
+	BF_SPACE_CUDA         = 3, // cudaMalloc
+	BF_SPACE_CUDA_HOST    = 4, // cudaHostAlloc
+	BF_SPACE_CUDA_MANAGED = 5 // cudaMallocManaged
 } BFspace;
 
 BFstatus bfMalloc(void** ptr, BFsize size, BFspace space);

src/fileutils.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2022, The Bifrost Authors. All rights reserved.
+ * Copyright (c) 2016-2022, The Bifrost Authors. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions