Merge remote-tracking branch 'mega/branch-0.3.0' into branch-0.3.0

Former-commit-id: bd55d1b4cdbe3a7a799b689777a71f36031f82bc

cpp/CHANGELOG.md

@@ -22,8 +22,10 @@ Please mark all change in change log and use the ticket from JIRA.
 - MS-73 - cmake: delete civetweb
 - MS-65 - Implement GetTableRowCount interface
 - MS-45 - Implement DeleteTable interface
+- MS-75 - cmake: change faiss version to 1.5.2; add CUDA gencode
 
 ## Task
+- MS-74 - Change README.md in cpp
 
 # MegaSearch 0.2.0 (2019-05-31)
 

cpp/CMakeLists.txt

@@ -20,11 +20,12 @@ MACRO (GET_GIT_BRANCH_NAME GIT_BRANCH_NAME)
 ENDMACRO (GET_GIT_BRANCH_NAME)
 
 GET_GIT_BRANCH_NAME(GIT_BRANCH_NAME)
-string(REGEX REPLACE "\n" "" GIT_BRANCH_NAME ${GIT_BRANCH_NAME})
+if(NOT GIT_BRANCH_NAME STREQUAL "")
+    string(REGEX REPLACE "\n" "" GIT_BRANCH_NAME ${GIT_BRANCH_NAME})
+endif()
 
 set(MEGASEARCH_VERSION "${GIT_BRANCH_NAME}")
 string(REGEX MATCH "[0-9]+\\.[0-9]+\\.[0-9]" MEGASEARCH_VERSION "${MEGASEARCH_VERSION}")
-message(STATUS "Build version = ${MEGASEARCH_VERSION}")
 
 if(CMAKE_BUILD_TYPE STREQUAL "Release")
     set(BUILD_TYPE "release")
@@ -33,8 +34,6 @@ else()
 endif()
 message(STATUS "Build type = ${BUILD_TYPE}")
 
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/version.h.macro ${CMAKE_CURRENT_SOURCE_DIR}/version.h)
-
 project(megasearch VERSION "${MEGASEARCH_VERSION}")
 project(vecwise_engine LANGUAGES CUDA CXX)
 
@@ -79,9 +78,13 @@ set(MEGASEARCH_VERSION_PATCH "${megasearch_VERSION_PATCH}")
 if(MEGASEARCH_VERSION_MAJOR STREQUAL ""
         OR MEGASEARCH_VERSION_MINOR STREQUAL ""
         OR MEGASEARCH_VERSION_PATCH STREQUAL "")
-    message(FATAL_ERROR "Failed to determine MegaSearch version from '${MEGASEARCH_VERSION}'")
+    message(WARNING "Failed to determine MegaSearch version from '${MEGASEARCH_VERSION}'")
+    set(MEGASEARCH_VERSION "unknown")
 endif()
 
+message(STATUS "Build version = ${MEGASEARCH_VERSION}")
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/version.h.macro ${CMAKE_CURRENT_SOURCE_DIR}/version.h)
+
 message(STATUS "MegaSearch version: "
         "${MEGASEARCH_VERSION_MAJOR}.${MEGASEARCH_VERSION_MINOR}.${MEGASEARCH_VERSION_PATCH} "
         "(full: '${MEGASEARCH_VERSION}')")

cpp/README.md

@@ -2,20 +2,12 @@
 #### Step 1: install necessery tools
 
     centos7 : 
-        yum install gfortran libsqlite3-dev libsnappy-dev libzstd-dev bzip2
+        yum install gfortran flex bison
         
     ubuntu16.04 : 
-        sudo apt-get install gfortran libsqlite3-dev libsnappy-dev libzstd-dev bzip2 liblz4-dev
+        sudo apt-get install gfortran flex bison
 
-#### Step 2: build third-parties
-Note: If you want to debug into third-parties, you can build debug with CXXFLAGS='-g -O0' with option 
-: -t Debug
-
-    cd [sourcecode path]/cpp/thid_party
-    ./build.sh -t Debug
-    ./build.sh -t Release
-    
-#### Step 3: build(output to cmake_build folder)
+#### Step 2: build(output to cmake_build folder)
 cmake_build/src/vecwise_server is the server
 
 cmake_build/src/libvecwise_engine.a is the static library
@@ -24,19 +16,30 @@ cmake_build/src/libvecwise_engine.a is the static library
     ./build.sh -t Debug
     ./build.sh -t Release
     ./build.sh -g # Build GPU version
-    
+
+If you encounter the following error when building:
+`protocol https not supported or disabled in libcurl`
+
+1. Install libcurl4-openssl-dev
+
+2. Install cmake 3.14: 
+
+   ```
+   ./bootstrap --system-curl 
+   make 
+   sudo make install
+   ```
+
 #### To build unittest:
-    
+
     ./build.sh -u
     or
     ./build.sh --unittest
-    
-    
+
 ### Launch server
 Set config in cpp/conf/server_config.yaml
 
 Then launch server with config:
-    
     cd [build output path]
     start_server.sh
     stop_server.sh
@@ -44,7 +47,7 @@ Then launch server with config:
 ### Launch test_client(only for debug)
 If you want to test remote api, you can build test_client.
 test_client use same config file with server:
-    
+
     cd [build output path]/test_client
     test_client -c [sourcecode path]/cpp/conf/server_config.yaml
 

cpp/cmake/DefineOptions.cmake

@@ -71,7 +71,7 @@ define_option(MEGASEARCH_WITH_FAISS "Build with FAISS library" ON)
 define_option(MEGASEARCH_WITH_FAISS_GPU_VERSION "Build with FAISS GPU version" ON)
 
 define_option_string(MEGASEARCH_FAISS_GPU_ARCH "Specifying which GPU architectures to build against"
-        "-gencode=arch=compute_61,code=sm_61")
+        "-gencode=arch=compute_35,code=sm_35 -gencode=arch=compute_52,code=sm_52 -gencode=arch=compute_60,code=sm_60 -gencode=arch=compute_61,code=sm_61")
 
 define_option(MEGASEARCH_WITH_LAPACK "Build with LAPACK library" ON)
 

cpp/cmake/ThirdPartyPackages.cmake

@@ -220,7 +220,7 @@ endif()
 if(DEFINED ENV{MEGASEARCH_FAISS_URL})
     set(FAISS_SOURCE_URL "$ENV{MEGASEARCH_FAISS_URL}")
 else()
-    set(FAISS_SOURCE_URL "https://github.com/JinHai-CN/faiss/archive/${FAISS_VERSION}.tar.gz")
+    set(FAISS_SOURCE_URL "https://github.com/facebookresearch/faiss/archive/${FAISS_VERSION}.tar.gz")
 endif()
 
 if (DEFINED ENV{MEGASEARCH_GTEST_URL})

cpp/thirdparty/versions.txt

@@ -26,7 +26,7 @@
 BOOST_VERSION=1.70.0
 BZIP2_VERSION=1.0.6
 EASYLOGGINGPP_VERSION=v9.96.7
-FAISS_VERSION=master
+FAISS_VERSION=v1.5.2
 GTEST_VERSION=1.8.1
 LAPACK_VERSION=v3.8.0
 LZ4_VERSION=v1.9.1
@@ -49,7 +49,7 @@ DEPENDENCIES=(
   "MEGASEARCH_BOOST_URL boost-${BOOST_VERSION}.tar.gz https://dl.bintray.com/boostorg/release/${BOOST_VERSION}/source/boost_${BOOST_VERSION//./_}.tar.gz"
   "MEGASEARCH_BZIP2_URL bzip2-${BZIP2_VERSION}.tar.gz https://fossies.org/linux/misc/bzip2-${BZIP2_VERSION}.tar.gz"
   "MEGASEARCH_EASYLOGGINGPP_URL easyloggingpp-${EASYLOGGINGPP_VERSION}.tar.gz https://github.com/zuhd-org/easyloggingpp/archive/${EASYLOGGINGPP_VERSION}.tar.gz"
-  "MEGASEARCH_FAISS_URL faiss-${FAISS_VERSION}.tar.gz https://github.com/JinHai-CN/faiss/archive/${FAISS_VERSION}.tar.gz"
+  "MEGASEARCH_FAISS_URL faiss-${FAISS_VERSION}.tar.gz https://github.com/facebookresearch/faiss/archive/${FAISS_VERSION}.tar.gz"
   "MEGASEARCH_GTEST_URL gtest-${GTEST_VERSION}.tar.gz https://github.com/google/googletest/archive/release-${GTEST_VERSION}.tar.gz"
   "MEGASEARCH_LAPACK_URL lapack-${LAPACK_VERSION}.tar.gz https://github.com/Reference-LAPACK/lapack/archive/${LAPACK_VERSION}.tar.gz
   "MEGASEARCH_LZ4_URL lz4-${LZ4_VERSION}.tar.gz https://github.com/lz4/lz4/archive/${LZ4_VERSION}.tar.gz"