Release 2.1.5 (#69)

* first include sys headers in detectCores.cpp * Release 2.1.4 * remove wait in threadpool dtor * add test for global pool dtor * bump version + NEWS --------- Co-authored-by: tnagler <thomas.nagler@tum.de>
tnagler · Jul 12, 2023 · fd008aa · fd008aa
1 parent 548751c
commit fd008aa
Show file tree

Hide file tree

Showing 13 changed files with 114 additions and 41 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -15,3 +15,4 @@ revdep/
 .vscode/
 new-benchmarks.R
 bench*
+^CRAN-SUBMISSION$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: RcppThread
 Title: R-Friendly Threading in C++
-Version: 2.1.3
+Version: 2.1.5
 Authors@R: c(
     person("Thomas", "Nagler",, "mail@tnagler.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-1855-0046"))
@@ -10,10 +10,9 @@ Description: Provides a C++11-style thread class and thread pool that can safely
 Depends: R (>= 3.3.0)
 License: MIT + file LICENSE
 Encoding: UTF-8
-SystemRequirements: C++11
 URL: https://github.com/tnagler/RcppThread
 BugReports: https://github.com/tnagler/RcppThread/issues
-RoxygenNote: 7.2.0
+RoxygenNote: 7.2.3
 Suggests: 
     testthat,
     R.rsp,

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,20 @@
+# RcppThread 2.1.5
+
+BUG FIX
+
+* Fixes static lifetime issue on MacM1.
+
+# RcppThread 2.1.4
+
+BUG FIX
+
+* Fixes order of headers in `detectCores.cpp`.
+
+REQUIREMENTS
+
+* Remove `Systemrequirements: C++11`
+
+
 # RcppThread 2.1.3
 
 BUG FIX

diff --git a/R/LdFlags.R b/R/LdFlags.R
@@ -79,3 +79,9 @@ LdFlags <- function() {
     cat(flags)
     invisible(flags)
 }
+
+# internal function for testing destructor of global thread pool
+testGlobal <- function() {
+    .Call("testGlobalCpp")
+}
+
diff --git a/R/inline.R b/R/inline.R
@@ -4,7 +4,6 @@ inlineCxxPlugin <- function(...) {
         package = "RcppThread",
         libs = RcppThread::LdFlags()
     )()
-    settings$env$USE_CXX11 <- "yes"
     settings
 }
 
diff --git a/README.md b/README.md
@@ -2,25 +2,25 @@
 
 <!-- badges: start -->
 [![R build status](https://github.com/tnagler/RcppThread/workflows/R-CMD-check/badge.svg)](https://github.com/tnagler/RcppThread/actions)
-[![CRAN version](http://www.r-pkg.org/badges/version/RcppThread)](https://cran.r-project.org/package=RcppThread) 
-[![CRAN downloads](http://cranlogs.r-pkg.org/badges/RcppThread)](https://cran.r-project.org/package=RcppThread)
+[![CRAN version](https://www.r-pkg.org/badges/version/RcppThread)](https://cran.r-project.org/package=RcppThread) 
+[![CRAN downloads](https://cranlogs.r-pkg.org/badges/RcppThread)](https://cran.r-project.org/package=RcppThread)
 <!-- badges: end -->
 
 Provides R-friendly threading functionality: 
 
-  * thread safe versions of [Rcpp's](http://www.rcpp.org/)
+  * thread safe versions of [Rcpp's](https://www.rcpp.org/)
     `checkUserInterrupt()`, `Rcout`, and `Rcerr`,
   * an interruptible thread class that otherwise behaves like 
-   [`std::thread`](http://en.cppreference.com/w/cpp/thread/thread),
+   [`std::thread`](https://en.cppreference.com/w/cpp/thread/thread),
   * classes for the [thread pool
     pattern](https://en.wikipedia.org/wiki/Thread_pool) and parallel for loops
     for easy and flexible parallelism,
   * thread safe progress tracking,
-  * state-of-the art speed, see  [benchmarks](https://github.com/tnagler/RcppThread/blob/benchmarks/benchmarks/benchmarks.md).
+  * state-of-the art speed, see  [benchmarks](https://github.com/tnagler/RcppThread/blob/main/benchmarks/benchmarks.md).
 
 The library is header-only, platform-independent, and only 
 requires a 
-[C++11-compatible compiler](http://en.cppreference.com/w/cpp/compiler_support#cpp11).
+[C++11-compatible compiler](https://en.cppreference.com/w/cpp/compiler_support#cpp11).
 
 ## Functionality
 

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,12 +1,13 @@
-Fixes clang-14 warning about bitwise & with boolen operands.
+Fixes clang-17 error caused by wrong order of system/R headers (macro `RF_length`).
 
 ## Test environments
-* ubuntu 20.04 (devel, release, old-rel)
+* ubuntu 22.04 (devel, release, old-rel)
 * macOS X (release)
 * Windows Server 2019 (release)
 * CRAN win builder (devel)
 
 ## Check status summary
+
                   NOTE OK
   Source packages    0  1
-  Reverse depends   17  1
+  Reverse depends   21  2
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = RcppThread
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.1.2
+PROJECT_NUMBER         = 2.1.4
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/inst/include/RcppThread/ThreadPool.hpp b/inst/include/RcppThread/ThreadPool.hpp
@@ -7,8 +7,8 @@
 #pragma once
 
 #include "RcppThread/RMonitor.hpp"
-#include "RcppThread/Rcout.hpp"
 #include "RcppThread/Rcerr.hpp"
+#include "RcppThread/Rcout.hpp"
 #include "RcppThread/quickpool.hpp"
 
 #include <atomic>
@@ -70,22 +70,21 @@ class ThreadPool
 //! constructs a thread pool with as many workers as there are cores.
 inline ThreadPool::ThreadPool()
   : ThreadPool(std::thread::hardware_concurrency())
-{}
+{
+}
 
 //! constructs a thread pool with `nWorkers` threads.
 //! @param nWorkers number of worker threads to create; if `nWorkers = 0`, all
 //!    work pushed to the pool will be done in the main thread.
 inline ThreadPool::ThreadPool(size_t nWorkers)
   : pool_{ new quickpool::ThreadPool(nWorkers) }
   , owner_thread_{ std::this_thread::get_id() }
-{}
-
-//! destructor joins all threads if possible.
-inline ThreadPool::~ThreadPool() noexcept
 {
-    this->wait();
 }
 
+//! destructor joins all threads if possible.
+inline ThreadPool::~ThreadPool() noexcept {}
+
 //! Access to the global thread pool instance.
 inline ThreadPool&
 ThreadPool::globalInstance()
@@ -173,7 +172,8 @@ ThreadPool::parallelFor(int begin, int end, F f, size_t nBatches)
     if (nBatches == 0) {
         // each worker has its dedicated range, but can steal part of another
         // worker's ranges when done with own
-        auto thr = std::max(pool_->get_active_threads(), static_cast<size_t>(1));
+        auto thr =
+          std::max(pool_->get_active_threads(), static_cast<size_t>(1));
         auto workers = quickpool::loop::create_workers<F>(f, begin, end, thr);
         for (size_t k = 0; k < thr; k++) {
             this->push([=] { workers->at(k).run(workers); });
@@ -189,7 +189,10 @@ ThreadPool::parallelFor(int begin, int end, F f, size_t nBatches)
         int rem = nTasks % nBatches;
         for (size_t b = 0; b < nBatches; b++) {
             int bs = sz + (rem-- > 0);
-            this->push([=] { for (int i = begin; i < begin + bs; ++i) f(i); });
+            this->push([=] {
+                for (int i = begin; i < begin + bs; ++i)
+                    f(i);
+            });
             begin += bs;
         }
     }

diff --git a/src/Makevars b/src/Makevars
@@ -0,0 +1,2 @@
+PKG_CPPFLAGS = -I../inst/include
+PKG_LIBS = `"$(R_HOME)/bin/Rscript" -e "source('../R/LdFlags.R'); LdFlags()"`
diff --git a/src/detectCores.cpp b/src/detectCores.cpp
@@ -1,27 +1,44 @@
+#include <thread>
+
+#define R_NO_REMAP
+
 #include <R.h>
 #include <Rdefines.h>
-#include <thread>
 
-extern "C" {
+#include "RcppThread.h"
 
-SEXP detectCoresCpp() {
-    SEXP result;
-    PROTECT(result = NEW_INTEGER(1));
-    INTEGER(result)[0] = std::thread::hardware_concurrency();
-    UNPROTECT(1);
-    return result;
-}
+extern "C"
+{
 
+    SEXP detectCoresCpp()
+    {
+        SEXP result;
+        PROTECT(result = NEW_INTEGER(1));
+        INTEGER(result)[0] = std::thread::hardware_concurrency();
+        UNPROTECT(1);
+        return result;
+    }
 
-static const R_CallMethodDef callMethods[] = {
-    {"detectCoresCpp", (DL_FUNC) &detectCoresCpp, 0},
-    {NULL, NULL, 0}
-};
+    SEXP testGlobalCpp()
+    {
+        auto fun = [](int i) {};
+        RcppThread::parallelFor(0, 100, fun);
+        SEXP result;
+        PROTECT(result = NEW_INTEGER(1));
+        INTEGER(result)[0] = 1;
+        UNPROTECT(1);
+        return result;
+    }
 
-void R_init_RcppThread(DllInfo *info)
-{
-    R_registerRoutines(info, NULL, callMethods, NULL, NULL);
-    R_useDynamicSymbols(info, TRUE);
-}
+    static const R_CallMethodDef callMethods[] = {
+        { "detectCoresCpp", (DL_FUNC)&detectCoresCpp, 0 },
+        { "testGlobalCpp", (DL_FUNC)&testGlobalCpp, 0 },
+        { NULL, NULL, 0 }
+    };
 
+    void R_init_RcppThread(DllInfo* info)
+    {
+        R_registerRoutines(info, NULL, callMethods, NULL, NULL);
+        R_useDynamicSymbols(info, TRUE);
+    }
 }
diff --git a/src/testGlobal.cpp b/src/testGlobal.cpp
@@ -0,0 +1,26 @@
+// #include "RcppThread.h"
+//
+// extern "C" {
+//
+// SEXP testGlobalCpp() {
+//     RcppThread::
+//     SEXP result;
+//     PROTECT(result = NEW_INTEGER(1));
+//     INTEGER(result)[0] = std::thread::hardware_concurrency();
+//     UNPROTECT(1);
+//     return result;
+// }
+//
+//
+// static const R_CallMethodDef callMethods[] = {
+//     {"testGlobalCpp", (DL_FUNC) &detectCoresCpp, 0},
+//     {NULL, NULL, 0}
+// };
+//
+// void R_init_RcppThread(DllInfo *info)
+// {
+//     R_registerRoutines(info, NULL, callMethods, NULL, NULL);
+//     R_useDynamicSymbols(info, TRUE);
+// }
+//
+// }
diff --git a/tests/testthat/tests.R b/tests/testthat/tests.R
@@ -1,3 +1,5 @@
+RcppThread:::testGlobal()
+
 if (RcppThread:::hasAtomicSupport()) {
 
     context("Compile test functions")