Merge branch 'master' into release/5.1.10

Author: kevinushey

.Rbuildignore

@@ -4,14 +4,15 @@
 ^\.Rprofile$
 ^\.Rproj\.user$
 ^appveyor\.yml$
+^check$
 ^doc$
 ^gen$
 ^libs$
 ^inst/lib$
 ^inst/libs$
 ^revdep$
 ^src/.*\.o$
-^src/tbb/build/lib_.*$
+^src/tbb/build$
 ^tags$
 ^tests/testthat/pkg/RcppParallelTest/src/.*\.dll$
 ^tests/testthat/pkg/RcppParallelTest/src/.*\.s?o$

.gitignore

@@ -3,6 +3,7 @@
 .Rhistory
 .RData
 .DS_Store
+check
 inst/doc
 inst/lib
 inst/libs
@@ -12,6 +13,8 @@ src-i386
 src-x64
 tbb.log
 
+src/tbb/build
+src/tbb/build-tbb
+
 R/tbb-autodetected.R
-src/install.libs.R
 

DESCRIPTION

@@ -3,36 +3,37 @@ Type: Package
 Title: Parallel Programming Tools for 'Rcpp'
 Version: 5.1.10
 Authors@R: c(
+    person("Kevin", "Ushey", role = c("aut", "cre"), email = "[email protected]",
+        comment = c(ORCID = "0000-0003-2880-7407")),
     person("JJ", "Allaire", role = c("aut"), email = "[email protected]"),
     person("Romain", "Francois", role = c("aut", "cph")),
-    person("Kevin", "Ushey", role = c("aut", "cre"), email = "[email protected]"),
     person("Gregory", "Vandenbrouck", role = "aut"),
     person("Marcus", "Geelnard", role = c("aut", "cph"),
        comment = "TinyThread library, https://tinythreadpp.bitsnbites.eu/"),
-    person("Hamada S.", "Badr",
-       email = "[email protected]",
-       role = c("ctb"),
+    person("Hamada S.", "Badr", email = "[email protected]", role = c("ctb"),
        comment = c(ORCID = "0000-0002-9808-2344")),
-    person(family = "Posit, PBC", role = "cph"),
-    person(family = "Intel", role = c("aut", "cph"),
-       comment = "Intel TBB library, https://www.threadingbuildingblocks.org/"),
-    person(family = "Microsoft", role = "cph")
+    person("Dirk", "Eddelbuettel", role = c("aut"), email = "[email protected]",
+        comment = c(ORCID = "0000-0001-6419-907X")),
+    person(family = "Intel", role = c("aut", "cph"), comment = "oneTBB library"),
+    person(family = "UXL Foundation", role = c("aut", "cph"), comment = "oneTBB library"),
+    person(family = "Microsoft", role = "cph"),
+    person(family = "Posit, PBC", role = "cph")
     )
 Description: High level functions for parallel programming with 'Rcpp'.
     For example, the 'parallelFor()' function can be used to convert the work of
     a standard serial "for" loop into a parallel one and the 'parallelReduce()'
     function can be used for accumulating aggregate or other values.
-Depends: R (>= 3.0.2)
+Depends: R (>= 3.6.0)
 Suggests:
     Rcpp,
     RUnit,
     knitr,
     rmarkdown
 Roxygen: list(markdown = TRUE)
-SystemRequirements: GNU make, Intel TBB, Windows: cmd.exe and cscript.exe, Solaris: g++ is required
+SystemRequirements: CMake (>= 3.5)
 License: GPL (>= 3)
 URL: https://rcppcore.github.io/RcppParallel/, https://github.com/RcppCore/RcppParallel
 BugReports: https://github.com/RcppCore/RcppParallel/issues
 Biarch: TRUE
-RoxygenNote: 7.1.1
+RoxygenNote: 7.3.2
 Encoding: UTF-8

NEWS.md

@@ -1,4 +1,14 @@
 
+## RcppParallel 6.0.0  (UNRELEASED)
+
+* RcppParallel now bundles oneTBB 2022.0.0. Note that the TBB ABI has changed;
+  packages which depend on RcppParallel may need to be rebuilt.
+  
+* On Windows, RcppParallel now uses the copy of TBB provided by Rtools.
+  If TBB is not available, RcppParallel will use only the fallback 'tinythread'
+  implementation. In practice, this implies that RcppParallel will now only
+  provide a TBB backend with R (>= 4.2.0).
+
 ## RcppParallel 5.1.10
 
 * Fixed an issue where packages linking to RcppParallel could inadverently

R/aaa.R

@@ -1,4 +1,8 @@
 
 # stubs that get overridden via configure script
-TBB_LIB <- ""
-TBB_INC <- ""
+TBB_ENABLED <- TRUE
+TBB_LIB  <- ""
+TBB_INC  <- ""
+
+TBB_NAME <- "tbb"
+TBB_MALLOC_NAME <- "tbbmalloc"

R/tbb-autodetected.R.in

@@ -1,3 +1,7 @@
 
-TBB_LIB <- "@TBB_LIB@"
-TBB_INC <- "@TBB_INC@"
+TBB_ENABLED <- @TBB_ENABLED@
+TBB_LIB  <- "@TBB_LIB@"
+TBB_INC  <- "@TBB_INC@"
+
+TBB_NAME <- "@TBB_NAME@"
+TBB_MALLOC_NAME <- "@TBB_MALLOC_NAME@"

R/tbb.R

@@ -37,39 +37,54 @@ tbbLibraryPath <- function(name = NULL) {
    # find the request library (if any)
    libNames <- tbbLibNames[[sysname]]
    for (libName in libNames) {
+      
       tbbName <- file.path(tbbRoot, libName)
       if (file.exists(tbbName))
          return(tbbName)
+      
+      arch <- if (nzchar(.Platform$r_arch)) .Platform$r_arch
+      suffix <- paste(c("lib", arch, libName), collapse = "/")
+      tbbName <- system.file(suffix, package = "RcppParallel")
+      if (file.exists(tbbName))
+         return(tbbName)
+      
    }
 
 }
 
 tbbCxxFlags <- function() {
 
-   flags <- character()
-
-   # opt-in to TBB on Windows
-   if (is_windows()) {
-      flags <- c(flags, "-DRCPP_PARALLEL_USE_TBB=1")
+  if (!TBB_ENABLED)
+      return("-DRCPP_PARALLEL_USE_TBB=0")
+   
+   flags <- c("-DRCPP_PARALLEL_USE_TBB=1")
+   
+   # TBB does not have assembly code for Windows ARM64
+   # so we need to use compiler builtins
+   if (TBB_ENABLED && is_windows()) {
       if (R.version$arch == "aarch64") {
-         # TBB does not have assembly code for Windows ARM64
-         # so we need to use compiler builtins
          flags <- c(flags, "-DTBB_USE_GCC_BUILTINS")
       }
    }
 
    # if TBB_INC is set, apply those library paths
    tbbInc <- Sys.getenv("TBB_INC", unset = TBB_INC)
-   if (nzchar(tbbInc)) {
-
-      # add include path
-      flags <- c(flags, paste0("-I", asBuildPath(tbbInc)))
-
-      # prefer new interface if version.h exists
+   if (!file.exists(tbbInc)) {
+      tbbInc <- system.file("include", package = "RcppParallel")
+   }
+   
+   # add include path
+   if (nzchar(tbbInc) && file.exists(tbbInc)) {
+      
+      # prefer new interface if version.h exists -- we keep this
+      # for compatibility with packages like StanHeaders, rstan
       versionPath <- file.path(tbbInc, "tbb/version.h")
       if (file.exists(versionPath))
          flags <- c(flags, "-DTBB_INTERFACE_NEW")
-
+      
+      # now add the include path
+      flags <- c(flags, paste0("-I", asBuildPath(tbbInc)))
+      
    }
 
    # return flags as string
@@ -79,41 +94,31 @@ tbbCxxFlags <- function() {
 
 # Return the linker flags required for TBB on this platform
 tbbLdFlags <- function() {
-
-   tbbFlags <- tbbLdFlagsImpl()
-
+   
+   # on Windows, we statically link to oneTBB
    if (is_windows()) {
-      libDir <- system.file("libs", .Platform$r_arch, package = "RcppParallel")
-      libName <- paste0("RcppParallel", .Platform$dynlib.ext)
-      newFlags <- sprintf("-L%s -lRcppParallel", shQuote(libDir))
-      tbbFlags <- paste(newFlags, tbbFlags)
+      
+      libPath <- system.file("libs", package = "RcppParallel")
+      if (nzchar(.Platform$r_arch))
+         libPath <- file.path(libPath, .Platform$r_arch)
+      
+      ldFlags <- sprintf("-L%s -lRcppParallel", asBuildPath(libPath))
+      return(ldFlags)
+      
    }
-
-   tbbFlags
-
-}
-
-tbbLdFlagsImpl <- function() {
-
+   
    # shortcut if TBB_LIB defined
    tbbLib <- Sys.getenv("TBB_LINK_LIB", Sys.getenv("TBB_LIB", unset = TBB_LIB))
    if (nzchar(tbbLib)) {
-
-      fmt <- if (is_windows()) {
-         "-L%1$s -ltbb -ltbbmalloc"
-      } else {
-         "-L%1$s -Wl,-rpath,%1$s -ltbb -ltbbmalloc"
-      }
-
-      return(sprintf(fmt, asBuildPath(tbbLib)))
+      fmt <- "-L%1$s -Wl,-rpath,%1$s -l%2$s -l%3$s"
+      return(sprintf(fmt, asBuildPath(tbbLib), TBB_NAME, TBB_MALLOC_NAME))
    }
-
-   # on Mac, Windows and Solaris, we need to explicitly link (#206)
-   needsExplicitFlags <- is_mac() || is_windows() || (is_solaris() && !is_sparc())
-   if (needsExplicitFlags) {
-      libPath <- asBuildPath(tbbLibraryPath())
-      libFlag <- paste0("-L", libPath)
-      return(paste(libFlag, "-ltbb", "-ltbbmalloc"))
+   
+   # explicitly link on macOS
+   # https://github.com/RcppCore/RcppParallel/issues/206
+   if (is_mac()) {
+      fmt <- "-L%s -l%s -l%s"
+      return(sprintf(fmt, asBuildPath(tbbLibraryPath()), TBB_NAME, TBB_MALLOC_NAME))
    }
 
    # nothing required on other platforms

R/zzz.R

@@ -27,6 +27,11 @@ loadTbbLibrary <- function(name) {
 
 .onLoad <- function(libname, pkgname) {
 
+   # on Windows, load RcppParallel first
+   if (.Platform$OS.type == "windows") {
+      .dllInfo <<- library.dynam("RcppParallel", pkgname, libname)
+   }
+   
    # load tbb, tbbmalloc
    .tbbDllInfo       <<- loadTbbLibrary("tbb")
    .tbbMallocDllInfo <<- loadTbbLibrary("tbbmalloc")
@@ -37,7 +42,9 @@ loadTbbLibrary <- function(name) {
       .tbbMallocProxyDllInfo <<- loadTbbLibrary("tbbmalloc_proxy")
 
    # load RcppParallel library if available
-   .dllInfo <<- library.dynam("RcppParallel", pkgname, libname, local = FALSE)
+   if (.Platform$OS.type != "windows") {
+      .dllInfo <<- library.dynam("RcppParallel", pkgname, libname, local = FALSE)
+   }
 
 }
 

RcppParallel.Rproj

@@ -1,5 +1,5 @@
 Version: 1.0
-ProjectId: f1ae2e5b-eb1d-4d93-9ae1-29e364a5eaa6
+ProjectId: 8e3d73b0-404c-42f5-b2ef-46f759f65dd4
 
 RestoreWorkspace: No
 SaveWorkspace: No

inst/include/RcppParallel.h

@@ -18,14 +18,13 @@
 #endif
 
 #if RCPP_PARALLEL_USE_TBB
-#if defined(WINNT) && defined(__aarch64__) && !defined(TBB_USE_GCC_BUILTINS)
-#define TBB_USE_GCC_BUILTINS 1
-#endif
+# if defined(WINNT) && defined(__aarch64__) && !defined(TBB_USE_GCC_BUILTINS)
+#  define TBB_USE_GCC_BUILTINS 1
+# endif
 # include "RcppParallel/TBB.h"
 #endif
 
 #include "RcppParallel/Backend.h"
-
 #include "RcppParallel/RVector.h"
 #include "RcppParallel/RMatrix.h"
 

inst/include/RcppParallel/Common.h

@@ -13,7 +13,11 @@ inline int resolveValue(const char* envvar,
                         U defaultValue)
 {
    // if the requested value is non-zero and not the default, we can use it
-   if (requestedValue != static_cast<T>(defaultValue) && requestedValue > 0)
+   bool useRequestedValue =
+      requestedValue != static_cast<T>(defaultValue) &&
+      requestedValue > 0;
+   
+   if (useRequestedValue)
       return requestedValue;
 
    // otherwise, try reading the default from associated envvar

inst/include/RcppParallel/TBB.h

@@ -10,6 +10,37 @@
 #include <tbb/tbb.h>
 #include <tbb/global_control.h>
 #include <tbb/scalable_allocator.h>
+#include <tbb/task_arena.h>
+
+// For compatibility with older R packages.
+namespace tbb {
+
+#ifndef __TBB_task_scheduler_init_H
+#define __TBB_task_scheduler_init_H
+
+class task_scheduler_init {
+   
+public:
+   task_scheduler_init(
+      int number_of_threads = -1,
+      std::size_t stack_size = 0)
+   {
+   }
+   
+   static int default_num_threads()
+   {
+      return tbb::this_task_arena::max_concurrency();
+   }
+   
+   static const int automatic = -1;
+   static const int deferred = -2;
+ 
+};
+
+#endif
+
+} // end namespace tbb
+
 
 namespace RcppParallel {