1PerconaFT 2====== 3 4PerconaFT is a high-performance, transactional key-value store, used in the 5TokuDB storage engine for Percona Server and MySQL, and in TokuMX, the 6high-performance MongoDB distribution. 7 8PerconaFT is provided as a shared library with an interface similar to 9Berkeley DB. 10 11To build the full MySQL product, see the instructions for 12[Percona/percona-server][percona-server]. This document covers PerconaFT only. 13 14[percona-server]: https://github.com/Percona/percona-server 15 16 17Building 18-------- 19 20PerconaFT is built using CMake >= 2.8.9. Out-of-source builds are 21recommended. You need a C++11 compiler, though only some versions 22of GCC >= 4.7 and Clang are tested. You also need zlib development 23packages (`yum install zlib-devel` or `apt-get install zlib1g-dev`). 24 25You will also need the source code for jemalloc, checked out in 26`third_party/`. 27 28```sh 29git clone git://github.com/Percona/PerconaFT.git percona-ft 30cd percona-ft 31git clone git://github.com/Percona/jemalloc.git third_party/jemalloc 32mkdir build 33cd build 34CC=gcc47 CXX=g++47 cmake \ 35 -D CMAKE_BUILD_TYPE=Debug \ 36 -D BUILD_TESTING=OFF \ 37 -D USE_VALGRIND=OFF \ 38 -D CMAKE_INSTALL_PREFIX=../prefix/ \ 39 .. 40cmake --build . --target install 41``` 42 43This will build `libft.so` and `libtokuportability.so` and install it, 44some header files, and some examples to `percona-ft/prefix/`. It will also 45build jemalloc and install it alongside these libraries, you should link 46to that if you are planning to run benchmarks or in production. 47 48### Platforms 49 50PerconaFT is supported on 64-bit Centos, Debian, and Ubuntu and should work 51on other 64-bit linux distributions, and may work on OSX 10.8 and FreeBSD. 52PerconaFT is not supported on 32-bit systems. 53 54[Transparent hugepages][transparent-hugepages] is a feature in newer linux 55kernel versions that causes problems for the memory usage tracking 56calculations in PerconaFT and can lead to memory overcommit. If you have 57this feature enabled, PerconaFT will not start, and you should turn it off. 58If you want to run with transparent hugepages on, you can set an 59environment variable `TOKU_HUGE_PAGES_OK=1`, but only do this for testing, 60and only with a small cache size. 61 62[transparent-hugepages]: https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Performance_Tuning_Guide/s-memory-transhuge.html 63 64 65Testing 66------- 67 68PerconaFT uses CTest for testing. The CDash testing dashboard is not 69currently public, but you can run the tests without submitting them. 70 71There are some large data files not stored in the git repository, that 72will be made available soon. For now, the tests that use these files will 73not run. 74 75In the build directory from above: 76 77```sh 78cmake -D BUILD_TESTING=ON .. 79ctest -D ExperimentalStart \ 80 -D ExperimentalConfigure \ 81 -D ExperimentalBuild \ 82 -D ExperimentalTest 83``` 84 85 86Contributing 87------------ 88 89Please report bugs in PerconaFT to the [issue tracker][jira]. 90 91We have two publicly accessible mailing lists for TokuDB: 92 93 - tokudb-user@googlegroups.com is for general and support related 94 questions about the use of TokuDB. 95 - tokudb-dev@googlegroups.com is for discussion of the development of 96 TokuDB. 97 98All source code and test contributions must be provided under a [BSD 2-Clause][bsd-2] license. For any small change set, the license text may be contained within the commit comment and the pull request. For larger contributions, the license must be presented in a COPYING.<feature_name> file in the root of the PerconaFT project. Please see the [BSD 2-Clause license template][bsd-2] for the content of the license text. 99 100[jira]: https://jira.percona.com/projects/TDB 101[bsd-2]: http://opensource.org/licenses/BSD-2-Clause/ 102 103 104License 105------- 106 107Portions of the PerconaFT library (the 'locktree' and 'omt') are available under the Apache version 2 license. 108PerconaFT is available under the GPL version 2, and AGPL version 3. 109See [COPYING.APACHEv2][apachelicense], 110[COPYING.AGPLv3][agpllicense], 111[COPYING.GPLv2][gpllicense], and 112[PATENTS][patents]. 113 114[apachelicense]: http://github.com/Percona/PerconaFT/blob/master/COPYING.APACHEv2 115[agpllicense]: http://github.com/Percona/PerconaFT/blob/master/COPYING.AGPLv3 116[gpllicense]: http://github.com/Percona/PerconaFT/blob/master/COPYING.GPLv2 117[patents]: http://github.com/Percona/PerconaFT/blob/master/PATENTS 118