shared library (#176)

added shared library support and fixed a bug with aligned vectors

Author: ladnir

.github/workflows/build-test.yml

@@ -27,15 +27,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
             submodules: recursive
-
-      # Runs a set of commands using the runners shell
-      
-      #- name: build relic
-      #  run:  python3 build.py -DENABLE_BOOST=OFF -DENABLE_SODIUM=OFF -DENABLE_ASAN=ON  -DCMAKE_BUILD_TYPE=RelWithDebInfo
-        
-      #- name: build bitpolymul
-      #  run:  python3 build.py --bitpolymul --par=4  -DVERBOSE_FETCH=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo
-          
+            
       - name: build libOTe
         run:  python3 build.py --par=4 -D ENABLE_ALL_OT=ON -DENABLE_CIRCUITS=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_ASAN=ON -DENABLE_MOCK_OT=true 
 
@@ -83,10 +75,22 @@ jobs:
             rm -rf out/
             cd ../..
   
-                    
+               
+  # This workflow contains a single job called "build"
+  build-ubuntu-sodium:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+        with:
+            submodules: recursive
+                 
       - name: build libOTe w/ sodium
         run:  |
-            rm ./out/build/linux/frontend/frontend_libOTe
             python3 build.py --par=4 -D ENABLE_ALL_OT=ON -D ENABLE_SODIUM=ON -DENABLE_RELIC=OFF -DPRINT_LOG_ON_FAIL=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo
 
       - name: unit tests
@@ -132,6 +136,69 @@ jobs:
             rm -rf out/
             cd ../..
 
+            
+               
+  # This workflow contains a single job called "build"
+  build-ubuntu-shared:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+        with:
+            submodules: recursive
+                 
+      - name: build libOTe
+        run:  |
+            python3 build.py --par=4  -D ENABLE_ALL_OT=ON -DENABLE_CIRCUITS=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_MOCK_OT=true  -DENABLE_PIC=ON -DENABLE_SHARED=ON
+
+      - name: unit tests
+        run:  ./out/build/linux/frontend/frontend_libOTe -u
+       
+
+      - name: find source tree
+        run: |
+            cd libOTe_Tests/cmakeTests
+            cmake -S . -B out/  -DCMAKE_BUILD_TYPE=RelWithDebInfo -DSODIUM=ON -D CMAKE_PREFIX_PATH=../../
+            cmake --build out/
+            ./out/main
+            rm -rf out/
+            cd ../..
+            
+      - name: hint test
+        run: |
+            cd libOTe_Tests/cmakeTests
+            cmake -S . -B out/ -DSODIUM=ON -D LIBOTE_HINT=../..
+            cmake --build out/
+            ./out/main
+            rm -rf out/
+            cd ../..
+
+      - name: install prefix test
+        run: |
+            python3 build.py --install=~/install
+            cd libOTe_Tests/cmakeTests
+            cmake -S . -B out/ -DSODIUM=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_PREFIX_PATH=~/install
+            cmake --build out/
+            ./out/main
+            rm -rf out/
+            cd ../..
+            
+
+      - name: install test
+        run: |
+            python3 build.py --install --sudo 
+            cd libOTe_Tests/cmakeTests
+            cmake -S . -B out/  -DSODIUM=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo
+            cmake --build out/
+            ./out/main
+            rm -rf out/
+            cd ../..
+
+
   # This workflow contains a single job called "build"
   build-osx:
     # The type of runner that the job will run on

CMakePresets.json

@@ -10,19 +10,22 @@
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "RelWithDebInfo",
         "FETCH_AUTO": true,
-        "ENABLE_ALL_OT": true,
         "ENABLE_SSE": true,
         "ENABLE_AVX": true,
         "ENABLE_BOOST": false,
         "ENABLE_BITPOLYMUL": false,
         "ENABLE_CIRCUITS": true,
-        "ENABLE_SIMPLESTOT": true,
-        "ENABLE_MRR": true,
-        "ENABLE_MR": true,
+        "ENABLE_SIMPLESTOT": false,
+        "ENABLE_SIMPLESTOT_ASM": false,
+        "ENABLE_MR_KYBER": false,
+        "ENABLE_MRR": false,
+        "ENABLE_MR": false,
         "ENABLE_RELIC": false,
         "ENABLE_SODIUM": false,
         "ENABLE_ASAN": true,
         "ENABLE_MOCK_OT": true,
+        "LIBOTE_SHARED": true,
+        "ENABLE_PIC": true,
         "LIBOTE_STD_VER": "20",
         "CMAKE_PREFIX_PATH": "${sourceDir}/../out/install",
         "CMAKE_INSTALL_PREFIX": "${sourceDir}/out/install/${presetName}"
@@ -72,7 +75,9 @@
         "VERBOSE_FETCH": true,
         "ENABLE_SSE": true,
         "ENABLE_AVX": true,
-        "ENABLE_ASAN": true,
+        "ENABLE_ASAN": false,
+        "BUILD_SHARED_LIBS": false,
+        "LIBOTE_SHARED": true,
         "CMAKE_INSTALL_PREFIX": "${sourceDir}/out/install/${presetName}",
         "CMAKE_PREFIX_PATH": "${sourceDir}/../out/install/${presetName}"
       },

cmake/buildOptions.cmake

@@ -52,7 +52,7 @@ if(DEFINED ENABLE_ALL_OT)
 
 
 	# requires linux
-	if(UNIX AND NOT(APPLE OR MSVC))
+	if(UNIX AND NOT(APPLE OR MSVC) AND NOT ENABLE_PIC)
 		set(oc_BB ${ENABLE_ALL_OT})
 	else()
 		set(oc_BB OFF)
@@ -180,7 +180,9 @@ message(STATUS "Option: ENABLE_KKRT           = ${ENABLE_KKRT}\n\n")
 
 
 message(STATUS "other \n=======================================================")
-message(STATUS "Option: NO_KOS_WARNING        = ${NO_KOS_WARNING}\n\n")
+message(STATUS "Option: NO_KOS_WARNING        = ${NO_KOS_WARNING}")
+message(STATUS "Option: LIBOTE_SHARED         = ${LIBOTE_SHARED}\n\n")
+
 
 #############################################
 #               Config Checks               #
@@ -226,5 +228,17 @@ if(ENABLE_IKNP AND NOT ENABLE_KOS)
 endif()
 
 
+if(LIBOTE_SHARED AND NOT ENABLE_PIC AND NOT MSVC)
+	message(FATAL_ERROR " LIBOTE_SHARED requires ENABLE_PIC. Set ENABLE_PIC to true and recompile.")
+endif()
+
+
+if(ENABLE_SIMPLESTOT_ASM AND ENABLE_PIC)
+	message(FATAL_ERROR " ENABLE_SIMPLESTOT_ASM can not be compiled with ENABLE_PIC.")
+endif()
+if(ENABLE_MR_KYBER AND ENABLE_PIC)
+	message(FATAL_ERROR " ENABLE_MR_KYBER can not be compiled with ENABLE_PIC.")
+endif()
+
 
 #include(${CMAKE_CURRENT_LIST_DIR}/../cryptoTools/cmake/cryptoToolsBuildOptions.cmake)

cmake/install.cmake

@@ -60,12 +60,16 @@ install(FILES
 set(exportLibs 
     "libOTe;libOTe_Tests;")
 
+if(LIBOTE_SHARED)
+    set(exportLibs "${exportLibs}libOTeShared;")
+endif()
+
 if(ENABLE_MR_KYBER)
     set(exportLibs "${exportLibs}KyberOT;")
 
     # install headers
     install(
-        DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/../KyberOT/ 
+        DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/../thirdparty/KyberOT/ 
         DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/KyberOT 
         FILES_MATCHING PATTERN "*.h")
 endif()
@@ -74,7 +78,7 @@ if(ENABLE_SIMPLESTOT_ASM)
     set(exportLibs "${exportLibs}SimplestOT;")
     # install headers
     install(
-        DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/../SimplestOT/ 
+        DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/../thirdparty/SimplestOT/ 
         DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/SimplestOT 
         FILES_MATCHING PATTERN "*.h")
 endif()

libOTe/CMakeLists.txt

@@ -7,6 +7,7 @@ set(SRCS "${SRCS}")
 add_library(libOTe STATIC ${SRCS} )
 
 
+
 # make projects that include libOTe use this as an include folder
 target_include_directories(libOTe PUBLIC
                     $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/..>
@@ -18,9 +19,7 @@ target_include_directories(libOTe PUBLIC
 target_link_libraries(libOTe cryptoTools)
 
 if(MSVC)
-    target_compile_definitions(libOTe PUBLIC _NO_DEBUG_HEAP=1)
     target_compile_options(libOTe PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/std:c++${LIBOTE_STD_VER}>)
-    #target_compile_options(libOTe PRIVATE -openmp:experimental)
 else()
     target_compile_options(libOTe PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-std=c++${LIBOTE_STD_VER}>)
 
@@ -36,14 +35,30 @@ if (ENABLE_BITPOLYMUL)
 endif ()
 if(ENABLE_SIMPLESTOT_ASM)
 	target_link_libraries(libOTe SimplestOT)
-    #target_compile_options(libOTe PRIVATE -fPIC -no-pie)
 endif()
 
 if(ENABLE_MR_KYBER)
 	target_link_libraries(libOTe KyberOT)
 endif()
 
 
+if(LIBOTE_SHARED)
+    
+    add_library(libOTeShared SHARED ${SRCS} )
+    target_link_libraries(libOTeShared libOTe)
+    if(MSVC)
+        target_compile_options(libOTeShared PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/std:c++${LIBOTE_STD_VER}>)
+    else()
+        target_compile_options(libOTeShared PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-std=c++${LIBOTE_STD_VER}>)
+
+        if(ENABLE_SSE)
+            target_compile_options(libOTeShared PRIVATE -maes -msse2 -msse3 -msse4.1 -mpclmul)
+        endif()
+        if(ENABLE_AVX)
+            target_compile_options(libOTeShared PRIVATE -mavx2)
+        endif()
+    endif()
+endif()
 
 #############################################
 #            Install                        #

libOTe/Triple/Foleage/FoleageTriple.cpp

@@ -143,7 +143,7 @@ namespace osuCrypto
 
 				BitVector choice(baseCount.mRecvCount);
 				choice.randomize(prng);
-				std::vector<block> recvMsg(choice.size());
+				AlignedUnVector<block> recvMsg(choice.size());
 				co_await mOtExtRecver->receive(choice, recvMsg, prng, sock);
 
 				if (extSenderCount)
@@ -153,7 +153,7 @@ namespace osuCrypto
 					mOtExtSender->setBaseOts(senderMsg, senderChoice);
 				}
 
-				std::vector<std::array<block, 2>> sendMsg(baseCount.mSendCount);
+				AlignedUnVector<std::array<block, 2>> sendMsg(baseCount.mSendCount);
 				co_await mOtExtSender->send(sendMsg, prng, sock);
 
 				choice = BitVector(choice.data(), choice.size() - extSenderCount, extSenderCount);
@@ -206,7 +206,7 @@ namespace osuCrypto
 					baseCount.mSendCount += extRecverCount;
 				}
 
-				std::vector<std::array<block,2>> sendMsg(baseCount.mSendCount);
+				AlignedUnVector<std::array<block,2>> sendMsg(baseCount.mSendCount);
 				co_await mOtExtSender->send(sendMsg, prng, sock);
 
 				if (extRecverCount)
@@ -217,7 +217,7 @@ namespace osuCrypto
 
 				BitVector choice(baseCount.mRecvCount);
 				choice.randomize(prng);
-				std::vector<block> recvMsg(choice.size());
+				AlignedUnVector<block> recvMsg(choice.size());
 				co_await mOtExtRecver->receive(choice, recvMsg, prng, sock);
 
 				setBaseOts(span<std::array<block, 2>>(sendMsg).subspan(extRecverCount), recvMsg, choice);

libOTe/TwoChooseOne/SoftSpokenOT/SoftSpokenShOtExt.cpp

@@ -37,7 +37,7 @@ namespace osuCrypto
 		MACORO_TRY{
 #ifdef ENABLE_SSE
 		if ((u64)messages.data() % 32)
-			throw std::runtime_error("SoftSpokenShOtSender: messages must point to 32 byte aligned memory. " LOCATION);
+			throw std::runtime_error("SoftSpokenShOtSender: messages must point to 32 byte aligned memory. " + macoro::trace(co_await macoro::get_trace()).str());
 #endif
 		auto numInstances = u64{};
 		auto numChunks = u64{};

libOTe_Tests/Foleage_Tests.cpp

@@ -247,9 +247,21 @@ namespace osuCrypto
 			auto r = macoro::sync_wait(macoro::when_all_ready(
 				oles[0].expand(ALsb, AMsb, C0Lsb, C0Msb, prng0, sock[0]),
 				oles[1].expand(BLsb, BMsb, C1Lsb, C1Msb, prng1, sock[1])));
-			std::get<0>(r).result();
+			std::exception_ptr ep;
+			try{
+				std::get<0>(r).result();
+			}
+			catch (std::exception& e)
+			{
+				std::cout << e.what() << std::endl;
+				ep = std::current_exception();
+			}
+
 			std::get<1>(r).result();
 
+			if (ep)
+				std::rethrow_exception(ep);
+
 			// Now we check that we got the correct OLE correlations and fail
 			// the test otherwise.
 			for (size_t i = 0; i < blocks; i++)