[Github Action] 너 cache 된거야! - ccache 를 이용한 c/c++ 빌드

 

 

C/C++ 기반의 프로젝트를 빌드하는데 있어 보통 cmake 와 make 를 이용해서 빌드를 하게 됩니다.

 

간략하게 cmake 는 CMakeList.txt 를 기반으로 Makefile 를 만들어주고, make 는 Makefile 를 통해 프로젝트를 빌드합니다.

 

cmake 는 빌드를 위한 프로세스이고, make 는 실제로 빌드를 해주는 프로세스인 셈이죠.

 

그런데 C/C++ 프로젝트를 빌드하는데, 빌드 시간이 대략 1시간 정도 소모됩니다. 너무 오래걸려요..

C/C++ 빌드 55분 소요

 

진행한 runner 는 2GB Memory 의 인스턴스입니다.

 

빌드 시간을 단축시키고 싶습니다. 빌드 시간을 단축시키기 위한 방법으로 가장 먼저 떠오르는 것은 바로 캐싱 입니다.

매번 같이 파일을 빌드하지 말고, 반복되는 빌드 파일을 캐싱해놓으면 시간이 많이 단축될 것입니다.

 

다행히 C/C++ 프로젝트의 빌드 캐싱 관련한 패키지가 존재합니다. 바로 ccache 죠.

 

ccache 는 apt, yum 과 같은 패키지 매니저로 쉽게 설치가 가능하며, 기본적으로 ~/.ccache 경로를 캐시 디렉터리로 사용합니다.

그래서 ccache 와 action/cache 를 사용하면 효율적으로 캐싱할 수 있을 것 같습니다.

action/cache 에 대해 궁금하다면 여기 참고!

 

그럼 렛츠두더코드~

 

우선 action/cache 입니다.

 

/home/runner/.ccache 를 캐시 디렉터리로 사용하기 때문에 action/cache 의 path 는 /home/runner/.ccache 로 작성합니다.

key 는 하고싶은 것으로 하면 됩니다.

jobs:
  linux-x64:
    runs-on: [ al2_x86_64 ]
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Cache
        id: cache
        uses: actions/cache@v3
        with:
          path: |
            /home/runner/.ccache
          key: ${{ runner.os }}-build-ccache
          restore-keys: |
            ccache
            ${{ runner.os }}-build-ccache

 

action/cache 부분을 이게 끝입니다.

 

이번엔 cmake, make 부분을 작성합니다.

 

build.sh 를 실행시켜 줄 것이고, 그 안에 실제 build 명령어를 작성합니다.

jobs:
  linux-x64:
    runs-on: [ al2_x86_64 ]
    steps:

		...

      - name: Build
        run: |
          bash build.sh

 

 

build.sh 입니다.

ccache 를 패키지 관리자로 설치해주면 /usr/lib/ccache 에 설치됩니다. (ubuntu 20 기준)

cmake 와 make 를 진행할 때 컴파일러를 ccache gcc 와 ccache g++ 로 사용할 것이기 때문에 명령어 인자로 아래와 같이 넘겨줍니다.

#!/bin/bash

set -eu

# ubuntu 20 기준 ccache 경로
declare -r C_COMPILER="/usr/lib/ccache/gcc"
declare -r CXX_COMPILER="/usr/lib/ccache/g++"

# ccache 컴파일러로 인자로 넘겨줌
cmake ./ -DCMAKE_C_COMPILER="${C_COMPILER}" -DCMAKE_CXX_COMPILER="${CXX_COMPILER}"
make -e CC="${C_COMPILER}" CXX="${CXX_COMPILER}"

 

좋습니다. 모든 준비는 끝난 거 같아요!

 

그럼 캐싱이 제대로 됐는 지 확인해보죠!

 

action/cache 는 성공적입니다.

action/cache

 

그럼 ccache 부분도 확인해보죠.

아래 이미지는 ccache -s 라는 명령어를 실행했을 때의 결과이며, 이를 통해 실제로 캐싱이 되었는 지 확인할 수 있습니다.

cache hit 가 올라갔다면 성공적으로 캐싱이 된 겁니다.

ccache

최초로 ccache 를 사용하면 cache hit 가 아닌 cache miss 만 계속 올라갈 것입니다.

이유는 최초에는 캐시된 파일이 없기 때문에 캐시 파일을 찾을 수 없어 cache miss 가 올라가는 것이죠.

그래서 최초의 빌드를 실행한 후 그 이후에는 cache miss 가 아닌 cache hit 이 올라갈 것입니다.

 

action 소요 시간으로도 비교해봅시다.

캐싱 전 - C/C++ 빌드 55분 소요

 

캐싱 후 - C/C++ 빌드 9분 소요

 

오~ 55분에서 9분으로 많이 단축됐어요!

 

그럼 자세하게 알기 위해 액션 단위가 아닌 실제 빌드만 수행하는 스텝 단위로 확인해보죠!

캐싱 전 - C/C++ 빌드 52분 소요

 

캐싱 후 - C/C++ 빌드 6분 소요

 

액션 단위에선 추가적인 스텝 부분들을 수행하는 시간이 있어서 순수 C/C++ 빌드가 일어나는 스텝 단위로 비교해봤는데,

 

무려 8배정도 단축시켰습니다!!

 

이번 시간에는 action/cache 와 ccache 를 이용해서 C/C++ 프로젝트의 빌드 시간을 대폭 단축시켜보았습니다.

 

그러면 오늘은 여기까지~