add tbbmalloc library (scalable multi-threaded allocator)

Author: jjallaire

NEWS

@@ -3,6 +3,7 @@ RcppParallel 4.3.7
 
 * Fix failure to compile with Rtools 3.3
 * Fix failure to compile on OS X Snow Leopard R toolchain
+* Add tbbmalloc library
 
 RcppParallel 4.3.6
 ------------------------------------------------------------------------

R/build.R

@@ -39,19 +39,19 @@ tbbLdFlags <- function() {
    # on Windows we need to explicitly link against tbb.dll
    if (Sys.info()['sysname'] == "Windows") {
       tbb <- tbbLibPath()
-      paste("-L", asBuildPath(dirname(tbb)), " -ltbb", sep="")
+      paste("-L", asBuildPath(dirname(tbb)), " -ltbb", "-ltbbmalloc", sep = "")
    } else {
       ""
    }
 }
 
 # Determine the platform-specific path to the TBB library
-tbbLibPath <- function() {
+tbbLibPath <- function(suffix = "") {
    sysname <- Sys.info()['sysname']
    tbbSupported <- list(
-      "Darwin" = "libtbb.dylib", 
-      "Linux" = "libtbb.so.2", 
-      "Windows" = "tbb.dll"
+      "Darwin" = paste("libtbb", suffix, ".dylib", sep = ""), 
+      "Linux" = paste("libtbb", suffix, ".so.2", sep = ""), 
+      "Windows" = paste("tbb", suffix, ".dll", sep = "") 
    )
    if (sysname %in% names(tbbSupported)) {
       libDir <- "lib/"

R/hooks.R

@@ -1,10 +1,10 @@
 
 dllInfo <- NULL
-
+mallocDllInfo <- NULL
 
 .onLoad <- function(libname, pkgname) {
 
-   # load tbb on supported platforms   
+   # load tbb and tbbmalloc on supported platforms   
    tbb <- tbbLibPath()
    if (!is.null(tbb)) {
       if (!file.exists(tbb)) {
@@ -13,6 +13,14 @@ dllInfo <- NULL
          dllInfo <<- dyn.load(tbb, local = FALSE, now = TRUE)
       }
    }
+   tbbMalloc <- tbbLibPath("malloc")
+   if (!is.null(tbbMalloc)) {
+      if (!file.exists(tbbMalloc)) {
+         warning(paste("TBB malloc library", tbbMalloc, "not found."))
+      } else {
+         mallocDllInfo <<- dyn.load(tbbMalloc, local = FALSE, now = TRUE)
+      }
+   }
 
    # load the package library
    library.dynam("RcppParallel", pkgname, libname)
@@ -29,4 +37,7 @@ dllInfo <- NULL
    # unload tbb if we loaded it
    if (!is.null(dllInfo))
       dyn.unload(dllInfo[["path"]])
+   # unload tbbmalloc if we loaded it
+   if (!is.null(mallocDllInfo))
+      dyn.unload(mallocDllInfo[["path"]])
 }

inst/include/RcppParallel/TBB.h

@@ -4,6 +4,7 @@
 #include "Common.h"
 
 #include <tbb/tbb.h>
+#include <tbb/scalable_allocator.h>
 
 namespace RcppParallel {
 

src/Makevars

@@ -4,7 +4,7 @@ PKG_CPPFLAGS += -I../inst/include/
 ifeq ($(OS), Windows_NT)
 
   USE_TBB=Windows
-  TBB_COPY_PATTERN=tbb.dll
+  TBB_COPY_PATTERN=tbb*.dll
 
   # Extra PATH entry for gcc (required by TBB)
   GCC_PATH = $(shell cygpath $(dir $(CC))):
@@ -14,7 +14,7 @@ ifeq ($(OS), Windows_NT)
 else
 
   UNAME := $(shell uname)
-  TBB_COPY_PATTERN=libtbb.*
+  TBB_COPY_PATTERN=libtbb*.*
   ifeq ($(UNAME), Darwin)
     USE_TBB=Mac
     # We don't set this on OS X because it caused build failures on
@@ -34,7 +34,7 @@ ifdef USE_TBB
 
 PKG_CPPFLAGS += -DRCPP_PARALLEL_USE_TBB=1
 
-MAKE_ARGS := CXXFLAGS=-DTBB_NO_LEGACY=1 tbb_release tbb_build_prefix=lib
+MAKE_ARGS := CXXFLAGS=-DTBB_NO_LEGACY=1 tbb_release tbbmalloc_release tbb_build_prefix=lib
 
 # What I really want is startswith but this doesn't appear to be available
 ifneq (,$(findstring clang,$(CC)))
@@ -56,7 +56,7 @@ ifeq ($(USE_TBB),  Windows)
 
   # Linker needs access to the tbb dll; otherwise you get errors such as:
   # "undefined reference to `tbb::task_scheduler_init::terminate()'"
-  PKG_LIBS += -L../inst/lib/$(ARCH_DIR) -ltbb
+  PKG_LIBS += -L../inst/lib/$(ARCH_DIR) -ltbb -ltbbmalloc
 
 endif
 

tests/testthat/cpp/malloc.cpp

@@ -0,0 +1,26 @@
+
+#include <Rcpp.h>
+using namespace Rcpp;
+
+// [[Rcpp::depends(RcppParallel)]]
+#include <RcppParallel.h>
+using namespace RcppParallel;
+
+// [[Rcpp::export]]
+void tbbMalloc() {
+   
+#if RCPP_PARALLEL_USE_TBB
+   
+   std::vector<int,tbb::tbb_allocator<int> > vec;
+   vec.push_back(42);
+   
+   std::vector<int,tbb::scalable_allocator<int> > scalableVec;
+   scalableVec.push_back(42);
+   
+   std::vector<int,tbb::cache_aligned_allocator<int> > cacheAlignedVec;
+   cacheAlignedVec.push_back(42);
+   
+#endif 
+  
+}
+

tests/testthat/pkg/RcppParallelTest/src/test.cpp

@@ -41,4 +41,22 @@ double parallelVectorSum(NumericVector x) {
    return sum.value;
 }
 
+// [[Rcpp::export]]
+void testMalloc() {
+   
+#if RCPP_PARALLEL_USE_TBB
+   
+   std::vector<int,tbb::tbb_allocator<int> > vec;
+   vec.push_back(42);
+   
+   std::vector<int,tbb::scalable_allocator<int> > scalableVec;
+   scalableVec.push_back(42);
+   
+   std::vector<int,tbb::cache_aligned_allocator<int> > cacheAlignedVec;
+   cacheAlignedVec.push_back(42);
+   
+#endif 
+   
+}
+
 

tests/testthat/test-malloc.R

@@ -0,0 +1,6 @@
+context( "malloc" )
+
+test_that( "tbbmalloc works", {
+    sourceCpp( "cpp/malloc.cpp" )
+})
+