Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TBB deprecation fix (partial) #209

Merged
merged 11 commits into from
May 6, 2020
Merged

TBB deprecation fix (partial) #209

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
98a9022
remove execution file mode
acxz Jan 11, 2020
eb85762
change from deprecated tbb::mutex to std::mutex
acxz Jan 11, 2020
b2e9331
remove unnecessary tbb task_scheduler_init
acxz Jan 11, 2020
1483df7
add TBB guards back for multithread option and potentially breaking c…
acxz Jan 11, 2020
af5d222
remove deprecated tbb_exception in favor of std_exception
acxz Jan 11, 2020
aff24bd
remove tbb.h include and specify individual includes needed
acxz Jan 11, 2020
bfc32e9
add deprecated task_scheduler_init until alternative is found
acxz Jan 13, 2020
8096b0e
add deprecated task_scheduler_init unitl alternative is found
acxz Mar 16, 2020
b4b4876
replace task_scheduler_init with task arena/group
acxz Apr 12, 2020
df9cf86
replace task_scheduler_init with task arena/group
acxz Apr 13, 2020
e0cbc76
change to more efficient call of threaded functions
acxz May 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions examples/SolverComparer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,6 @@
#include <fstream>
#include <iostream>

#ifdef GTSAM_USE_TBB
#include <tbb/tbb.h>
#undef max // TBB seems to include windows.h and we don't want these macros
#undef min
#endif

using namespace std;
using namespace gtsam;
using namespace gtsam::symbol_shorthand;
Expand Down Expand Up @@ -206,10 +200,8 @@ int main(int argc, char *argv[]) {
}

#ifdef GTSAM_USE_TBB
std::unique_ptr<tbb::task_scheduler_init> init;
if(nThreads > 0) {
cout << "Using " << nThreads << " threads" << endl;
init.reset(new tbb::task_scheduler_init(nThreads));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. This line was important to the test.

Copy link
Contributor Author

@acxz acxz Jan 12, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just because we do not explicitly create a task_scheduler_init does not mean, TBB or C++11 is not using its internal one. n threads are still created and the test is run in parallel if TBB is being used, although not needed now, since C++11 has concurrency.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we always wanted max number of threads (i.e. threads = number of cores) that might be ok, but nThreads is an optional parameter to this program, so that the user can test timing for a specific number of threads. As I see it, removing this line effectively turns nThreads into an on/off switch.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, thats right. Thx for the thorough review! I'll add a commit that adds this deprecated feature for now until we figure out how to handle it in the future.

} else
cout << "Using threads for all processors" << endl;
#else
Expand Down
8 changes: 5 additions & 3 deletions examples/TimeTBB.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ using boost::assign::list_of;

#ifdef GTSAM_USE_TBB

#include <tbb/tbb.h>
#undef max // TBB seems to include windows.h and we don't want these macros
#undef min
#include <tbb/blocked_range.h> // tbb::blocked_range
#include <tbb/tick_count.h> // tbb::tick_count
#include <tbb/parallel_for.h> // tbb::parallel_for
#include <tbb/cache_aligned_allocator.h> // tbb::cache_aligned_allocator
#include <tbb/task_scheduler_init.h> // tbb::task_scheduler_init

static const DenseIndex numberOfProblems = 1000000;
static const DenseIndex problemSize = 4;
Expand Down
46 changes: 5 additions & 41 deletions gtsam/base/ThreadsafeException.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

/**
* @file ThreadSafeException.h
* @brief Base exception type that uses tbb_exception if GTSAM is compiled with TBB
* @brief Base exception type that uses tbb_allocator if GTSAM is compiled with TBB
* @author Richard Roberts
* @date Aug 21, 2010
* @addtogroup base
Expand All @@ -25,34 +25,28 @@
#include <gtsam/dllexport.h>
#include <string>
#include <typeinfo>
#include <exception>

#ifdef GTSAM_USE_TBB
#include <tbb/tbb_allocator.h>
#include <tbb/tbb_exception.h>
#include <tbb/scalable_allocator.h>
#include <iostream>
#endif

namespace gtsam {

/// Base exception type that uses tbb_exception if GTSAM is compiled with TBB.
/// Base exception type that uses tbb_allocator if GTSAM is compiled with TBB.
template<class DERIVED>
class ThreadsafeException:
#ifdef GTSAM_USE_TBB
public tbb::tbb_exception
#else
public std::exception
#endif
{
#ifdef GTSAM_USE_TBB
private:
typedef tbb::tbb_exception Base;
typedef std::exception Base;
#ifdef GTSAM_USE_TBB
protected:
typedef std::basic_string<char, std::char_traits<char>,
tbb::tbb_allocator<char> > String;
#else
private:
typedef std::exception Base;
protected:
typedef std::string String;
#endif
Expand Down Expand Up @@ -82,36 +76,6 @@ public std::exception
}

public:
// Implement functions for tbb_exception
#ifdef GTSAM_USE_TBB
virtual tbb::tbb_exception* move() throw () {
void* cloneMemory = scalable_malloc(sizeof(DERIVED));
if (!cloneMemory) {
std::cerr << "Failed allocating memory to copy thrown exception, exiting now." << std::endl;
exit(-1);
}
DERIVED* clone = ::new(cloneMemory) DERIVED(static_cast<DERIVED&>(*this));
clone->dynamic_ = true;
return clone;
}

virtual void destroy() throw () {
if (dynamic_) {
DERIVED* derivedPtr = static_cast<DERIVED*>(this);
derivedPtr->~DERIVED();
scalable_free(derivedPtr);
}
}

virtual void throw_self() {
throw *static_cast<DERIVED*>(this);
}

virtual const char* name() const throw () {
return typeid(DERIVED).name();
}
#endif

virtual const char* what() const throw () {
return description_ ? description_->c_str() : "";
}
Expand Down
8 changes: 4 additions & 4 deletions gtsam/base/debug.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,29 @@
#include <gtsam/config.h> // for GTSAM_USE_TBB

#ifdef GTSAM_USE_TBB
#include <tbb/mutex.h>
#include <mutex> // std::mutex, std::unique_lock
#endif

namespace gtsam {

GTSAM_EXPORT FastMap<std::string, ValueWithDefault<bool, false> > debugFlags;

#ifdef GTSAM_USE_TBB
tbb::mutex debugFlagsMutex;
std::mutex debugFlagsMutex;
#endif

/* ************************************************************************* */
bool guardedIsDebug(const std::string& s) {
#ifdef GTSAM_USE_TBB
tbb::mutex::scoped_lock lock(debugFlagsMutex);
std::unique_lock<std::mutex> lock(debugFlagsMutex);
#endif
return gtsam::debugFlags[s];
}

/* ************************************************************************* */
void guardedSetDebug(const std::string& s, const bool v) {
#ifdef GTSAM_USE_TBB
tbb::mutex::scoped_lock lock(debugFlagsMutex);
std::unique_lock<std::mutex> lock(debugFlagsMutex);
#endif
gtsam::debugFlags[s] = v;
}
Expand Down
7 changes: 2 additions & 5 deletions gtsam/base/treeTraversal/parallelTraversalTasks.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,8 @@
#include <boost/make_shared.hpp>

#ifdef GTSAM_USE_TBB
# include <tbb/tbb.h>
# include <tbb/scalable_allocator.h>
# undef max // TBB seems to include windows.h and we don't want these macros
# undef min
# undef ERROR
#include <tbb/task.h> // tbb::task, tbb::task_list
#include <tbb/scalable_allocator.h> // tbb::scalable_allocator

namespace gtsam {

Expand Down
4 changes: 2 additions & 2 deletions gtsam/base/types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
#include <cstddef>
#include <cstdint>

#include <exception>

#ifdef GTSAM_USE_TBB
#include <tbb/task_scheduler_init.h>
#include <tbb/tbb_exception.h>
#include <tbb/scalable_allocator.h>
#endif

Expand Down
2 changes: 1 addition & 1 deletion gtsam/geometry/Unit3.cpp
100755 → 100644
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ const Matrix32& Unit3::basis(OptionalJacobian<6, 2> H) const {
// NOTE(hayk): At some point it seemed like this reproducably resulted in
// deadlock. However, I don't know why and I can no longer reproduce it.
// It either was a red herring or there is still a latent bug left to debug.
tbb::mutex::scoped_lock lock(B_mutex_);
std::unique_lock<std::mutex> lock(B_mutex_);
#endif

const bool cachedBasis = static_cast<bool>(B_);
Expand Down
4 changes: 2 additions & 2 deletions gtsam/geometry/Unit3.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
#include <string>

#ifdef GTSAM_USE_TBB
#include <tbb/mutex.h>
#include <mutex> // std::mutex
#endif

namespace gtsam {
Expand All @@ -48,7 +48,7 @@ class Unit3 {
mutable boost::optional<Matrix62> H_B_; ///< Cached basis derivative

#ifdef GTSAM_USE_TBB
mutable tbb::mutex B_mutex_; ///< Mutex to protect the cached basis.
mutable std::mutex B_mutex_; ///< Mutex to protect the cached basis.
#endif

public:
Expand Down