Support both Linux ABIs, legacy and C++11 (#213)

jonsimantov · web-flow · commit 03e6698e4a86 · 2020-12-16T12:54:03.000-08:00
This change keeps the legacy ABI but also adds an option to build using the C++11 ABI if FIREBASE_LINUX_USE_CXX11_ABI is set during the cmake configure step.

In packaging, the location of the Linux libraries is now libs/linux/$arch/$abi, where $arch is x86_64 or i386 (as before), and $abi is legacy or cxx11. For example, libs/linux/x86_64/cxx11/libfirebase_app.a. The binary package's CMakeLists.txt has been updated to choose the correct one based on whether the compiler option is enabled (it checks the actual CFLAGS for the option, not the Firebase-specific flag, so it should handle the selection automatically even if the developer's CMake project doesn't provide the Firebase-specific flag).

Also any sub-builds (e.g. boringssl) will also be configured with the requested ABI option.
diff --git a/.github/workflows/cpp-packaging.yml b/.github/workflows/cpp-packaging.yml
@@ -220,7 +220,7 @@ jobs:
           path: firebase-cpp-sdk-android-${{ matrix.stl }}-package.tgz
 
   build_desktop:
-    name: build-${{ matrix.sdk_platform }}-${{ matrix.architecture }}-${{ matrix.build_type }}-${{ matrix.msvc_runtime }}
+    name: build-${{ matrix.sdk_platform }}-${{ matrix.architecture }}-${{ matrix.build_type }}-${{ matrix.msvc_runtime }}-${{ matrix.linux_abi }}
     runs-on: ${{ matrix.os }}
     if: ${{ github.event.inputs.downloadPublicVersion == '' && github.event.inputs.downloadPreviousRun == '' }}
     strategy:
@@ -230,6 +230,7 @@ jobs:
         build_type: ["Release", "Debug"]
         architecture: ["x64", "x86"]
         msvc_runtime: ["static", "dynamic"]
+        linux_abi: ["legacy", "c++11"]
         python_version: [3.7]
         include:
         - os: windows-latest
@@ -251,10 +252,14 @@ jobs:
           sdk_platform: "darwin"
 
         exclude:
+        - os: windows-latest
+          linux_abi: "c++11"
         - os: macos-latest
           architecture: "x86"
         - os: macos-latest
           msvc_runtime: "dynamic"
+        - os: macos-latest
+          linux_abi: "c++11"
         - os: macos-latest
           build_type: "Debug"
         - os: ubuntu-latest
@@ -276,8 +281,8 @@ jobs:
         shell: bash
         run: |
           echo "VCPKG_RESPONSE_FILE=external/vcpkg_${{ matrix.vcpkg_triplet }}_response_file.txt" >> $GITHUB_ENV
-          echo "MATRIX_UNIQUE_NAME=${{ matrix.os }}-${{ matrix.build_type }}-${{ matrix.architecture }}-${{ matrix.python_version }}" >> $GITHUB_ENV
-          echo "SDK_NAME=${{ matrix.sdk_platform }}-${{ matrix.architecture }}-${{ matrix.build_type }}-${{ matrix.msvc_runtime }}" >> $GITHUB_ENV
+          echo "MATRIX_UNIQUE_NAME=${{ matrix.os }}-${{ matrix.build_type }}-${{ matrix.architecture }}-${{ matrix.python_version }}-${{ matrix.msvc_runtime }}-${{ matrix.linux_abi }}" >> $GITHUB_ENV
+          echo "SDK_NAME=${{ matrix.sdk_platform }}-${{ matrix.architecture }}-${{ matrix.build_type }}-${{ matrix.msvc_runtime }}-${{ matrix.linux_abi }}" >> $GITHUB_ENV
 
       - name: Add msbuild to PATH (windows)
         if: startsWith(matrix.os, 'windows')
@@ -288,7 +293,7 @@ jobs:
         uses: actions/cache@v2
         with:
           path: external/vcpkg/installed
-          key: dev-vcpkg-${{ matrix.architecture }}-${{ matrix.vcpkg_triplet_suffix }}-${{ matrix.msvc_runtime }}-${{ hashFiles(format('{0}', env.VCPKG_RESPONSE_FILE)) }}-${{ hashFiles('.git/modules/external/vcpkg/HEAD') }}
+          key: dev-vcpkg-${{ matrix.architecture }}-${{ matrix.vcpkg_triplet_suffix }}-${{ matrix.msvc_runtime }}-${{ matrix.linux_abi }}-${{ hashFiles(format('{0}', env.VCPKG_RESPONSE_FILE)) }}-${{ hashFiles('.git/modules/external/vcpkg/HEAD') }}
 
       - name: Cache ccache files
         if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macos')
@@ -310,7 +315,7 @@ jobs:
       - name: Build desktop SDK
         shell: bash
         run: |
-          python scripts/gha/build_desktop.py --arch "${{ matrix.architecture }}" --config "${{ matrix.build_type }}" --msvc_runtime_library "${{ matrix.msvc_runtime }}" --build_dir out-${{ env.SDK_NAME }} ${{ matrix.additional_build_flags }}
+          python scripts/gha/build_desktop.py --arch "${{ matrix.architecture }}" --config "${{ matrix.build_type }}" --msvc_runtime_library "${{ matrix.msvc_runtime }}" --linux_abi "${{ matrix.linux_abi }}" --build_dir out-${{ env.SDK_NAME }} ${{ matrix.additional_build_flags }}
           # Make a list of all the source files, for debugging purposes.
           cd out-${{ env.SDK_NAME }}
           find .. -type f -print > src_file_list.txt
@@ -579,17 +584,19 @@ jobs:
         name: |
           packaging-tools-darwin
           packaging-tools-linux
-          firebase-cpp-sdk-windows-x86-Release-dynamic-build
-          firebase-cpp-sdk-windows-x64-Release-dynamic-build
-          firebase-cpp-sdk-windows-x86-Debug-dynamic-build
-          firebase-cpp-sdk-windows-x64-Debug-dynamic-build
-          firebase-cpp-sdk-windows-x86-Release-static-build
-          firebase-cpp-sdk-windows-x64-Release-static-build
-          firebase-cpp-sdk-windows-x86-Debug-static-build
-          firebase-cpp-sdk-windows-x64-Debug-static-build
-          firebase-cpp-sdk-linux-x86-Release-static-build
-          firebase-cpp-sdk-linux-x64-Release-static-build
-          firebase-cpp-sdk-darwin-x64-Release-static-build
+          firebase-cpp-sdk-windows-x86-Release-dynamic-legacy-build
+          firebase-cpp-sdk-windows-x64-Release-dynamic-legacy-build
+          firebase-cpp-sdk-windows-x86-Debug-dynamic-legacy-build
+          firebase-cpp-sdk-windows-x64-Debug-dynamic-legacy-build
+          firebase-cpp-sdk-windows-x86-Release-static-legacy-build
+          firebase-cpp-sdk-windows-x64-Release-static-legacy-build
+          firebase-cpp-sdk-windows-x86-Debug-static-legacy-build
+          firebase-cpp-sdk-windows-x64-Debug-static-legacy-build
+          firebase-cpp-sdk-linux-x86-Release-static-legacy-build
+          firebase-cpp-sdk-linux-x64-Release-static-legacy-build
+          firebase-cpp-sdk-linux-x86-Release-static-c++11-build
+          firebase-cpp-sdk-linux-x64-Release-static-c++11-build
+          firebase-cpp-sdk-darwin-x64-Release-static-legacy-build
           firebase-cpp-sdk-windows-x86-Release-dynamic-package
           firebase-cpp-sdk-windows-x64-Release-dynamic-package
           firebase-cpp-sdk-windows-x86-Debug-dynamic-package
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -68,6 +68,8 @@ option(FIREBASE_CPP_USE_PRIOR_GRADLE_BUILD
         "When building with Gradle, use the previously built libraries." OFF)
 option(FIREBASE_USE_BORINGSSL
         "Build against BoringSSL instead of using your system's OpenSSL." OFF)
+option(FIREBASE_USE_LINUX_CXX11_ABI
+        "Build Linux SDK using the C++11 ABI instead of the legacy ABI." OFF)
 
 set(FIREBASE_ANDROID_STL "" CACHE STRING "STL implementation to use.")
 if (NOT FIREBASE_ANDROID_STL STREQUAL "")
@@ -119,9 +121,15 @@ endif()
 
 if(DESKTOP AND NOT MSVC AND NOT APPLE)
   # Linux-specific option.
-  add_definitions(-D_GLIBCXX_USE_CXX11_ABI=0)
-  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_GLIBCXX_USE_CXX11_ABI=0")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_GLIBCXX_USE_CXX11_ABI=0")
+  if (FIREBASE_LINUX_USE_CXX11_ABI)
+    add_definitions(-D_GLIBCXX_USE_CXX11_ABI=1)
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_GLIBCXX_USE_CXX11_ABI=1")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_GLIBCXX_USE_CXX11_ABI=1")
+  else()
+    add_definitions(-D_GLIBCXX_USE_CXX11_ABI=0)
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_GLIBCXX_USE_CXX11_ABI=0")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_GLIBCXX_USE_CXX11_ABI=0")
+  endif()
 endif()
 
 # Set directories needed by the Firebase subprojects
diff --git a/build_scripts/desktop/get_variant.sh b/build_scripts/desktop/get_variant.sh
@@ -32,6 +32,7 @@ debugmode=Release
 msvc_runtime_library=MD
 vs=VS2015
 stl=c++
+linux_abi=legacy
 
 for c in $(echo "${filename}" | tr "_.-" "\n\n\n"); do
     case $c in
@@ -133,6 +134,15 @@ for c in $(echo "${filename}" | tr "_.-" "\n\n\n"); do
 	stlport)
 	    stl=stlport
         ;;
+	cxx11)
+	    linux_abi=cxx11
+        ;;
+	c++11)
+	    linux_abi=cxx11
+        ;;
+	legacy)
+	    linux_abi=legacy
+        ;;
     esac
 done
 
@@ -154,7 +164,7 @@ case ${os} in
 	    echo "Couldn't determine architecture" 1>&2
 	    exit 1
 	fi
-	echo -n "${arch}"
+	echo -n "${arch}/${linux_abi}"
     ;;
     windows)
 	if [[ -z "${arch_win}" ]]; then
diff --git a/cmake/external_rules.cmake b/cmake/external_rules.cmake
@@ -197,7 +197,9 @@ function(build_external_dependencies)
     endif()
   else()
     # Propagate Linux build flags.
-    if("${CMAKE_CXX_FLAGS}" MATCHES "-D_GLIBCXX_USE_CXX11_ABI=0")
+    get_directory_property(CURR_DIRECTORY_DEFS COMPILE_DEFINITIONS)
+    if("${CURR_DIRECTORY_DEFS}" MATCHES "_GLIBCXX_USE_CXX11_ABI=0" OR
+       "${CMAKE_CXX_FLAGS}" MATCHES "-D_GLIBCXX_USE_CXX11_ABI=0")
       set(SUBBUILD_USE_CXX11_ABI 0)
     else()
       set(SUBBUILD_USE_CXX11_ABI 1)
diff --git a/cmake/toolchains/linux_32.cmake b/cmake/toolchains/linux_32.cmake
@@ -16,4 +16,5 @@
 
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32")
-set(CMAKE_LIBRARY_PATH "/usr/lib/i386-linux-gnu")
+set(CMAKE_LIBRARY_PATH "/usr/lib/i386-linux-gnu")
+set(INCLUDE_DIRECTORIES ${INCLUDE_DIRECTORIES} "/usr/include/i386-linux-gnu")
diff --git a/external/vcpkg_custom_data/toolchains/linux_32.cmake b/external/vcpkg_custom_data/toolchains/linux_32.cmake
@@ -16,6 +16,7 @@
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32")
 set(CMAKE_LIBRARY_PATH "/usr/lib/i386-linux-gnu")
+set(INCLUDE_DIRECTORIES ${INCLUDE_DIRECTORIES} "/usr/include/i386-linux-gnu")
 
 # From this line onwards, everything is a copy of the standard toolchain file
 # shipped with vcpkg (vcpkg/scripts/buildsystems/vcpkg.cmake). This way, we can
diff --git a/release_build_files/CMakeLists.txt b/release_build_files/CMakeLists.txt
@@ -49,10 +49,18 @@ elseif(MSVC)
   set(FIREBASE_SDK_LIBDIR
       ${FIREBASE_CPP_SDK_DIR}/libs/windows/${MSVC_VS_VERSION}/${MSVC_RUNTIME_MODE}/${MSVC_CPU}/${MSVC_CONFIG})
 else()
-  # The Firebase libraries are not built with glibcxx11, so disable the ABI.
-  set(DISABLE_CXX11 TRUE)
+  # Check whether we are building with CXX11 ABI.
+  get_directory_property(CURR_DIRECTORY_DEFS COMPILE_DEFINITIONS)
+  if ("${CURR_DIRECTORY_DEFS}" MATCHES "_GLIBCXX_USE_CXX11_ABI=0" OR
+      "${CMAKE_CXX_FLAGS}" MATCHES "-D_GLIBCXX_USE_CXX11_ABI=0")
+    set(DISABLE_CXX11 TRUE)
+    set(LINUX_ABI legacy)
+  else()
+    set(DISABLE_CXX11 FALSE)
+    set(LINUX_ABI cxx11)
+  endif()  
   set(LINUX_CPU x86_64)
-  set(FIREBASE_SDK_LIBDIR ${FIREBASE_CPP_SDK_DIR}/libs/linux/${LINUX_CPU})
+  set(FIREBASE_SDK_LIBDIR ${FIREBASE_CPP_SDK_DIR}/libs/linux/${LINUX_CPU}/${LINUX_ABI})
 endif()
 
 # Defines a Firebase target, linking it with the correct prebuilt library.
diff --git a/scripts/gha/build_desktop.py b/scripts/gha/build_desktop.py
@@ -59,7 +59,9 @@ def append_line_to_file(path, line):
 def install_x86_support_libraries():
   """Install support libraries needed to build x86 on x86_64 hosts."""
   if utils.is_linux_os():
-    packages = ['gcc-multilib', 'g++-multilib', 'libglib2.0-dev:i386', 'libsecret-1-dev:i386']
+    packages = ['gcc-multilib', 'g++-multilib', 'libglib2.0-dev:i386',
+                'libsecret-1-dev:i386', 'libpthread-stubs0-dev:i386',
+                'libssl-dev:i386']
 
     # First check if these packages exist on the machine already
     devnull = open(os.devnull, "w")
@@ -70,7 +72,7 @@ def install_x86_support_libraries():
       # Install them.
       utils.run_command(['dpkg', '--add-architecture', 'i386'], as_root=True)
       utils.run_command(['apt', 'update'], as_root=True)
-      utils.run_command(['apt', 'install'] + packages, as_root=True)
+      utils.run_command(['apt', 'install', '-y'] + packages, as_root=True)
 
 
 def _install_cpp_dependencies_with_vcpkg(arch, msvc_runtime_library):
@@ -138,7 +140,7 @@ def install_cpp_dependencies_with_vcpkg(arch, msvc_runtime_library, cleanup=True
     # could be several GBs and cause github runners to run out of space
     utils.clean_vcpkg_temp_data()
 
-def cmake_configure(build_dir, arch, msvc_runtime_library='static',
+def cmake_configure(build_dir, arch, msvc_runtime_library='static', linux_abi='legacy',
                     build_tests=True, config=None, target_format=None):
   """ CMake configure.
 
@@ -149,6 +151,7 @@ def cmake_configure(build_dir, arch, msvc_runtime_library='static',
    build_dir (str): Output build directory.
    arch (str): Platform Architecture (example: 'x64').
    msvc_runtime_library (str): Runtime library for MSVC (eg: 'static', 'dynamic').
+   linux_abi (str): Linux ABI (eg: 'legacy', 'c++11').
    build_tests (bool): Build cpp unit tests.
    config (str): Release/Debug config.
           If its not specified, cmake's default is used (most likely Debug).
@@ -192,6 +195,9 @@ def cmake_configure(build_dir, arch, msvc_runtime_library='static',
     if msvc_runtime_library == "static":
       cmd.append('-DMSVC_RUNTIME_LIBRARY_STATIC=ON')
 
+  if utils.is_linux_os() and linux_abi == 'c++11':
+      cmd.append('-DFIREBASE_LINUX_USE_CXX11_ABI=TRUE')
+
   if (target_format):
     cmd.append('-DFIREBASE_XCODE_TARGET_FORMAT={0}'.format(target_format))
 
@@ -219,7 +225,7 @@ def main():
     return
 
   # CMake configure
-  cmake_configure(args.build_dir, args.arch, args.msvc_runtime_library,
+  cmake_configure(args.build_dir, args.arch, args.msvc_runtime_library, args.linux_abi,
                   args.build_tests, args.config, args.target_format)
 
   # Small workaround before build, turn off -Werror=sign-compare for a specific Firestore core lib.
@@ -253,6 +259,8 @@ def parse_cmdline_args():
   parser.add_argument('-a', '--arch', default='x64', help='Platform architecture (x64, x86)')
   parser.add_argument('--msvc_runtime_library', default='static',
                       help='Runtime library for MSVC (static(/MT) or dynamic(/MD)')
+  parser.add_argument('--linux_abi', default='legacy',
+                      help='C++ ABI for Linux (legacy or c++11)')
   parser.add_argument('--build_dir', default='build', help='Output build directory')
   parser.add_argument('--build_tests', action='store_true', help='Build unit tests too')
   parser.add_argument('--vcpkg_step_only', action='store_true', help='Just install cpp packages using vcpkg and exit.')
