[libc] add multi-platform pre-commit github actions #119104

SchrodingerZhu · 2024-12-08T01:20:58Z

~~This is a proof-of-concept for now.~~

We do not have CI coverage for Windows/MacOS and we regularly run into problem where changes break post-commit fullbuild which is not tested in pre-commit builds. This PR utilizes the github action to address such issues.

llvmbot · 2024-12-08T01:21:39Z

@llvm/pr-subscribers-github-workflow

Author: Schrodinger ZHU Yifan (SchrodingerZhu)

Changes

Full diff: https://github.com/llvm/llvm-project/pull/119104.diff

3 Files Affected:

(added) .github/workflows/libc-fullbuild-tests.yml ()
(added) .github/workflows/libc-gpu-build.yml ()
(added) .github/workflows/libc-overlay-tests.yml (+66)

diff --git a/.github/workflows/libc-fullbuild-tests.yml b/.github/workflows/libc-fullbuild-tests.yml
new file mode 100644
index 00000000000000..e69de29bb2d1d6
diff --git a/.github/workflows/libc-gpu-build.yml b/.github/workflows/libc-gpu-build.yml
new file mode 100644
index 00000000000000..e69de29bb2d1d6
diff --git a/.github/workflows/libc-overlay-tests.yml b/.github/workflows/libc-overlay-tests.yml
new file mode 100644
index 00000000000000..63732a37277886
--- /dev/null
+++ b/.github/workflows/libc-overlay-tests.yml
@@ -0,0 +1,66 @@
+# This workflow is for pre-commit testing of the LLVM-libc project.
+name: LLVM-libc Pre-commit Overlay Tests
+
+on:
+  pull_request:
+    branches: [ "main" ]
+    paths:
+      - 'libc/**'
+      - '.github/workflows/libc-overlay-tests.yml'
+
+jobs:
+  build:
+    env:
+      SCCACHE_GHA_ENABLED: "true"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations.
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        build_type: [Release, Debug]
+        compiler: [
+          { c_compiler: gcc, cpp_compiler: g++ },
+          { c_compiler: clang, cpp_compiler: clang++ },
+          { c_compiler: clang-cl, cpp_compiler: clang-cl }
+        ]
+        exclude:
+          - os: windows-latest
+            compiler: { c_compiler: gcc, cpp_compiler: g++ }
+          - os: ubuntu-latest
+            compiler: { c_compiler: clang-cl, cpp_compiler: clang-cl }
+          - os: macos-latest
+            compiler: { c_compiler: clang-cl, cpp_compiler: clang-cl }
+          - os: macos-latest
+            compiler: { c_compiler: gcc, cpp_compiler: g++ }
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Run sccache-cache
+      uses: mozilla-actions/sccache-action@v0.0.6
+
+    - name: Set reusable strings
+      id: strings
+      shell: bash
+      run: |
+        echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT"
+
+    - name: Configure CMake
+      run: >
+        cmake -B ${{ steps.strings.outputs.build-output-dir }}
+        -DCMAKE_CXX_COMPILER=${{ matrix.compiler.cpp_compiler }}
+        -DCMAKE_C_COMPILER=${{ matrix.compiler.c_compiler }}
+        -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+        -DCMAKE_C_COMPILER_LAUNCHER=sccache
+        -DCMAKE_CXX_COMPILER_LAUNCHER=sccache
+        -DLLVM_ENABLE_RUNTIMES=libc
+        -G Ninja
+        -S ${{ github.workspace }}/runtimes
+
+    - name: Build
+      run: cmake --build ${{ steps.strings.outputs.build-output-dir }}
+
+    - name: Test
+      working-directory: ${{ steps.strings.outputs.build-output-dir }}
+      run: ninja check-libc

.github/workflows/libc-fullbuild-tests.yml

.github/workflows/libc-overlay-tests.yml

SchrodingerZhu · 2024-12-08T04:16:32Z

Update branch to check caching.

SchrodingerZhu · 2024-12-08T04:38:12Z

I can see that the cache writing run into errors but I don't know why. Perhaps github forbids some writes when update the cache too frequently. For the time being, I guess this is already the best caching effort I can do with sccache.

tstellar · 2024-12-08T05:32:28Z

I can see that the cache writing run into errors but I don't know why. Perhaps github forbids some writes when update the cache too frequently. For the time being, I guess this is already the best caching effort I can do with sccache.

I'm not sure what kind of errors you are seeing but for the other jobs we've been using a different action for managing the sccache and it's working pretty well: https://github.com/llvm/llvm-project/blob/main/.github/workflows/llvm-project-tests.yml#L93

SchrodingerZhu · 2024-12-08T05:54:41Z

I'm not sure what kind of errors you are seeing

Post job cleanup.
Get human-readable stats
Get JSON stats
Notice: 0% - 0 hits, 5527 misses, 0 errors
Full human-readable stats:
Compile requests                   5527
Compile requests executed          5527
Cache hits                            0
Cache misses                       5527
Cache misses (C/C++)               5527
Cache hits rate                    0.00 %
Cache hits rate (C/C++)            0.00 %
Cache timeouts                        0
Cache read errors                     0
Forced recaches                       0
Cache write errors                 5527
Compilation failures                  0
Cache errors                          0
Non-cacheable compilations            0
Non-cacheable calls                   0
Non-compilation calls                 0
Unsupported compiler calls            0
Average cache write               0.000 s
Average compiler                  0.942 s
Average cache read hit            0.000 s
Failed distributed compilations       0
Cache location                  ghac, name: sccache-v0.8.2, prefix: /sccache/
Version (client)                0.8.2

There is a Cache write errors 5527 in statistics.

I will try the other action later on.

boomanaiden154

The windows testing should probably go into the traditional premerge pipeline where we have decently powerful machines available.

SchrodingerZhu · 2024-12-08T13:52:53Z

The windows/macos testing are all light weight, even without caching, it finishes within 10 mins. The Linux one is a bit more problematic, as there are 9000+ testing units. But all of these finishes in 20mins.

SchrodingerZhu · 2024-12-08T17:42:35Z

GHAC does not like to handle too many requests. I think this makes the mozilla/sccache ghac storage approach actually not a good fit for its purpose. Switching to the ccache action with sccache variant.

nickdesaulniers

Cool! Mostly just some simple questions about the PR.

nickdesaulniers · 2024-12-09T18:36:07Z

.github/workflows/libc-fullbuild-tests.yml

+          # TODO: add back gcc build when it is fixed
+          # - c_compiler: gcc
+          #   cpp_compiler: g++


Do you have more context about what's going wrong with the gcc builds?

Please see https://github.com/llvm/llvm-project/actions/runs/12217700280/job/34082285018?pr=119104 and https://github.com/llvm/llvm-project/actions/runs/12218362957/job/34083763790?pr=119104

First one is for overlay and latter one for fullbuild.

nickdesaulniers · 2024-12-09T18:36:24Z

.github/workflows/libc-fullbuild-tests.yml

+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libmpfr-dev libgmp-dev libmpc-dev ninja-build linux-headers-generic linux-libc-dev
+        sudo ln -sf /usr/include/$(uname -p)-linux-gnu/asm /usr/include/asm


Why do we need the symlink?

Debian and its variants has a multilib sysroot, so arch-dependent headers are not installed into /usr/include/.

Ideally, libc should also add /usr/include/$(uname -p)-linux-gnu/ in its include directories but we do not do that.

nickdesaulniers · 2024-12-09T18:36:43Z

.github/workflows/libc-fullbuild-tests.yml

+        cmake -B ${{ steps.strings.outputs.build-output-dir }}
+        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
+        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
+        -DCMAKE_BUILD_TYPE=MinSizeRel


Why MinSizeRel (vs. Release)?

GHA has limited cache capability (10G in total). And we need to share it with other projects such as libcxx. Therefore, I decide to optimize for sizes.

nickdesaulniers · 2024-12-09T18:38:26Z

.github/workflows/libc-overlay-tests.yml

+    - name: Prepare dependencies (Windows)
+      if: runner.os == 'Windows'
+      run: |
+        choco install ninja


What is choco?

https://github.com/chocolatey/choco

does that itself have to be installed, or does it ship on the github buildbots? I guess same question for brew on OSX; usually those don't come pre-installed IIRC.

It is shipped in image per github spec. Please see https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md

nickdesaulniers · 2024-12-09T18:39:41Z

.github/workflows/libc-overlay-tests.yml

+        -DCMAKE_C_COMPILER_LAUNCHER=sccache
+        -DCMAKE_CXX_COMPILER_LAUNCHER=sccache
+        -DCMAKE_POLICY_DEFAULT_CMP0141=NEW
+        -DCMAKE_MSVC_DEBUG_INFORMATION_FORMAT=Embedded


Is this necessary for MinSizeRel or Release?

This is following the instructions from https://github.com/mozilla/sccache/tree/main?tab=readme-ov-file#usage

nickdesaulniers · 2024-12-09T18:40:01Z

.github/workflows/libc-overlay-tests.yml

+        -DCMAKE_BUILD_TYPE=MinSizeRel
+        -DCMAKE_C_COMPILER_LAUNCHER=sccache
+        -DCMAKE_CXX_COMPILER_LAUNCHER=sccache
+        -DCMAKE_POLICY_DEFAULT_CMP0141=NEW


Do we need to set 141? Surely we can omit that?

Same as above, following the instructions from https://github.com/mozilla/sccache/tree/main?tab=readme-ov-file#usage

tstellar · 2024-12-10T03:01:45Z

.github/workflows/libc-fullbuild-tests.yml

@@ -0,0 +1,76 @@
+# This workflow is for pre-commit testing of the LLVM-libc project.
+name: LLVM-libc Pre-commit Fullbuild Tests
+


Can you add:

permissions: contents: read

To each new file you've added. This is standard best practices for GitHub actions definitions.

In the same level of name? Sure. Adding now

We do not have CI coverage for Windows/MacOS and we regularly run into problem where changes break post-commit fullbuild which is not tested in pre-commit builds. This PR utilizes the github action to address such issues.

[libc] add multi-platform pre-commit github actions

e6e227a

llvmbot added the github:workflow label Dec 8, 2024

SchrodingerZhu added 8 commits December 7, 2024 20:22

[libc] add multi-platform pre-commit github actions

49ca7bc

[libc] add multi-platform pre-commit github actions

a16c16e

[libc] add multi-platform pre-commit github actions

feb3428

[libc] add multi-platform pre-commit github actions

d1af585

prepare to fix windows build

0cf345f

add ubuntu preparation step

008ffef

setup ninja

1263dbc

remove build type

a7738ed

tstellar reviewed Dec 8, 2024

View reviewed changes

.github/workflows/libc-fullbuild-tests.yml Outdated Show resolved Hide resolved

.github/workflows/libc-overlay-tests.yml Outdated Show resolved Hide resolved

.github/workflows/libc-overlay-tests.yml Outdated Show resolved Hide resolved

SchrodingerZhu added 3 commits December 7, 2024 20:54

fix winget installation

8f3c0ee

fix winget installation

df70886

more fixes

08d00cc

tstellar reviewed Dec 8, 2024

View reviewed changes

.github/workflows/libc-overlay-tests.yml Outdated Show resolved Hide resolved

SchrodingerZhu added 11 commits December 7, 2024 21:34

more fixes

fcb2500

more fixes

0be378f

enable fullbuild

779c806

fix

009b76c

fix

6776e8d

fix

a9eba5e

fix

8482b9d

skip gcc and speed up clang testing

5c8fba1

use windows-2022 instead of windows-latest

39e83dc

improve windows sccache hit

6f3b9eb

try use ninja on all platforms

0b4323b

Merge branch 'main' into libc/github-action

7cee92f

SchrodingerZhu requested review from lntue, jhuber6, michaelrj-google and nickdesaulniers December 8, 2024 04:39

boomanaiden154 reviewed Dec 8, 2024

View reviewed changes

SchrodingerZhu added 4 commits December 8, 2024 12:14

switch caching

19c4456

switch caching (fix syntax)

1b0d03b

switch caching (changing key)

2356ffd

switch caching (fix)

2e014bd

SchrodingerZhu and others added 2 commits December 8, 2024 13:05

Merge branch 'main' into libc/github-action

e2f1982

lift uncompressed local storage size to 1G

ad8b7d8

nickdesaulniers reviewed Dec 9, 2024

View reviewed changes

SchrodingerZhu requested a review from nickdesaulniers December 9, 2024 20:09

SchrodingerZhu mentioned this pull request Dec 9, 2024

[libc] gcc build failures on github action runners #119266

Closed

nickdesaulniers approved these changes Dec 9, 2024

View reviewed changes

SchrodingerZhu merged commit f15cc6f into llvm:main Dec 9, 2024
10 checks passed

SchrodingerZhu deleted the libc/github-action branch December 9, 2024 21:04

tstellar reviewed Dec 10, 2024

View reviewed changes

nickdesaulniers mentioned this pull request Dec 10, 2024

[libc] fix up strings.h entrypoints #119417

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[libc] add multi-platform pre-commit github actions #119104

[libc] add multi-platform pre-commit github actions #119104

SchrodingerZhu commented Dec 8, 2024 •

edited

Loading

llvmbot commented Dec 8, 2024

SchrodingerZhu commented Dec 8, 2024

SchrodingerZhu commented Dec 8, 2024

tstellar commented Dec 8, 2024

SchrodingerZhu commented Dec 8, 2024 •

edited

Loading

boomanaiden154 left a comment

SchrodingerZhu commented Dec 8, 2024

SchrodingerZhu commented Dec 8, 2024

nickdesaulniers left a comment

nickdesaulniers Dec 9, 2024

SchrodingerZhu Dec 9, 2024 •

edited

Loading

nickdesaulniers Dec 9, 2024

SchrodingerZhu Dec 9, 2024

nickdesaulniers Dec 9, 2024

SchrodingerZhu Dec 9, 2024 •

edited

Loading

nickdesaulniers Dec 9, 2024

SchrodingerZhu Dec 9, 2024

nickdesaulniers Dec 9, 2024

SchrodingerZhu Dec 9, 2024

nickdesaulniers Dec 9, 2024

SchrodingerZhu Dec 9, 2024

tstellar Dec 10, 2024

SchrodingerZhu Dec 10, 2024

		@@ -0,0 +1,76 @@
		# This workflow is for pre-commit testing of the LLVM-libc project.
		name: LLVM-libc Pre-commit Fullbuild Tests

[libc] add multi-platform pre-commit github actions #119104

[libc] add multi-platform pre-commit github actions #119104

Conversation

SchrodingerZhu commented Dec 8, 2024 • edited Loading

llvmbot commented Dec 8, 2024

SchrodingerZhu commented Dec 8, 2024

SchrodingerZhu commented Dec 8, 2024

tstellar commented Dec 8, 2024

SchrodingerZhu commented Dec 8, 2024 • edited Loading

boomanaiden154 left a comment

Choose a reason for hiding this comment

SchrodingerZhu commented Dec 8, 2024

SchrodingerZhu commented Dec 8, 2024

nickdesaulniers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SchrodingerZhu Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SchrodingerZhu Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SchrodingerZhu commented Dec 8, 2024 •

edited

Loading

SchrodingerZhu commented Dec 8, 2024 •

edited

Loading

SchrodingerZhu Dec 9, 2024 •

edited

Loading

SchrodingerZhu Dec 9, 2024 •

edited

Loading