.gitlab-ci.yml

# Copyright 2025 ETH Zurich and University of Bologna.
# Licensed under the Apache License, Version 2.0, see LICENSE.APACHE for details.
# SPDX-License-Identifier: Apache-2.0

# Author: Alessandro Nadalini <alessandro.nadalini3@unibo.it>
#         Alberto Dequino <alberto.dequino@unibo.it> 
#         Victor Jung <junvi@iis.ee.ethz.ch>

workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
      when: never
    - if: $CI_COMMIT_BRANCH

variables:
  MAGIA: './MAGIA'
  RISCV_GCC_BINROOT: /usr/pack/pulpsdk-1.0-kgf/artifactory/pulp-sdk-release/pkg/pulp_riscv_gcc/1.0.16/bin
  OPENHW_GCC_BINROOT: /usr/scratch2/lagrev5/anadalini/cv32e40p-gcc-toolchain/bin
  PYENV_BINROOT: /home/adequi/.pyenv/bin
  LLVM_DIR: /usr/pack/riscv-1.0-kgf/spatz-llvm-2023.08.10/
  GIT_CLONE_PATH: "$CI_BUILDS_DIR/$CI_CONCURRENT_ID/$CI_PIPELINE_ID/$CI_JOB_ID"
  GIT_STRATEGY: clone
  GIT_CLEAN_FLAGS: "-ffdx"

.export_path:
  before_script:
    - export PATH=$OPENHW_GCC_BINROOT:$PATH
    - export PATH=$PYENV_BINROOT:$PATH
    - export LLVM_INSTALL_DIR=$LLVM_DIR

stages:
  - clone
  - python_setup
  - build_tiles_4
  - build_test_tiles_4_spatz
  - test_tiles_4_spatz
  - build_test_tiles_4_cluster
  - test_tiles_4_cluster
  - build_test_tiles_4_spatz+cluster
  - test_tiles_4_spatz+cluster
  - build_tiles_1
  - build_test_tiles_1_spatz
  - test_tiles_1_spatz
  - build_test_tiles_1_cluster
  - test_tiles_1_cluster
  - build_test_tiles_1_spatz+cluster
  - test_tiles_1_spatz+cluster
  - postscript

python_gvsoc:
  extends: [.base, .export_path]
  stage: python_setup
  variables:
    UV_CACHE_DIR: "$CI_PROJECT_DIR/.uv-cache"
    PIP_CACHE_DIR: "$CI_PROJECT_DIR/.pip-cache"
  script:
    - eval "$(pyenv init -)"
    - pyenv local 3.12
    - python -m venv gvsoc_venv
    - source gvsoc_venv/bin/activate && pip install uv
    - source gvsoc_venv/bin/activate && uv pip install .
  artifacts:
    paths: [ "gvsoc_venv" ]


.base:
 artifacts:
  when: always
  expire_in: 4 week


clone_magia:
  extends: .base
  stage: clone
  script:
    - source scripts/deps.env
    - git clone https://github.com/pulp-platform/MAGIA.git
    - cd MAGIA && git fetch origin "$MAGIA_COMMIT" && git checkout "$MAGIA_COMMIT"
  artifacts:
    paths: [ "MAGIA" ]

clone_gvsoc:
  extends: .base
  stage: clone
  script:
    - make gvsoc_init
  artifacts:
    paths: [ "gvsoc" ]

.gvsoc:
  extends: [.base]
  script:
    - source gvsoc_venv/bin/activate && export CC=/usr/sepp/bin/gcc-11.2.0 && export CXX=/usr/sepp/bin/g++-11.2.0 && make gvsoc tiles=${tiles}
  artifacts:
    paths: [ "gvsoc/install" , "gvsoc/pulp/pulp/chips/magia_v2/arch.py"]

gvsoc_tiles_4:
  extends: .gvsoc
  stage: build_tiles_4
  variables:
    tiles: 4
  artifacts:
    paths: [ "gvsoc/install" ]
  dependencies:
    - clone_gvsoc
    - python_gvsoc

gvsoc_tiles_1:
  extends: .gvsoc
  stage: build_tiles_1
  variables:
    tiles: 1
  artifacts:
    paths: [ "gvsoc/install" ]
  dependencies:
    - clone_gvsoc
    - python_gvsoc


.MAGIA:
  extends: [.base]
  script:
    - make rtl-clean MAGIA_RTL_DIR=$MAGIA
    - make MAGIA MAGIA_RTL_DIR=$MAGIA tiles=${tiles} target_platform=${target_platform} fast_sim=1
  artifacts:
    paths: [ "$MAGIA/work", "$MAGIA/sim/work", "$MAGIA/sim/modelsim.ini", "$MAGIA/scripts/sim_ret_errors.sh", "$MAGIA/scripts/compile.tcl", "$MAGIA/Makefile", "$MAGIA/hw/mesh/magia_pkg.sv", "$MAGIA/hw/tile/magia_tile_pkg.sv" ]

magia_v3_tiles_4:
  extends: .MAGIA
  stage: build_tiles_4
  variables:
    tiles: 4
    target_platform: magia_v3
  dependencies:
    - clone_magia

magia_v3_tiles_1:
  extends: .MAGIA
  stage: build_tiles_1
  variables:
    tiles: 1
    target_platform: magia_v3
  dependencies:
    - clone_magia

.build:
  extends: [.base, .export_path]
  script:
    - make clean build tiles=${tiles} target_platform=${target_platform} compiler=${compiler} CMAKE=${CMAKE}
  artifacts:
    paths: [ "build", "targets/${target_platform}/include/addr_map/tile_addr_map.h" ]

build_test_magia_v3_tiles_4_spatz:
  extends: .build
  stage: build_test_tiles_4_spatz
  variables:
    tiles: 4
    target_platform: magia_v3
    compiler: GCC_MULTILIB
    CMAKE: cmake-3.28.3
    spatz: 1
    pulp_cores: 0
  dependencies:
    - python_gvsoc

build_test_magia_v3_tiles_1_spatz:
  extends: .build
  stage: build_test_tiles_1_spatz
  variables:
    tiles: 1
    target_platform: magia_v3
    compiler: GCC_MULTILIB
    CMAKE: cmake-3.28.3
    spatz: 1
    pulp_cores: 0
  dependencies:
    - python_gvsoc

build_test_magia_v3_tiles_4_cluster:
  extends: .build
  stage: build_test_tiles_4_cluster
  variables:
    tiles: 4
    target_platform: magia_v3
    compiler: GCC_MULTILIB
    CMAKE: cmake-3.28.3
    spatz: 0
    pulp_cores: 8
  dependencies:
    - python_gvsoc

build_test_magia_v3_tiles_1_cluster:
  extends: .build
  stage: build_test_tiles_1_cluster
  variables:
    tiles: 1
    target_platform: magia_v3
    compiler: GCC_MULTILIB
    CMAKE: cmake-3.28.3
    spatz: 0
    pulp_cores: 8
  dependencies:
    - python_gvsoc

build_test_magia_v3_tiles_4_spatz+cluster:
  extends: .build
  stage: build_test_tiles_4_spatz+cluster
  variables:
    tiles: 4
    target_platform: magia_v3
    compiler: GCC_MULTILIB
    CMAKE: cmake-3.28.3
    spatz: 1
    pulp_cores: 8
  dependencies:
    - python_gvsoc

build_test_magia_v3_tiles_1_spatz+cluster:
  extends: .build
  stage: build_test_tiles_1_spatz+cluster
  variables:
    tiles: 1
    target_platform: magia_v3
    compiler: GCC_MULTILIB
    CMAKE: cmake-3.28.3
    spatz: 1
    pulp_cores: 8
  dependencies:
    - python_gvsoc

.sim:
  extends: [.base, .export_path]
  script:
    - export TESTLOG="${TESTNAME##*/}"
    - make run MAGIA_RTL_DIR=$MAGIA platform=${platform} test=$TESTNAME tiles=${tiles} fast_sim=1 > $TESTLOG.log
    - ./scripts/sim_ret_errors.sh $TESTLOG.log
  artifacts:
    paths: [ "*.log" ]
    expire_in: 2 weeks

.sim_gvsoc:
  extends: [.base, .export_path]
  script:
    - export TESTLOG="${TESTNAME##*/}"
    - source gvsoc_venv/bin/activate && make run MAGIA_RTL_DIR=$MAGIA platform=${platform} test=$TESTNAME tiles=${tiles} > $TESTLOG.log
    - ./scripts/sim_ret_errors_gvsoc.sh $TESTLOG.log
  artifacts:
    paths: [ "*.log" ]
    expire_in: 2 weeks

magia_v3_tiles_4_rtl_sim_spatz:
  extends: [.sim]
  stage: test_tiles_4_spatz
  variables:
    platform: rtl
    tiles: 4
  parallel:
    matrix:
      - TESTNAME: [test_helloworld, test_fsync_levels, test_fsync_rc, test_fsync_diag, test_mm_is, test_mm_ws, test_mm_os, test_idma_2d, test_idma_1d, test_cemm_global, test_mm_is_2, test_mm_os_2, test_mm_ws_2, test_fsync_lr, test_gemv, test_alloc, onnx_add, onnx_ceil, onnx_clip, onnx_floor, onnx_relu, onnx_sub]
  dependencies:
    - clone_magia
    - magia_v3_tiles_4
    - build_test_magia_v3_tiles_4_spatz


magia_v3_tiles_4_gvsoc_sim_spatz:
  extends: [.sim_gvsoc]
  stage: test_tiles_4_spatz
  variables:
    platform: gvsoc
    tiles: 4
  parallel:
    matrix:
      - TESTNAME: [test_helloworld, test_fsync_levels, test_fsync_rc, test_fsync_diag, test_mm_is, test_mm_ws, test_mm_os, test_idma_2d, test_idma_1d, test_cemm_global, test_mm_is_2, test_mm_os_2, test_mm_ws_2, test_fsync_lr, test_gemv, test_alloc, onnx_add, onnx_ceil, onnx_clip, onnx_div, onnx_floor, onnx_relu, onnx_sub]
  dependencies:
    - clone_magia
    - magia_v3_tiles_4
    - clone_gvsoc
    - gvsoc_tiles_4
    - build_test_magia_v3_tiles_4_spatz
    - python_gvsoc


magia_v3_tiles_1_rtl_sim_spatz:
  extends: [.sim]
  stage: test_tiles_1_spatz
  variables:
    platform: rtl
    tiles: 1
  parallel:
    matrix:
      - TESTNAME: [test_helloworld, test_fsync_levels, test_fsync_rc, test_fsync_diag, test_mm_is, test_mm_ws, test_mm_os, test_idma_2d, test_idma_1d, test_cemm_global, test_mm_is_2, test_mm_os_2, test_mm_ws_2, test_fsync_lr, test_gemv, test_alloc,  onnx_add, onnx_ceil, onnx_clip, onnx_floor, onnx_relu, onnx_sub]
  dependencies:
    - clone_magia
    - magia_v3_tiles_1
    - build_test_magia_v3_tiles_1_spatz


magia_v2_tiles_1_gvsoc_sim_spatz:
  extends: [.sim_gvsoc]
  stage: test_tiles_1_spatz
  variables:
    platform: gvsoc
    tiles: 1
  parallel:
    matrix:
      - TESTNAME: [test_helloworld, test_fsync_levels, test_fsync_rc, test_fsync_diag, test_mm_is, test_mm_ws, test_mm_os, test_idma_2d, test_idma_1d, test_cemm_global, test_mm_is_2, test_mm_os_2, test_mm_ws_2, test_fsync_lr, test_gemv, test_alloc, onnx_add, onnx_ceil, onnx_clip, onnx_div, onnx_floor, onnx_relu, onnx_sub]
  dependencies:
    - clone_magia
    - magia_v3_tiles_1
    - clone_gvsoc
    - gvsoc_tiles_1
    - build_test_magia_v3_tiles_1_spatz
    - python_gvsoc

magia_v3_tiles_4_rtl_sim_cluster:
  extends: [.sim]
  stage: test_tiles_4_cluster
  variables:
    platform: rtl
    tiles: 4
  parallel:
    matrix:
      - TESTNAME: [hello_pulp_2, multi_task]
  dependencies:
    - clone_magia
    - magia_v3_tiles_4
    - build_test_magia_v3_tiles_4_cluster


magia_v3_tiles_4_gvsoc_sim_cluster:
  extends: [.sim_gvsoc]
  stage: test_tiles_4_cluster
  variables:
    platform: gvsoc
    tiles: 4
  parallel:
    matrix:
      - TESTNAME: [hello_pulp_2, multi_task]
  dependencies:
    - clone_magia
    - magia_v3_tiles_4
    - clone_gvsoc
    - gvsoc_tiles_4
    - build_test_magia_v3_tiles_4_cluster
    - python_gvsoc


magia_v3_tiles_1_rtl_sim_cluster:
  extends: [.sim]
  stage: test_tiles_1_cluster
  variables:
    platform: rtl
    tiles: 1
  parallel:
    matrix:
      - TESTNAME: [hello_pulp_2, multi_task]
  dependencies:
    - clone_magia
    - magia_v3_tiles_1
    - build_test_magia_v3_tiles_1_cluster


magia_v2_tiles_1_gvsoc_sim_cluster:
  extends: [.sim_gvsoc]
  stage: test_tiles_1_cluster
  variables:
    platform: gvsoc
    tiles: 1
  parallel:
    matrix:
      - TESTNAME: [hello_pulp_2, multi_task]
  dependencies:
    - clone_magia
    - magia_v3_tiles_1
    - clone_gvsoc
    - gvsoc_tiles_1
    - build_test_magia_v3_tiles_1_cluster
    - python_gvsoc

magia_v3_tiles_4_rtl_sim_spatz+cluster:
  extends: [.sim]
  stage: test_tiles_4_spatz+cluster
  variables:
    platform: rtl
    tiles: 4
  parallel:
    matrix:
      - TESTNAME: [hello_spatz_pulp_2, multi_task]
  dependencies:
    - clone_magia
    - magia_v3_tiles_4
    - build_test_magia_v3_tiles_4_spatz+cluster


magia_v3_tiles_4_gvsoc_sim_spatz+cluster:
  extends: [.sim_gvsoc]
  stage: test_tiles_4_spatz+cluster
  variables:
    platform: gvsoc
    tiles: 4
  parallel:
    matrix:
      - TESTNAME: [hello_spatz_pulp_2, multi_task]
  dependencies:
    - clone_magia
    - magia_v3_tiles_4
    - clone_gvsoc
    - gvsoc_tiles_4
    - build_test_magia_v3_tiles_4_spatz+cluster
    - python_gvsoc


magia_v3_tiles_1_rtl_sim_spatz+cluster:
  extends: [.sim]
  stage: test_tiles_1_spatz+cluster
  variables:
    platform: rtl
    tiles: 1
  parallel:
    matrix:
      - TESTNAME: [hello_spatz_pulp_2, multi_task]
  dependencies:
    - clone_magia
    - magia_v3_tiles_1
    - build_test_magia_v3_tiles_1_spatz+cluster


magia_v2_tiles_1_gvsoc_sim_spatz+cluster:
  extends: [.sim_gvsoc]
  stage: test_tiles_1_spatz+cluster
  variables:
    platform: gvsoc
    tiles: 1
  parallel:
    matrix:
      - TESTNAME: [hello_spatz_pulp_2, multi_task]
  dependencies:
    - clone_magia
    - magia_v3_tiles_1
    - clone_gvsoc
    - gvsoc_tiles_1
    - build_test_magia_v3_tiles_1_spatz+cluster
    - python_gvsoc

cleanup:
  stage: postscript
  when: always
  script:
    - test -n "$CI_PIPELINE_ID"
    - rm -rf "$CI_BUILDS_DIR"/*/"$CI_PIPELINE_ID" || true