Use ccache with Github actions (#3073)

* Add ccache action.

* Review comments.

.dockerignore

@@ -4,4 +4,5 @@
 **/Dockerfile
 **/*.md
 
+build
 docs

.github/workflows/ci-ptf.yml

@@ -37,10 +37,16 @@ jobs:
         with:
           submodules: recursive
 
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1
+        with:
+          key: test-${{ env.UNIFIED }}-${{ runner.os }}
+          max-size: 1000M
+
       - name: Build (Linux)
         run: |
-          tools/start_ccache
           docker build --network host -t p4c --build-arg MAKEFLAGS=-j8 --build-arg IMAGE_TYPE=test --build-arg ENABLE_UNIFIED_COMPILATION=$UNIFIED --build-arg ENABLE_GMP=$ENABLE_GMP --build-arg INSTALL_PTF_EBPF_DEPENDENCIES=ON .
+          ./tools/export_ccache.sh
 
       - name: Run PTF tests for eBPF backend (Linux)
         run: |

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

@@ -7,6 +7,7 @@ on:
     branches: [ main ]
 
 
+# Cancel any preceding run on the pull request.
 concurrency:
   group: static-build-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
@@ -23,7 +24,14 @@ jobs:
     - uses: actions/checkout@v2
       with:
         submodules: recursive
+
+    - name: ccache
+      uses: hendrikmuhs/ccache-action@v1
+      with:
+        key: static-${{ runner.os }}
+        max-size: 1000M
+
     - name: Build (Linux)
       run: |
-        tools/start_ccache
-        docker build --network ccache_network -t p4c --build-arg IMAGE_TYPE=build --build-arg ENABLE_UNIFIED_COMPILATION=ON --build-arg BUILD_STATIC_RELEASE=ON --build-arg ENABLE_GMP=ON .
+        docker build -t p4c --build-arg IMAGE_TYPE=test --build-arg ENABLE_UNIFIED_COMPILATION=ON --build-arg BUILD_STATIC_RELEASE=ON --build-arg ENABLE_GMP=ON  .
+        ./tools/export_ccache.sh

.github/workflows/ci-test.yml

@@ -30,13 +30,19 @@ jobs:
       with:
         submodules: recursive
 
+    - name: ccache
+      uses: hendrikmuhs/ccache-action@v1
+      with:
+        key: test-${{ matrix.unified }}-${{ runner.os }}
+        max-size: 1000M
+
     - name: Build (Ubuntu Linux)
       run: |
-        tools/start_ccache
         # To flush out issues with unified vs. non-unified builds,
         # do a non-unified build before continuing with the rest,
         # which produces a unified build.
-        docker build --network ccache_network -t p4c --build-arg IMAGE_TYPE=test --build-arg ENABLE_UNIFIED_COMPILATION=${{matrix.unified}} --build-arg ENABLE_GMP=${{ matrix.enable_gmp }} .
+        docker build -t p4c --build-arg IMAGE_TYPE=test --build-arg ENABLE_UNIFIED_COMPILATION=${{ matrix.unified }} --build-arg ENABLE_GMP=${{ matrix.enable_gmp }} .
+        ./tools/export_ccache.sh
 
       # run with sudo (...) --privileged
       # this is needed to create network namespaces for the ebpf tests.
@@ -73,11 +79,18 @@ jobs:
     - name: Install dependencies (Fedora Linux)
       run: tools/install_fedora_deps.sh
 
+    - name: ccache
+      uses: hendrikmuhs/ccache-action@v1
+      with:
+        key: fedora-test-${{ runner.os }}
+        max-size: 1000M
+
     - name: Build p4c (Fedora Linux)
       run: |
-        ./bootstrap.sh -DCMAKE_BUILD_TYPE=RELEASE -DENABLE_UNIFIED_COMPILATION=${{matrix.unified}} -DENABLE_GMP=${{ matrix.enable_gmp }}
+        ./bootstrap.sh -DCMAKE_BUILD_TYPE=RELEASE -DENABLE_UNIFIED_COMPILATION=${{ matrix.unified }} -DENABLE_GMP=${{ matrix.enable_gmp }}
         make -j2 -C build
 
+
     - name: Run p4c tests (Fedora Linux)
       run: ctest --output-on-failure --schedule-random
       working-directory: ./build
@@ -101,6 +114,12 @@ jobs:
       with:
         submodules: recursive
 
+    - name: ccache
+      uses: hendrikmuhs/ccache-action@v1
+      with:
+        key: test-${{ runner.os }}
+        max-size: 1000M
+
     - name: Install dependencies (MacOS)
       run: |
            tools/install_mac_deps.sh
@@ -113,7 +132,7 @@ jobs:
           # which produces a unified build.
           # On MacOS we have noticed problems with the C++
           # garbage-collector, so we disable it
-          ./bootstrap.sh -DENABLE_GC=OFF -DCMAKE_BUILD_TYPE=RELEASE -DENABLE_UNIFIED_COMPILATION=${{matrix.unified}} -DENABLE_GMP=${{ matrix.enable_gmp }} && cd build && make -j2
+          ./bootstrap.sh -DENABLE_GC=OFF -DCMAKE_BUILD_TYPE=RELEASE -DENABLE_UNIFIED_COMPILATION=${{ matrix.unified }} -DENABLE_GMP=${{ matrix.enable_gmp }} && cd build && make -j2
 
     - name: Run tests (MacOS)
       run: |

.github/workflows/ci-validation.yml

@@ -27,10 +27,16 @@ jobs:
       with:
         submodules: recursive
 
+    - name: ccache
+      uses: hendrikmuhs/ccache-action@v1
+      with:
+        key: validation-${{ runner.os }}
+        max-size: 1000M
+
     - name: Build (Linux)
       run: |
-        tools/start_ccache
-        docker build --network ccache_network -t p4c --build-arg IMAGE_TYPE=test --build-arg ENABLE_UNIFIED_COMPILATION=$UNIFIED --build-arg ENABLE_GMP=$ENABLE_GMP --build-arg VALIDATION=ON . || echo "BUILD_SUCCESS=false" >> $GITHUB_ENV
+        docker build -t p4c --build-arg IMAGE_TYPE=test --build-arg ENABLE_UNIFIED_COMPILATION=$UNIFIED --build-arg ENABLE_GMP=$ENABLE_GMP --build-arg VALIDATION=ON . || echo "BUILD_SUCCESS=false" >> $GITHUB_ENV
+        ./tools/export_ccache.sh
 
     - name: Validate
       if: env.BUILD_SUCCESS == 'true'

Dockerfile

@@ -18,12 +18,15 @@ ARG VALIDATION=OFF
 # This creates a release build that includes link time optimization and links
 # all libraries statically.
 ARG BUILD_STATIC_RELEASE=OFF
+# Toggle usage of the GNU Multiple Precision Arithmetic Library.
+ARG ENABLE_GMP=ON
 # No questions asked during package installation.
 ARG DEBIAN_FRONTEND=noninteractive
 # Whether to install dependencies required to run PTF-ebpf tests
 ARG INSTALL_PTF_EBPF_DEPENDENCIES=OFF
 
 # Delegate the build to tools/ci-build.
 COPY . /p4c/
+RUN chmod u+x /p4c/tools/ci-build.sh && /p4c/tools/ci-build.sh
+# Set the workdir after building p4c.
 WORKDIR /p4c/
-RUN chmod u+x tools/ci-build.sh && tools/ci-build.sh

tools/ci-build.sh

@@ -46,15 +46,18 @@ export P4C_PIP_PACKAGES="ipaddr \
                           ply==3.8 \
                           scapy==2.4.5"
 
-
-
 apt-get update
 apt-get install -y --no-install-recommends \
   ${P4C_DEPS} \
   ${P4C_EBPF_DEPS} \
   ${P4C_RUNTIME_DEPS} \
   git
 
+# TODO: Remove this rm -rf line once the ccache memcache config is removed.
+rm -rf /usr/local/etc/ccache.conf
+/usr/local/bin/ccache --set-config cache_dir=/p4c/.ccache
+/usr/local/bin/ccache --set-config max_size=1G
+
 # we want to use Python as the default so change the symlinks
 ln -sf /usr/bin/python3 /usr/bin/python
 ln -sf /usr/bin/pip3 /usr/bin/pip
@@ -65,7 +68,7 @@ pip3 install $P4C_PIP_PACKAGES
 # Build libbpf for eBPF tests.
 cd /p4c
 backends/ebpf/build_libbpf
-cd -
+cd /p4c
 
 function install_ptf_ebpf_test_deps() (
   export P4C_PTF_PACKAGES="gcc-multilib \

tools/export_ccache.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+docker cp $(docker create --rm p4c):/p4c/.ccache .

tools/install_fedora_deps.sh

@@ -13,6 +13,7 @@ sudo dnf install -y -q \
     boost-system \
     boost-test \
     boost-thread \
+    ccache \
     clang \
     cmake \
     cpp \
@@ -69,7 +70,7 @@ pushd "${tmp_dir}"
 git clone --depth=1 https://github.com/p4lang/behavioral-model
 cd behavioral-model
 ./autogen.sh
-./configure --with-pdfixed --with-thrift --with-pi --with-stress-tests --enable-debugger
+./configure --with-pdfixed --with-thrift --with-pi --with-stress-tests --enable-debugger CC="ccache gcc" CXX="ccache g++"
 make
 make install-strip
 popd

tools/install_mac_deps.sh

@@ -7,19 +7,10 @@ if [[ ! -x $BREW ]]; then
 fi
 
 $BREW update
-$BREW install autoconf automake bdw-gc bison boost ccache cmake git \
+$BREW install autoconf automake bdw-gc bison boost ccache cmake \
       libtool openssl pkg-config python
-$BREW install gmp --c++11
-
-# Install specific version of Protobuf, since newer versions break compatibility
-wget https://github.com/protocolbuffers/protobuf/releases/download/v3.6.1/protobuf-all-3.6.1.tar.gz
-tar xfz protobuf-all-3.6.1.tar.gz
-cd protobuf-3.6.1
-./configure
-make
-sudo make install
-cd ..
-rm -rf protobuf-3.6.1
+$BREW install protobuf
+$BREW install gmp
 
 # Prefer Homebrew's bison over the macOS-provided version
 $BREW link --force bison