Add kv state cache module.

.github/workflows/build-test.yml

@@ -329,6 +329,16 @@ jobs:
         if: false
         uses: mxschmitt/action-tmate@v3
 
+      - name: Run llm tests
+        run: |
+          export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib:/usr/local/lib64:/usr/local/lib/x86_64-linux-gnu
+          export VINEYARD_DATA_DIR=`pwd`/gstest
+          export TMPDIR="${TMPDIR:-$(dirname $(mktemp))}"
+
+          rm -rf default.etcd
+          rm -rf /dev/shm/etcd*
+          python3 test/runner.py $RUNNER_ARGS --with-llm
+
       - name: Run cpp tests
         run: |
           export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib:/usr/local/lib64:/usr/local/lib/x86_64-linux-gnu

CMakeLists.txt

@@ -62,6 +62,7 @@ option(BUILD_VINEYARD_MALLOC_OVERRIDE "Using the client-side malloc to override
 option(BUILD_VINEYARD_FUSE "Enable vineyard's fuse support" OFF)
 option(BUILD_VINEYARD_FUSE_PARQUET "Enable vineyard's fuse parquet support" OFF)
 option(BUILD_VINEYARD_HOSSEINMOEIN_DATAFRAME "Enable hosseinmoein dataframe support" OFF)
+option(BUILD_VINEYARD_LLM_CACHE "Enable kv-state cache support" ON)
 
 option(BUILD_VINEYARD_TESTS "Generate make targets for vineyard tests" ON)
 option(BUILD_VINEYARD_TESTS_ALL "Include make targets for vineyard tests to ALL" OFF)
@@ -932,6 +933,11 @@ if(BUILD_VINEYARD_HOSSEINMOEIN_DATAFRAME)
     list(APPEND VINEYARD_INSTALL_LIBS vineyard_hosseinmoein_dataframe)
 endif()
 
+if(BUILD_VINEYARD_LLM_CACHE)
+    add_subdirectory(modules/llm-cache)
+    list(APPEND VINEYARD_INSTALL_LIBS vineyard_llm_cache)
+endif()
+
 if(BUILD_VINEYARD_TESTS)
     add_subdirectory(test)
 endif()
@@ -975,7 +981,7 @@ endfunction()
 
 file_glob_recurse(FILES_NEED_FORMAT DIRECTORIES      "src" "modules" "python" "test" "benchmark"
                                     PATTERNS         ".*\\.(cc|cpp|h|hpp|vineyard-mod)$"
-                                    EXCLUDE_PATTERNS ".*\\.vineyard.h$"
+                                    EXCLUDE_PATTERNS "(.*\\.vineyard.h$)"
 )
 
 # the `memcpy.h` is borrowed from external project

LICENSE

@@ -1181,3 +1181,18 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+-------------------------------------------------------------------------------
+
+The files thirdparty/rax/{radix.cc, radix.h, rax_malloc} is referred from project antirez/rax,
+which has the following license:
+
+Copyright (c) 2017, Salvatore Sanfilippo <[email protected]>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

NOTICE.txt

@@ -55,3 +55,7 @@ This product includes software from the ClickHouse project
 This product includes software from the BBHash project
  * Copyright (c) 2015 Guillaume Rizk
  * https://github.com/rizkg/BBHash
+
+This product includes software from the rax project (BSD, 2-clause)
+ * Copyright (c) 2017-2019, Salvatore Sanfilippo <antirez at gmail dot com>
+ * https://github.com/antirez/rax

README.rst

@@ -298,6 +298,7 @@ We thank the following excellent open-source projects:
 - `skywalking-swck <https://github.com/apache/skywalking-swck>`_ A kubernetes operator for the Apache Skywalking.
 - `wyhash <https://github.com/alainesp/wy>`_, C++ wrapper around wyhash and wyrand.
 - `BBHash <https://github.com/rizkg/BBHash>`_, a fast, minimal-memory perfect hash function.
+- `rax <https://github.com/antirez/rax>`_, an ANSI C radix tree implementation.
 
 License
 -------

modules/llm-cache/CMakeLists.txt

@@ -0,0 +1,17 @@
+file(GLOB VINEYARD_LLM_CACHE_SRCS "${CMAKE_CURRENT_SOURCE_DIR}"
+                                  "ds/*.cc"
+                                  "ds/*.h"
+                                  "radix-tree/*.cc"
+                                  "radix-tree/*.h"
+                                  "${PROJECT_SOURCE_DIR}/thirdparty/rax/*.cc"
+                                  "${PROJECT_SOURCE_DIR}/thirdparty/rax/*.h"
+)
+
+add_library(vineyard_llm_cache ${VINEYARD_LLM_CACHE_SRCS})
+target_link_libraries(vineyard_llm_cache PUBLIC vineyard_client vineyard_basic)
+
+install_export_vineyard_target(vineyard_llm_cache)
+install_vineyard_headers("${CMAKE_CURRENT_SOURCE_DIR}/ds/")
+install_vineyard_headers("${CMAKE_CURRENT_SOURCE_DIR}/radix-tree/")
+
+add_subdirectory(tests)

modules/llm-cache/README.rst

@@ -0,0 +1,27 @@
+KV-state cache on Vineyard
+=============================
+
+Run test
+--------
+
+Build vineyard and vineyard test
+
+.. code:: bash
+    mkdir build
+    cd build
+    cmake .. -DBUILD_VINEYARD_TESTS=ON -DCMAKE_BUILD_TYPE=Debug
+    make -j$(nproc)
+    make vineyard_tests -j$(nproc)
+
+Start vineyard server
+
+.. code:: bash
+    cd build
+    ./bin/vineyardd --socket=/tmp/vineyard_test.sock  # make sure the env VINEYARD_IPC_SOCKET is set properly
+
+Run test
+
+.. code:: bash
+    cd build
+    export VINEYARD_IPC_SOCKET=/tmp/vineyard_test.sock
+    ./bin/kv_state_cache_test