xref: /optee_os/.github/workflows/ci.yml (revision 200eb7bd88d1baad5f7201839b918317c20ce8e2)
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.1 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 PLATFORM=vexpress-qemu_armv8a
121          _make PLATFORM=vexpress-qemu_armv8a COMPILER=clang
122          _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
123          _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
124          _make PLATFORM=vexpress-qemu_armv8a CFG_WITH_PAGER=y
125          _make PLATFORM=vexpress-qemu_armv8a CFG_FTRACE_SUPPORT=y CFG_ULIBS_MCOUNT=y CFG_ULIBS_SHARED=y
126          _make PLATFORM=vexpress-qemu_armv8a CFG_TA_GPROF_SUPPORT=y CFG_FTRACE_SUPPORT=y CFG_SYSCALL_FTRACE=y CFG_ULIBS_MCOUNT=y
127          _make PLATFORM=vexpress-qemu_armv8a CFG_NS_VIRTUALIZATION=y
128          _make PLATFORM=vexpress-qemu_armv8a CFG_CORE_PREALLOC_EL0_TBLS=y
129          _make PLATFORM=vexpress-qemu_armv8a CFG_CORE_SEL1_SPMC=y
130          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
131          if [ -d $HOME/scp-firmware ]; then _make PLATFORM=vexpress-qemu_armv8a CFG_SCMI_SCPFW=y CFG_SCP_FIRMWARE=$HOME/scp-firmware; fi
132          _make PLATFORM=stm-b2260
133          _make PLATFORM=stm-cannes
134          _make PLATFORM=stm32mp1
135          _make PLATFORM=stm32mp1-135F_DK
136          if [ -d $HOME/scp-firmware ]; then _make PLATFORM=stm32mp1-157C_DK2 CFG_SCMI_SCPFW=y CFG_SCP_FIRMWARE=$HOME/scp-firmware; fi
137          _make PLATFORM=vexpress-fvp
138          _make PLATFORM=vexpress-fvp CFG_ARM64_core=y
139          _make PLATFORM=vexpress-fvp CFG_ARM64_core=y CFG_CORE_SEL1_SPMC=y CFG_SECURE_PARTITION=y
140          if [ -d $HOME/scp-firmware ]; then _make PLATFORM=vexpress-fvp CFG_SCMI_SCPFW=y CFG_SCP_FIRMWARE=$HOME/scp-firmware; fi
141          _make PLATFORM=vexpress-juno
142          _make PLATFORM=vexpress-juno CFG_ARM64_core=y
143          _make PLATFORM=hikey
144          _make PLATFORM=hikey CFG_ARM64_core=y
145          _make PLATFORM=mediatek-mt8173
146          _make PLATFORM=mediatek-mt8175
147          _make PLATFORM=mediatek-mt8183
148          _make PLATFORM=mediatek-mt8516
149          _make PLATFORM=imx-mx6ulevk
150          _make PLATFORM=imx-mx6ulevk CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
151          _make PLATFORM=imx-mx6ul9x9evk
152          _make PLATFORM=imx-mx6ullevk CFG_WITH_SOFTWARE_PRNG=n CFG_IMX_RNGB=y
153          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
154          _make PLATFORM=imx-mx6ulzevk
155          _make PLATFORM=imx-mx6slevk
156          _make PLATFORM=imx-mx6sllevk
157          _make PLATFORM=imx-mx6sxsabreauto
158          _make PLATFORM=imx-mx6sxsabresd
159          _make PLATFORM=imx-mx6sxsabresd CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
160          _make PLATFORM=imx-mx6solosabresd
161          _make PLATFORM=imx-mx6solosabreauto
162          _make PLATFORM=imx-mx6sxsabreauto
163          _make PLATFORM=imx-mx6qsabrelite
164          _make PLATFORM=imx-mx6qsabresd
165          _make PLATFORM=imx-mx6qsabresd CFG_RPMB_FS=y
166          _make PLATFORM=imx-mx6qsabreauto
167          _make PLATFORM=imx-mx6qsabreauto CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
168          _make PLATFORM=imx-mx6qpsabreauto
169          _make PLATFORM=imx-mx6qpsabresd
170          _make PLATFORM=imx-mx6dlsabresd
171          _make PLATFORM=imx-mx6dlsabreauto
172          _make PLATFORM=imx-mx6dapalis
173          _make PLATFORM=imx-mx6qapalis
174          _make PLATFORM=imx-mx7dsabresd
175          _make PLATFORM=imx-mx7dsabresd CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
176          _make PLATFORM=imx-mx7ulpevk
177          _make PLATFORM=imx-mx8mmevk
178          _make PLATFORM=imx-mx8mmevk CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
179          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
180          _make PLATFORM=imx-mx8mnevk
181          _make PLATFORM=imx-mx8mqevk
182          _make PLATFORM=imx-mx8mpevk
183          _make PLATFORM=imx-mx8qxpmek
184          _make PLATFORM=imx-mx8qmmek
185          _make PLATFORM=imx-mx8dxlevk
186          _make PLATFORM=imx-mx8ulpevk
187          _make PLATFORM=imx-mx8ulpevk CFG_NXP_CAAM=y CFG_CRYPTO_DRIVER=y
188          _make PLATFORM=imx-mx93evk
189          _make PLATFORM=k3-j721e
190          _make PLATFORM=k3-j721e CFG_ARM64_core=y
191          _make PLATFORM=k3-j784s4
192          _make PLATFORM=k3-j784s4 CFG_ARM64_core=y
193          _make PLATFORM=k3-am65x
194          _make PLATFORM=k3-am65x CFG_ARM64_core=y
195          _make PLATFORM=k3-am64x
196          _make PLATFORM=k3-am64x CFG_ARM64_core=y
197          _make PLATFORM=k3-am62x
198          _make PLATFORM=k3-am62x CFG_ARM64_core=y
199          _make PLATFORM=ti-dra7xx out/core/tee{,-pager,-pageable}.bin
200          _make PLATFORM=ti-am57xx
201          _make PLATFORM=ti-am43xx
202          _make PLATFORM=sprd-sc9860
203          _make PLATFORM=sprd-sc9860 CFG_ARM64_core=y
204          _make PLATFORM=ls-ls1043ardb
205          _make PLATFORM=ls-ls1046ardb
206          _make PLATFORM=ls-ls1012ardb
207          _make PLATFORM=ls-ls1028ardb
208          _make PLATFORM=ls-ls1088ardb
209          _make PLATFORM=ls-ls2088ardb
210          _make PLATFORM=ls-lx2160ardb
211          _make PLATFORM=ls-lx2160aqds
212          _make PLATFORM=zynq7k-zc702
213          _make PLATFORM=zynqmp-zcu102
214          _make PLATFORM=zynqmp-zcu102 CFG_ARM64_core=y
215          _make PLATFORM=zynqmp-zcu102 CFG_ARM64_core=y CFG_WITH_SOFTWARE_PRNG=n CFG_XIPHERA_TRNG=y CFG_ZYNQMP_HUK=y
216          _make PLATFORM=d02
217          _make PLATFORM=d02 CFG_ARM64_core=y
218          _make PLATFORM=rcar
219          _make PLATFORM=rzg
220          _make PLATFORM=rzg CFG_ARM64_core=y
221          _make PLATFORM=rpi3
222          _make PLATFORM=rpi3 CFG_ARM64_core=y
223          _make PLATFORM=hikey-hikey960
224          _make PLATFORM=hikey-hikey960 COMPILER=clang
225          _make PLATFORM=hikey-hikey960 CFG_ARM64_core=y
226          _make PLATFORM=hikey-hikey960 CFG_ARM64_core=y COMPILER=clang
227          _make PLATFORM=hikey-hikey960 CFG_SECURE_DATA_PATH=n
228          _make PLATFORM=poplar
229          _make PLATFORM=poplar CFG_ARM64_core=y
230          _make PLATFORM=rockchip-rk322x
231          _make PLATFORM=rockchip-rk3399
232          _make PLATFORM=sam
233          _make PLATFORM=marvell-armada7k8k
234          _make PLATFORM=marvell-armada3700
235          _make PLATFORM=marvell-otx2t96
236          _make PLATFORM=marvell-otx2f95
237          _make PLATFORM=marvell-otx2t98
238          _make PLATFORM=synquacer
239          _make PLATFORM=sunxi-bpi_zero
240          _make PLATFORM=sunxi-sun50i_a64
241          _make PLATFORM=bcm-ns3 CFG_ARM64_core=y
242          _make PLATFORM=hisilicon-hi3519av100_demo
243          _make PLATFORM=amlogic
244          _make PLATFORM=rzn1
245          _make PLATFORM=versal CFG_VERSAL_FPGA_DDR_ADDR=0x40000000
246          _make PLATFORM=corstone1000
247
248  QEMUv8_check:
249    name: make check (QEMUv8)
250    runs-on: ubuntu-latest
251    container: jforissier/optee_os_ci:qemuv8_check2
252    steps:
253      - name: Restore build cache
254        uses: actions/cache@v3
255        with:
256          path: /github/home/.cache/ccache
257          key: qemuv8_check-cache-${{ github.sha }}
258          restore-keys: |
259            qemuv8_check-cache-
260      - name: Checkout
261        uses: actions/checkout@v3
262      - shell: bash
263        run: |
264          # make check task
265          set -e -v
266          export LC_ALL=C
267          export BR2_CCACHE_DIR=/github/home/.cache/ccache
268          export CFG_TEE_CORE_LOG_LEVEL=0
269          WD=$(pwd)
270          cd ..
271          TOP=$(pwd)/optee_repo_qemu_v8
272          /root/get_optee_qemuv8.sh ${TOP}
273          mv ${TOP}/optee_os ${TOP}/optee_os_old
274          ln -s ${WD} ${TOP}/optee_os
275          cd ${TOP}/build
276
277          make -j$(nproc) check
278
279          make -j$(nproc) check CFG_CRYPTO_WITH_CE82=y
280
281  QEMUv8_Xen_check:
282    name: make check (QEMUv8, Xen)
283    runs-on: ubuntu-latest
284    container: jforissier/optee_os_ci:qemuv8_check2
285    steps:
286      - name: Restore build cache
287        uses: actions/cache@v3
288        with:
289          path: /github/home/.cache/ccache
290          key: qemuv8_xen_check-cache-${{ github.sha }}
291          restore-keys: |
292            qemuv8_xen_check-cache-
293      - name: Checkout
294        uses: actions/checkout@v3
295      - shell: bash
296        run: |
297          # make check task
298          set -e -v
299          export LC_ALL=C
300          export CFG_TEE_CORE_LOG_LEVEL=0
301          export BR2_CCACHE_DIR=/github/home/.cache/ccache
302          WD=$(pwd)
303          cd ..
304          TOP=$(pwd)/optee_repo_qemu_v8
305          /root/get_optee_qemuv8.sh ${TOP}
306          mv ${TOP}/optee_os ${TOP}/optee_os_old
307          ln -s ${WD} ${TOP}/optee_os
308          cd ${TOP}/build
309
310          make -j$(nproc) check XEN_BOOT=y
311
312  QEMUv8_check_BTI_MTE_PAC:
313    name: make check (QEMUv8, BTI+MTE+PAC)
314    runs-on: ubuntu-latest
315    container: jforissier/optee_os_ci:qemuv8_check2
316    steps:
317      - name: Restore build cache
318        uses: actions/cache@v3
319        with:
320          path: /github/home/.cache/ccache
321          key: qemuv8_check_bti_mte_pac-cache-${{ github.sha }}
322          restore-keys: |
323            qemuv8_check_bti_mte_pac-cache-
324      - name: Checkout
325        uses: actions/checkout@v3
326      - shell: bash
327        run: |
328          # make check task
329          set -e -v
330          export LC_ALL=C
331          # The BTI-enabled toolchain is aarch64-unknown-linux-uclibc-gcc in /usr/local/bin
332          export PATH=/usr/local/bin:$PATH
333          export AARCH64_CROSS_COMPILE=aarch64-unknown-linux-uclibc-
334          export BR2_CCACHE_DIR=/github/home/.cache/ccache
335          export CFG_TEE_CORE_LOG_LEVEL=0
336          export CFG_USER_TA_TARGETS=ta_arm64
337          WD=$(pwd)
338          cd ..
339          TOP=$(pwd)/optee_repo_qemu_v8
340          # TF-A v2.6 fails to build with the above toolchain so override it
341          export TF_A_EXPORTS="CROSS_COMPILE=${TOP}/toolchains/aarch64/bin/aarch64-linux-gnu-"
342          /root/get_optee_qemuv8.sh ${TOP}
343          # QEMU v7.2.0 has an issue with MTE
344          # https://github.com/OP-TEE/optee_os/issues/5759#issuecomment-1380590951
345          cd ${TOP}/qemu && git fetch github && git checkout 13356edb87
346          mv ${TOP}/optee_os ${TOP}/optee_os_old
347          ln -s ${WD} ${TOP}/optee_os
348          cd ${TOP}/build
349
350          # xtest 1031 is excluded because 1031.4 (C++ exception from shared library) fails with this cross-compiler
351          make -j$(nproc) CFG_CORE_BTI=y CFG_TA_BTI=y MEMTAG=y PAUTH=y XTEST_ARGS="-x 1031" check
352
353  QEMUv8_check_rust:
354    name: make check-rust (QEMUv8)
355    if: false # disabled until https://github.com/OP-TEE/optee_os/pull/5688#issuecomment-1370608865 is addressed
356    runs-on: ubuntu-latest
357    container: jforissier/optee_os_ci:qemuv8_check2
358    steps:
359      - name: Restore build cache
360        uses: actions/cache@v3
361        with:
362          path: /github/home/.cache/ccache
363          key: qemuv8_check_rust-cache-${{ github.sha }}
364          restore-keys: |
365            qemuv8_check_rust-cache-
366      - name: Checkout
367        uses: actions/checkout@v3
368      - shell: bash
369        run: |
370          # make check-rust task
371          set -e -v
372          export LC_ALL=C
373          export BR2_CCACHE_DIR=/github/home/.cache/ccache
374          WD=$(pwd)
375          cd ..
376          TOP=$(pwd)/optee_repo_qemu_v8
377          /root/get_optee_qemuv8.sh ${TOP}
378          mv ${TOP}/optee_os ${TOP}/optee_os_old
379          ln -s ${WD} ${TOP}/optee_os
380          cd ${TOP}/build
381
382          # Without this line, the following one fails with "ld: cannot find -lteec" when building acipher-rs
383          make -j$(nproc)
384          make -j$(nproc) OPTEE_RUST_ENABLE=y check-rust
385