xref: /optee_os/.github/workflows/ci.yml (revision b6bdf694e08a3936700e39efac139a1801bb63bc)
1name: CI
2on: [push, pull_request]
3permissions:
4  contents: read # to fetch code (actions/checkout)
5jobs:
6  code_style:
7    name: Code style
8    runs-on: ubuntu-latest
9    container: jforissier/optee_os_ci
10    steps:
11      - name: Checkout
12        uses: actions/checkout@v3
13        with:
14          fetch-depth: 0 # full history so checkpatch can check commit IDs in commit messages
15      - name: Update Git config
16        run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
17      - name: Run checkpatch
18        shell: bash
19        run: |
20          # checkpatch task
21          set -e
22          git config --global --add safe.directory /__w/optee_os/optee_os
23          pushd . >/dev/null
24          mkdir -p /tmp/linux/scripts
25          cd /tmp/linux/scripts
26          wget --quiet https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/plain/scripts/checkpatch.pl
27          chmod +x checkpatch.pl
28          wget --quiet https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/plain/scripts/spelling.txt
29          echo "invalid.struct.name" >const_structs.checkpatch
30          export PATH=/tmp/linux/scripts:$PATH
31          popd >/dev/null
32          source scripts/checkpatch_inc.sh
33          function _do() { echo '>>' $*; $*; }
34          # Run checkpatch.pl:
35          # - on the tip of the branch only if we're not in a pull request
36          # - otherwise:
37          #   * on each commit in the development branch that is not in the target (merge to) branch
38          #   * on the global diff if the PR contains more than one commit (useful to check if fixup
39          #     commits do solve previous checkpatch errors)
40          if [ "${GITHUB_EVENT_NAME}" = "push" ]; then \
41            _do checkpatch HEAD || failed=1; \
42          else \
43            for c in $(git rev-list HEAD^1..HEAD^2); do \
44              _do checkpatch $c || failed=1; \
45            done; \
46            if [ "$(git rev-list --count HEAD^1..HEAD^2)" -gt 1 ]; then \
47              _do checkdiff $(git rev-parse HEAD^1) $(git rev-parse HEAD^2) || failed=1; \
48            fi; \
49          fi
50          [ -z "$failed" ]
51      - name: Run pycodestyle
52        if: success() || failure()
53        run: |
54          # pycodestyle task
55          sudo -E bash -c "apt update -qq -y && apt install -qq -y pycodestyle"
56          pycodestyle scripts/*.py core/arch/arm/plat-stm32mp1/scripts/stm32image.py
57  builds:
58    name: make (multi-platform)
59    runs-on: ubuntu-latest
60    container: jforissier/optee_os_ci
61    steps:
62      - name: Restore build cache
63        uses: actions/cache@v3
64        with:
65          path: /github/home/.cache/ccache
66          key: builds-cache-${{ github.sha }}
67          restore-keys: |
68            builds-cache-
69      - name: Checkout
70        uses: actions/checkout@v3
71      - shell: bash
72        run: |
73          # build task
74          set -e -v
75          export LC_ALL=C
76          export PATH=/usr/local/bin:$PATH  # clang
77          export CROSS_COMPILE32="ccache arm-linux-gnueabihf-"
78          export CROSS_COMPILE64="ccache aarch64-linux-gnu-"
79          export CFG_DEBUG_INFO=n
80          export CFG_WERROR=y
81
82          function _make() { make -j$(nproc) -s O=out $*; }
83          function download_plug_and_trust() { mkdir -p $HOME/se050 && git clone --single-branch -b v0.4.2 https://github.com/foundriesio/plug-and-trust $HOME/se050/plug-and-trust || (rm -rf $HOME/se050 ; echo Nervermind); }
84          function download_scp_firmware() { git clone --single-branch https://github.com/ARM-software/SCP-firmware.git $HOME/scp-firmware || echo Nervermind; }
85
86          ccache -s -v
87          download_plug_and_trust
88          download_scp_firmware
89
90          _make
91          _make COMPILER=clang
92          _make CFG_TEE_CORE_LOG_LEVEL=4 CFG_TEE_CORE_DEBUG=y CFG_TEE_TA_LOG_LEVEL=4 CFG_CC_OPT_LEVEL=0 CFG_DEBUG_INFO=y
93          _make CFG_TEE_CORE_LOG_LEVEL=0 CFG_TEE_CORE_DEBUG=n CFG_TEE_TA_LOG_LEVEL=0 CFG_DEBUG_INFO=n CFG_ENABLE_EMBEDDED_TESTS=n
94          _make CFG_TEE_CORE_MALLOC_DEBUG=y CFG_CORE_DEBUG_CHECK_STACKS=y
95          _make CFG_CORE_SANITIZE_KADDRESS=y
96          _make CFG_LOCKDEP=y
97          _make CFG_CRYPTO=n
98          _make CFG_CRYPTO_{AES,DES}=n
99          _make CFG_CRYPTO_{DSA,RSA,DH}=n
100          _make CFG_CRYPTO_{DSA,RSA,DH,ECC}=n
101          _make CFG_CRYPTO_{H,C,CBC_}MAC=n
102          _make CFG_CRYPTO_{G,C}CM=n
103          _make CFG_CRYPTO_{MD5,SHA{1,224,256,384,512,512_256}}=n
104          _make CFG_WITH_PAGER=y out/core/tee{,-pager,-pageable}.bin
105          _make CFG_WITH_PAGER=y CFG_CRYPTOLIB_NAME=mbedtls CFG_CRYPTOLIB_DIR=lib/libmbedtls
106          _make CFG_WITH_PAGER=y CFG_WITH_LPAE=y
107          _make CFG_WITH_LPAE=y
108          _make CFG_CORE_PREALLOC_EL0_TBLS=y
109          _make CFG_RPMB_FS=y
110          _make CFG_RPMB_FS=y CFG_RPMB_TESTKEY=y
111          _make CFG_REE_FS=n CFG_RPMB_FS=y
112          _make CFG_WITH_PAGER=y CFG_WITH_LPAE=y CFG_RPMB_FS=y CFG_DT=y CFG_TEE_CORE_LOG_LEVEL=1 CFG_TEE_CORE_DEBUG=y CFG_CC_OPT_LEVEL=0 CFG_DEBUG_INFO=y
113          _make CFG_WITH_PAGER=y CFG_WITH_LPAE=y CFG_RPMB_FS=y CFG_DT=y CFG_TEE_CORE_LOG_LEVEL=0 CFG_TEE_CORE_DEBUG=n DEBUG=0
114          _make CFG_BUILT_IN_ARGS=y CFG_PAGEABLE_ADDR=0 CFG_NS_ENTRY_ADDR=0 CFG_DT_ADDR=0 CFG_DT=y
115          _make CFG_FTRACE_SUPPORT=y CFG_ULIBS_MCOUNT=y CFG_ULIBS_SHARED=y
116          _make CFG_TA_GPROF_SUPPORT=y CFG_FTRACE_SUPPORT=y CFG_SYSCALL_FTRACE=y CFG_ULIBS_MCOUNT=y
117          _make CFG_SECURE_DATA_PATH=y
118          _make CFG_REE_FS_TA_BUFFERED=y
119          _make CFG_WITH_USER_TA=n
120          _make CFG_{ATTESTATION,DEVICE_ENUM,RTC,SCMI,SECSTOR_TA_MGT}_PTA=y CFG_WITH_STATS=y CFG_TA_STATS=y
121          _make PLATFORM=vexpress-qemu_armv8a
122          _make PLATFORM=vexpress-qemu_armv8a COMPILER=clang
123          _make PLATFORM=vexpress-qemu_armv8a CFG_TEE_CORE_LOG_LEVEL=0 CFG_TEE_CORE_DEBUG=n CFG_TEE_TA_LOG_LEVEL=0 CFG_DEBUG_INFO=n
124          _make PLATFORM=vexpress-qemu_armv8a CFG_TEE_CORE_LOG_LEVEL=4 CFG_TEE_CORE_DEBUG=y CFG_TEE_TA_LOG_LEVEL=4 CFG_CC_OPT_LEVEL=0 CFG_DEBUG_INFO=y
125          _make PLATFORM=vexpress-qemu_armv8a CFG_WITH_PAGER=y
126          _make PLATFORM=vexpress-qemu_armv8a CFG_FTRACE_SUPPORT=y CFG_ULIBS_MCOUNT=y CFG_ULIBS_SHARED=y
127          _make PLATFORM=vexpress-qemu_armv8a CFG_TA_GPROF_SUPPORT=y CFG_FTRACE_SUPPORT=y CFG_SYSCALL_FTRACE=y CFG_ULIBS_MCOUNT=y
128          _make PLATFORM=vexpress-qemu_armv8a CFG_NS_VIRTUALIZATION=y
129          _make PLATFORM=vexpress-qemu_armv8a CFG_CORE_PREALLOC_EL0_TBLS=y
130          _make PLATFORM=vexpress-qemu_armv8a CFG_CORE_SEL1_SPMC=y
131          _make PLATFORM=vexpress-qemu_armv8a CFG_{ATTESTATION,DEVICE_ENUM,RTC,SCMI,SECSTOR_TA_MGT}_PTA=y CFG_WITH_STATS=y CFG_TA_STATS=y
132          dd if=/dev/urandom of=BL32_AP_MM.fd bs=2621440 count=1 && _make PLATFORM=vexpress-qemu_armv8a CFG_STMM_PATH=BL32_AP_MM.fd CFG_RPMB_FS=y CFG_CORE_HEAP_SIZE=524288 CFG_TEE_RAM_VA_SIZE=0x00400000
133          if [ -d $HOME/scp-firmware ]; then _make PLATFORM=vexpress-qemu_armv8a CFG_SCMI_SCPFW=y CFG_SCP_FIRMWARE=$HOME/scp-firmware; fi
134          _make PLATFORM=stm-b2260
135          _make PLATFORM=stm-cannes
136          _make PLATFORM=stm32mp1
137          _make PLATFORM=stm32mp1-135F_DK
138          if [ -d $HOME/scp-firmware ]; then _make PLATFORM=stm32mp1-157C_DK2 CFG_SCMI_SCPFW=y CFG_SCP_FIRMWARE=$HOME/scp-firmware; fi
139          _make PLATFORM=vexpress-fvp
140          _make PLATFORM=vexpress-fvp CFG_ARM64_core=y
141          _make PLATFORM=vexpress-fvp CFG_ARM64_core=y CFG_CORE_SEL1_SPMC=y CFG_SECURE_PARTITION=y
142          if [ -d $HOME/scp-firmware ]; then _make PLATFORM=vexpress-fvp CFG_SCMI_SCPFW=y CFG_SCP_FIRMWARE=$HOME/scp-firmware; fi
143          _make PLATFORM=vexpress-juno
144          _make PLATFORM=vexpress-juno CFG_ARM64_core=y
145          _make PLATFORM=hikey
146          _make PLATFORM=hikey CFG_ARM64_core=y
147          _make PLATFORM=mediatek-mt8173
148          _make PLATFORM=mediatek-mt8175
149          _make PLATFORM=mediatek-mt8183
150          _make PLATFORM=mediatek-mt8516
151          _make PLATFORM=imx-mx6ulevk
152          _make PLATFORM=imx-mx6ulevk CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
153          _make PLATFORM=imx-mx6ul9x9evk
154          _make PLATFORM=imx-mx6ullevk CFG_WITH_SOFTWARE_PRNG=n CFG_IMX_RNGB=y
155          if [ -d $HOME/se050/plug-and-trust ]; then _make PLATFORM=imx-mx6ullevk CFG_NXP_SE05X=y CFG_IMX_I2C=y CFG_STACK_{THREAD,TMP}_EXTRA=8192 CFG_CRYPTO_DRV_{CIPHER,ACIPHER}=y CFG_WITH_SOFTWARE_PRNG=n CFG_NXP_SE05X_{DIEID,RNG,RSA,ECC,CTR}_DRV=y CFG_NXP_SE05X_RSA_DRV_FALLBACK=y CFG_NXP_SE05X_ECC_DRV_FALLBACK=y CFG_NXP_SE05X_PLUG_AND_TRUST=$HOME/se050/plug-and-trust ; fi
156          _make PLATFORM=imx-mx6ulzevk
157          _make PLATFORM=imx-mx6slevk
158          _make PLATFORM=imx-mx6sllevk
159          _make PLATFORM=imx-mx6sxsabreauto
160          _make PLATFORM=imx-mx6sxsabresd
161          _make PLATFORM=imx-mx6sxsabresd CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
162          _make PLATFORM=imx-mx6solosabresd
163          _make PLATFORM=imx-mx6solosabreauto
164          _make PLATFORM=imx-mx6sxsabreauto
165          _make PLATFORM=imx-mx6qsabrelite
166          _make PLATFORM=imx-mx6qsabresd
167          _make PLATFORM=imx-mx6qsabresd CFG_RPMB_FS=y
168          _make PLATFORM=imx-mx6qsabreauto
169          _make PLATFORM=imx-mx6qsabreauto CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
170          _make PLATFORM=imx-mx6qpsabreauto
171          _make PLATFORM=imx-mx6qpsabresd
172          _make PLATFORM=imx-mx6dlsabresd
173          _make PLATFORM=imx-mx6dlsabreauto
174          _make PLATFORM=imx-mx6dapalis
175          _make PLATFORM=imx-mx6qapalis
176          _make PLATFORM=imx-mx7dsabresd
177          _make PLATFORM=imx-mx7dsabresd CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
178          _make PLATFORM=imx-mx7ulpevk
179          _make PLATFORM=imx-mx8mmevk
180          _make PLATFORM=imx-mx8mmevk CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
181          if [ -d $HOME/se050/plug-and-trust ]; then _make PLATFORM=imx-mx8mmevk CFG_NXP_CAAM=y CFG_NXP_CAAM_RNG_DRV=y CFG_NXP_SE05X=y CFG_IMX_I2C=y CFG_STACK_{THREAD,TMP}_EXTRA=8192 CFG_CRYPTO_DRV_{CIPHER,ACIPHER}=y CFG_NXP_SE05X_RNG_DRV=n CFG_WITH_SOFTWARE_PRNG=n CFG_NXP_SE05X_{DIEID,RSA,ECC,CTR}_DRV=y CFG_NXP_SE05X_RSA_DRV_FALLBACK=y CFG_NXP_SE05X_ECC_DRV_FALLBACK=y CFG_NXP_SE05X_PLUG_AND_TRUST=$HOME/se050/plug-and-trust ; fi
182          _make PLATFORM=imx-mx8mnevk
183          _make PLATFORM=imx-mx8mqevk
184          _make PLATFORM=imx-mx8mpevk
185          _make PLATFORM=imx-mx8qxpmek
186          _make PLATFORM=imx-mx8qmmek
187          _make PLATFORM=imx-mx8dxlevk
188          _make PLATFORM=imx-mx8ulpevk
189          _make PLATFORM=imx-mx8ulpevk CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
190          _make PLATFORM=imx-mx93evk
191          _make PLATFORM=k3-j721e
192          _make PLATFORM=k3-j721e CFG_ARM64_core=y
193          _make PLATFORM=k3-j784s4
194          _make PLATFORM=k3-j784s4 CFG_ARM64_core=y
195          _make PLATFORM=k3-am65x
196          _make PLATFORM=k3-am65x CFG_ARM64_core=y
197          _make PLATFORM=k3-am64x
198          _make PLATFORM=k3-am64x CFG_ARM64_core=y
199          _make PLATFORM=k3-am62x
200          _make PLATFORM=k3-am62x CFG_ARM64_core=y
201          _make PLATFORM=ti-dra7xx out/core/tee{,-pager,-pageable}.bin
202          _make PLATFORM=ti-am57xx
203          _make PLATFORM=ti-am43xx
204          _make PLATFORM=sprd-sc9860
205          _make PLATFORM=sprd-sc9860 CFG_ARM64_core=y
206          _make PLATFORM=ls-ls1043ardb
207          _make PLATFORM=ls-ls1046ardb
208          _make PLATFORM=ls-ls1012ardb
209          _make PLATFORM=ls-ls1028ardb
210          _make PLATFORM=ls-ls1088ardb
211          _make PLATFORM=ls-ls2088ardb
212          _make PLATFORM=ls-lx2160ardb
213          _make PLATFORM=ls-lx2160aqds
214          _make PLATFORM=zynq7k-zc702
215          _make PLATFORM=zynqmp-zcu102
216          _make PLATFORM=zynqmp-zcu102 CFG_ARM64_core=y
217          _make PLATFORM=zynqmp-zcu102 CFG_ARM64_core=y CFG_WITH_SOFTWARE_PRNG=n CFG_XIPHERA_TRNG=y CFG_ZYNQMP_HUK=y
218          _make PLATFORM=d02
219          _make PLATFORM=d02 CFG_ARM64_core=y
220          _make PLATFORM=rcar
221          _make PLATFORM=rzg
222          _make PLATFORM=rzg CFG_ARM64_core=y
223          _make PLATFORM=rpi3
224          _make PLATFORM=rpi3 CFG_ARM64_core=y
225          _make PLATFORM=hikey-hikey960
226          _make PLATFORM=hikey-hikey960 COMPILER=clang
227          _make PLATFORM=hikey-hikey960 CFG_ARM64_core=y
228          _make PLATFORM=hikey-hikey960 CFG_ARM64_core=y COMPILER=clang
229          _make PLATFORM=hikey-hikey960 CFG_SECURE_DATA_PATH=n
230          _make PLATFORM=poplar
231          _make PLATFORM=poplar CFG_ARM64_core=y
232          _make PLATFORM=rockchip-rk322x
233          _make PLATFORM=rockchip-rk3399
234          _make PLATFORM=sam
235          _make PLATFORM=sam-sama5d27_wlsom1_ek
236          _make PLATFORM=marvell-armada7k8k
237          _make PLATFORM=marvell-armada3700
238          _make PLATFORM=marvell-otx2t96
239          _make PLATFORM=marvell-otx2f95
240          _make PLATFORM=marvell-otx2t98
241          _make PLATFORM=synquacer
242          _make PLATFORM=sunxi-bpi_zero
243          _make PLATFORM=sunxi-sun50i_a64
244          _make PLATFORM=bcm-ns3 CFG_ARM64_core=y
245          _make PLATFORM=hisilicon-hi3519av100_demo
246          _make PLATFORM=amlogic
247          _make PLATFORM=rzn1
248          _make PLATFORM=versal CFG_VERSAL_FPGA_DDR_ADDR=0x40000000
249          _make PLATFORM=corstone1000
250
251  QEMUv8_check:
252    name: make check (QEMUv8)
253    runs-on: ubuntu-latest
254    container: jforissier/optee_os_ci:qemuv8_check2
255    steps:
256      - name: Restore build cache
257        uses: actions/cache@v3
258        with:
259          path: /github/home/.cache/ccache
260          key: qemuv8_check-cache-${{ github.sha }}
261          restore-keys: |
262            qemuv8_check-cache-
263      - name: Checkout
264        uses: actions/checkout@v3
265      - shell: bash
266        run: |
267          # make check task
268          set -e -v
269          export LC_ALL=C
270          export BR2_CCACHE_DIR=/github/home/.cache/ccache
271          export CFG_TEE_CORE_LOG_LEVEL=0
272          WD=$(pwd)
273          cd ..
274          TOP=$(pwd)/optee_repo_qemu_v8
275          /root/get_optee_qemuv8.sh ${TOP}
276          mv ${TOP}/optee_os ${TOP}/optee_os_old
277          ln -s ${WD} ${TOP}/optee_os
278          cd ${TOP}/build
279
280          make -j$(nproc) check
281
282          make -j$(nproc) check CFG_CRYPTO_WITH_CE82=y
283
284  QEMUv8_Xen_check:
285    name: make check (QEMUv8, Xen)
286    runs-on: ubuntu-latest
287    container: jforissier/optee_os_ci:qemuv8_check2
288    steps:
289      - name: Restore build cache
290        uses: actions/cache@v3
291        with:
292          path: /github/home/.cache/ccache
293          key: qemuv8_xen_check-cache-${{ github.sha }}
294          restore-keys: |
295            qemuv8_xen_check-cache-
296      - name: Checkout
297        uses: actions/checkout@v3
298      - shell: bash
299        run: |
300          # make check task
301          set -e -v
302          export LC_ALL=C
303          export CFG_TEE_CORE_LOG_LEVEL=0
304          export BR2_CCACHE_DIR=/github/home/.cache/ccache
305          WD=$(pwd)
306          cd ..
307          TOP=$(pwd)/optee_repo_qemu_v8
308          /root/get_optee_qemuv8.sh ${TOP}
309          mv ${TOP}/optee_os ${TOP}/optee_os_old
310          ln -s ${WD} ${TOP}/optee_os
311          cd ${TOP}/build
312
313          make -j$(nproc) check XEN_BOOT=y
314
315  QEMUv8_check_BTI_MTE_PAC:
316    name: make check (QEMUv8, BTI+MTE+PAC)
317    runs-on: ubuntu-latest
318    container: jforissier/optee_os_ci:qemuv8_check2
319    steps:
320      - name: Restore build cache
321        uses: actions/cache@v3
322        with:
323          path: /github/home/.cache/ccache
324          key: qemuv8_check_bti_mte_pac-cache-${{ github.sha }}
325          restore-keys: |
326            qemuv8_check_bti_mte_pac-cache-
327      - name: Checkout
328        uses: actions/checkout@v3
329      - shell: bash
330        run: |
331          # make check task
332          set -e -v
333          export LC_ALL=C
334          # The BTI-enabled toolchain is aarch64-unknown-linux-uclibc-gcc in /usr/local/bin
335          export PATH=/usr/local/bin:$PATH
336          export AARCH64_CROSS_COMPILE=aarch64-unknown-linux-uclibc-
337          export BR2_CCACHE_DIR=/github/home/.cache/ccache
338          export CFG_TEE_CORE_LOG_LEVEL=0
339          export CFG_USER_TA_TARGETS=ta_arm64
340          WD=$(pwd)
341          cd ..
342          TOP=$(pwd)/optee_repo_qemu_v8
343          # TF-A v2.6 fails to build with the above toolchain so override it
344          export TF_A_EXPORTS="CROSS_COMPILE=${TOP}/toolchains/aarch64/bin/aarch64-linux-gnu-"
345          /root/get_optee_qemuv8.sh ${TOP}
346          # QEMU v7.2.0 has an issue with MTE
347          # https://github.com/OP-TEE/optee_os/issues/5759#issuecomment-1380590951
348          cd ${TOP}/qemu && git fetch github && git checkout 13356edb87
349          mv ${TOP}/optee_os ${TOP}/optee_os_old
350          ln -s ${WD} ${TOP}/optee_os
351          cd ${TOP}/build
352
353          # xtest 1031 is excluded because 1031.4 (C++ exception from shared library) fails with this cross-compiler
354          make -j$(nproc) CFG_CORE_BTI=y CFG_TA_BTI=y MEMTAG=y PAUTH=y XTEST_ARGS="-x 1031" check
355
356  QEMUv8_check_rust:
357    name: make check-rust (QEMUv8)
358    runs-on: ubuntu-latest
359    container: jforissier/optee_os_ci:qemuv8_check2
360    steps:
361      - name: Restore build cache
362        uses: actions/cache@v3
363        with:
364          path: /github/home/.cache/ccache
365          key: qemuv8_check_rust-cache-${{ github.sha }}
366          restore-keys: |
367            qemuv8_check_rust-cache-
368      - name: Checkout
369        uses: actions/checkout@v3
370      - shell: bash
371        run: |
372          # make check-rust task
373          set -e -v
374          export LC_ALL=C
375          export BR2_CCACHE_DIR=/github/home/.cache/ccache
376          WD=$(pwd)
377          cd ..
378          TOP=$(pwd)/optee_repo_qemu_v8
379          /root/get_optee_qemuv8.sh ${TOP}
380          mv ${TOP}/optee_os ${TOP}/optee_os_old
381          ln -s ${WD} ${TOP}/optee_os
382          cd ${TOP}/build
383
384          # Without this line, the following one fails with "ld: cannot find -lteec" when building acipher-rs
385          make -j$(nproc)
386          make -j$(nproc) OPTEE_RUST_ENABLE=y check-rust
387