mmap()'d Ring Space

.travis.yml

@@ -5,7 +5,7 @@ language: python
 python:
     - 2.7
     # PyPy versions
-    - pypy-5.4.1
+    - pypy2.7-6.0
 
 services:
     - docker

python/bifrost/Space.py

@@ -1,5 +1,5 @@
 
-# Copyright (c) 2016, The Bifrost Authors. All rights reserved.
+# Copyright (c) 2016-2019, 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
@@ -29,20 +29,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, basestring):
-            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

@@ -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
@@ -145,6 +145,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}
@@ -156,6 +157,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

@@ -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
@@ -35,10 +35,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/ndarray.py

@@ -90,8 +90,8 @@ def zeros(shape, dtype='f32', space=None, **kwargs):
 def copy_array(dst, src):
     dst_bf = asarray(dst)
     src_bf = asarray(src)
-    if (space_accessible(dst_bf.bf.space, ['system']) and
-        space_accessible(src_bf.bf.space, ['system'])):
+    if (space_accessible(dst_bf.bf.space, ['system',]) and      # TODO:  Should mapped be here as well?
+        space_accessible(src_bf.bf.space, ['system',])):
         np.copyto(dst_bf, src_bf)
     else:
         _check(_bf.bfArrayCopy(dst_bf.as_BFarray(),

python/bifrost/pipeline.py

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

src/Makefile

@@ -100,6 +100,10 @@ ifdef ALIGNMENT
   CPPFLAGS   += -DBF_ALIGNMENT=$(ALIGNMENT)
 endif
 
+ifdef MAPPED_RING_DIR
+  CPPFLAGS   += -DBF_MAPPED_RING_DIR='"$(patsubst %/,%,$(MAPPED_RING_DIR))"'
+endif
+
 ifdef CUDA_DEBUG
   NVCCFLAGS += -G
 endif

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,13 +43,14 @@ extern "C" {
 #ifndef BF_ALIGNMENT
   #define BF_ALIGNMENT 4096//512
 #endif
-
+   
 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

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2016-2020, 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
+ * are met:
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of The Bifrost Authors nor the names of its
+ *   contributors may be used to endorse or promote products derived
+ *   from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <sys/file.h>  // For flock
+#include <sys/stat.h>  // For fstat
+#include <sys/types.h> // For getpid
+#include <unistd.h>    // For getpid
+#include <system_error>
+
+inline void make_dir(std::string path, int perms=775) {
+	if( std::system(("mkdir -p "+path+" -m "+std::to_string(perms)).c_str()) ) {
+		throw std::runtime_error("Failed to create path: "+path);
+	}
+}
+inline void remove_all(std::string path) {
+	if( std::system(("rm -rf "+path).c_str()) ) {
+		throw std::runtime_error("Failed to remove all: "+path);
+	}
+}
+inline void remove_dir(std::string path) {
+	if( std::system(("rmdir "+path+" 2> /dev/null").c_str()) ) {
+		throw std::runtime_error("Failed to remove dir: "+path);
+	}
+}
+inline void remove_file(std::string path) {
+	if( std::system(("rm -f "+path).c_str()) ) {
+		throw std::runtime_error("Failed to remove file: "+path);
+	}
+}
+inline bool file_exists(std::string path) {
+    struct stat s;
+    return !(stat(path.c_str(), &s) == -1
+	         && errno == ENOENT);
+}
+inline bool process_exists(pid_t pid) {
+	struct stat s;
+	return !(stat(("/proc/"+std::to_string(pid)).c_str(), &s) == -1
+	         && errno == ENOENT);
+}
+
+inline std::string get_dirname(std::string filename) {
+	// TODO: This is crude, but works for our proclog use-case
+	return filename.substr(0, filename.find_last_of("/"));
+}
+
+class LockFile {
+	std::string _lockfile;
+	int         _fd;
+public:
+	LockFile(LockFile const& ) = delete;
+	LockFile& operator=(LockFile const& ) = delete;
+	LockFile(std::string lockfile) : _lockfile(lockfile) {
+		while( true ) {
+			_fd = open(_lockfile.c_str(), O_CREAT, 600);
+			flock(_fd, LOCK_EX);
+			struct stat fd_stat, lockfile_stat;
+			fstat(_fd, &fd_stat);
+			stat(_lockfile.c_str(), &lockfile_stat);
+			// Compare inodes
+			if( fd_stat.st_ino == lockfile_stat.st_ino ) {
+				// Got the lock
+				break;
+			}
+			close(_fd);
+		}
+	}
+	~LockFile() {
+		unlink(_lockfile.c_str());
+		flock(_fd, LOCK_UN);
+	}
+};
+