feat: Support sampled subgraph matching with an extension

.github/workflows/build-extensions.yml

@@ -4,9 +4,9 @@ on:
   workflow_dispatch:
     inputs:
       extensions:
-        description: 'Semicolon-separated list of extensions to build (e.g., json;parquet)'
+        description: 'Semicolon-separated list of extensions to build (e.g., json;parquet;sampled_match)'
         required: false
-        default: 'json;parquet'
+        default: 'json;parquet;sampled_match'
       version:
         description: 'Version tag for the extensions (e.g., 0.1.1)'
         required: false
@@ -51,7 +51,7 @@ jobs:
           if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
             EXTENSIONS="${{ github.event.inputs.extensions }}"
           else
-            EXTENSIONS="json;parquet"
+            EXTENSIONS="json;parquet;sampled_match"
           fi
           echo "extensions=$EXTENSIONS" >> $GITHUB_OUTPUT
           echo "Building extensions: $EXTENSIONS"

.github/workflows/neug-extension-test.yml

@@ -88,7 +88,7 @@ jobs:
         export USE_NINJA=OFF
         export WITH_MIMALLOC=OFF
         export CMAKE_INSTALL_PREFIX=/opt/neug-install/
-        export BUILD_EXTENSIONS="json;parquet"
+        export BUILD_EXTENSIONS="json;parquet;sampled_match"
         sudo mkdir -p /opt/neug-install
         sudo chown -R $USER:$USER /opt/neug-install/
         export CC="ccache gcc"
@@ -109,6 +109,7 @@ jobs:
         cd build/neug_py_bind
         ctest -R json_extension_test -V
         ctest -R parquet_extension_test -V
+        ctest -R sampled_match_extension_test -V
         export FLEX_DATA_DIR=${GITHUB_WORKSPACE}/example_dataset/tinysnb
         ctest -R test_extension -V
 

extension/CMakeLists.txt

@@ -126,5 +126,7 @@ endfunction()
 add_extension_if_enabled("json")
 # Add parquet extension
 add_extension_if_enabled("parquet")
+# Add sampled_match extension
+add_extension_if_enabled("sampled_match")
 
 message(STATUS "=== Extension configuration complete ===")

extension/sampled_match/CMakeLists.txt

@@ -0,0 +1,83 @@
+# Find required packages for FaSTest
+find_package(Boost REQUIRED)
+find_package(GSL REQUIRED)
+
+# Collect FaSTest source files (header-only library with some cpp files)
+file(GLOB_RECURSE FASTEST_LIB_SOURCES
+    "${CMAKE_CURRENT_SOURCE_DIR}/include/fastest_lib/src/**/*.cpp")
+
+# Collect sampled_match extension source files
+file(GLOB SAMPLED_MATCH_EXTENSION_SOURCES
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cc"
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp")
+
+# Combine all sources
+set(SAMPLED_MATCH_EXTENSION_OBJECT_FILES
+    ${SAMPLED_MATCH_EXTENSION_SOURCES}
+    ${FASTEST_LIB_SOURCES})
+
+# Use the extension build system (should be called before add_extension_test)
+build_extension_lib("sampled_match")
+
+# Set include directories
+target_include_directories(neug_sampled_match_extension PRIVATE
+    ${CMAKE_SOURCE_DIR}
+    ${CMAKE_CURRENT_SOURCE_DIR}/include
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/fastest_lib/src
+    ${CMAKE_CURRENT_BINARY_DIR}
+    ${Boost_INCLUDE_DIRS}
+    ${GSL_INCLUDE_DIRS})
+
+# Include rapidjson for JSON parsing
+target_include_directories(neug_sampled_match_extension PRIVATE SYSTEM
+    ${CMAKE_SOURCE_DIR}/third_party/rapidjson/include)
+
+# Link libraries
+# protobuf::libprotobuf is added explicitly because src/CMakeLists.txt:35
+# links protobuf as PRIVATE on the neug target — its INTERFACE_LINK_LIBRARIES
+# does not propagate to downstream extension consumers, even though many neug
+# PUBLIC headers (neug_db.h, connection.h, query_result.h, …) transitively
+# include generated *.pb.h files. Linking it here ensures the extension can
+# resolve protobuf symbols at link/load time independently of how libneug
+# happens to expose (or not expose) them.
+target_link_libraries(neug_sampled_match_extension PRIVATE
+    ${GSL_LIBRARIES}
+    Boost::boost
+    neug
+    protobuf::libprotobuf
+)
+
+# Build test by compiling extension sources directly (no link to neug_sampled_match_extension)
+if(BUILD_TEST)
+    add_extension_test(NAME sampled_match
+        TEST_SRCS ${CMAKE_CURRENT_SOURCE_DIR}/tests/sampled_match_test.cpp
+        EXTRA_INCLUDE_DIRS
+            ${CMAKE_CURRENT_SOURCE_DIR}/include/fastest_lib/src
+            ${CMAKE_SOURCE_DIR}/third_party/rapidjson/include
+        EXTRA_LINK_LIBS
+            GSL::gsl
+            GSL::gslcblas
+            Boost::boost
+    )
+    # The project bundles googletest 1.13 via FetchContent and links
+    # libgtest.a built from those sources. On Homebrew Macs the root
+    # CMakeLists adds /opt/homebrew/include project-wide (via
+    # include_directories(SYSTEM ${OPENSSL_INCLUDE_DIR}) -> SYSTEM list),
+    # which contains a newer gtest with a different MakeAndRegisterTestInfo
+    # signature. The two SYSTEM dirs share -isystem priority and homebrew
+    # is listed first, so its header silently wins -> undefined symbols at
+    # link time. Force the bundled gtest headers to be searched first by
+    # adding them as a non-SYSTEM PRIVATE include: -I always beats -isystem
+    # in clang's search order.
+    if(TARGET sampled_match_extension_test)
+        target_include_directories(sampled_match_extension_test BEFORE PRIVATE
+            ${CMAKE_BINARY_DIR}/_deps/googletest-src/googletest/include
+            ${CMAKE_BINARY_DIR}/_deps/googletest-src/googlemock/include)
+        # The test calls LOAD sampled_match; at runtime, which dlopens the
+        # libsampled_match.neug_extension produced by build_extension_lib().
+        # add_extension_test does not wire this build-order dependency, so
+        # add it explicitly — otherwise `make sampled_match_extension_test`
+        # produces the binary without the .so it expects to find.
+        add_dependencies(sampled_match_extension_test neug_sampled_match_extension)
+    endif()
+endif()

extension/sampled_match/README.md

@@ -0,0 +1,23 @@
+# sampled_match Extension
+
+This extension implements subgraph matching cardinality estimation based on the FaSTest algorithm described in:
+
+**Cardinality Estimation of Subgraph Matching: A Filtering-Sampling Approach** (VLDB 2024)
+
+See the original project note in `include/fastest_lib/README.md`:
+- `Fastest [VLDB 2024]`
+- `Cardinality Estimation of Subgraph Matching: A Filtering-Sampling Approach`
+
+## Build Test
+
+From your build directory, compile tests with:
+
+```sh
+mkdir build && cd build
+cmake .. -DBUILD_EXTENSIONS="sampled_match" -DBUILD_TEST=ON
+make -j8 sampled_match_extension_test
+ctest -R sampled_match_extension_test --output-on-failure
+```
+
+Each `TEST_F` runs under a unique `mkdtemp` scratch directory, so the suite
+is safe to run in parallel (e.g. `ctest -j`).

extension/sampled_match/include/fastest_lib/CMakeLists.txt

@@ -0,0 +1,41 @@
+cmake_minimum_required(VERSION 3.21)
+project(Fastest)
+
+message(STATUS "C Compiler: ${CMAKE_C_COMPILER}")
+message(STATUS "C++ Compiler: ${CMAKE_CXX_COMPILER}")
+ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++20 -Ofast")
+#set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++20")
+FIND_PACKAGE(Boost REQUIRED)
+FIND_PACKAGE(GSL REQUIRED)
+include_directories(${Boost_INCLUDE_DIRS})
+include_directories(${GSL_INCLUDE_DIRS})
+include_directories(src)
+
+
+# add_executable(Fastest driver/subgraph-cardinality-estimation.cc)
+
+file(GLOB_RECURSE FASTEST_LIB_HEADERS "src/**/*.hpp" "src/**/*.h")
+file(GLOB_RECURSE FASTEST_LIB_SOURCES "src/**/*.cpp")
+
+
+if(FASTEST_LIB_SOURCES OR FASTEST_LIB_HEADERS)
+    add_library(FaSTestLib STATIC ${FASTEST_LIB_SOURCES})
+    target_include_directories(FaSTestLib PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>
+        $<INSTALL_INTERFACE:include>
+    )
+    target_link_libraries(FaSTestLib PUBLIC Boost::boost ${GSL_LIBRARIES})
+
+    # 安装和导出FaSTestLib
+    install(TARGETS FaSTestLib
+        EXPORT GBITargets
+        ARCHIVE DESTINATION lib
+        INCLUDES DESTINATION include
+    )
+
+    # 安装头文件
+    install(DIRECTORY src/ DESTINATION include/fastest_lib
+        FILES_MATCHING PATTERN "*.hpp"
+                     PATTERN "*.h"
+    )
+endif()

extension/sampled_match/include/fastest_lib/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.