#!/bin/bash # Builds protoc executable into target/protoc.exe; optionally build protoc # plugins into target/protoc-gen-*.exe # To be run from Maven. # Usage: build-protoc.sh # and are ${os.detected.name} and ${os.detected.arch} from os-maven-plugin # can be "protoc" or "protoc-gen-javalite" # # The script now supports cross-compiling windows and linux-arm64 in linux-x86 # environment. Required packages: # - Windows: i686-w64-mingw32-gcc (32bit) and x86_64-w64-mingw32-gcc (64bit) # - Arm64: g++-aarch64-linux-gnu OS=$1 ARCH=$2 MAKE_TARGET=$3 if [[ $# < 3 ]]; then echo "No arguments provided. This script is intended to be run from Maven." exit 1 fi case $MAKE_TARGET in protoc-gen-javalite) ;; protoc) ;; *) echo "Target ""$TARGET"" invalid." exit 1 esac # Under Cygwin, bash doesn't have these in PATH when called from Maven which # runs in Windows version of Java. export PATH="/bin:/usr/bin:$PATH" ############################################################################ # Helper functions ############################################################################ E_PARAM_ERR=98 E_ASSERT_FAILED=99 # Usage: fail() { echo "ERROR: $1" echo exit $E_ASSERT_FAILED } # Usage: assertEq VAL1 VAL2 $LINENO assertEq () { lineno=$3 if [ -z "$lineno" ]; then echo "lineno not given" exit $E_PARAM_ERR fi if [[ "$1" != "$2" ]]; then echo "Assertion failed: \"$1\" == \"$2\"" echo "File \"$0\", line $lineno" # Give name of file and line number. exit $E_ASSERT_FAILED fi } # Checks the artifact is for the expected architecture # Usage: checkArch checkArch () { echo echo "Checking file format ..." if [[ "$OS" == windows || "$OS" == linux ]]; then format="$(objdump -f "$1" | grep -o "file format .*$" | grep -o "[^ ]*$")" echo Format=$format if [[ "$OS" == linux ]]; then if [[ "$ARCH" == x86_32 ]]; then assertEq $format "elf32-i386" $LINENO elif [[ "$ARCH" == x86_64 ]]; then assertEq $format "elf64-x86-64" $LINENO elif [[ "$ARCH" == aarch_64 ]]; then assertEq $format "elf64-little" $LINENO elif [[ "$ARCH" == ppcle_64 ]]; then assertEq $format "elf64-powerpcle" $LINENO else fail "Unsupported arch: $ARCH" fi else # $OS == windows if [[ "$ARCH" == x86_32 ]]; then assertEq $format "pei-i386" $LINENO elif [[ "$ARCH" == x86_64 ]]; then assertEq $format "pei-x86-64" $LINENO else fail "Unsupported arch: $ARCH" fi fi elif [[ "$OS" == osx ]]; then format="$(file -b "$1" | grep -o "[^ ]*$")" echo Format=$format if [[ "$ARCH" == x86_32 ]]; then assertEq $format "i386" $LINENO elif [[ "$ARCH" == x86_64 ]]; then assertEq $format "x86_64" $LINENO else fail "Unsupported arch: $ARCH" fi else fail "Unsupported system: $OS" fi echo } # Checks the dependencies of the artifact. Artifacts should only depend on # system libraries. # Usage: checkDependencies checkDependencies () { if [[ "$OS" == windows ]]; then dump_cmd='objdump -x '"$1"' | fgrep "DLL Name"' white_list="KERNEL32\.dll\|msvcrt\.dll" elif [[ "$OS" == linux ]]; then dump_cmd='ldd '"$1" if [[ "$ARCH" == x86_32 ]]; then white_list="linux-gate\.so\.1\|libpthread\.so\.0\|libm\.so\.6\|libc\.so\.6\|ld-linux\.so\.2" elif [[ "$ARCH" == x86_64 ]]; then white_list="linux-vdso\.so\.1\|libpthread\.so\.0\|libm\.so\.6\|libc\.so\.6\|ld-linux-x86-64\.so\.2" elif [[ "$ARCH" == ppcle_64 ]]; then white_list="linux-vdso64\.so\.1\|libpthread\.so\.0\|libm\.so\.6\|libc\.so\.6\|libz\.so\.1\|ld64\.so\.2" elif [[ "$ARCH" == aarch_64 ]]; then dump_cmd='objdump -p '"$1"' | grep NEEDED' white_list="libpthread\.so\.0\|libm\.so\.6\|libc\.so\.6\|ld-linux-aarch64\.so\.1" fi elif [[ "$OS" == osx ]]; then dump_cmd='otool -L '"$1"' | fgrep dylib' white_list="libz\.1\.dylib\|libstdc++\.6\.dylib\|libSystem\.B\.dylib" fi if [[ -z "$white_list" || -z "$dump_cmd" ]]; then fail "Unsupported platform $OS-$ARCH." fi echo "Checking for expected dependencies ..." eval $dump_cmd | grep -i "$white_list" || fail "doesn't show any expected dependencies" echo "Checking for unexpected dependencies ..." eval $dump_cmd | grep -i -v "$white_list" ret=$? if [[ $ret == 0 ]]; then fail "found unexpected dependencies (listed above)." elif [[ $ret != 1 ]]; then fail "Error when checking dependencies." fi # grep returns 1 when "not found", which is what we expect echo "Dependencies look good." echo } ############################################################################ echo "Building protoc, OS=$OS ARCH=$ARCH TARGET=$TARGET" # Nested double quotes are unintuitive, but it works. cd "$(dirname "$0")" WORKING_DIR=$(pwd) CONFIGURE_ARGS="--disable-shared" TARGET_FILE=target/$MAKE_TARGET.exe if [[ "$OS" == windows ]]; then MAKE_TARGET="${MAKE_TARGET}.exe" fi # Override the default value set in configure.ac that has '-g' which produces # huge binary. CXXFLAGS="-DNDEBUG" LDFLAGS="" if [[ "$(uname)" == CYGWIN* ]]; then assertEq "$OS" windows $LINENO # Use mingw32 compilers because executables produced by Cygwin compiler # always have dependency on Cygwin DLL. if [[ "$ARCH" == x86_64 ]]; then CONFIGURE_ARGS="$CONFIGURE_ARGS --host=x86_64-w64-mingw32" elif [[ "$ARCH" == x86_32 ]]; then CONFIGURE_ARGS="$CONFIGURE_ARGS --host=i686-pc-mingw32" else fail "Unsupported arch by CYGWIN: $ARCH" fi elif [[ "$(uname)" == MINGW32* ]]; then assertEq "$OS" windows $LINENO assertEq "$ARCH" x86_32 $LINENO elif [[ "$(uname)" == MINGW64* ]]; then assertEq "$OS" windows $LINENO assertEq "$ARCH" x86_64 $LINENO elif [[ "$(uname)" == Linux* ]]; then if [[ "$OS" == linux ]]; then if [[ "$ARCH" == x86_64 ]]; then CXXFLAGS="$CXXFLAGS -m64" elif [[ "$ARCH" == x86_32 ]]; then CXXFLAGS="$CXXFLAGS -m32" elif [[ "$ARCH" == aarch_64 ]]; then CONFIGURE_ARGS="$CONFIGURE_ARGS --host=aarch64-linux-gnu" elif [[ "$ARCH" == ppcle_64 ]]; then CXXFLAGS="$CXXFLAGS -m64" else fail "Unsupported arch: $ARCH" fi elif [[ "$OS" == windows ]]; then # Cross-compilation for Windows CONFIGURE_ARGS="$CONFIGURE_ARGS" if [[ "$ARCH" == x86_64 ]]; then CONFIGURE_ARGS="$CONFIGURE_ARGS --host=x86_64-w64-mingw32" elif [[ "$ARCH" == x86_32 ]]; then CONFIGURE_ARGS="$CONFIGURE_ARGS --host=i686-w64-mingw32" else fail "Unsupported arch: $ARCH" fi else fail "Cannot build $OS on $(uname)" fi elif [[ "$(uname)" == Darwin* ]]; then assertEq "$OS" osx $LINENO # Make the binary compatible with OSX 10.7 and later CXXFLAGS="$CXXFLAGS -mmacosx-version-min=10.7" if [[ "$ARCH" == x86_64 ]]; then CXXFLAGS="$CXXFLAGS -m64" elif [[ "$ARCH" == x86_32 ]]; then CXXFLAGS="$CXXFLAGS -m32" else fail "Unsupported arch: $ARCH" fi else fail "Unsupported system: $(uname)" fi # Statically link libgcc and libstdc++. # -s to produce stripped binary. if [[ "$OS" == windows ]]; then # Also static link libpthread required by mingw64 LDFLAGS="$LDFLAGS -static-libgcc -static-libstdc++ -Wl,-Bstatic -lstdc++ -lpthread -s" elif [[ "$OS" != osx ]]; then # And they don't work under Mac. LDFLAGS="$LDFLAGS -static-libgcc -static-libstdc++ -s" fi export CXXFLAGS LDFLAGS cd "$WORKING_DIR"/.. && ./configure $CONFIGURE_ARGS && cd src && make clean && make $MAKE_TARGET && cd "$WORKING_DIR" && mkdir -p target && cp ../src/$MAKE_TARGET $TARGET_FILE || exit 1 if [[ "$OS" == osx ]]; then # Since Mac linker doesn't accept "-s", we need to run strip strip $TARGET_FILE || exit 1 fi checkArch $TARGET_FILE && checkDependencies $TARGET_FILE