Add debug build option support (#104)

Author: Kudo

lib/android-jsc/build.gradle

@@ -15,6 +15,10 @@ android {
             jniLibs.srcDirs = ["${rootDir}/../build/compiled"]
         }
     }
+
+    packagingOptions {
+        doNotStrip "**/libjsc.so"
+    }
 }
 
 dependencies {}

patches/jsc_features.patch

@@ -23,9 +23,9 @@ diff -aur target-org/webkit/CMakeLists.txt target/webkit/CMakeLists.txt
  # -----------------------------------------------------------------------------
  # Print the features list last, for maximum visibility.
 diff -aur target-org/webkit/Source/cmake/OptionsJSCOnly.cmake target/webkit/Source/cmake/OptionsJSCOnly.cmake
---- target-org/webkit/Source/cmake/OptionsJSCOnly.cmake	2017-04-17 15:51:21.000000000 +0200
-+++ target/webkit/Source/cmake/OptionsJSCOnly.cmake	2017-07-11 11:34:55.962374878 +0200
-@@ -35,12 +35,11 @@
+--- target-org/webkit/Source/cmake/OptionsJSCOnly.cmake 2019-03-26 11:25:17.000000000 +0800
++++ target/webkit/Source/cmake/OptionsJSCOnly.cmake     2019-03-26 11:28:29.000000000 +0800
+@@ -35,12 +35,7 @@
  set(ENABLE_WEBCORE OFF)
  set(ENABLE_WEBKIT_LEGACY OFF)
  set(ENABLE_WEBKIT OFF)
@@ -36,13 +36,9 @@ diff -aur target-org/webkit/Source/cmake/OptionsJSCOnly.cmake target/webkit/Sour
 -    set(ENABLE_API_TESTS ON)
 -endif ()
 +set(ENABLE_API_TESTS OFF)
-+set(ENABLE_SAMPLING_PROFILER OFF)
-+set(ENABLE_DFG_JIT ON)
-+set(ENABLE_FTL_JIT OFF)
-+set(ENABLE_JIT ON)
 
- if (WTF_CPU_X86 OR WTF_CPU_X86_64)
-     SET_AND_EXPOSE_TO_BUILD(USE_UDIS86 1)
+ if (WTF_CPU_ARM OR WTF_CPU_MIPS)
+     SET_AND_EXPOSE_TO_BUILD(USE_CAPSTONE TRUE)
 diff -aur target-org/webkit/Source/JavaScriptCore/CMakeLists.txt target/webkit/Source/JavaScriptCore/CMakeLists.txt
 --- target-org/webkit/Source/JavaScriptCore/CMakeLists.txt	2017-05-02 21:13:03.000000000 +0200
 +++ target/webkit/Source/JavaScriptCore/CMakeLists.txt	2017-07-11 11:34:55.962374878 +0200

patches/jsc_fix_build_error_mulodi4.patch

@@ -0,0 +1,30 @@
+diff -aur target-org/webkit/Source/WTF/wtf/CheckedArithmetic.h target/webkit/Source/WTF/wtf/CheckedArithmetic.h
+--- target-org/webkit/Source/WTF/wtf/CheckedArithmetic.h	2018-07-26 17:00:09.000000000 +0800
++++ target/webkit/Source/WTF/wtf/CheckedArithmetic.h	2019-04-12 12:03:55.000000000 +0800
+@@ -317,7 +317,7 @@
+
+     static inline bool multiply(LHS lhs, RHS rhs, ResultType& result) WARN_UNUSED_RETURN
+     {
+-#if COMPILER(GCC_OR_CLANG)
++#if COMPILER(GCC_OR_CLANG) && CPU(ARM_THUMB2) && defined(NDEBUG)
+         ResultType temp;
+         if (__builtin_mul_overflow(lhs, rhs, &temp))
+             return false;
+@@ -390,7 +390,7 @@
+
+     static inline bool multiply(LHS lhs, RHS rhs, ResultType& result) WARN_UNUSED_RETURN
+     {
+-#if COMPILER(GCC_OR_CLANG)
++#if COMPILER(GCC_OR_CLANG) && CPU(ARM_THUMB2) && defined(NDEBUG)
+         ResultType temp;
+         if (__builtin_mul_overflow(lhs, rhs, &temp))
+             return false;
+@@ -453,7 +453,7 @@
+
+     static inline bool multiply(int64_t lhs, int64_t rhs, ResultType& result)
+     {
+-#if COMPILER(GCC_OR_CLANG)
++#if COMPILER(GCC_OR_CLANG) && CPU(ARM_THUMB2) && defined(NDEBUG)
+         ResultType temp;
+         if (__builtin_mul_overflow(lhs, rhs, &temp))
+             return false;

scripts/compile/common.sh

@@ -121,9 +121,21 @@ if [[ $err = true ]]; then exit 1; fi
 
 ####
 
+DEBUG_SYMBOL_LEVEL="-g2"
+if [[ "$BUILD_TYPE" = "Release" ]]
+then
+    FRAME_POINTER_FLAG="-fomit-frame-pointer"
+    CFLAGS_BUILD_TYPE="-DNDEBUG"
+    ICU_CFLAGS_BUILD_TYPE="-Oz"
+else
+    FRAME_POINTER_FLAG="-fno-omit-frame-pointer"
+    CFLAGS_BUILD_TYPE=""
+    ICU_CFLAGS_BUILD_TYPE=$DEBUG_SYMBOL_LEVEL
+fi
+
+####
+
 COMMON_LDFLAGS=" \
--fuse-ld=gold \
--Wl,--icf=safe \
 -Wl,-z,noexecstack \
 -Wl,--gc-sections \
 -Wl,--exclude-libs,libgcc.a \
@@ -134,26 +146,27 @@ COMMON_LDFLAGS=" \
 COMMON_CFLAGS=" \
 -fstack-protector \
 -ffunction-sections \
--fomit-frame-pointer \
+$FRAME_POINTER_FLAG \
 -fno-strict-aliasing \
--fexceptions \
--frtti \
 -funwind-tables \
 -DPIC \
 -fPIC \
 -fvisibility=hidden \
--DNDEBUG \
 -DCUSTOMIZE_REACT_NATIVE \
 $SWITCH_COMMON_CFLAGS_INTL \
+$CFLAGS_BUILD_TYPE \
 "
 
 COMMON_CXXFLAGS=" \
---std=c++11 \
 "
 
-ICU_CFLAGS="$COMMON_CFLAGS $PLATFORM_CFLAGS -Oz"
-ICU_CXXFLAGS="$COMMON_CXXFLAGS $ICU_CFLAGS -Oz"
-ICU_LDFLAGS="$COMMON_LDFLAGS $PLATFORM_LDFLAGS -s"
+ICU_CFLAGS="$COMMON_CFLAGS $PLATFORM_CFLAGS $ICU_CFLAGS_BUILD_TYPE"
+ICU_CXXFLAGS="$COMMON_CXXFLAGS $ICU_CFLAGS $ICU_CFLAGS_BUILD_TYPE"
+ICU_LDFLAGS="$COMMON_LDFLAGS \
+-fuse-ld=gold \
+-Wl,--icf=safe \
+$PLATFORM_LDFLAGS \
+"
 
 JSC_LDFLAGS="$COMMON_LDFLAGS"
 JSC_CFLAGS="$COMMON_CFLAGS -DU_STATIC_IMPLEMENTATION=1 -DU_SHOW_CPLUSPLUS_API=0"

scripts/compile/icu.sh

@@ -18,7 +18,15 @@ cd $BUILD_DIR
 CROSS_BUILD_DIR=$(realpath $TARGETDIR/icu/host)
 PATH=$TOOLCHAIN_DIR/bin:$PATH
 
+if [[ "$BUILD_TYPE" = "Release" ]]
+then
+    BUILD_TYPE_CONFIG="--enable-release=yes"
+else
+    BUILD_TYPE_CONFIG="--enable-debug=yes"
+fi
+
 $TARGETDIR/icu/source/configure --prefix=$(pwd)/prebuilts \
+    $BUILD_TYPE_CONFIG \
     --host=$CROSS_COMPILE_PLATFORM \
     --enable-static=yes \
     --enable-shared=no \

scripts/compile/jsc.sh

@@ -40,9 +40,19 @@ ARCH_NAME_PLATFORM_x86_64="x86_64"
 var="ARCH_NAME_PLATFORM_$JSC_ARCH"
 export ARCH_NAME=${!var}
 
+
+if [[ "$BUILD_TYPE" = "Release" ]]
+then
+    BUILD_TYPE_CONFIG="--release"
+    BUILD_TYPE_FLAGS=""
+else
+    BUILD_TYPE_CONFIG="--debug"
+    BUILD_TYPE_FLAGS="-DDEBUG_FISSION=OFF"
+fi
+
 $TARGETDIR/webkit/Tools/Scripts/build-webkit \
   --jsc-only \
-  --release \
+  $BUILD_TYPE_CONFIG \
   --jit \
   "$SWITCH_BUILD_WEBKIT_OPTIONS_INTL" \
   --no-webassembly \
@@ -62,12 +72,19 @@ $TARGETDIR/webkit/Tools/Scripts/build-webkit \
   -DCMAKE_SYSROOT_COMPILE=$TOOLCHAIN_DIR/sysroot \
   -DCMAKE_CXX_FLAGS='${CMAKE_CXX_FLAGS} $COMMON_CXXFLAGS $CMAKE_CXX_FLAGS' \
   -DCMAKE_C_FLAGS='${CMAKE_C_FLAGS} $CMAKE_CXX_FLAGS' \
+  -DCMAKE_C_FLAGS_DEBUG='${DEBUG_SYMBOL_LEVEL}' \
+  -DCMAKE_CXX_FLAGS_DEBUG='${DEBUG_SYMBOL_LEVEL}' \
   -DCMAKE_SHARED_LINKER_FLAGS='${CMAKE_SHARED_LINKER_FLAGS} $CMAKE_LD_FLAGS' \
   -DCMAKE_EXE_LINKER_FLAGS='${CMAKE_MODULE_LINKER_FLAGS} $CMAKE_LD_FLAGS' \
-  -DENABLE_API_TESTS=0 \
   -DCMAKE_VERBOSE_MAKEFILE=on \
+  -DENABLE_API_TESTS=OFF \
+  -DENABLE_SAMPLING_PROFILER=OFF \
+  -DENABLE_JIT=ON \
+  -DENABLE_DFG_JIT=ON \
+  -DENABLE_FTL_JIT=OFF \
   -DJSC_VERSION=\"${JSC_VERSION}\" \
+  $BUILD_TYPE_FLAGS \
   "
 
-cp $TARGETDIR/webkit/WebKitBuild/Release/lib/libjsc.so $INSTALL_DIR
+cp $TARGETDIR/webkit/WebKitBuild/$BUILD_TYPE/lib/libjsc.so $INSTALL_DIR
 mv $TARGETDIR/webkit/WebKitBuild $TARGETDIR/webkit/${CROSS_COMPILE_PLATFORM}-${FLAVOR}

scripts/patch.sh

@@ -41,6 +41,10 @@ JSC_PATCHSET=(
 
   # Will print current JSC version in adb log during initialization
   "jsc_startup_log_version.patch"
+
+  # NDK r17c does not define __mulodi4, which is being used in debug build.
+  # (However, NDK r19 fixed this)
+  "jsc_fix_build_error_mulodi4.patch"
 )
 
 if [[ "$I18N" = false ]]

scripts/start.sh

@@ -6,6 +6,9 @@ export ROOTDIR=$PWD
 export TARGETDIR=$ROOTDIR/build/target
 source $ROOTDIR/scripts/info.sh
 export JSC_VERSION=${npm_package_version}
+export BUILD_TYPE=Release
+# export BUILD_TYPE=Debug
+
 SCRIPT_DIR=$(cd `dirname $0`; pwd)
 
 patchAndMakeICU() {
@@ -22,9 +25,16 @@ patchAndMakeICU() {
   mkdir -p $TARGETDIR/icu/host
   cd $TARGETDIR/icu/host
 
+  if [[ "$BUILD_TYPE" = "Release" ]]
+  then
+    CFLAGS="-Os"
+  else
+    CFLAGS="-g2"
+  fi
+
   $TARGETDIR/icu/source/runConfigureICU Linux \
   --prefix=$PWD/prebuilts \
-  CFLAGS="-Os" \
+  CFLAGS="$CFLAGS" \
   CXXFLAGS="--std=c++11" \
   --disable-tests \
   --disable-samples \