Add option to build with dynamic libc and c++, but static other dependencies; change static option name (#4597)

* Add option to build with dynamic libc and c++, but static boost and other dependencies

* Improve options' documentation

* Add CI for static-sans-stdlib

* Merge the static builds using matrix, factor the check to a bash script, run on schedule + optional

* Perform exact match on library names

* Fix checks, pass binary to check on commandline

* Fix label name

* Improve comment

* Fix ci-build

* Simplify setting of static options

* cmake: Rename the "static" options

* CI: Update option names for semi-static

* Remove remaining mentions of the old version of static options

* Rename the static option once more

Author: vlstill

.github/workflows/ci-static-build-test.yml

@@ -1,12 +1,13 @@
 name: "static-build-test-p4c"
 
 on:
+  schedule:
+    # Every day on midnight UTC
+    - cron: "0 0 * * *"
   push:
     branches: [main]
   pull_request:
     branches: [main]
-  merge_group:
-    branches: [main]
 
 # Cancel any preceding run on the pull request.
 concurrency:
@@ -16,11 +17,21 @@ concurrency:
 jobs:
   # Build a p4c release on Ubuntu 20.04.
   build-linux:
+    # Only run on pull requests with the "run-static" label.
+    if: ${{ github.event_name == 'schedule' || contains(github.event.pull_request.labels.*.name, 'run-static') }}
+    # Note: Actions have no real ternary condition operator, but this hack works because non-empty
+    # strings are true.
+    name: "Dynamic ${{ matrix.dynamic.glibc == 'ON' && 'glibc' || 'stdlib' }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        dynamic: [{glibc: ON, stdlib: OFF}, {glibc: OFF, stdlib: ON}]
     runs-on: ubuntu-20.04
     env:
       IMAGE_TYPE: test
       CMAKE_UNITY_BUILD: ON
-      BUILD_STATIC_RELEASE_SANS_GLIBC: ON
+      STATIC_BUILD_WITH_DYNAMIC_GLIBC: "${{ matrix.dynamic.glibc }}"
+      STATIC_BUILD_WITH_DYNAMIC_STDLIB: "${{ matrix.dynamic.stdlib }}"
       ENABLE_TEST_TOOLS: ON
       BUILD_GENERATOR: Ninja
     steps:
@@ -38,21 +49,5 @@ jobs:
         name: Build (Ubuntu 20.04)
         run: |
           sudo -E tools/ci-build.sh
-          # Disabling these checks until we find a better way to build a fully static binary.
-          # ldd ./build/p4c-bm2-psa 2>&1  | grep -E -qi "(not a dynamic executable)|(statically linked)"
-          # ldd ./build/p4c-bm2-ss 2>&1  | grep -E -qi "(not a dynamic executable)|(statically linked)"
-          # ldd ./build/p4c-dpdk 2>&1  | grep -E -qi "(not a dynamic executable)|(statically linked)"
-          # ldd ./build/p4c-ebpf 2>&1  | grep -E -qi "(not a dynamic executable)|(statically linked)"
-          # ldd ./build/p4c-pna-p4tc 2>&1  | grep -E -qi "(not a dynamic executable)|(statically linked)"
-          # ldd ./build/p4c-ubpf 2>&1  | grep -E -qi "(not a dynamic executable)|(statically linked)"
-          # ldd ./build/p4test 2>&1  | grep -E -qi "(not a dynamic executable)|(statically linked)"
-          # ldd ./build/p4testgen 2>&1  | grep -E -qi "(not a dynamic executable)|(statically linked)"
-
-          ! ldd ./build/p4c-bm2-psa 2>&1 | grep -E "libgc|libboost_iostreams"
-          ! ldd ./build/p4c-bm2-ss 2>&1 | grep -E "libgc|libboost_iostreams"
-          ! ldd ./build/p4c-dpdk 2>&1 | grep -E "libgc|libboost_iostreams"
-          ! ldd ./build/p4c-ebpf 2>&1 | grep -E "libgc|libboost_iostreams"
-          ! ldd ./build/p4c-pna-p4tc 2>&1 | grep -E "libgc|libboost_iostreams"
-          ! ldd ./build/p4c-ubpf 2>&1 | grep -E "libgc|libboost_iostreams"
-          ! ldd ./build/p4test 2>&1 | grep -E "libgc|libboost_iostreams"
-          ! ldd ./build/p4testgen 2>&1 | grep -E "libgc|libboost_iostreams"
+          ./tools/ci-check-static.sh ./build/p4c-bm2-ss ./build/p4c-dpdk ./build/p4c-ebpf \
+              ./build/p4c-pna-p4tc ./build/p4c-ubpf ./build/p4test ./build/p4testgen

CMakeLists.txt

@@ -48,10 +48,15 @@ OPTION (ENABLE_GC "Use libgc" ON)
 OPTION (ENABLE_MULTITHREAD "Use multithreading" OFF)
 OPTION (ENABLE_WERROR "Treat warnings as errors" OFF)
 OPTION (ENABLE_SANITIZERS "Enable sanitizers" OFF)
-OPTION (BUILD_STATIC_RELEASE_SANS_GLIBC
-       "Build a (mostly) statically linked release binary. Glibc is linked dynamically." OFF
-)
-if (BUILD_STATIC_RELEASE_SANS_GLIBC)
+OPTION (STATIC_BUILD_WITH_DYNAMIC_GLIBC "Build a (mostly) statically linked release binary. \
+Glibc is linked dynamically. WARNING: This only works if all dependencies that depend on the C++ \
+standard library can be linked statically, otherwise the build will likely be broken and it will \
+likely depend on the standard libary anyway. If you have some non-static C++ dependencies, use \
+STATIC_BUILD_WITH_DYNAMIC_STDLIB." OFF)
+OPTION (STATIC_BUILD_WITH_DYNAMIC_STDLIB "Build a (mostly) statically linked release binary. \
+Glibc and C++ standard library is linked dynamically." OFF)
+
+if (STATIC_BUILD_WITH_DYNAMIC_GLIBC OR STATIC_BUILD_WITH_DYNAMIC_STDLIB)
     # We want to optimize the binary size for a static release binary by default.
     set (_ENABLE_LTO_DEFAULT ON)
 else()
@@ -130,9 +135,15 @@ endif ()
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 # Set the required options for a (mostly) static release build.
-if(BUILD_STATIC_RELEASE_SANS_GLIBC)
+if(STATIC_BUILD_WITH_DYNAMIC_GLIBC OR STATIC_BUILD_WITH_DYNAMIC_STDLIB)
+  if (STATIC_BUILD_WITH_DYNAMIC_GLIBC AND STATIC_BUILD_WITH_DYNAMIC_STDLIB)
+    message(WARNING "Both STATIC_BUILD_WITH_DYNAMIC_GLIBC and STATIC_BUILD_WITH_DYNAMIC_STDLIB "
+      "enabled at once; using 'DYNAMIC_STDLIB' settings (dynamic glibc and c++ standard library).")
+  endif()
   message(STATUS "Building static release binaries")
-  message(WARNING "glibc is linked dynamically in current static builds.")
+  if (NOT STATIC_BUILD_WITH_DYNAMIC_STDLIB)
+    message(WARNING "glibc is linked dynamically in current static builds.")
+  endif()
   set(BUILD_SHARED_LIBS OFF)
   set(CMAKE_FIND_LIBRARY_SUFFIXES .a)
   # Link Boost statically
@@ -146,8 +157,11 @@ if(BUILD_STATIC_RELEASE_SANS_GLIBC)
   # and see whether static linking improves on Linux.
   # Do not bring in dynamic libstdcc and libgcc
   set(CMAKE_EXE_LINKER_FLAGS
-      "${CMAKE_EXE_LINKER_FLAGS} -static-libgcc -static-libstdc++ -Wl,-z,muldefs"
+      "${CMAKE_EXE_LINKER_FLAGS} -static-libgcc -Wl,-z,muldefs"
   )
+  if (NOT STATIC_BUILD_WITH_DYNAMIC_STDLIB)
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static-libstdc++")
+  endif()
   add_definitions(-DP4C_STATIC_BUILD)
 endif()
 

Dockerfile

@@ -18,8 +18,11 @@ ARG CMAKE_UNITY_BUILD=ON
 # Whether to enable translation validation
 ARG VALIDATION=OFF
 # This creates a release build that includes link time optimization and links
-# all libraries statically.
-ARG BUILD_STATIC_RELEASE_SANS_GLIBC=OFF
+# all libraries except for glibc statically.
+ARG STATIC_BUILD_WITH_DYNAMIC_GLIBC=OFF
+# This creates a release build that includes link time optimization and links
+# all libraries except for glibc and libstdc++ statically.
+ARG STATIC_BUILD_WITH_DYNAMIC_STDLIB=OFF
 # No questions asked during package installation.
 ARG DEBIAN_FRONTEND=noninteractive
 # Whether to install dependencies required to run PTF-ebpf tests

tools/ci-build.sh

@@ -22,8 +22,11 @@ P4C_DIR=$(readlink -f ${THIS_DIR}/..)
 # Whether to enable translation validation
 : "${VALIDATION:=OFF}"
 # This creates a release build that includes link time optimization and links
-# all libraries statically.
-: "${BUILD_STATIC_RELEASE_SANS_GLIBC:=OFF}"
+# all libraries except for glibc statically.
+: "${STATIC_BUILD_WITH_DYNAMIC_GLIBC:=OFF}"
+# This creates a release build that includes link time optimization and links
+# all libraries except for glibc and libstdc++ statically.
+: "${STATIC_BUILD_WITH_DYNAMIC_STDLIB:=OFF}"
 # No questions asked during package installation.
 : "${DEBIAN_FRONTEND:=noninteractive}"
 # Whether to install dependencies required to run PTF-ebpf tests
@@ -236,7 +239,8 @@ export CXXFLAGS="${CXXFLAGS} -O3"
 # Toggle unity compilation.
 CMAKE_FLAGS+="-DCMAKE_UNITY_BUILD=${CMAKE_UNITY_BUILD} "
 # Toggle static builds.
-CMAKE_FLAGS+="-DBUILD_STATIC_RELEASE_SANS_GLIBC=${BUILD_STATIC_RELEASE_SANS_GLIBC} "
+CMAKE_FLAGS+="-DSTATIC_BUILD_WITH_DYNAMIC_GLIBC=${STATIC_BUILD_WITH_DYNAMIC_GLIBC} "
+CMAKE_FLAGS+="-DSTATIC_BUILD_WITH_DYNAMIC_STDLIB=${STATIC_BUILD_WITH_DYNAMIC_STDLIB} "
 # Toggle the installation of the tools back end.
 CMAKE_FLAGS+="-DENABLE_TEST_TOOLS=${ENABLE_TEST_TOOLS} "
 # RELEASE should be default, but we want to make sure.

tools/ci-check-static.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+# Script for checking semi-static build results.
+
+# No set -e. Do not exit on error, errors are handled explictly.
+set -x  # Make command execution verbose
+set -u  # Error on unbound variables.
+
+# Usage: check EXPECTED REAL_RET_CODE BINARY MESSAGE
+check() {
+    if [[ $2 = 0 ]]; then
+        expected='true';
+    else
+        expected='false';
+    fi
+    if [[ $1 != $expected ]]; then
+        echo "Binary dynamic dependency check failed for ${3}: ${4}."
+        ldd $3
+        exit 1
+    fi
+}
+
+# Usage: has_lib EXPECTED BINARY LIB_PATTERN
+# Does string match, not regex match.
+has_lib() {
+    ldd $2 2>&1 | grep -F -qi $3
+    check $1 $? $2 "has_lib ${3} expected to be ${1}"
+}
+
+# Usage: is_static EXPECTED BINARY
+is_static() {
+    ldd $2 2>&1 | grep -E -qi "(not a dynamic executable)|(statically linked)"
+    check $1 $? $2 "is_static expected to be ${1}"
+}
+
+# The binaries to check -- arguments except for $0.
+bins=${@:1}
+
+# Run checks on all the binaries produced by the builds.
+for bin in ${bins[@]}; do
+    # Disabling this checks until we find a better way to build a fully static binary.
+    # is_static true $bin
+    is_static false $bin
+    has_lib true $bin "libc"
+    has_lib false $bin "libboost_iostreams"
+    if [[ ${STATIC_BUILD_WITH_DYNAMIC_STDLIB} = "ON" ]]; then
+        has_lib true $bin 'libstdc++'
+    else
+        has_lib false $bin 'libstdc++'
+    fi
+done

tools/debian-build/packaging.conf

@@ -14,7 +14,7 @@ CONFOPT+="-DCMAKE_UNITY_BUILD=ON "
 # RELEASE should be default, but we want to make sure.
 CONFOPT+="-DCMAKE_BUILD_TYPE=RELEASE "
 # The binaries we produce should not depend on system libraries.
-CONFOPT+="-DBUILD_STATIC_RELEASE_SANS_GLIBC=ON "
+CONFOPT+="-DSTATIC_BUILD_WITH_DYNAMIC_GLIBC=ON "
 MAKE_DIST="cd ${P4C_DIR}/backends/ebpf && ./build_libbpf && mkdir -p ${P4C_DIR}/build && cd ${P4C_DIR}/build && cmake .. $CONFOPT && make && make dist"
 # Distributions which are *not* supported!
 NOT_TARGET_DISTRIBUTIONS="lucid precise trusty xenial bionic"