Merge pull request #617 from pq-code-package/c99_c11_build

CI: Generalize compiler test to exercise various C standards
pq-code-package · Jan 6, 2025 · 8868f4e · 8868f4e · oqs-bot · Jan 6, 2025
2 parents b99d14a + 472f946
commit 8868f4e
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 37 deletions.
diff --git a/.github/actions/functest/action.yml b/.github/actions/functest/action.yml
@@ -88,6 +88,7 @@ runs:
       - name: ${{ env.MODE }} ${{ inputs.opt }} tests (${{ env.FUNC }}, ${{ env.KAT }}, ${{ env.NISTKAT }})
         shell: ${{ env.SHELL }}
         run: |
+          make clean
           ./scripts/tests all --exec-wrapper="${{ inputs.exec_wrapper }}" --cross-prefix="${{ inputs.cross_prefix }}" --cflags="${{ inputs.cflags }}" --opt=${{ inputs.opt }} --${{ env.FUNC }} --${{ env.KAT }} --${{ env.NISTKAT }} --${{ env.ACVP }} -v
       - name: Check namespacing ${{ env.MODE }} ${{ inputs.opt }} tests (${{ env.FUNC }}, ${{ env.KAT }}, ${{ env.NISTKAT }})
         shell: ${{ env.SHELL }}

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -243,31 +243,48 @@ jobs:
           compile_mode: native
           cflags: "-DMLKEM_DEBUG -fsanitize=address -fsanitize=undefined -fno-sanitize-recover=all"
   compiler_tests:
-    name: Compiler tests (${{ matrix.target.name }})
+    name: Compiler tests  (${{ matrix.compiler.name }}, ${{ matrix.target.name }})
     needs: [quickcheck, quickcheck-windows, quickcheck-c90, quickcheck-lib, examples, lint, lint-markdown-link]
     strategy:
       fail-fast: false
       matrix:
-        external:
-         - ${{ github.repository_owner != 'pq-code-package' }}
         target:
          - runner: pqcp-arm64
            name: 'aarch64'
          - runner: ubuntu-latest
            name: 'x86_64'
          - runner: macos-latest
            name: 'macos'
-        exclude:
-          - {external: true,
-             target: {
-               runner: pqcp-arm64,
-               name: 'aarch64'
-             }}
+        compiler:
+         - name: gcc-4.8
+           shell: ci_gcc48
+           darwin: False
+           c17: False
+         - name: gcc-4.9
+           shell: ci_gcc49
+           darwin: False
+           c17: False
+         - name: gcc-7
+           shell: ci_gcc7
+           darwin: False
+           c17: False
+         - name: gcc-11
+           shell: ci_gcc11
+           darwin: True
+         - name: gcc-13
+           shell: ci
+           darwin: True
+         - name: gcc-14
+           shell: ci_gcc14
+           darwin: True
+         - name: clang-18
+           shell: ci_clang18
+           darwin: True
     runs-on: ${{ matrix.target.runner }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - name: native build+functest (gcc-4.8)
-        if: ${{ matrix.target.runner != 'macos-latest' }}
+      - name: native build+functest (default)
+        if: ${{ matrix.compiler.darwin || matrix.target.runner != 'macos-latest' }}
         uses: ./.github/actions/multi-functest
         with:
           gh_token: ${{ secrets.GITHUB_TOKEN }}
@@ -276,10 +293,10 @@ jobs:
           nistkat: false
           kat: false
           acvp: false
-          nix-shell: "ci_gcc48"
+          nix-shell: ${{ matrix.compiler.shell }}
           cflags: "-O1" # _FORTIFY_SOURCE requires compiling with optimization
-      - name: native build+functest (gcc-4.9)
-        if: ${{ matrix.target.runner != 'macos-latest' }}
+      - name: native build+functest (C90)
+        if: ${{ matrix.compiler.darwin || matrix.target.runner != 'macos-latest' }}
         uses: ./.github/actions/multi-functest
         with:
           gh_token: ${{ secrets.GITHUB_TOKEN }}
@@ -288,10 +305,10 @@ jobs:
           nistkat: false
           kat: false
           acvp: false
-          nix-shell: "ci_gcc49"
-          cflags: "-O1" # _FORTIFY_SOURCE requires compiling with optimization
-      - name: native build+functest (gcc-7)
-        if: ${{ matrix.target.runner != 'macos-latest' }}
+          nix-shell: ${{ matrix.compiler.shell }}
+          cflags: "-O1 -std=c90" # _FORTIFY_SOURCE requires compiling with optimization
+      - name: native build+functest (C99)
+        if: ${{ matrix.compiler.darwin || matrix.target.runner != 'macos-latest' }}
         uses: ./.github/actions/multi-functest
         with:
           gh_token: ${{ secrets.GITHUB_TOKEN }}
@@ -300,9 +317,10 @@ jobs:
           nistkat: false
           kat: false
           acvp: false
-          nix-shell: "ci_gcc7"
-          cflags: "-O1" # _FORTIFY_SOURCE requires compiling with optimization
-      - name: native build+functest (gcc-11)
+          nix-shell: ${{ matrix.compiler.shell }}
+          cflags: "-O1 -std=c99" # _FORTIFY_SOURCE requires compiling with optimization
+      - name: native build+functest (C11)
+        if: ${{ matrix.compiler.darwin || matrix.target.runner != 'macos-latest' }}
         uses: ./.github/actions/multi-functest
         with:
           gh_token: ${{ secrets.GITHUB_TOKEN }}
@@ -311,9 +329,11 @@ jobs:
           nistkat: false
           kat: false
           acvp: false
-          nix-shell: "ci_gcc11"
-          cflags: "-O1" # _FORTIFY_SOURCE requires compiling with optimization
-      - name: native build+functest (gcc-14)
+          nix-shell: ${{ matrix.compiler.shell }}
+          cflags: "-O1 -std=c11" # _FORTIFY_SOURCE requires compiling with optimization
+      - name: native build+functest (C17)
+        if: ${{ (matrix.compiler.darwin || matrix.target.runner != 'macos-latest') &&
+                matrix.compiler.c17 }}
         uses: ./.github/actions/multi-functest
         with:
           gh_token: ${{ secrets.GITHUB_TOKEN }}
@@ -322,19 +342,8 @@ jobs:
           nistkat: false
           kat: false
           acvp: false
-          nix-shell: "ci_gcc14"
-          cflags: "-O1" # _FORTIFY_SOURCE requires compiling with optimization
-      - name: native build+functest (clang-18)
-        uses: ./.github/actions/multi-functest
-        with:
-          gh_token: ${{ secrets.GITHUB_TOKEN }}
-          compile_mode: native
-          func: true
-          nistkat: false
-          kat: false
-          acvp: false
-          nix-shell: "ci_clang18"
-          cflags: "-O1" # _FORTIFY_SOURCE requires compiling with optimization
+          nix-shell: ${{ matrix.compiler.shell }}
+          cflags: "-O1 -std=c17" # _FORTIFY_SOURCE requires compiling with optimization
   # The purpose of this job is to test non-default yet valid configurations
   config_variations:
     name: Non-standard configurations
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`29058` cycles	`29067` cycles	`1.00`
`ML-KEM-512 encaps`	`35382` cycles	`35385` cycles	`1.00`
`ML-KEM-512 decaps`	`45860` cycles	`45862` cycles	`1.00`
`ML-KEM-768 keypair`	`49389` cycles	`49392` cycles	`1.00`
`ML-KEM-768 encaps`	`55565` cycles	`55568` cycles	`1.00`
`ML-KEM-768 decaps`	`70304` cycles	`70309` cycles	`1.00`
`ML-KEM-1024 keypair`	`72051` cycles	`72049` cycles	`1.00`
`ML-KEM-1024 encaps`	`80826` cycles	`80822` cycles	`1.00`
`ML-KEM-1024 decaps`	`100699` cycles	`100697` cycles	`1.00`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`13503` cycles	`13932` cycles	`0.97`
`ML-KEM-512 encaps`	`17257` cycles	`17229` cycles	`1.00`
`ML-KEM-512 decaps`	`22970` cycles	`23067` cycles	`1.00`
`ML-KEM-768 keypair`	`22552` cycles	`22541` cycles	`1.00`
`ML-KEM-768 encaps`	`24486` cycles	`24579` cycles	`1.00`
`ML-KEM-768 decaps`	`32444` cycles	`32616` cycles	`0.99`
`ML-KEM-1024 keypair`	`31399` cycles	`31347` cycles	`1.00`
`ML-KEM-1024 encaps`	`34899` cycles	`34871` cycles	`1.00`
`ML-KEM-1024 decaps`	`45814` cycles	`45724` cycles	`1.00`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`18137` cycles	`18131` cycles	`1.00`
`ML-KEM-512 encaps`	`23204` cycles	`23320` cycles	`1.00`
`ML-KEM-512 decaps`	`30535` cycles	`30514` cycles	`1.00`
`ML-KEM-768 keypair`	`31111` cycles	`31099` cycles	`1.00`
`ML-KEM-768 encaps`	`34183` cycles	`34188` cycles	`1.00`
`ML-KEM-768 decaps`	`44761` cycles	`44753` cycles	`1.00`
`ML-KEM-1024 keypair`	`44622` cycles	`44903` cycles	`0.99`
`ML-KEM-1024 encaps`	`49946` cycles	`50096` cycles	`1.00`
`ML-KEM-1024 decaps`	`64347` cycles	`64467` cycles	`1.00`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`20340` cycles	`20328` cycles	`1.00`
`ML-KEM-512 encaps`	`27013` cycles	`27011` cycles	`1.00`
`ML-KEM-512 decaps`	`35811` cycles	`35816` cycles	`1.00`
`ML-KEM-768 keypair`	`34884` cycles	`34877` cycles	`1.00`
`ML-KEM-768 encaps`	`38143` cycles	`38125` cycles	`1.00`
`ML-KEM-768 decaps`	`50962` cycles	`50938` cycles	`1.00`
`ML-KEM-1024 keypair`	`47941` cycles	`47970` cycles	`1.00`
`ML-KEM-1024 encaps`	`54104` cycles	`54127` cycles	`1.00`
`ML-KEM-1024 decaps`	`71632` cycles	`71661` cycles	`1.00`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`15062` cycles	`15064` cycles	`1.00`
`ML-KEM-512 encaps`	`19683` cycles	`19672` cycles	`1.00`
`ML-KEM-512 decaps`	`26322` cycles	`26302` cycles	`1.00`
`ML-KEM-768 keypair`	`25620` cycles	`25556` cycles	`1.00`
`ML-KEM-768 encaps`	`28260` cycles	`28234` cycles	`1.00`
`ML-KEM-768 decaps`	`38044` cycles	`37837` cycles	`1.01`
`ML-KEM-1024 keypair`	`35650` cycles	`35628` cycles	`1.00`
`ML-KEM-1024 encaps`	`41064` cycles	`40992` cycles	`1.00`
`ML-KEM-1024 decaps`	`54484` cycles	`54513` cycles	`1.00`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`34901` cycles	`34861` cycles	`1.00`
`ML-KEM-512 encaps`	`45102` cycles	`45002` cycles	`1.00`
`ML-KEM-512 decaps`	`58999` cycles	`58952` cycles	`1.00`
`ML-KEM-768 keypair`	`59232` cycles	`59205` cycles	`1.00`
`ML-KEM-768 encaps`	`71909` cycles	`71841` cycles	`1.00`
`ML-KEM-768 decaps`	`89376` cycles	`89360` cycles	`1.00`
`ML-KEM-1024 keypair`	`87492` cycles	`87803` cycles	`1.00`
`ML-KEM-1024 encaps`	`104562` cycles	`104187` cycles	`1.00`
`ML-KEM-1024 decaps`	`127571` cycles	`126933` cycles	`1.01`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`18131` cycles	`18136` cycles	`1.00`
`ML-KEM-512 encaps`	`22163` cycles	`22163` cycles	`1`
`ML-KEM-512 decaps`	`28770` cycles	`28771` cycles	`1.00`
`ML-KEM-768 keypair`	`30568` cycles	`30564` cycles	`1.00`
`ML-KEM-768 encaps`	`33617` cycles	`33614` cycles	`1.00`
`ML-KEM-768 decaps`	`43141` cycles	`43141` cycles	`1`
`ML-KEM-1024 keypair`	`44192` cycles	`44194` cycles	`1.00`
`ML-KEM-1024 encaps`	`49654` cycles	`49661` cycles	`1.00`
`ML-KEM-1024 decaps`	`62650` cycles	`62652` cycles	`1.00`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`18965` cycles	`18964` cycles	`1.00`
`ML-KEM-512 encaps`	`23587` cycles	`23585` cycles	`1.00`
`ML-KEM-512 decaps`	`30670` cycles	`30670` cycles	`1`
`ML-KEM-768 keypair`	`32289` cycles	`32287` cycles	`1.00`
`ML-KEM-768 encaps`	`35876` cycles	`35883` cycles	`1.00`
`ML-KEM-768 decaps`	`46041` cycles	`46044` cycles	`1.00`
`ML-KEM-1024 keypair`	`46615` cycles	`46610` cycles	`1.00`
`ML-KEM-1024 encaps`	`52447` cycles	`52444` cycles	`1.00`
`ML-KEM-1024 decaps`	`66246` cycles	`66247` cycles	`1.00`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`29190` cycles	`29058` cycles	`1.00`
`ML-KEM-512 encaps`	`35531` cycles	`35382` cycles	`1.00`
`ML-KEM-512 decaps`	`46128` cycles	`45900` cycles	`1.00`
`ML-KEM-768 keypair`	`49417` cycles	`49420` cycles	`1.00`
`ML-KEM-768 encaps`	`55570` cycles	`55573` cycles	`1.00`
`ML-KEM-768 decaps`	`70317` cycles	`70322` cycles	`1.00`
`ML-KEM-1024 keypair`	`72050` cycles	`72049` cycles	`1.00`
`ML-KEM-1024 encaps`	`80851` cycles	`80866` cycles	`1.00`
`ML-KEM-1024 decaps`	`100731` cycles	`100730` cycles	`1.00`
Benchmark suite	Current: `8868f4e`	Previous: `b99d14a`	Ratio
`ML-KEM-512 keypair`	`52248` cycles	`52176` cycles	`1.00`
`ML-KEM-512 encaps`	`65810` cycles	`65790` cycles	`1.00`
`ML-KEM-512 decaps`	`88449` cycles	`88431` cycles	`1.00`
`ML-KEM-768 keypair`	`84761` cycles	`84781` cycles	`1.00`
`ML-KEM-768 encaps`	`101508` cycles	`101483` cycles	`1.00`
`ML-KEM-768 decaps`	`132101` cycles	`132128` cycles	`1.00`
`ML-KEM-1024 keypair`	`124061` cycles	`124170` cycles	`1.00`
`ML-KEM-1024 encaps`	`145681` cycles	`145849` cycles	`1.00`
`ML-KEM-1024 decaps`	`183669` cycles	`183830` cycles	`1.00`