set(HAVE_LZ4 ${LZ4_FOUND})
endif(WITH_LZ4)
+option(WITH_CEPH_DEBUG_MUTEX "Use debug ceph::mutex with lockdep" OFF)
+
#if allocator is set on command line make sure it matches below strings
set(ALLOCATOR "" CACHE STRING
"specify memory allocator to use. currently tcmalloc, tcmalloc_minimal, \
set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Default BUILD_TYPE is RelWithDebInfo, other options are: Debug, Release, and MinSizeRel." FORCE)
endif()
+if(WITH_CEPH_DEBUG_MUTEX OR CMAKE_BUILD_TYPE STREQUAL Debug)
+ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DCEPH_DEBUG_MUTEX")
+endif()
+
include(CheckCCompilerFlag)
if(CMAKE_CXX_COMPILER_ID STREQUAL GNU)
CHECK_C_COMPILER_FLAG("-U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=2" HAS_FORTIFY_SOURCE)
--- /dev/null
+// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
+// vim: ts=8 sw=2 smarttab
+
+#pragma once
+
+// What and why
+// ============
+//
+// For general code making use of mutexes, use these ceph:: types.
+// The key requirement is that you make use of the ceph::make_mutex()
+// and make_recursive_mutex() factory methods, which take a string
+// naming the mutex for the purposes of the lockdep debug variant.
+//
+// For legacy Mutex users that passed recursive=true, use
+// ceph::make_recursive_mutex. For legacy Mutex users that passed
+// lockdep=false, use std::mutex directly.
+
+#ifdef CEPH_DEBUG_MUTEX
+
+// ============================================================================
+// debug (lockdep-capable, various sanity checks and asserts)
+// ============================================================================
+
+#include "common/mutex_debug.h"
+#include "common/condition_variable_debug.h"
+
+namespace ceph {
+ typedef ceph::mutex_debug mutex;
+ typedef ceph::mutex_recursive_debug recursive_mutex;
+ typedef ceph::condition_variable_debug condition_variable;
+
+ // pass arguments to mutex_debug ctor
+ template <typename ...Args>
+ mutex make_mutex(Args&& ...args) {
+ return {std::forward<Args>(args)...};
+ }
+
+ // pass arguments to recursive_mutex_debug ctor
+ template <typename ...Args>
+ recursive_mutex make_recursive_mutex(Args&& ...args) {
+ return {std::forward<Args>(args)...};
+ }
+
+ // debug methods
+ #define ceph_mutex_is_locked(m) ((m).is_locked())
+ #define ceph_mutex_is_locked_by_me(m) ((m).is_locked_by_me())
+}
+
+#else
+
+// ============================================================================
+// release (fast and minimal)
+// ============================================================================
+
+#include <mutex>
+#include <condition_variable>
+
+namespace ceph {
+
+ typedef std::mutex mutex;
+ typedef std::recursive_mutex recursive_mutex;
+ typedef std::condition_variable condition_variable;
+
+ // discard arguments to make_mutex (they are for debugging only)
+ template <typename ...Args>
+ std::mutex make_mutex(Args&& ...args) {
+ return {};
+ }
+ template <typename ...Args>
+ std::recursive_mutex make_recursive_mutex(Args&& ...args) {
+ return {};
+ }
+
+ // debug methods. Note that these can blindly return true
+ // because any code that does anything other than assert these
+ // are true is broken.
+ #define ceph_mutex_is_locked(m) true
+ #define ceph_mutex_is_locked_by_me(m) true
+}
+
+#endif
target_link_libraries(unittest_blkdev ceph-common ${BLKID_LIBRARIES})
endif()
+# unittest_lockdep
+add_executable(unittest_lockdep
+ test_lockdep.cc
+ )
+add_ceph_unittest(unittest_lockdep)
+target_link_libraries(unittest_lockdep ceph-common global)
+
# unittest_bloom_filter
add_executable(unittest_bloom_filter
test_bloom_filter.cc
--- /dev/null
+// -*- mode:C; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
+// vim: ts=8 sw=2 smarttab
+
+#include "common/ceph_context.h"
+#include "include/util.h"
+#include "gtest/gtest.h"
+#include "common/ceph_mutex.h"
+#include "global/global_context.h"
+#include "global/global_init.h"
+
+TEST(lockdep, abba)
+{
+ ASSERT_TRUE(g_lockdep);
+
+ ceph::mutex a(ceph::make_mutex("a")), b(ceph::make_mutex("b"));
+ a.lock();
+ ASSERT_TRUE(ceph_mutex_is_locked(a));
+ ASSERT_TRUE(ceph_mutex_is_locked_by_me(a));
+ b.lock();
+ ASSERT_TRUE(ceph_mutex_is_locked(b));
+ ASSERT_TRUE(ceph_mutex_is_locked_by_me(b));
+ a.unlock();
+ b.unlock();
+
+ b.lock();
+ EXPECT_DEATH(a.lock(), "");
+ b.unlock();
+}
+
+TEST(lockdep, recursive)
+{
+ ASSERT_TRUE(g_lockdep);
+
+ ceph::mutex a(ceph::make_mutex("a"));
+ a.lock();
+ EXPECT_DEATH(a.lock(), "");
+ a.unlock();
+
+ ceph::recursive_mutex b(ceph::make_recursive_mutex("b"));
+ b.lock();
+ ASSERT_TRUE(ceph_mutex_is_locked(b));
+ ASSERT_TRUE(ceph_mutex_is_locked_by_me(b));
+ b.lock();
+ b.unlock();
+ b.unlock();
+}
+
+int main(int argc, char **argv) {
+#ifdef NDEBUG
+ cout << "NDEBUG is defined" << std::endl;
+#else
+ cout << "NDEBUG is NOT defined" << std::endl;
+#endif
+#ifndef CEPH_DEBUG_MUTEX
+ cerr << "WARNING: CEPH_DEBUG_MUTEX is not defined, lockdep will not work"
+ << std::endl;
+ exit(0);
+#endif
+ std::vector<const char*> args(argv, argv + argc);
+ args.push_back("--lockdep");
+ auto cct = global_init(NULL, args,
+ CEPH_ENTITY_TYPE_CLIENT,
+ CODE_ENVIRONMENT_UTILITY,
+ CINIT_FLAG_NO_MON_CONFIG);
+ common_init_finish(g_ceph_context);
+
+ ::testing::InitGoogleTest(&argc, argv);
+ return RUN_ALL_TESTS();
+}
#include "test/librados_test_stub/TestWatchNotify.h"
#include "include/Context.h"
+#include "common/Cond.h"
#include "include/stringify.h"
#include "common/Finisher.h"
#include "test/librados_test_stub/TestCluster.h"
projects / ceph.git / commitdiff