Skip to content

Commit

Permalink
provide some backwards compatibility with existing binaries (#233)
Browse files Browse the repository at this point in the history
* first steps at backwards compat

* more exports for linux

* include stub library on Windows

* tweaks

* dll export

* clean up when we're done

* overwrite
  • Loading branch information
kevinushey authored Jan 18, 2025
1 parent 965e198 commit c276b03
Show file tree
Hide file tree
Showing 17 changed files with 378 additions and 25 deletions.
8 changes: 8 additions & 0 deletions R/tbb.R
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,17 @@ 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)

}

}
Expand Down
9 changes: 8 additions & 1 deletion R/zzz.R
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand All @@ -37,7 +42,9 @@ loadTbbLibrary <- function(name) {
.tbbMallocProxyDllInfo <<- loadTbbLibrary("tbbmalloc_proxy")

# load RcppParallel library if available
.dllInfo <<- library.dynam("RcppParallel", pkgname, libname)
if (.Platform$OS.type != "windows") {
.dllInfo <<- library.dynam("RcppParallel", pkgname, libname)
}

}

Expand Down
1 change: 1 addition & 0 deletions RcppParallel.Rproj
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ RnwWeave: Sweave
LaTeX: pdfLaTeX

BuildType: Package
PackageCleanBeforeInstall: No
PackageInstallArgs: --with-keep.source --clean
PackageCheckArgs: --as-cran
PackageRoxygenize: rd,collate,namespace
26 changes: 18 additions & 8 deletions src/install.libs.R
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
tbbLibs <- tbbLibs[!nzchar(Sys.readlink(tbbLibs))]

# copy / link the libraries
useSymlinks <- Sys.getenv("TBB_USE_SYMLINKS", unset = "TRUE")
useSymlinks <- Sys.getenv("TBB_USE_SYMLINKS", unset = .Platform$OS.type != "windows")
if (useSymlinks) {
file.symlink(tbbLibs, tbbDest)
} else {
Expand All @@ -68,6 +68,19 @@

}

# on Windows, we create a stub library that links to us so that
# older binaries (like rstan) can still load
if (.Platform$OS.type == "windows") {
tbbDll <- file.path(tbbDest, "tbb.dll")
if (!file.exists(tbbDll)) {
writeLines("** creating tbb stub library")
status <- system("R CMD SHLIB tbb-compat/tbb-compat.cpp")
if (status != 0)
stop("error building tbb stub library")
file.rename("tbb-compat/tbb-compat.dll", file.path(tbbDest, "tbb.dll"))
}
}

}

useTbbPreamble <- function(tbbInc) {
Expand Down Expand Up @@ -99,7 +112,7 @@ useBundledTbb <- function() {
"-DTBB_EXAMPLES=0",
"-DTBB_STRICT=0",
".."
)
)

writeLines("*** configuring tbb")
owd <- setwd("tbb/build-tbb")
Expand Down Expand Up @@ -133,17 +146,14 @@ useBundledTbb <- function() {
)

tbbFiles <- list.files(
"tbb/build-tbb",
file.path(getwd(), "tbb/build-tbb"),
pattern = shlibPattern,
recursive = TRUE,
full.names = TRUE
)

tbbDir <- dirname(tbbFiles[[1L]])

dir.create("tbb/build", showWarnings = FALSE)
unlink("tbb/build/lib_release", recursive = TRUE)
file.rename(tbbDir, "tbb/build/lib_release")
dir.create("tbb/build/lib_release", recursive = TRUE, showWarnings = FALSE)
file.copy(tbbFiles, "tbb/build/lib_release", overwrite = TRUE)
unlink("tbb/build-tbb", recursive = TRUE)
writeLines("*** finished building tbb")

Expand Down
143 changes: 143 additions & 0 deletions src/tbb-compat/tbb-compat.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@

#include <atomic>

#include "../tbb/include/oneapi/tbb/detail/_namespace_injection.h"
#include "../tbb/include/oneapi/tbb/task_arena.h"

#include "../tbb/src/tbb/observer_proxy.h"
#include "../tbb/src/tbb/main.h"
#include "../tbb/src/tbb/thread_data.h"

#ifdef _WIN32
# define DLL_EXPORT __declspec(dllexport)
#else
# define DLL_EXPORT
#endif

namespace tbb {

namespace interface6 {
class task_scheduler_observer;
}

namespace internal {

class task_scheduler_observer_v3 {
friend class tbb::detail::r1::observer_proxy;
friend class tbb::detail::r1::observer_list;
friend class interface6::task_scheduler_observer;

//! Pointer to the proxy holding this observer.
/** Observers are proxied by the scheduler to maintain persistent lists of them. **/
tbb::detail::r1::observer_proxy* my_proxy;

//! Counter preventing the observer from being destroyed while in use by the scheduler.
/** Valid only when observation is on. **/
std::atomic<intptr_t> my_busy_count;

public:
//! Enable or disable observation
/** For local observers the method can be used only when the current thread
has the task scheduler initialized or is attached to an arena.
Repeated calls with the same state are no-ops. **/
void __TBB_EXPORTED_METHOD observe( bool state=true );

//! Returns true if observation is enabled, false otherwise.
bool is_observing() const {return my_proxy!=NULL;}

//! Construct observer with observation disabled.
task_scheduler_observer_v3() : my_proxy(NULL) { my_busy_count.store(0); }

//! Entry notification
/** Invoked from inside observe(true) call and whenever a worker enters the arena
this observer is associated with. If a thread is already in the arena when
the observer is activated, the entry notification is called before it
executes the first stolen task.
Obsolete semantics. For global observers it is called by a thread before
the first steal since observation became enabled. **/
virtual void on_scheduler_entry( bool /*is_worker*/ ) {}

//! Exit notification
/** Invoked from inside observe(false) call and whenever a worker leaves the
arena this observer is associated with.
Obsolete semantics. For global observers it is called by a thread before
the first steal since observation became enabled. **/
virtual void on_scheduler_exit( bool /*is_worker*/ ) {}

//! Destructor automatically switches observation off if it is enabled.
virtual ~task_scheduler_observer_v3() { if(my_proxy) observe(false);}
};

} // namespace internal

namespace interface6 {

class task_scheduler_observer : public internal::task_scheduler_observer_v3 {
friend class internal::task_scheduler_observer_v3;
friend class tbb::detail::r1::observer_proxy;
friend class tbb::detail::r1::observer_list;

/** Negative numbers with the largest absolute value to minimize probability
of coincidence in case of a bug in busy count usage. **/
// TODO: take more high bits for version number
static const intptr_t v6_trait = (intptr_t)((~(uintptr_t)0 >> 1) + 1);

//! contains task_arena pointer or tag indicating local or global semantics of the observer
intptr_t my_context_tag;
enum { global_tag = 0, implicit_tag = 1 };

public:
//! Construct local or global observer in inactive state (observation disabled).
/** For a local observer entry/exit notifications are invoked whenever a worker
thread joins/leaves the arena of the observer's owner thread. If a thread is
already in the arena when the observer is activated, the entry notification is
called before it executes the first stolen task. **/
/** TODO: Obsolete.
Global observer semantics is obsolete as it violates master thread isolation
guarantees and is not composable. Thus the current default behavior of the
constructor is obsolete too and will be changed in one of the future versions
of the library. **/
explicit task_scheduler_observer( bool local = false ) {
my_context_tag = local? implicit_tag : global_tag;
}

//! Construct local observer for a given arena in inactive state (observation disabled).
/** entry/exit notifications are invoked whenever a thread joins/leaves arena.
If a thread is already in the arena when the observer is activated, the entry notification
is called before it executes the first stolen task. **/
explicit task_scheduler_observer( task_arena & a) {
my_context_tag = (intptr_t)&a;
}

/** Destructor protects instance of the observer from concurrent notification.
It is recommended to disable observation before destructor of a derived class starts,
otherwise it can lead to concurrent notification callback on partly destroyed object **/
virtual ~task_scheduler_observer() { if(my_proxy) observe(false); }

//! Enable or disable observation
/** Warning: concurrent invocations of this method are not safe.
Repeated calls with the same state are no-ops. **/
void observe( bool state=true ) {
if( state && !my_proxy ) {
__TBB_ASSERT( !my_busy_count, "Inconsistent state of task_scheduler_observer instance");
my_busy_count.store(v6_trait);
}
internal::task_scheduler_observer_v3::observe(state);
}
};

} // namespace interface6

} // namespace tbb

namespace tbb {
namespace internal {

DLL_EXPORT
void __TBB_EXPORTED_FUNC task_scheduler_observer_v3::observe( bool enable ) {
auto* tso = (tbb::detail::d1::task_scheduler_observer*) (this);
tbb::detail::r1::observe(*tso, enable);
}

} // namespace internal
} // namespace tbb
4 changes: 3 additions & 1 deletion src/tbb/include/oneapi/tbb/detail/_task.h
Original file line number Diff line number Diff line change
Expand Up @@ -124,12 +124,14 @@ class wait_context {
}
}

public:
bool continue_execution() const {
std::uint64_t r = m_ref_count.load(std::memory_order_acquire);
__TBB_ASSERT_EX((r & overflow_mask) == 0, "Overflow is detected");
return r > 0;
}


private:
friend class r1::thread_data;
friend class r1::task_dispatcher;
friend class r1::external_waiter;
Expand Down
Loading

0 comments on commit c276b03

Please sign in to comment.