Get rid of libomp dependency for ios builds. Add libgmp to distributions.

Author: olomix

.github/workflows/build.yml

@@ -14,11 +14,6 @@ jobs:
         with:
           submodules: "recursive"
 
-      - name: look up for android SDK
-        run: |
-          echo $ANDROID_NDK
-          ls /usr/local/lib/android/sdk/ndk/25.2.9519653
-
       - name: install requirements
         uses: awalsh128/cache-apt-pkgs-action@v1
         with:
@@ -86,15 +81,17 @@ jobs:
 
       - name: build
         run: |
-          brew install libomp
           if [[ ! -d "depends/gmp/package_ios_arm64" ]]; then ./build_gmp.sh ios; fi
+          if [[ ! -d "depends/gmp/package_iphone_simulator" ]]; then ./build_gmp.sh ios_simulator; fi
           mkdir build_prover_ios && cd build_prover_ios
           cmake .. -GXcode -DTARGET_PLATFORM=IOS -DCMAKE_INSTALL_PREFIX=../package_ios
           xcodebuild -destination 'generic/platform=iOS' -scheme rapidsnarkStatic -project rapidsnark.xcodeproj -configuration Release
+          cp ../depends/gmp/package_ios_arm64/lib/libgmp.a src/Release-iphoneos
           cd ../
           mkdir build_prover_ios_simulator && cd build_prover_ios_simulator
           cmake .. -GXcode -DTARGET_PLATFORM=IOS -DCMAKE_INSTALL_PREFIX=../package_ios_simulator -DUSE_ASM=NO
           xcodebuild -destination 'generic/platform=iOS Simulator' -scheme rapidsnarkStatic -project rapidsnark.xcodeproj
+          cp ../depends/gmp/package_ios_simulator/lib/libgmp.a src/Debug-iphonesimulator
 
       - name: upload iOS artifacts
         uses: actions/upload-artifact@v3

README.md

@@ -8,55 +8,55 @@ You should have installed gcc, cmake, libsodium, and gmp (development)
 
 In ubuntu:
 
-````
+```
 sudo apt-get install build-essential cmake libgmp-dev libsodium-dev nasm curl m4
-````
+```
 
 ## Compile prover in standalone mode
 
 ### Compile prover for x86_64 host machine
 
-````sh
+```sh
 git submodule init
 git submodule update
 ./build_gmp.sh host
 mkdir build_prover && cd build_prover
 cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../package
 make -j4 && make install
-````
+```
 
 ### Compile prover for macOS arm64 host machine
 
-````sh
+```sh
 git submodule init
 git submodule update
 ./build_gmp.sh host_noasm
 mkdir build_prover && cd build_prover
 cmake .. -DTARGET_PLATFORM=arm64_host -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../package
 make -j4 && make install
-````
+```
 
 ### Compile prover for linux arm64 host machine
 
-````sh
+```sh
 git submodule init
 git submodule update
 ./build_gmp.sh host
 mkdir build_prover && cd build_prover
 cmake .. -DTARGET_PLATFORM=arm64_host -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../package
 make -j4 && make install
-````
+```
 
 ### Compile prover for linux arm64 machine
 
-````sh
+```sh
 git submodule init
 git submodule update
 ./build_gmp.sh host
 mkdir build_prover && cd build_prover
 cmake .. -DTARGET_PLATFORM=aarch64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../package_aarch64
 make -j4 && make install
-````
+```
 
 ### Compile prover for Android
 
@@ -66,10 +66,10 @@ Set the value of ANDROID_NDK environment variable to the absolute path of Androi
 
 Examples:
 
-````sh
+```sh
 export ANDROID_NDK=/home/test/Android/Sdk/ndk/23.1.7779620  # NDK is installed by "SDK Manager" in Android Studio.
 export ANDROID_NDK=/home/test/android-ndk-r23b              # NDK is installed as a stand-alone package.
-````
+```
 
 Prerequisites if build on Ubuntu:
 
@@ -79,82 +79,86 @@ apt-get install curl xz-utils build-essential cmake m4 nasm
 
 Compilation:
 
-````sh
+```sh
 git submodule init
 git submodule update
 ./build_gmp.sh android
 mkdir build_prover_android && cd build_prover_android
 cmake .. -DTARGET_PLATFORM=ANDROID -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../package_android
 make -j4 && make install
-````
+```
 
 ### Compile prover for iOS
 
 Install Xcode & homebrew.
 
-````sh
-brew install libomp
+```sh
 git submodule init
 git submodule update
 ./build_gmp.sh ios
 mkdir build_prover_ios && cd build_prover_ios
 cmake .. -GXcode -DTARGET_PLATFORM=IOS -DCMAKE_INSTALL_PREFIX=../package_ios
 xcodebuild -destination 'generic/platform=iOS' -scheme rapidsnarkStatic -project rapidsnark.xcodeproj -configuration Release
-````
+```
 Open generated Xcode project and compile prover.
 
 ## Build for iOS emulator
 
 Install Xcode & homebrew.
 
-````sh
-brew install libomp
+```sh
 git submodule init
 git submodule update
-./build_gmp.sh ios
+./build_gmp.sh ios_simulator
 mkdir build_prover_ios_simulator && cd build_prover_ios_simulator
 cmake .. -GXcode -DTARGET_PLATFORM=IOS -DCMAKE_INSTALL_PREFIX=../package_ios_simulator -DUSE_ASM=NO
 xcodebuild -destination 'generic/platform=iOS Simulator' -scheme rapidsnarkStatic -project rapidsnark.xcodeproj
-````
+```
+
+Files that you need to copy to your XCode project to link against Rapidsnark:
+* build_prover_ios_simulator/src/Debug-iphonesimulator/librapidsnark.a
+* build_prover_ios_simulator/src/Debug-iphonesimulator/libfq.a
+* build_prover_ios_simulator/src/Debug-iphonesimulator/libfr.a
+* depends/gmp/package_iphone_simulator/lib/libgmp.a
 
 ## Building proof
 
 You have a full prover compiled in the build directory.
 
 So you can replace snarkjs command:
 
-````sh
+```sh
 snarkjs groth16 prove <circuit.zkey> <witness.wtns> <proof.json> <public.json>
-````
+```
 
 by this one
-````sh
+```sh
 ./package/bin/prover <circuit.zkey> <witness.wtns> <proof.json> <public.json>
-````
+```
 
 ## Compile prover in server mode
 
-````sh
+```sh
 npm install
 git submodule init
 git submodule update
 npx task createFieldSources
 npx task buildPistache
 npx task buildProverServer
-````
+```
 
 ## Launch prover in server mode
-````sh
+```sh
 ./build/proverServer  <port> <circuit1_zkey> <circuit2_zkey> ... <circuitN_zkey>
-````
+```
 
 For every `circuit.circom` you have to generate with circom with --c option the `circuit_cpp` and after compilation you have to copy the executable into the `build` folder so the server can generate the witness and then the proof based on this witness.
 You have an example of the usage calling the server endpoints to generate the proof with Nodejs in `/tools/request.js`.
 
 To test a request you should pass an `input.json` as a parameter to the request call.
-````sh
+```sh
 node tools/request.js <input.json> <circuit>
-````
+```
 
 ## Benchmark
 

build_gmp.sh

@@ -1,5 +1,7 @@
 #!/bin/sh
 
+set -e
+
 NPROC=8
 fetch_cmd=$( (type wget > /dev/null 2>&1 && echo "wget") || echo "curl -O" )
 
@@ -11,7 +13,7 @@ usage()
     echo "    android_x86_64: build for Android x86_64"
     echo "    aarch64:        build for Linux aarch64"
     echo "    ios:            build for iOS arm64"
-    echo "    ios_x86_64:     build for iOS simulator on x86_64"
+    echo "    ios_simulator:  build for iPhone Simulator for arm64/x86_64 (fat binary)"
     echo "    host:           build for this host"
     echo "    host_noasm:     build for this host without asm optimizations (e.g. needed for macOS)"
 
@@ -233,42 +235,51 @@ build_ios()
     cd ..
 }
 
-build_ios_x86_64()
+build_ios_simulator()
 {
-    PACKAGE_DIR="$GMP_DIR/package_ios_x86_64"
-    BUILD_DIR=build_ios_x86_64
-
-    if [ -d "$PACKAGE_DIR" ]; then
-        echo "iOS package is built already. See $PACKAGE_DIR"
-        return 1
-    fi
-
-    export SDK="iphonesimulator"
-    export TARGET=x86_64-apple-darwin
-    export MIN_IOS_VERSION=8.0
-
-    export ARCH_FLAGS="-arch x86_64"
-    export OPT_FLAGS="-O3 -g3 -fembed-bitcode"
-    export HOST_FLAGS="${ARCH_FLAGS} -miphoneos-version-min=${MIN_IOS_VERSION} -isysroot $(xcrun --sdk ${SDK} --show-sdk-path)"
-
-    export CC=$(xcrun --find --sdk "${SDK}" clang)
-    export CXX=$(xcrun --find --sdk "${SDK}" clang++)
-    export CPP=$(xcrun --find --sdk "${SDK}" cpp)
-    export CFLAGS="${HOST_FLAGS} ${OPT_FLAGS}"
-    export CXXFLAGS="${HOST_FLAGS} ${OPT_FLAGS}"
-    export LDFLAGS="${HOST_FLAGS}"
-
-    echo $TARGET
-
-    rm -rf "$BUILD_DIR"
-    mkdir "$BUILD_DIR"
-    cd "$BUILD_DIR"
-
-    ../configure --host $TARGET --prefix="$PACKAGE_DIR" --with-pic --disable-fft --disable-assembly &&
-    make -j${NPROC} &&
-    make install
-
-    cd ..
+	libs=()
+	for ARCH in "arm64" "x86_64"; do
+		case "$ARCH" in
+			"arm64" )
+				echo "Building for iPhone Simulator ARM64"
+				ARCH_FLAGS="-arch arm64 -arch arm64e"
+				;;
+			"x86_64" )
+				echo "Building for iPhone Simulator x86_64"
+				ARCH_FLAGS="-arch x86_64"
+				;;
+			* )
+				echo "Incorrect iPhone Simulator arch"
+				exit 1
+		esac
+		
+		BUILD_DIR="build_iphone_simulator_${ARCH}"
+		PACKAGE_DIR="$GMP_DIR/package_iphone_simulator_${ARCH}"
+		libs+=("${PACKAGE_DIR}/lib/libgmp.a")
+
+		if [ -d "$PACKAGE_DIR" ]; then
+			echo "iPhone Simulator ${ARCH} package is built already. See $PACKAGE_DIR. Skip building this ARCH."
+			continue
+		fi
+
+		rm -rf "$BUILD_DIR"
+		mkdir "$BUILD_DIR"
+		cd "$BUILD_DIR"
+
+		../configure --prefix="${PACKAGE_DIR}" \
+					 CC="$(xcrun --sdk iphonesimulator --find clang)" \
+					 CFLAGS="-O3 -isysroot $(xcrun --sdk iphonesimulator --show-sdk-path) ${ARCH_FLAGS} -fvisibility=hidden -mios-simulator-version-min=8.0" \
+					 LDFLAGS="" \
+					 --host ${ARCH}-apple-darwin --disable-assembly --enable-static --disable-shared --with-pic &&
+			make -j${NPROC} &&
+			make install
+		
+		cd ..
+	done
+
+	mkdir -p "${GMP_DIR}/package_iphone_simulator/lib"
+	lipo ${libs[@]} -create -output "${GMP_DIR}/package_iphone_simulator/lib/libgmp.a"
+	echo "Wrote universal fat library for iPhone Simulator arm64/x86_64 to ${GMP_DIR}/package_iphone_simulator/lib/libgmp.a"
 }
 
 if [ $# -ne 1 ]; then
@@ -292,9 +303,9 @@ case "$TARGET_PLATFORM" in
         build_ios
     ;;
 
-    "ios_x86_64" )
-        echo "Building for ios simulator on x86_64"
-        build_ios_x86_64
+    "ios_simulator" )
+        echo "Building for iPhone Simulator"
+        build_ios_simulator
     ;;
 
     "android" )

depends/ffiasm

@@ -105,14 +105,6 @@ include_directories(
     ../depends/ffiasm/c
     ../depends/json/single_include)
 
-if(APPLE)
-    execute_process(COMMAND brew --prefix OUTPUT_VARIABLE BREW_PREFIX OUTPUT_STRIP_TRAILING_WHITESPACE)
-	if(NOT EXISTS "${BREW_PREFIX}/opt/libomp/include")
-	    message(FATAL_ERROR "libomp is not found in ${BREW_PREFIX}/opt/libomp/include, install it with `brew install libomp`")
-	endif()
-	include_directories("${BREW_PREFIX}/opt/libomp/include")
-endif()
-
 add_library(rapidsnarkStatic STATIC ${LIB_SOURCES})
 set_target_properties(rapidsnarkStatic PROPERTIES OUTPUT_NAME rapidsnark)