sfu-dis / bztree

An open-source BzTree implementation

BzTree

An open-source BzTree implementation, used in our VLDB paper:

Lucas Lersch, Xiangpeng Hao, Ismail Oukid, Tianzheng Wang, Thomas Willhalm:
Evaluating Persistent Memory Range Indexes. PVLDB 13(4): 574-587 (2019)

Build

Use PMDK

mkdir build & cd build
cmake -DPMEM_BACKEND=PMDK ..

Volatile only

mkdir build & cd build
cmake -DPMEM_BACKEND=VOLATILE ..

Other build options

-DPMEM_BACKEND=EMU to emulate persistent memory using DRAM

-DGOOGLE_FRAMEWORK=0 if you're not comfortable with google frameworks (gtest/glog/gflags)

-DBUILD_TESTS=0 to build shared library only (without tests)

-DMAX_FREEZE_RETRY=n to set max freeze retry times, default to 1, check the original paper for details

-DENABLE_MERGE=1 to enable merge after delete, this is disabled by default, check the original paper for details.

Benchmark on PiBench

We officially support bztree wrapper for pibench:

make bztree_pibench_wrapper -j

Checkout PiBench here: https://github.com/wangtzh/pibench

Build/Create BzTree shared lib

mkdir Release & cd Release
cmake -DCMAKE_BUILD_TYPE=Release -DPMEM_BACKEND=${BACKEND} -DGOOGLE_FRAMEWORK=0 -DBUILD_TESTS=0 ..

bztree's Issues

Runtime Error (PMDK version)

I have been tried bztree on YCSB index benchmark tools.
Volatile and Emu are properly working. But if I set the PDMK, it turned out errors belows.
Is PMDK version of the bztree master branch still working?

• I'm using PMDK 1.6 stable version.

Program received signal SIGSEGV, Segmentation fault.
0x00007ffff7794519 in pmemobj_mutex_lock () from /usr/local/lib/libpmemobj.so.1
(gdb) bt
#0  0x00007ffff7794519 in pmemobj_mutex_lock () from /usr/local/lib/libpmemobj.so.1
#1  0x00007ffff7790729 in pmemobj_root_construct () from /usr/local/lib/libpmemobj.so.1
#2  0x00007ffff779096a in pmemobj_root () from /usr/local/lib/libpmemobj.so.1
#3  0x00005555555a4510 in ycsb_load_run_randint(int, int, int, int, int, std::vector<unsigned long, std::allocator<unsigned long> >&, std::vector<unsigned long, std::allocator<unsigned long> >&, std::vector<int, std::allocator<int> >&, std::vector<int, std::allocator<int> >&) ()
#4  0x000055555559833b in main ()
(gdb) 

Descriptor Pool Allocation Failure in bztree_pmdk_test

Hi, I have been trying out the PMDK version using real PM. However, I got an allocation error when allocating the pointer to DescriptorPool the second time (Line 69). Then the subsequent newing of DescriptorPool causes a segfault.
https://github.com/wangtzh/bztree/blob/b31c82380405dc8fdc097f4b75103bb5b7cb74a7/tests/bztree_pmdk_tests.cc#L69

The error message is shown below:

~/Documents/bztree/PMDK-Debug(master*) » ./bztree_pmdk_tests                                                                                                        
[==========] Running 5 tests from 2 test cases.
[----------] Global test environment set-up.
[----------] 2 tests from BzTreePMEMTest
[ RUN      ] BzTreePMEMTest.InsertTest
[       OK ] BzTreePMEMTest.InsertTest (658 ms)
[ RUN      ] BzTreePMEMTest.ReadTest
Allocate: TXN Allocation Error: 72
[1]    276595 segmentation fault (core dumped)  ./bztree_pmdk_tests

Any suggestion on this would be very helpful.

build error

Hi,
I'm trying to build bztree. However, no matter 'PMDK' used or not, I cannot build it. And the error is always:

ubuntu@VM-16-11-ubuntu:~/Downloads/bztree/build$ cmake -DPMEM_BACKEND=VOLATILE/PMDK ..
-- The C compiler identification is GNU 9.3.0
-- The CXX compiler identification is GNU 9.3.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Persistence support: off/on
-- GOOGLE_FRAMEWORK is defined, will use glog, gflags and gtest
-- BUILD_TESTS: not defined

PS: I used Ubuntu 20.04, the latest PMDK was installed from its source code.
Thanks

Values > 8B

Thanks for your implementation of BzTree.

I have noticed that the PiBench wrapper only supports values of up to 8B. Is there a simple way to test the performance of BzTrees with values larger than 8B? (I don't really care if the actual values are persisted, I just want to get a rough idea of the influence of the payload's size on performance.)

Thanks,

Build failures

Hi, I'm trying to build the BzTree but it doesn't seem to be working.
I've tried cmake -DPMEM_BACKEND=PMDK -DCMAKE_BUILD_TYPE=Release .. and cmake -DPMEM_BACKEND=VOLATILE-DCMAKE_BUILD_TYPE=Debug .. and neither compiled successfully.

The errors were mostly that the allocator descriptor in pmwcas/mwcas was of the wrong type. I was able to fix most of those by using GetRaw where needed to get a pointer instead of a DescriptorGuard. I also needed to bump the CMakeLists.txt C++ version to std=c++17 for pmwcas. Once I fixed those errors, I was still getting errors about the use of google framework things in pmwcas and mwcas (both with and without GOOGLE_FRAMEWORK defined).

Was the BzTree meant to use some older version of pmwcas. If so, could you pin to that version? Otherwise, could someone please point me to a working build path?

Thanks!

Add glog/gtest/gflags to the build system

instead of using the global installed ones.