You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tvm.apache.org by GitBox <gi...@apache.org> on 2022/11/11 22:29:53 UTC
[GitHub] [tvm] gigiblender commented on a diff in pull request #13300: [ci] Split Jenkinsfile into platform-specific jobs
gigiblender commented on code in PR #13300:
URL: https://github.com/apache/tvm/pull/13300#discussion_r1020333114
##########
ci/jenkins/generate.py:
##########
@@ -133,36 +99,44 @@ def change_type(lines: List[str]) -> Change:
return Change.FULL
-if __name__ == "__main__":
- help = "Regenerate Jenkinsfile from template"
- parser = argparse.ArgumentParser(description=help)
- parser.add_argument("--force", action="store_true", help="always overwrite timestamp")
- parser.add_argument("--check", action="store_true", help="just verify the output didn't change")
- args = parser.parse_args()
-
- with open(JENKINSFILE) as f:
- content = f.read()
+def update_jenkinsfile(source: Path) -> ChangeData:
+ destination = JENKINS_DIR / "generated" / source.stem
Review Comment:
Use `GENERATED_DIR` instead?
##########
ci/jenkins/generated/arm_jenkinsfile.groovy:
##########
@@ -0,0 +1,1042 @@
+#!groovy
+// -*- mode: groovy -*-
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Jenkins pipeline
+// See documents at https://jenkins.io/doc/book/pipeline/jenkinsfile/
+
+// Docker env used for testing
+// Different image may have different version tag
+// because some of them are more stable than anoter.
+//
+// Docker images are maintained by PMC, cached in dockerhub
+// and remains relatively stable over the time.
+// Flow for upgrading docker env(need commiter)
+//
+// - Send PR to upgrade build script in the repo
+// - Build the new docker image
+// - Tag the docker image with a new version and push to a binary cache.
+// - Update the version in the Jenkinsfile, send a PR
+// - Fix any issues wrt to the new image version in the PR
+// - Merge the PR and now we are in new version
+// - Tag the new version as the lates
+// - Periodically cleanup the old versions on local workers
+//
+
+// ============================= IMPORTANT NOTE =============================
+// This file is generated by 'jenkins/generate.py'. Do not edit this file directly!
+// Make edits to 'jenkins/Jenkinsfile.j2' and regenerate this with
+// 'python3 jenkins/generate.py'
+// Note: This timestamp is here to ensure that updates to the Jenkinsfile are
+// always rebased on main before merging:
+// Generated at 2022-11-03T15:11:02.702503
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+// NOTE: these lines are scanned by docker/dev_common.sh. Please update the regex as needed. -->
+ci_lint = 'tlcpack/ci-lint:20221013-060115-61c9742ea'
+ci_gpu = 'tlcpack/ci-gpu:20221019-060125-0b4836739'
+ci_cpu = 'tlcpack/ci-cpu:20221013-060115-61c9742ea'
+ci_minimal = 'tlcpack/ci-minimal:20221013-060115-61c9742ea'
+ci_wasm = 'tlcpack/ci-wasm:20221013-060115-61c9742ea'
+ci_i386 = 'tlcpack/ci-i386:20221013-060115-61c9742ea'
+ci_cortexm = 'tlcpack/ci-cortexm:20221013-060115-61c9742ea'
+ci_arm = 'tlcpack/ci-arm:20221013-060115-61c9742ea'
+ci_hexagon = 'tlcpack/ci-hexagon:20221013-060115-61c9742ea'
+ci_riscv = 'tlcpack/ci-riscv:20221013-060115-61c9742ea'
+// <--- End of regex-scanned config.
+
+// Parameters to allow overriding (in Jenkins UI), the images
+// to be used by a given build. When provided, they take precedence
+// over default values above.
+properties([
+ parameters([
+ string(name: 'ci_arm_param', defaultValue: ''),
+ string(name: 'ci_cortexm_param', defaultValue: ''),
+ string(name: 'ci_cpu_param', defaultValue: ''),
+ string(name: 'ci_gpu_param', defaultValue: ''),
+ string(name: 'ci_hexagon_param', defaultValue: ''),
+ string(name: 'ci_i386_param', defaultValue: ''),
+ string(name: 'ci_lint_param', defaultValue: ''),
+ string(name: 'ci_minimal_param', defaultValue: ''),
+ string(name: 'ci_riscv_param', defaultValue: ''),
+ string(name: 'ci_wasm_param', defaultValue: ''),
+ ])
+])
+
+// Placeholders for newly built Docker image names (if rebuild_docker_images
+// is used)
+ built_ci_arm = null;
+ built_ci_cortexm = null;
+ built_ci_cpu = null;
+ built_ci_gpu = null;
+ built_ci_hexagon = null;
+ built_ci_i386 = null;
+ built_ci_lint = null;
+ built_ci_minimal = null;
+ built_ci_riscv = null;
+ built_ci_wasm = null;
+
+// Global variable assigned during Sanity Check that holds the sha1 which should be
+// merged into the PR in all branches.
+upstream_revision = null
+
+// command to start a docker container
+docker_run = 'docker/bash.sh --env CI --env TVM_SHARD_INDEX --env TVM_NUM_SHARDS --env RUN_DISPLAY_URL --env PLATFORM --env SKIP_SLOW_TESTS --env TEST_STEP_NAME'
+docker_build = 'docker/build.sh'
+// timeout in minutes
+max_time = 180
+rebuild_docker_images = false
+
+s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
+
+// General note: Jenkins has limits on the size of a method (or top level code)
+// that are pretty strict, so most usage of groovy methods in these templates
+// are purely to satisfy the JVM
+def per_exec_ws(folder) {
+ return "workspace/exec_${env.EXECUTOR_NUMBER}/" + folder
+}
+
+// initialize source codes
+def init_git() {
+ retry(5) {
+ checkout scm
+ }
+
+ // Add more info about job node
+ sh (
+ script: './tests/scripts/task_show_node_info.sh',
+ label: 'Show executor node info',
+ )
+
+ // Determine merge commit to use for all stages
+ sh (
+ script: 'git fetch origin main',
+ label: 'Fetch upstream',
+ )
+ if (upstream_revision == null) {
+ upstream_revision = sh(
+ script: 'git log -1 FETCH_HEAD --format=\'%H\'',
+ label: 'Determine upstream revision',
+ returnStdout: true,
+ ).trim()
+ }
+ sh (
+ script: "git -c user.name=TVM-Jenkins -c user.email=jenkins@tvm.apache.org merge ${upstream_revision}",
+ label: 'Merge to origin/main'
+ )
+
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 3 timeout 5m git submodule update --init -f --jobs 0
+ """,
+ label: 'Update git submodules',
+ )
+ checkout_trusted_files()
+}
+
+def docker_init(image) {
+ // Clear out all Docker images that aren't going to be used
+ sh(
+ script: """
+ set -eux
+ docker image ls --all
+ IMAGES=\$(docker image ls --all --format '{{.Repository}}:{{.Tag}} {{.ID}}')
+
+ echo -e "Found images:\\n\$IMAGES"
+ echo "\$IMAGES" | { grep -vE '${image}' || test \$? = 1; } | { xargs docker rmi || test \$? = 123; }
+
+ docker image ls --all
+ """,
+ label: 'Clean old Docker images',
+ )
+
+ if (image.contains("amazonaws.com")) {
+ // If this string is in the image name it's from ECR and needs to be pulled
+ // with the right credentials
+ ecr_pull(image)
+ } else {
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${image}
+ """,
+ label: 'Pull docker image',
+ )
+ }
+}
+
+def should_skip_slow_tests(pr_number) {
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run slow tests, exit code of 0 means skip slow tests
+ result = sh (
+ returnStatus: true,
+ script: "./ci/scripts/should_run_slow_tests.py --pr '${pr_number}'",
+ label: 'Check if CI should run slow tests',
+ )
+ }
+ return result == 0
+}
+
+def cancel_previous_build() {
+ // cancel previous build if it is not on main.
+ if (env.BRANCH_NAME != 'main') {
+ def buildNumber = env.BUILD_NUMBER as int
+ // Milestone API allows us to cancel previous build
+ // with the same milestone number
+ if (buildNumber > 1) milestone(buildNumber - 1)
+ milestone(buildNumber)
+ }
+}
+
+def checkout_trusted_files() {
+ // trust everything from branch builds
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ return;
+ }
+
+ // trust peoople listed in CONTRIBUTING.md
+ grep_code = sh(
+ returnStatus: true,
+ script: "git show '${upstream_revision}:CONTRIBUTORS.md' | grep '@${env.CHANGE_AUTHOR}'",
+ label: 'Check if change is from a contributor',
+ )
+
+ if (grep_code == 1) {
+ // Any scripts that run on the bare host and not inside a Docker container
+ // (especially those that access secrets) should be checked out here so
+ // only trusted versions are used in CI
+ sh(
+ script: "git checkout ${upstream_revision} ci/scripts/.",
+ label: 'Check out trusted files',
+ )
+ }
+}
+
+def should_skip_ci(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ glob_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci_globs.py",
+ label: 'Check if CI should be skipped due to changed files',
+ )
+ if (glob_skip_ci_code == 0) {
+ return true
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run full CI (or the script had an error, so run
+ // full CI just in case). Exit code of 0 means skip CI.
+ git_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci.py --pr '${pr_number}'",
+ label: 'Check if CI should be skipped',
+ )
+ }
+ return git_skip_ci_code == 0
+}
+
+def check_pr(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ sh (
+ script: "python3 ci/scripts/check_pr.py --pr ${pr_number}",
+ label: 'Check PR title and body',
+ )
+ }
+
+}
+
+def prepare() {
+ stage('Prepare') {
+ node('CPU-SMALL') {
+ ws("workspace/exec_${env.EXECUTOR_NUMBER}/tvm/prepare") {
+ init_git()
+
+ check_pr(env.CHANGE_ID)
+
+ if (env.DETERMINE_DOCKER_IMAGES == 'yes') {
+ sh(
+ script: "./ci/scripts/determine_docker_images.py ci_arm=${ci_arm} ci_cortexm=${ci_cortexm} ci_cpu=${ci_cpu} ci_gpu=${ci_gpu} ci_hexagon=${ci_hexagon} ci_i386=${ci_i386} ci_lint=${ci_lint} ci_minimal=${ci_minimal} ci_riscv=${ci_riscv} ci_wasm=${ci_wasm} ",
+ label: 'Decide whether to use tlcpack or tlcpackstaging for Docker images',
+ )
+ // Pull image names from the results of should_rebuild_docker.py
+ ci_arm = sh(
+ script: "cat .docker-image-names/ci_arm",
+ label: "Find docker image name for ci_arm",
+ returnStdout: true,
+ ).trim()
+ ci_cortexm = sh(
+ script: "cat .docker-image-names/ci_cortexm",
+ label: "Find docker image name for ci_cortexm",
+ returnStdout: true,
+ ).trim()
+ ci_cpu = sh(
+ script: "cat .docker-image-names/ci_cpu",
+ label: "Find docker image name for ci_cpu",
+ returnStdout: true,
+ ).trim()
+ ci_gpu = sh(
+ script: "cat .docker-image-names/ci_gpu",
+ label: "Find docker image name for ci_gpu",
+ returnStdout: true,
+ ).trim()
+ ci_hexagon = sh(
+ script: "cat .docker-image-names/ci_hexagon",
+ label: "Find docker image name for ci_hexagon",
+ returnStdout: true,
+ ).trim()
+ ci_i386 = sh(
+ script: "cat .docker-image-names/ci_i386",
+ label: "Find docker image name for ci_i386",
+ returnStdout: true,
+ ).trim()
+ ci_lint = sh(
+ script: "cat .docker-image-names/ci_lint",
+ label: "Find docker image name for ci_lint",
+ returnStdout: true,
+ ).trim()
+ ci_minimal = sh(
+ script: "cat .docker-image-names/ci_minimal",
+ label: "Find docker image name for ci_minimal",
+ returnStdout: true,
+ ).trim()
+ ci_riscv = sh(
+ script: "cat .docker-image-names/ci_riscv",
+ label: "Find docker image name for ci_riscv",
+ returnStdout: true,
+ ).trim()
+ ci_wasm = sh(
+ script: "cat .docker-image-names/ci_wasm",
+ label: "Find docker image name for ci_wasm",
+ returnStdout: true,
+ ).trim()
+ }
+
+ ci_arm = params.ci_arm_param ?: ci_arm
+ ci_cortexm = params.ci_cortexm_param ?: ci_cortexm
+ ci_cpu = params.ci_cpu_param ?: ci_cpu
+ ci_gpu = params.ci_gpu_param ?: ci_gpu
+ ci_hexagon = params.ci_hexagon_param ?: ci_hexagon
+ ci_i386 = params.ci_i386_param ?: ci_i386
+ ci_lint = params.ci_lint_param ?: ci_lint
+ ci_minimal = params.ci_minimal_param ?: ci_minimal
+ ci_riscv = params.ci_riscv_param ?: ci_riscv
+ ci_wasm = params.ci_wasm_param ?: ci_wasm
+
+ sh (script: """
+ echo "Docker images being used in this build:"
+ echo " ci_arm = ${ci_arm}"
+ echo " ci_cortexm = ${ci_cortexm}"
+ echo " ci_cpu = ${ci_cpu}"
+ echo " ci_gpu = ${ci_gpu}"
+ echo " ci_hexagon = ${ci_hexagon}"
+ echo " ci_i386 = ${ci_i386}"
+ echo " ci_lint = ${ci_lint}"
+ echo " ci_minimal = ${ci_minimal}"
+ echo " ci_riscv = ${ci_riscv}"
+ echo " ci_wasm = ${ci_wasm}"
+ """, label: 'Docker image names')
+
+ is_docs_only_build = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docs.sh',
+ label: 'Check for docs only changes',
+ )
+ skip_ci = should_skip_ci(env.CHANGE_ID)
+ skip_slow_tests = should_skip_slow_tests(env.CHANGE_ID)
+ rebuild_docker_images = sh (
Review Comment:
I can see `rebuild_docker_images` is set and never used in all the generated Jenkins files except the docker one. I don't think this is a particular issue at the moment. Even though it would be nice to have only the current image name used (`ci_arm` in this case).
However, it makes me wonder if having a separate job for building the docker images allows for a race between a job trying to pull a docker image and the `docker_jenkisfile` building a new docker image.
Should we maybe have instead each platform (arm, cpu, gpu ...) build its own image if needed?
##########
ci/jenkins/generated/lint_jenkinsfile.groovy:
##########
@@ -0,0 +1,513 @@
+#!groovy
+// -*- mode: groovy -*-
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Jenkins pipeline
+// See documents at https://jenkins.io/doc/book/pipeline/jenkinsfile/
+
+// Docker env used for testing
+// Different image may have different version tag
+// because some of them are more stable than anoter.
+//
+// Docker images are maintained by PMC, cached in dockerhub
+// and remains relatively stable over the time.
+// Flow for upgrading docker env(need commiter)
+//
+// - Send PR to upgrade build script in the repo
+// - Build the new docker image
+// - Tag the docker image with a new version and push to a binary cache.
+// - Update the version in the Jenkinsfile, send a PR
+// - Fix any issues wrt to the new image version in the PR
+// - Merge the PR and now we are in new version
+// - Tag the new version as the lates
+// - Periodically cleanup the old versions on local workers
+//
+
+// ============================= IMPORTANT NOTE =============================
+// This file is generated by 'jenkins/generate.py'. Do not edit this file directly!
+// Make edits to 'jenkins/Jenkinsfile.j2' and regenerate this with
+// 'python3 jenkins/generate.py'
+// Note: This timestamp is here to ensure that updates to the Jenkinsfile are
+// always rebased on main before merging:
+// Generated at 2022-11-03T15:09:47.665751
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+// NOTE: these lines are scanned by docker/dev_common.sh. Please update the regex as needed. -->
+ci_lint = 'tlcpack/ci-lint:20221013-060115-61c9742ea'
+ci_gpu = 'tlcpack/ci-gpu:20221019-060125-0b4836739'
+ci_cpu = 'tlcpack/ci-cpu:20221013-060115-61c9742ea'
+ci_minimal = 'tlcpack/ci-minimal:20221013-060115-61c9742ea'
+ci_wasm = 'tlcpack/ci-wasm:20221013-060115-61c9742ea'
+ci_i386 = 'tlcpack/ci-i386:20221013-060115-61c9742ea'
+ci_cortexm = 'tlcpack/ci-cortexm:20221013-060115-61c9742ea'
+ci_arm = 'tlcpack/ci-arm:20221013-060115-61c9742ea'
+ci_hexagon = 'tlcpack/ci-hexagon:20221013-060115-61c9742ea'
+ci_riscv = 'tlcpack/ci-riscv:20221013-060115-61c9742ea'
+// <--- End of regex-scanned config.
+
+// Parameters to allow overriding (in Jenkins UI), the images
+// to be used by a given build. When provided, they take precedence
+// over default values above.
+properties([
+ parameters([
+ string(name: 'ci_arm_param', defaultValue: ''),
+ string(name: 'ci_cortexm_param', defaultValue: ''),
+ string(name: 'ci_cpu_param', defaultValue: ''),
+ string(name: 'ci_gpu_param', defaultValue: ''),
+ string(name: 'ci_hexagon_param', defaultValue: ''),
+ string(name: 'ci_i386_param', defaultValue: ''),
+ string(name: 'ci_lint_param', defaultValue: ''),
+ string(name: 'ci_minimal_param', defaultValue: ''),
+ string(name: 'ci_riscv_param', defaultValue: ''),
+ string(name: 'ci_wasm_param', defaultValue: ''),
+ ])
+])
+
+// Placeholders for newly built Docker image names (if rebuild_docker_images
+// is used)
+ built_ci_arm = null;
+ built_ci_cortexm = null;
+ built_ci_cpu = null;
+ built_ci_gpu = null;
+ built_ci_hexagon = null;
+ built_ci_i386 = null;
+ built_ci_lint = null;
+ built_ci_minimal = null;
+ built_ci_riscv = null;
+ built_ci_wasm = null;
+
+// Global variable assigned during Sanity Check that holds the sha1 which should be
+// merged into the PR in all branches.
+upstream_revision = null
+
+// command to start a docker container
+docker_run = 'docker/bash.sh --env CI --env TVM_SHARD_INDEX --env TVM_NUM_SHARDS --env RUN_DISPLAY_URL --env PLATFORM --env SKIP_SLOW_TESTS --env TEST_STEP_NAME'
+docker_build = 'docker/build.sh'
+// timeout in minutes
+max_time = 180
+rebuild_docker_images = false
+
+s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
+
+// General note: Jenkins has limits on the size of a method (or top level code)
+// that are pretty strict, so most usage of groovy methods in these templates
+// are purely to satisfy the JVM
+def per_exec_ws(folder) {
+ return "workspace/exec_${env.EXECUTOR_NUMBER}/" + folder
+}
+
+// initialize source codes
+def init_git() {
+ retry(5) {
+ checkout scm
+ }
+
+ // Add more info about job node
+ sh (
+ script: './tests/scripts/task_show_node_info.sh',
+ label: 'Show executor node info',
+ )
+
+ // Determine merge commit to use for all stages
+ sh (
+ script: 'git fetch origin main',
+ label: 'Fetch upstream',
+ )
+ if (upstream_revision == null) {
+ upstream_revision = sh(
+ script: 'git log -1 FETCH_HEAD --format=\'%H\'',
+ label: 'Determine upstream revision',
+ returnStdout: true,
+ ).trim()
+ }
+ sh (
+ script: "git -c user.name=TVM-Jenkins -c user.email=jenkins@tvm.apache.org merge ${upstream_revision}",
+ label: 'Merge to origin/main'
+ )
+
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 3 timeout 5m git submodule update --init -f --jobs 0
+ """,
+ label: 'Update git submodules',
+ )
+ checkout_trusted_files()
+}
+
+def docker_init(image) {
+ // Clear out all Docker images that aren't going to be used
+ sh(
+ script: """
+ set -eux
+ docker image ls --all
+ IMAGES=\$(docker image ls --all --format '{{.Repository}}:{{.Tag}} {{.ID}}')
+
+ echo -e "Found images:\\n\$IMAGES"
+ echo "\$IMAGES" | { grep -vE '${image}' || test \$? = 1; } | { xargs docker rmi || test \$? = 123; }
+
+ docker image ls --all
+ """,
+ label: 'Clean old Docker images',
+ )
+
+ if (image.contains("amazonaws.com")) {
+ // If this string is in the image name it's from ECR and needs to be pulled
+ // with the right credentials
+ ecr_pull(image)
+ } else {
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${image}
+ """,
+ label: 'Pull docker image',
+ )
+ }
+}
+
+def should_skip_slow_tests(pr_number) {
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run slow tests, exit code of 0 means skip slow tests
+ result = sh (
+ returnStatus: true,
+ script: "./ci/scripts/should_run_slow_tests.py --pr '${pr_number}'",
+ label: 'Check if CI should run slow tests',
+ )
+ }
+ return result == 0
+}
+
+def cancel_previous_build() {
+ // cancel previous build if it is not on main.
+ if (env.BRANCH_NAME != 'main') {
+ def buildNumber = env.BUILD_NUMBER as int
+ // Milestone API allows us to cancel previous build
+ // with the same milestone number
+ if (buildNumber > 1) milestone(buildNumber - 1)
+ milestone(buildNumber)
+ }
+}
+
+def checkout_trusted_files() {
+ // trust everything from branch builds
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ return;
+ }
+
+ // trust peoople listed in CONTRIBUTING.md
+ grep_code = sh(
+ returnStatus: true,
+ script: "git show '${upstream_revision}:CONTRIBUTORS.md' | grep '@${env.CHANGE_AUTHOR}'",
+ label: 'Check if change is from a contributor',
+ )
+
+ if (grep_code == 1) {
+ // Any scripts that run on the bare host and not inside a Docker container
+ // (especially those that access secrets) should be checked out here so
+ // only trusted versions are used in CI
+ sh(
+ script: "git checkout ${upstream_revision} ci/scripts/.",
+ label: 'Check out trusted files',
+ )
+ }
+}
+
+def should_skip_ci(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ glob_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci_globs.py",
+ label: 'Check if CI should be skipped due to changed files',
+ )
+ if (glob_skip_ci_code == 0) {
+ return true
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run full CI (or the script had an error, so run
+ // full CI just in case). Exit code of 0 means skip CI.
+ git_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci.py --pr '${pr_number}'",
+ label: 'Check if CI should be skipped',
+ )
+ }
+ return git_skip_ci_code == 0
+}
+
+def check_pr(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ sh (
+ script: "python3 ci/scripts/check_pr.py --pr ${pr_number}",
+ label: 'Check PR title and body',
+ )
+ }
+
+}
+
+def prepare() {
+ stage('Prepare') {
+ node('CPU-SMALL') {
+ ws("workspace/exec_${env.EXECUTOR_NUMBER}/tvm/prepare") {
+ init_git()
+
+ check_pr(env.CHANGE_ID)
+
+ if (env.DETERMINE_DOCKER_IMAGES == 'yes') {
+ sh(
+ script: "./ci/scripts/determine_docker_images.py ci_arm=${ci_arm} ci_cortexm=${ci_cortexm} ci_cpu=${ci_cpu} ci_gpu=${ci_gpu} ci_hexagon=${ci_hexagon} ci_i386=${ci_i386} ci_lint=${ci_lint} ci_minimal=${ci_minimal} ci_riscv=${ci_riscv} ci_wasm=${ci_wasm} ",
+ label: 'Decide whether to use tlcpack or tlcpackstaging for Docker images',
+ )
+ // Pull image names from the results of should_rebuild_docker.py
+ ci_arm = sh(
+ script: "cat .docker-image-names/ci_arm",
+ label: "Find docker image name for ci_arm",
+ returnStdout: true,
+ ).trim()
+ ci_cortexm = sh(
+ script: "cat .docker-image-names/ci_cortexm",
+ label: "Find docker image name for ci_cortexm",
+ returnStdout: true,
+ ).trim()
+ ci_cpu = sh(
+ script: "cat .docker-image-names/ci_cpu",
+ label: "Find docker image name for ci_cpu",
+ returnStdout: true,
+ ).trim()
+ ci_gpu = sh(
+ script: "cat .docker-image-names/ci_gpu",
+ label: "Find docker image name for ci_gpu",
+ returnStdout: true,
+ ).trim()
+ ci_hexagon = sh(
+ script: "cat .docker-image-names/ci_hexagon",
+ label: "Find docker image name for ci_hexagon",
+ returnStdout: true,
+ ).trim()
+ ci_i386 = sh(
+ script: "cat .docker-image-names/ci_i386",
+ label: "Find docker image name for ci_i386",
+ returnStdout: true,
+ ).trim()
+ ci_lint = sh(
+ script: "cat .docker-image-names/ci_lint",
+ label: "Find docker image name for ci_lint",
+ returnStdout: true,
+ ).trim()
+ ci_minimal = sh(
+ script: "cat .docker-image-names/ci_minimal",
+ label: "Find docker image name for ci_minimal",
+ returnStdout: true,
+ ).trim()
+ ci_riscv = sh(
+ script: "cat .docker-image-names/ci_riscv",
+ label: "Find docker image name for ci_riscv",
+ returnStdout: true,
+ ).trim()
+ ci_wasm = sh(
+ script: "cat .docker-image-names/ci_wasm",
+ label: "Find docker image name for ci_wasm",
+ returnStdout: true,
+ ).trim()
+ }
+
+ ci_arm = params.ci_arm_param ?: ci_arm
+ ci_cortexm = params.ci_cortexm_param ?: ci_cortexm
+ ci_cpu = params.ci_cpu_param ?: ci_cpu
+ ci_gpu = params.ci_gpu_param ?: ci_gpu
+ ci_hexagon = params.ci_hexagon_param ?: ci_hexagon
+ ci_i386 = params.ci_i386_param ?: ci_i386
+ ci_lint = params.ci_lint_param ?: ci_lint
+ ci_minimal = params.ci_minimal_param ?: ci_minimal
+ ci_riscv = params.ci_riscv_param ?: ci_riscv
+ ci_wasm = params.ci_wasm_param ?: ci_wasm
+
+ sh (script: """
+ echo "Docker images being used in this build:"
+ echo " ci_arm = ${ci_arm}"
+ echo " ci_cortexm = ${ci_cortexm}"
+ echo " ci_cpu = ${ci_cpu}"
+ echo " ci_gpu = ${ci_gpu}"
+ echo " ci_hexagon = ${ci_hexagon}"
+ echo " ci_i386 = ${ci_i386}"
+ echo " ci_lint = ${ci_lint}"
+ echo " ci_minimal = ${ci_minimal}"
+ echo " ci_riscv = ${ci_riscv}"
+ echo " ci_wasm = ${ci_wasm}"
+ """, label: 'Docker image names')
+
+ is_docs_only_build = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docs.sh',
+ label: 'Check for docs only changes',
+ )
+ skip_ci = should_skip_ci(env.CHANGE_ID)
+ skip_slow_tests = should_skip_slow_tests(env.CHANGE_ID)
+ rebuild_docker_images = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docker.sh',
+ label: 'Check for any docker changes',
+ )
+
+ if (skip_ci) {
+ // Don't rebuild when skipping CI
+ rebuild_docker_images = false
+ }
+ }
+ }
+ }
+}
+def ci_setup(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_ci_setup.sh",
+ label: 'Set up CI environment',
+ )
+}
+
+def python_unittest(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_unittest.sh",
+ label: 'Run Python unit tests',
+ )
+}
+
+def fsim_test(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_vta_fsim.sh",
+ label: 'Run VTA tests in FSIM',
+ )
+}
+
+def cmake_build(image, path, make_flag) {
+ sh (
+ script: "${docker_run} --env CI_NUM_EXECUTORS ${image} ./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod",
+ label: 'Run cmake build',
+ )
+}
+
+def cpp_unittest(image) {
+ sh (
+ script: "${docker_run} --env CI_NUM_EXECUTORS ${image} ./tests/scripts/task_cpp_unittest.sh",
+ label: 'Build and run C++ tests',
+ )
+}
+
+def add_microtvm_permissions() {
+ sh(
+ script: 'find build/microtvm_template_projects -type f | grep qemu-hack | xargs chmod +x',
+ label: 'Add execute permissions for microTVM files',
+ )
+}
+
+def add_hexagon_permissions() {
+ sh(
+ script: 'find build/hexagon_api_output -type f | xargs chmod +x',
+ label: 'Add execute permissions for hexagon files',
+ )
+}
+
+// Run make. First try to do an incremental make from a previous workspace in hope to
+// accelerate the compilation. If something is wrong, clean the workspace and then
+// build from scratch.
+def make(docker_type, path, make_flag) {
+ timeout(time: max_time, unit: 'MINUTES') {
+ try {
+ cmake_build(docker_type, path, make_flag)
+ } catch (hudson.AbortException ae) {
+ // script exited due to user abort, directly throw instead of retry
+ if (ae.getMessage().contains('script returned exit code 143')) {
+ throw ae
+ }
+ echo 'Incremental compilation failed. Fall back to build from scratch'
+ sh (
+ script: "${docker_run} ${docker_type} ./tests/scripts/task_clean.sh ${path}",
+ label: 'Clear old cmake workspace',
+ )
+ cmake_build(docker_type, path, make_flag)
+ }
+ }
+}
+
+
+cancel_previous_build()
+
+prepare()
+
+stage('Lint') {
Review Comment:
This stage is also defined outside of a method
##########
ci/jenkins/generate.py:
##########
@@ -173,17 +147,30 @@ def change_type(lines: List[str]) -> Change:
diff = "".join(diff)
+ return ChangeData(diff=diff, content=new_content, source=source, destination=destination)
+
+
+if __name__ == "__main__":
+ help = "Regenerate Jenkinsfile from template"
+ parser = argparse.ArgumentParser(description=help)
+ parser.add_argument("--force", action="store_true", help="always overwrite timestamp")
+ parser.add_argument("--check", action="store_true", help="just verify the output didn't change")
+ args = parser.parse_args()
+
+ sources = TEMPLATES_DIR.glob("*jenkinsfile.groovy.j2")
+ changes = [update_jenkinsfile(source) for source in sources if source.name != "base.groovy.j2"]
+
if args.check:
- if not diff:
- print("Success, the newly generated Jenkinsfile matched the one on disk")
+ if all(not data.diff for data in changes):
+ print("Success, the newly generated Jenkinsfiles matched the ones on disk")
exit(0)
else:
print(
textwrap.dedent(
"""
- Newly generated Jenkinsfile did not match the one on disk! If you have made
- edits to the Jenkinsfile, move them to 'jenkins/Jenkinsfile.j2' and
- regenerate the Jenkinsfile from the template with
+ Newly generated Jenkinsfiles did not match the ones on disk! If you have made
+ edits to the Jenkinsfiles in genrated/, move them to the corresponding source and
Review Comment:
`genrated` -> `generated`
##########
ci/jenkins/generated/arm_jenkinsfile.groovy:
##########
@@ -0,0 +1,1042 @@
+#!groovy
+// -*- mode: groovy -*-
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Jenkins pipeline
+// See documents at https://jenkins.io/doc/book/pipeline/jenkinsfile/
+
+// Docker env used for testing
+// Different image may have different version tag
+// because some of them are more stable than anoter.
+//
+// Docker images are maintained by PMC, cached in dockerhub
+// and remains relatively stable over the time.
+// Flow for upgrading docker env(need commiter)
+//
+// - Send PR to upgrade build script in the repo
+// - Build the new docker image
+// - Tag the docker image with a new version and push to a binary cache.
+// - Update the version in the Jenkinsfile, send a PR
+// - Fix any issues wrt to the new image version in the PR
+// - Merge the PR and now we are in new version
+// - Tag the new version as the lates
+// - Periodically cleanup the old versions on local workers
+//
+
+// ============================= IMPORTANT NOTE =============================
+// This file is generated by 'jenkins/generate.py'. Do not edit this file directly!
+// Make edits to 'jenkins/Jenkinsfile.j2' and regenerate this with
+// 'python3 jenkins/generate.py'
+// Note: This timestamp is here to ensure that updates to the Jenkinsfile are
+// always rebased on main before merging:
+// Generated at 2022-11-03T15:11:02.702503
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+// NOTE: these lines are scanned by docker/dev_common.sh. Please update the regex as needed. -->
+ci_lint = 'tlcpack/ci-lint:20221013-060115-61c9742ea'
+ci_gpu = 'tlcpack/ci-gpu:20221019-060125-0b4836739'
+ci_cpu = 'tlcpack/ci-cpu:20221013-060115-61c9742ea'
+ci_minimal = 'tlcpack/ci-minimal:20221013-060115-61c9742ea'
+ci_wasm = 'tlcpack/ci-wasm:20221013-060115-61c9742ea'
+ci_i386 = 'tlcpack/ci-i386:20221013-060115-61c9742ea'
+ci_cortexm = 'tlcpack/ci-cortexm:20221013-060115-61c9742ea'
+ci_arm = 'tlcpack/ci-arm:20221013-060115-61c9742ea'
+ci_hexagon = 'tlcpack/ci-hexagon:20221013-060115-61c9742ea'
+ci_riscv = 'tlcpack/ci-riscv:20221013-060115-61c9742ea'
+// <--- End of regex-scanned config.
+
+// Parameters to allow overriding (in Jenkins UI), the images
+// to be used by a given build. When provided, they take precedence
+// over default values above.
+properties([
+ parameters([
+ string(name: 'ci_arm_param', defaultValue: ''),
+ string(name: 'ci_cortexm_param', defaultValue: ''),
+ string(name: 'ci_cpu_param', defaultValue: ''),
+ string(name: 'ci_gpu_param', defaultValue: ''),
+ string(name: 'ci_hexagon_param', defaultValue: ''),
+ string(name: 'ci_i386_param', defaultValue: ''),
+ string(name: 'ci_lint_param', defaultValue: ''),
+ string(name: 'ci_minimal_param', defaultValue: ''),
+ string(name: 'ci_riscv_param', defaultValue: ''),
+ string(name: 'ci_wasm_param', defaultValue: ''),
+ ])
+])
+
+// Placeholders for newly built Docker image names (if rebuild_docker_images
+// is used)
+ built_ci_arm = null;
+ built_ci_cortexm = null;
+ built_ci_cpu = null;
+ built_ci_gpu = null;
+ built_ci_hexagon = null;
+ built_ci_i386 = null;
+ built_ci_lint = null;
+ built_ci_minimal = null;
+ built_ci_riscv = null;
+ built_ci_wasm = null;
+
+// Global variable assigned during Sanity Check that holds the sha1 which should be
+// merged into the PR in all branches.
+upstream_revision = null
+
+// command to start a docker container
+docker_run = 'docker/bash.sh --env CI --env TVM_SHARD_INDEX --env TVM_NUM_SHARDS --env RUN_DISPLAY_URL --env PLATFORM --env SKIP_SLOW_TESTS --env TEST_STEP_NAME'
+docker_build = 'docker/build.sh'
+// timeout in minutes
+max_time = 180
+rebuild_docker_images = false
+
+s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
+
+// General note: Jenkins has limits on the size of a method (or top level code)
+// that are pretty strict, so most usage of groovy methods in these templates
+// are purely to satisfy the JVM
+def per_exec_ws(folder) {
+ return "workspace/exec_${env.EXECUTOR_NUMBER}/" + folder
+}
+
+// initialize source codes
+def init_git() {
+ retry(5) {
+ checkout scm
+ }
+
+ // Add more info about job node
+ sh (
+ script: './tests/scripts/task_show_node_info.sh',
+ label: 'Show executor node info',
+ )
+
+ // Determine merge commit to use for all stages
+ sh (
+ script: 'git fetch origin main',
+ label: 'Fetch upstream',
+ )
+ if (upstream_revision == null) {
+ upstream_revision = sh(
+ script: 'git log -1 FETCH_HEAD --format=\'%H\'',
+ label: 'Determine upstream revision',
+ returnStdout: true,
+ ).trim()
+ }
+ sh (
+ script: "git -c user.name=TVM-Jenkins -c user.email=jenkins@tvm.apache.org merge ${upstream_revision}",
+ label: 'Merge to origin/main'
+ )
+
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 3 timeout 5m git submodule update --init -f --jobs 0
+ """,
+ label: 'Update git submodules',
+ )
+ checkout_trusted_files()
+}
+
+def docker_init(image) {
+ // Clear out all Docker images that aren't going to be used
+ sh(
+ script: """
+ set -eux
+ docker image ls --all
+ IMAGES=\$(docker image ls --all --format '{{.Repository}}:{{.Tag}} {{.ID}}')
+
+ echo -e "Found images:\\n\$IMAGES"
+ echo "\$IMAGES" | { grep -vE '${image}' || test \$? = 1; } | { xargs docker rmi || test \$? = 123; }
+
+ docker image ls --all
+ """,
+ label: 'Clean old Docker images',
+ )
+
+ if (image.contains("amazonaws.com")) {
+ // If this string is in the image name it's from ECR and needs to be pulled
+ // with the right credentials
+ ecr_pull(image)
Review Comment:
I think this method is not defined in this file
##########
ci/jenkins/generate.py:
##########
@@ -173,17 +147,30 @@ def change_type(lines: List[str]) -> Change:
diff = "".join(diff)
+ return ChangeData(diff=diff, content=new_content, source=source, destination=destination)
+
+
+if __name__ == "__main__":
+ help = "Regenerate Jenkinsfile from template"
+ parser = argparse.ArgumentParser(description=help)
+ parser.add_argument("--force", action="store_true", help="always overwrite timestamp")
+ parser.add_argument("--check", action="store_true", help="just verify the output didn't change")
+ args = parser.parse_args()
+
+ sources = TEMPLATES_DIR.glob("*jenkinsfile.groovy.j2")
+ changes = [update_jenkinsfile(source) for source in sources if source.name != "base.groovy.j2"]
Review Comment:
Not sure if the `if` condition is necessary
##########
ci/jenkins/generated/docker_jenkinsfile.groovy:
##########
@@ -0,0 +1,928 @@
+#!groovy
+// -*- mode: groovy -*-
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Jenkins pipeline
+// See documents at https://jenkins.io/doc/book/pipeline/jenkinsfile/
+
+// Docker env used for testing
+// Different image may have different version tag
+// because some of them are more stable than anoter.
+//
+// Docker images are maintained by PMC, cached in dockerhub
+// and remains relatively stable over the time.
+// Flow for upgrading docker env(need commiter)
+//
+// - Send PR to upgrade build script in the repo
+// - Build the new docker image
+// - Tag the docker image with a new version and push to a binary cache.
+// - Update the version in the Jenkinsfile, send a PR
+// - Fix any issues wrt to the new image version in the PR
+// - Merge the PR and now we are in new version
+// - Tag the new version as the lates
+// - Periodically cleanup the old versions on local workers
+//
+
+// ============================= IMPORTANT NOTE =============================
+// This file is generated by 'jenkins/generate.py'. Do not edit this file directly!
+// Make edits to 'jenkins/Jenkinsfile.j2' and regenerate this with
+// 'python3 jenkins/generate.py'
+// Note: This timestamp is here to ensure that updates to the Jenkinsfile are
+// always rebased on main before merging:
+// Generated at 2022-11-03T15:09:47.700341
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+// NOTE: these lines are scanned by docker/dev_common.sh. Please update the regex as needed. -->
+ci_lint = 'tlcpack/ci-lint:20221013-060115-61c9742ea'
+ci_gpu = 'tlcpack/ci-gpu:20221019-060125-0b4836739'
+ci_cpu = 'tlcpack/ci-cpu:20221013-060115-61c9742ea'
+ci_minimal = 'tlcpack/ci-minimal:20221013-060115-61c9742ea'
+ci_wasm = 'tlcpack/ci-wasm:20221013-060115-61c9742ea'
+ci_i386 = 'tlcpack/ci-i386:20221013-060115-61c9742ea'
+ci_cortexm = 'tlcpack/ci-cortexm:20221013-060115-61c9742ea'
+ci_arm = 'tlcpack/ci-arm:20221013-060115-61c9742ea'
+ci_hexagon = 'tlcpack/ci-hexagon:20221013-060115-61c9742ea'
+ci_riscv = 'tlcpack/ci-riscv:20221013-060115-61c9742ea'
+// <--- End of regex-scanned config.
+
+// Parameters to allow overriding (in Jenkins UI), the images
+// to be used by a given build. When provided, they take precedence
+// over default values above.
+properties([
+ parameters([
+ string(name: 'ci_arm_param', defaultValue: ''),
+ string(name: 'ci_cortexm_param', defaultValue: ''),
+ string(name: 'ci_cpu_param', defaultValue: ''),
+ string(name: 'ci_gpu_param', defaultValue: ''),
+ string(name: 'ci_hexagon_param', defaultValue: ''),
+ string(name: 'ci_i386_param', defaultValue: ''),
+ string(name: 'ci_lint_param', defaultValue: ''),
+ string(name: 'ci_minimal_param', defaultValue: ''),
+ string(name: 'ci_riscv_param', defaultValue: ''),
+ string(name: 'ci_wasm_param', defaultValue: ''),
+ ])
+])
+
+// Placeholders for newly built Docker image names (if rebuild_docker_images
+// is used)
+ built_ci_arm = null;
+ built_ci_cortexm = null;
+ built_ci_cpu = null;
+ built_ci_gpu = null;
+ built_ci_hexagon = null;
+ built_ci_i386 = null;
+ built_ci_lint = null;
+ built_ci_minimal = null;
+ built_ci_riscv = null;
+ built_ci_wasm = null;
+
+// Global variable assigned during Sanity Check that holds the sha1 which should be
+// merged into the PR in all branches.
+upstream_revision = null
+
+// command to start a docker container
+docker_run = 'docker/bash.sh --env CI --env TVM_SHARD_INDEX --env TVM_NUM_SHARDS --env RUN_DISPLAY_URL --env PLATFORM --env SKIP_SLOW_TESTS --env TEST_STEP_NAME'
+docker_build = 'docker/build.sh'
+// timeout in minutes
+max_time = 180
+rebuild_docker_images = false
+
+s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
+
+// General note: Jenkins has limits on the size of a method (or top level code)
+// that are pretty strict, so most usage of groovy methods in these templates
+// are purely to satisfy the JVM
+def per_exec_ws(folder) {
+ return "workspace/exec_${env.EXECUTOR_NUMBER}/" + folder
+}
+
+// initialize source codes
+def init_git() {
+ retry(5) {
+ checkout scm
+ }
+
+ // Add more info about job node
+ sh (
+ script: './tests/scripts/task_show_node_info.sh',
+ label: 'Show executor node info',
+ )
+
+ // Determine merge commit to use for all stages
+ sh (
+ script: 'git fetch origin main',
+ label: 'Fetch upstream',
+ )
+ if (upstream_revision == null) {
+ upstream_revision = sh(
+ script: 'git log -1 FETCH_HEAD --format=\'%H\'',
+ label: 'Determine upstream revision',
+ returnStdout: true,
+ ).trim()
+ }
+ sh (
+ script: "git -c user.name=TVM-Jenkins -c user.email=jenkins@tvm.apache.org merge ${upstream_revision}",
+ label: 'Merge to origin/main'
+ )
+
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 3 timeout 5m git submodule update --init -f --jobs 0
+ """,
+ label: 'Update git submodules',
+ )
+ checkout_trusted_files()
+}
+
+def docker_init(image) {
+ // Clear out all Docker images that aren't going to be used
+ sh(
+ script: """
+ set -eux
+ docker image ls --all
+ IMAGES=\$(docker image ls --all --format '{{.Repository}}:{{.Tag}} {{.ID}}')
+
+ echo -e "Found images:\\n\$IMAGES"
+ echo "\$IMAGES" | { grep -vE '${image}' || test \$? = 1; } | { xargs docker rmi || test \$? = 123; }
+
+ docker image ls --all
+ """,
+ label: 'Clean old Docker images',
+ )
+
+ if (image.contains("amazonaws.com")) {
+ // If this string is in the image name it's from ECR and needs to be pulled
+ // with the right credentials
+ ecr_pull(image)
+ } else {
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${image}
+ """,
+ label: 'Pull docker image',
+ )
+ }
+}
+
+def should_skip_slow_tests(pr_number) {
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run slow tests, exit code of 0 means skip slow tests
+ result = sh (
+ returnStatus: true,
+ script: "./ci/scripts/should_run_slow_tests.py --pr '${pr_number}'",
+ label: 'Check if CI should run slow tests',
+ )
+ }
+ return result == 0
+}
+
+def cancel_previous_build() {
+ // cancel previous build if it is not on main.
+ if (env.BRANCH_NAME != 'main') {
+ def buildNumber = env.BUILD_NUMBER as int
+ // Milestone API allows us to cancel previous build
+ // with the same milestone number
+ if (buildNumber > 1) milestone(buildNumber - 1)
+ milestone(buildNumber)
+ }
+}
+
+def checkout_trusted_files() {
+ // trust everything from branch builds
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ return;
+ }
+
+ // trust peoople listed in CONTRIBUTING.md
+ grep_code = sh(
+ returnStatus: true,
+ script: "git show '${upstream_revision}:CONTRIBUTORS.md' | grep '@${env.CHANGE_AUTHOR}'",
+ label: 'Check if change is from a contributor',
+ )
+
+ if (grep_code == 1) {
+ // Any scripts that run on the bare host and not inside a Docker container
+ // (especially those that access secrets) should be checked out here so
+ // only trusted versions are used in CI
+ sh(
+ script: "git checkout ${upstream_revision} ci/scripts/.",
+ label: 'Check out trusted files',
+ )
+ }
+}
+
+def should_skip_ci(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ glob_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci_globs.py",
+ label: 'Check if CI should be skipped due to changed files',
+ )
+ if (glob_skip_ci_code == 0) {
+ return true
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run full CI (or the script had an error, so run
+ // full CI just in case). Exit code of 0 means skip CI.
+ git_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci.py --pr '${pr_number}'",
+ label: 'Check if CI should be skipped',
+ )
+ }
+ return git_skip_ci_code == 0
+}
+
+def check_pr(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ sh (
+ script: "python3 ci/scripts/check_pr.py --pr ${pr_number}",
+ label: 'Check PR title and body',
+ )
+ }
+
+}
+
+def prepare() {
+ stage('Prepare') {
+ node('CPU-SMALL') {
+ ws("workspace/exec_${env.EXECUTOR_NUMBER}/tvm/prepare") {
+ init_git()
+
+ check_pr(env.CHANGE_ID)
+
+ if (env.DETERMINE_DOCKER_IMAGES == 'yes') {
+ sh(
+ script: "./ci/scripts/determine_docker_images.py ci_arm=${ci_arm} ci_cortexm=${ci_cortexm} ci_cpu=${ci_cpu} ci_gpu=${ci_gpu} ci_hexagon=${ci_hexagon} ci_i386=${ci_i386} ci_lint=${ci_lint} ci_minimal=${ci_minimal} ci_riscv=${ci_riscv} ci_wasm=${ci_wasm} ",
+ label: 'Decide whether to use tlcpack or tlcpackstaging for Docker images',
+ )
+ // Pull image names from the results of should_rebuild_docker.py
+ ci_arm = sh(
+ script: "cat .docker-image-names/ci_arm",
+ label: "Find docker image name for ci_arm",
+ returnStdout: true,
+ ).trim()
+ ci_cortexm = sh(
+ script: "cat .docker-image-names/ci_cortexm",
+ label: "Find docker image name for ci_cortexm",
+ returnStdout: true,
+ ).trim()
+ ci_cpu = sh(
+ script: "cat .docker-image-names/ci_cpu",
+ label: "Find docker image name for ci_cpu",
+ returnStdout: true,
+ ).trim()
+ ci_gpu = sh(
+ script: "cat .docker-image-names/ci_gpu",
+ label: "Find docker image name for ci_gpu",
+ returnStdout: true,
+ ).trim()
+ ci_hexagon = sh(
+ script: "cat .docker-image-names/ci_hexagon",
+ label: "Find docker image name for ci_hexagon",
+ returnStdout: true,
+ ).trim()
+ ci_i386 = sh(
+ script: "cat .docker-image-names/ci_i386",
+ label: "Find docker image name for ci_i386",
+ returnStdout: true,
+ ).trim()
+ ci_lint = sh(
+ script: "cat .docker-image-names/ci_lint",
+ label: "Find docker image name for ci_lint",
+ returnStdout: true,
+ ).trim()
+ ci_minimal = sh(
+ script: "cat .docker-image-names/ci_minimal",
+ label: "Find docker image name for ci_minimal",
+ returnStdout: true,
+ ).trim()
+ ci_riscv = sh(
+ script: "cat .docker-image-names/ci_riscv",
+ label: "Find docker image name for ci_riscv",
+ returnStdout: true,
+ ).trim()
+ ci_wasm = sh(
+ script: "cat .docker-image-names/ci_wasm",
+ label: "Find docker image name for ci_wasm",
+ returnStdout: true,
+ ).trim()
+ }
+
+ ci_arm = params.ci_arm_param ?: ci_arm
+ ci_cortexm = params.ci_cortexm_param ?: ci_cortexm
+ ci_cpu = params.ci_cpu_param ?: ci_cpu
+ ci_gpu = params.ci_gpu_param ?: ci_gpu
+ ci_hexagon = params.ci_hexagon_param ?: ci_hexagon
+ ci_i386 = params.ci_i386_param ?: ci_i386
+ ci_lint = params.ci_lint_param ?: ci_lint
+ ci_minimal = params.ci_minimal_param ?: ci_minimal
+ ci_riscv = params.ci_riscv_param ?: ci_riscv
+ ci_wasm = params.ci_wasm_param ?: ci_wasm
+
+ sh (script: """
+ echo "Docker images being used in this build:"
+ echo " ci_arm = ${ci_arm}"
+ echo " ci_cortexm = ${ci_cortexm}"
+ echo " ci_cpu = ${ci_cpu}"
+ echo " ci_gpu = ${ci_gpu}"
+ echo " ci_hexagon = ${ci_hexagon}"
+ echo " ci_i386 = ${ci_i386}"
+ echo " ci_lint = ${ci_lint}"
+ echo " ci_minimal = ${ci_minimal}"
+ echo " ci_riscv = ${ci_riscv}"
+ echo " ci_wasm = ${ci_wasm}"
+ """, label: 'Docker image names')
+
+ is_docs_only_build = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docs.sh',
+ label: 'Check for docs only changes',
+ )
+ skip_ci = should_skip_ci(env.CHANGE_ID)
+ skip_slow_tests = should_skip_slow_tests(env.CHANGE_ID)
+ rebuild_docker_images = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docker.sh',
+ label: 'Check for any docker changes',
+ )
+
+ if (skip_ci) {
+ // Don't rebuild when skipping CI
+ rebuild_docker_images = false
+ }
+ }
+ }
+ }
+}
+def ci_setup(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_ci_setup.sh",
+ label: 'Set up CI environment',
+ )
+}
+
+def python_unittest(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_unittest.sh",
+ label: 'Run Python unit tests',
+ )
+}
+
+def fsim_test(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_vta_fsim.sh",
+ label: 'Run VTA tests in FSIM',
+ )
+}
+
+def cmake_build(image, path, make_flag) {
+ sh (
+ script: "${docker_run} --env CI_NUM_EXECUTORS ${image} ./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod",
+ label: 'Run cmake build',
+ )
+}
+
+def cpp_unittest(image) {
+ sh (
+ script: "${docker_run} --env CI_NUM_EXECUTORS ${image} ./tests/scripts/task_cpp_unittest.sh",
+ label: 'Build and run C++ tests',
+ )
+}
+
+def add_microtvm_permissions() {
+ sh(
+ script: 'find build/microtvm_template_projects -type f | grep qemu-hack | xargs chmod +x',
+ label: 'Add execute permissions for microTVM files',
+ )
+}
+
+def add_hexagon_permissions() {
+ sh(
+ script: 'find build/hexagon_api_output -type f | xargs chmod +x',
+ label: 'Add execute permissions for hexagon files',
+ )
+}
+
+// Run make. First try to do an incremental make from a previous workspace in hope to
+// accelerate the compilation. If something is wrong, clean the workspace and then
+// build from scratch.
+def make(docker_type, path, make_flag) {
+ timeout(time: max_time, unit: 'MINUTES') {
+ try {
+ cmake_build(docker_type, path, make_flag)
+ } catch (hudson.AbortException ae) {
+ // script exited due to user abort, directly throw instead of retry
+ if (ae.getMessage().contains('script returned exit code 143')) {
+ throw ae
+ }
+ echo 'Incremental compilation failed. Fall back to build from scratch'
+ sh (
+ script: "${docker_run} ${docker_type} ./tests/scripts/task_clean.sh ${path}",
+ label: 'Clear old cmake workspace',
+ )
+ cmake_build(docker_type, path, make_flag)
+ }
+ }
+}
+
+
+cancel_previous_build()
+
+prepare()
+def ecr_push(full_name) {
+ aws_account_id = sh(
+ returnStdout: true,
+ script: 'aws sts get-caller-identity | grep Account | cut -f4 -d\\"',
+ label: 'Get AWS ID'
+ ).trim()
+
+ def ecr_name = "${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com/${full_name}"
+ try {
+ withEnv([
+ "AWS_ACCOUNT_ID=${aws_account_id}",
+ 'AWS_DEFAULT_REGION=us-west-2',
+ "AWS_ECR_REPO=${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com"]) {
+ sh(
+ script: '''
+ set -eux
+ aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin $AWS_ECR_REPO
+ ''',
+ label: 'Log in to ECR'
+ )
+ sh(
+ script: """
+ set -x
+ . ci/scripts/retry.sh
+ docker tag ${full_name} \$AWS_ECR_REPO/${full_name}
+ retry 5 docker push \$AWS_ECR_REPO/${full_name}
+ """,
+ label: 'Upload image to ECR'
+ )
+ }
+ } finally {
+ withEnv([
+ "AWS_ACCOUNT_ID=${aws_account_id}",
+ 'AWS_DEFAULT_REGION=us-west-2',
+ "AWS_ECR_REPO=${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com"]) {
+ sh(
+ script: 'docker logout $AWS_ECR_REPO',
+ label: 'Clean up login credentials'
+ )
+ }
+ }
+ return ecr_name
+}
+
+def ecr_pull(full_name) {
+ aws_account_id = sh(
+ returnStdout: true,
+ script: 'aws sts get-caller-identity | grep Account | cut -f4 -d\\"',
+ label: 'Get AWS ID'
+ ).trim()
+
+ try {
+ withEnv([
+ "AWS_ACCOUNT_ID=${aws_account_id}",
+ 'AWS_DEFAULT_REGION=us-west-2',
+ "AWS_ECR_REPO=${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com"]) {
+ sh(
+ script: '''
+ set -eux
+ aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin $AWS_ECR_REPO
+ ''',
+ label: 'Log in to ECR'
+ )
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${full_name}
+ """,
+ label: 'Pull image from ECR'
+ )
+ }
+ } finally {
+ withEnv([
+ "AWS_ACCOUNT_ID=${aws_account_id}",
+ 'AWS_DEFAULT_REGION=us-west-2',
+ "AWS_ECR_REPO=${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com"]) {
+ sh(
+ script: 'docker logout $AWS_ECR_REPO',
+ label: 'Clean up login credentials'
+ )
+ }
+ }
+}
+
+def build_image(image_name) {
+ hash = sh(
+ returnStdout: true,
+ script: 'git log -1 --format=\'%h\''
+ ).trim()
+ def full_name = "${image_name}:${env.BRANCH_NAME}-${hash}-${env.BUILD_NUMBER}"
+ sh(
+ script: "${docker_build} ${image_name} --spec ${full_name}",
+ label: 'Build docker image'
+ )
+ return ecr_push(full_name)
+}
+
+def update_docker(ecr_image, hub_image) {
+ if (ecr_image == null) {
+ sh("image was not rebuilt, skipping")
+ return
+ }
+ if (!ecr_image.contains("amazonaws.com")) {
+ sh("echo \"Skipping '${ecr_image}' -> '${hub_image}' since it doesn\'t look like an ECR image\"")
+ return
+ }
+ docker_init(ecr_image)
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ docker tag \
+ ${ecr_image} \
+ ${hub_image}
+ retry 5 docker push ${hub_image}
+ """,
+ label: "Update ${hub_image} on Docker Hub",
+ )
+}
+
+stage('Docker Image Build') {
+ parallel(
+ 'ci_arm': {
+ node('ARM') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_arm = build_image('ci_arm')
+ built_ci_arm = build_image('ci_arm');
+ }
+ }
+ },
+ 'ci_cortexm': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_cortexm = build_image('ci_cortexm')
+ built_ci_cortexm = build_image('ci_cortexm');
+ }
+ }
+ },
+ 'ci_cpu': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_cpu = build_image('ci_cpu')
+ built_ci_cpu = build_image('ci_cpu');
+ }
+ }
+ },
+ 'ci_gpu': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_gpu = build_image('ci_gpu')
+ built_ci_gpu = build_image('ci_gpu');
+ }
+ }
+ },
+ 'ci_hexagon': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_hexagon = build_image('ci_hexagon')
+ built_ci_hexagon = build_image('ci_hexagon');
+ }
+ }
+ },
+ 'ci_i386': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_i386 = build_image('ci_i386')
+ built_ci_i386 = build_image('ci_i386');
+ }
+ }
+ },
+ 'ci_lint': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_lint = build_image('ci_lint')
+ built_ci_lint = build_image('ci_lint');
+ }
+ }
+ },
+ 'ci_minimal': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_minimal = build_image('ci_minimal')
+ built_ci_minimal = build_image('ci_minimal');
+ }
+ }
+ },
+ 'ci_riscv': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_riscv = build_image('ci_riscv')
+ built_ci_riscv = build_image('ci_riscv');
+ }
+ }
+ },
+ 'ci_wasm': {
+ node('CPU') {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ // We're purposefully not setting the built image here since they
+ // are not yet being uploaded to tlcpack
+ // ci_wasm = build_image('ci_wasm')
+ built_ci_wasm = build_image('ci_wasm');
+ }
+ }
+ },
+ )
+}
+
+def deploy() {
+ stage('Deploy') {
+ if (env.BRANCH_NAME == 'main') {
+ parallel(
+ 'Upload built Docker images': {
+ if (env.DEPLOY_DOCKER_IMAGES == 'yes' && rebuild_docker_images && upstream_revision != null) {
+ node('CPU') {
+ ws("workspace/exec_${env.EXECUTOR_NUMBER}/tvm/deploy-docker") {
+ timeout(time: max_time, unit: 'MINUTES') {
+ init_git()
+ try {
+ withCredentials([string(
+ credentialsId: 'dockerhub-tlcpackstaging-key',
+ variable: 'DOCKERHUB_KEY',
+ )]) {
+ sh(
+ script: 'docker login -u tlcpackstaging -p ${DOCKERHUB_KEY}',
+ label: 'Log in to Docker Hub',
+ )
+ }
+ def date_Ymd_HMS = sh(
+ script: 'python3 -c \'import datetime; print(datetime.datetime.now().strftime("%Y%m%d-%H%M%S"))\'',
+ label: 'Determine date',
+ returnStdout: true,
+ ).trim()
+ def tag = "${date_Ymd_HMS}-${upstream_revision.substring(0, 8)}"
+ update_docker(built_ci_arm, "tlcpackstaging/ci_arm:${tag}")
+ update_docker(built_ci_cortexm, "tlcpackstaging/ci_cortexm:${tag}")
+ update_docker(built_ci_cpu, "tlcpackstaging/ci_cpu:${tag}")
+ update_docker(built_ci_gpu, "tlcpackstaging/ci_gpu:${tag}")
+ update_docker(built_ci_hexagon, "tlcpackstaging/ci_hexagon:${tag}")
+ update_docker(built_ci_i386, "tlcpackstaging/ci_i386:${tag}")
+ update_docker(built_ci_lint, "tlcpackstaging/ci_lint:${tag}")
+ update_docker(built_ci_minimal, "tlcpackstaging/ci_minimal:${tag}")
+ update_docker(built_ci_riscv, "tlcpackstaging/ci_riscv:${tag}")
+ update_docker(built_ci_wasm, "tlcpackstaging/ci_wasm:${tag}")
+ } finally {
+ sh(
+ script: 'docker logout',
+ label: 'Clean up login credentials'
+ )
+ }
+ }
+ }
+ }
+ } else {
+ Utils.markStageSkippedForConditional('Upload built Docker images')
+ }
+ },
+ 'Tag tlcpackstaging to tlcpack': {
+ if (env.DOCS_DEPLOY_ENABLED == 'yes') {
Review Comment:
Should check for `env.DEPLOY_DOCKER_IMAGES` instead?
##########
ci/jenkins/generated/docker_jenkinsfile.groovy:
##########
@@ -0,0 +1,928 @@
+#!groovy
+// -*- mode: groovy -*-
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Jenkins pipeline
+// See documents at https://jenkins.io/doc/book/pipeline/jenkinsfile/
+
+// Docker env used for testing
+// Different image may have different version tag
+// because some of them are more stable than anoter.
+//
+// Docker images are maintained by PMC, cached in dockerhub
+// and remains relatively stable over the time.
+// Flow for upgrading docker env(need commiter)
+//
+// - Send PR to upgrade build script in the repo
+// - Build the new docker image
+// - Tag the docker image with a new version and push to a binary cache.
+// - Update the version in the Jenkinsfile, send a PR
+// - Fix any issues wrt to the new image version in the PR
+// - Merge the PR and now we are in new version
+// - Tag the new version as the lates
+// - Periodically cleanup the old versions on local workers
+//
+
+// ============================= IMPORTANT NOTE =============================
+// This file is generated by 'jenkins/generate.py'. Do not edit this file directly!
+// Make edits to 'jenkins/Jenkinsfile.j2' and regenerate this with
+// 'python3 jenkins/generate.py'
+// Note: This timestamp is here to ensure that updates to the Jenkinsfile are
+// always rebased on main before merging:
+// Generated at 2022-11-03T15:09:47.700341
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+// NOTE: these lines are scanned by docker/dev_common.sh. Please update the regex as needed. -->
+ci_lint = 'tlcpack/ci-lint:20221013-060115-61c9742ea'
+ci_gpu = 'tlcpack/ci-gpu:20221019-060125-0b4836739'
+ci_cpu = 'tlcpack/ci-cpu:20221013-060115-61c9742ea'
+ci_minimal = 'tlcpack/ci-minimal:20221013-060115-61c9742ea'
+ci_wasm = 'tlcpack/ci-wasm:20221013-060115-61c9742ea'
+ci_i386 = 'tlcpack/ci-i386:20221013-060115-61c9742ea'
+ci_cortexm = 'tlcpack/ci-cortexm:20221013-060115-61c9742ea'
+ci_arm = 'tlcpack/ci-arm:20221013-060115-61c9742ea'
+ci_hexagon = 'tlcpack/ci-hexagon:20221013-060115-61c9742ea'
+ci_riscv = 'tlcpack/ci-riscv:20221013-060115-61c9742ea'
+// <--- End of regex-scanned config.
+
+// Parameters to allow overriding (in Jenkins UI), the images
+// to be used by a given build. When provided, they take precedence
+// over default values above.
+properties([
+ parameters([
+ string(name: 'ci_arm_param', defaultValue: ''),
+ string(name: 'ci_cortexm_param', defaultValue: ''),
+ string(name: 'ci_cpu_param', defaultValue: ''),
+ string(name: 'ci_gpu_param', defaultValue: ''),
+ string(name: 'ci_hexagon_param', defaultValue: ''),
+ string(name: 'ci_i386_param', defaultValue: ''),
+ string(name: 'ci_lint_param', defaultValue: ''),
+ string(name: 'ci_minimal_param', defaultValue: ''),
+ string(name: 'ci_riscv_param', defaultValue: ''),
+ string(name: 'ci_wasm_param', defaultValue: ''),
+ ])
+])
+
+// Placeholders for newly built Docker image names (if rebuild_docker_images
+// is used)
+ built_ci_arm = null;
+ built_ci_cortexm = null;
+ built_ci_cpu = null;
+ built_ci_gpu = null;
+ built_ci_hexagon = null;
+ built_ci_i386 = null;
+ built_ci_lint = null;
+ built_ci_minimal = null;
+ built_ci_riscv = null;
+ built_ci_wasm = null;
+
+// Global variable assigned during Sanity Check that holds the sha1 which should be
+// merged into the PR in all branches.
+upstream_revision = null
+
+// command to start a docker container
+docker_run = 'docker/bash.sh --env CI --env TVM_SHARD_INDEX --env TVM_NUM_SHARDS --env RUN_DISPLAY_URL --env PLATFORM --env SKIP_SLOW_TESTS --env TEST_STEP_NAME'
+docker_build = 'docker/build.sh'
+// timeout in minutes
+max_time = 180
+rebuild_docker_images = false
+
+s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
+
+// General note: Jenkins has limits on the size of a method (or top level code)
+// that are pretty strict, so most usage of groovy methods in these templates
+// are purely to satisfy the JVM
+def per_exec_ws(folder) {
+ return "workspace/exec_${env.EXECUTOR_NUMBER}/" + folder
+}
+
+// initialize source codes
+def init_git() {
+ retry(5) {
+ checkout scm
+ }
+
+ // Add more info about job node
+ sh (
+ script: './tests/scripts/task_show_node_info.sh',
+ label: 'Show executor node info',
+ )
+
+ // Determine merge commit to use for all stages
+ sh (
+ script: 'git fetch origin main',
+ label: 'Fetch upstream',
+ )
+ if (upstream_revision == null) {
+ upstream_revision = sh(
+ script: 'git log -1 FETCH_HEAD --format=\'%H\'',
+ label: 'Determine upstream revision',
+ returnStdout: true,
+ ).trim()
+ }
+ sh (
+ script: "git -c user.name=TVM-Jenkins -c user.email=jenkins@tvm.apache.org merge ${upstream_revision}",
+ label: 'Merge to origin/main'
+ )
+
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 3 timeout 5m git submodule update --init -f --jobs 0
+ """,
+ label: 'Update git submodules',
+ )
+ checkout_trusted_files()
+}
+
+def docker_init(image) {
+ // Clear out all Docker images that aren't going to be used
+ sh(
+ script: """
+ set -eux
+ docker image ls --all
+ IMAGES=\$(docker image ls --all --format '{{.Repository}}:{{.Tag}} {{.ID}}')
+
+ echo -e "Found images:\\n\$IMAGES"
+ echo "\$IMAGES" | { grep -vE '${image}' || test \$? = 1; } | { xargs docker rmi || test \$? = 123; }
+
+ docker image ls --all
+ """,
+ label: 'Clean old Docker images',
+ )
+
+ if (image.contains("amazonaws.com")) {
+ // If this string is in the image name it's from ECR and needs to be pulled
+ // with the right credentials
+ ecr_pull(image)
+ } else {
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${image}
+ """,
+ label: 'Pull docker image',
+ )
+ }
+}
+
+def should_skip_slow_tests(pr_number) {
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run slow tests, exit code of 0 means skip slow tests
+ result = sh (
+ returnStatus: true,
+ script: "./ci/scripts/should_run_slow_tests.py --pr '${pr_number}'",
+ label: 'Check if CI should run slow tests',
+ )
+ }
+ return result == 0
+}
+
+def cancel_previous_build() {
+ // cancel previous build if it is not on main.
+ if (env.BRANCH_NAME != 'main') {
+ def buildNumber = env.BUILD_NUMBER as int
+ // Milestone API allows us to cancel previous build
+ // with the same milestone number
+ if (buildNumber > 1) milestone(buildNumber - 1)
+ milestone(buildNumber)
+ }
+}
+
+def checkout_trusted_files() {
+ // trust everything from branch builds
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ return;
+ }
+
+ // trust peoople listed in CONTRIBUTING.md
+ grep_code = sh(
+ returnStatus: true,
+ script: "git show '${upstream_revision}:CONTRIBUTORS.md' | grep '@${env.CHANGE_AUTHOR}'",
+ label: 'Check if change is from a contributor',
+ )
+
+ if (grep_code == 1) {
+ // Any scripts that run on the bare host and not inside a Docker container
+ // (especially those that access secrets) should be checked out here so
+ // only trusted versions are used in CI
+ sh(
+ script: "git checkout ${upstream_revision} ci/scripts/.",
+ label: 'Check out trusted files',
+ )
+ }
+}
+
+def should_skip_ci(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ glob_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci_globs.py",
+ label: 'Check if CI should be skipped due to changed files',
+ )
+ if (glob_skip_ci_code == 0) {
+ return true
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run full CI (or the script had an error, so run
+ // full CI just in case). Exit code of 0 means skip CI.
+ git_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci.py --pr '${pr_number}'",
+ label: 'Check if CI should be skipped',
+ )
+ }
+ return git_skip_ci_code == 0
+}
+
+def check_pr(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ sh (
+ script: "python3 ci/scripts/check_pr.py --pr ${pr_number}",
+ label: 'Check PR title and body',
+ )
+ }
+
+}
+
+def prepare() {
+ stage('Prepare') {
+ node('CPU-SMALL') {
+ ws("workspace/exec_${env.EXECUTOR_NUMBER}/tvm/prepare") {
+ init_git()
+
+ check_pr(env.CHANGE_ID)
+
+ if (env.DETERMINE_DOCKER_IMAGES == 'yes') {
+ sh(
+ script: "./ci/scripts/determine_docker_images.py ci_arm=${ci_arm} ci_cortexm=${ci_cortexm} ci_cpu=${ci_cpu} ci_gpu=${ci_gpu} ci_hexagon=${ci_hexagon} ci_i386=${ci_i386} ci_lint=${ci_lint} ci_minimal=${ci_minimal} ci_riscv=${ci_riscv} ci_wasm=${ci_wasm} ",
+ label: 'Decide whether to use tlcpack or tlcpackstaging for Docker images',
+ )
+ // Pull image names from the results of should_rebuild_docker.py
+ ci_arm = sh(
+ script: "cat .docker-image-names/ci_arm",
+ label: "Find docker image name for ci_arm",
+ returnStdout: true,
+ ).trim()
+ ci_cortexm = sh(
+ script: "cat .docker-image-names/ci_cortexm",
+ label: "Find docker image name for ci_cortexm",
+ returnStdout: true,
+ ).trim()
+ ci_cpu = sh(
+ script: "cat .docker-image-names/ci_cpu",
+ label: "Find docker image name for ci_cpu",
+ returnStdout: true,
+ ).trim()
+ ci_gpu = sh(
+ script: "cat .docker-image-names/ci_gpu",
+ label: "Find docker image name for ci_gpu",
+ returnStdout: true,
+ ).trim()
+ ci_hexagon = sh(
+ script: "cat .docker-image-names/ci_hexagon",
+ label: "Find docker image name for ci_hexagon",
+ returnStdout: true,
+ ).trim()
+ ci_i386 = sh(
+ script: "cat .docker-image-names/ci_i386",
+ label: "Find docker image name for ci_i386",
+ returnStdout: true,
+ ).trim()
+ ci_lint = sh(
+ script: "cat .docker-image-names/ci_lint",
+ label: "Find docker image name for ci_lint",
+ returnStdout: true,
+ ).trim()
+ ci_minimal = sh(
+ script: "cat .docker-image-names/ci_minimal",
+ label: "Find docker image name for ci_minimal",
+ returnStdout: true,
+ ).trim()
+ ci_riscv = sh(
+ script: "cat .docker-image-names/ci_riscv",
+ label: "Find docker image name for ci_riscv",
+ returnStdout: true,
+ ).trim()
+ ci_wasm = sh(
+ script: "cat .docker-image-names/ci_wasm",
+ label: "Find docker image name for ci_wasm",
+ returnStdout: true,
+ ).trim()
+ }
+
+ ci_arm = params.ci_arm_param ?: ci_arm
+ ci_cortexm = params.ci_cortexm_param ?: ci_cortexm
+ ci_cpu = params.ci_cpu_param ?: ci_cpu
+ ci_gpu = params.ci_gpu_param ?: ci_gpu
+ ci_hexagon = params.ci_hexagon_param ?: ci_hexagon
+ ci_i386 = params.ci_i386_param ?: ci_i386
+ ci_lint = params.ci_lint_param ?: ci_lint
+ ci_minimal = params.ci_minimal_param ?: ci_minimal
+ ci_riscv = params.ci_riscv_param ?: ci_riscv
+ ci_wasm = params.ci_wasm_param ?: ci_wasm
+
+ sh (script: """
+ echo "Docker images being used in this build:"
+ echo " ci_arm = ${ci_arm}"
+ echo " ci_cortexm = ${ci_cortexm}"
+ echo " ci_cpu = ${ci_cpu}"
+ echo " ci_gpu = ${ci_gpu}"
+ echo " ci_hexagon = ${ci_hexagon}"
+ echo " ci_i386 = ${ci_i386}"
+ echo " ci_lint = ${ci_lint}"
+ echo " ci_minimal = ${ci_minimal}"
+ echo " ci_riscv = ${ci_riscv}"
+ echo " ci_wasm = ${ci_wasm}"
+ """, label: 'Docker image names')
+
+ is_docs_only_build = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docs.sh',
+ label: 'Check for docs only changes',
+ )
+ skip_ci = should_skip_ci(env.CHANGE_ID)
+ skip_slow_tests = should_skip_slow_tests(env.CHANGE_ID)
+ rebuild_docker_images = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docker.sh',
+ label: 'Check for any docker changes',
+ )
+
+ if (skip_ci) {
+ // Don't rebuild when skipping CI
+ rebuild_docker_images = false
+ }
+ }
+ }
+ }
+}
+def ci_setup(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_ci_setup.sh",
+ label: 'Set up CI environment',
+ )
+}
+
+def python_unittest(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_unittest.sh",
+ label: 'Run Python unit tests',
+ )
+}
+
+def fsim_test(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_vta_fsim.sh",
+ label: 'Run VTA tests in FSIM',
+ )
+}
+
+def cmake_build(image, path, make_flag) {
+ sh (
+ script: "${docker_run} --env CI_NUM_EXECUTORS ${image} ./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod",
+ label: 'Run cmake build',
+ )
+}
+
+def cpp_unittest(image) {
+ sh (
+ script: "${docker_run} --env CI_NUM_EXECUTORS ${image} ./tests/scripts/task_cpp_unittest.sh",
+ label: 'Build and run C++ tests',
+ )
+}
+
+def add_microtvm_permissions() {
+ sh(
+ script: 'find build/microtvm_template_projects -type f | grep qemu-hack | xargs chmod +x',
+ label: 'Add execute permissions for microTVM files',
+ )
+}
+
+def add_hexagon_permissions() {
+ sh(
+ script: 'find build/hexagon_api_output -type f | xargs chmod +x',
+ label: 'Add execute permissions for hexagon files',
+ )
+}
+
+// Run make. First try to do an incremental make from a previous workspace in hope to
+// accelerate the compilation. If something is wrong, clean the workspace and then
+// build from scratch.
+def make(docker_type, path, make_flag) {
+ timeout(time: max_time, unit: 'MINUTES') {
+ try {
+ cmake_build(docker_type, path, make_flag)
+ } catch (hudson.AbortException ae) {
+ // script exited due to user abort, directly throw instead of retry
+ if (ae.getMessage().contains('script returned exit code 143')) {
+ throw ae
+ }
+ echo 'Incremental compilation failed. Fall back to build from scratch'
+ sh (
+ script: "${docker_run} ${docker_type} ./tests/scripts/task_clean.sh ${path}",
+ label: 'Clear old cmake workspace',
+ )
+ cmake_build(docker_type, path, make_flag)
+ }
+ }
+}
+
+
+cancel_previous_build()
+
+prepare()
+def ecr_push(full_name) {
+ aws_account_id = sh(
+ returnStdout: true,
+ script: 'aws sts get-caller-identity | grep Account | cut -f4 -d\\"',
+ label: 'Get AWS ID'
+ ).trim()
+
+ def ecr_name = "${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com/${full_name}"
+ try {
+ withEnv([
+ "AWS_ACCOUNT_ID=${aws_account_id}",
+ 'AWS_DEFAULT_REGION=us-west-2',
+ "AWS_ECR_REPO=${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com"]) {
+ sh(
+ script: '''
+ set -eux
+ aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin $AWS_ECR_REPO
+ ''',
+ label: 'Log in to ECR'
+ )
+ sh(
+ script: """
+ set -x
+ . ci/scripts/retry.sh
+ docker tag ${full_name} \$AWS_ECR_REPO/${full_name}
+ retry 5 docker push \$AWS_ECR_REPO/${full_name}
+ """,
+ label: 'Upload image to ECR'
+ )
+ }
+ } finally {
+ withEnv([
+ "AWS_ACCOUNT_ID=${aws_account_id}",
+ 'AWS_DEFAULT_REGION=us-west-2',
+ "AWS_ECR_REPO=${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com"]) {
+ sh(
+ script: 'docker logout $AWS_ECR_REPO',
+ label: 'Clean up login credentials'
+ )
+ }
+ }
+ return ecr_name
+}
+
+def ecr_pull(full_name) {
+ aws_account_id = sh(
+ returnStdout: true,
+ script: 'aws sts get-caller-identity | grep Account | cut -f4 -d\\"',
+ label: 'Get AWS ID'
+ ).trim()
+
+ try {
+ withEnv([
+ "AWS_ACCOUNT_ID=${aws_account_id}",
+ 'AWS_DEFAULT_REGION=us-west-2',
+ "AWS_ECR_REPO=${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com"]) {
+ sh(
+ script: '''
+ set -eux
+ aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin $AWS_ECR_REPO
+ ''',
+ label: 'Log in to ECR'
+ )
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${full_name}
+ """,
+ label: 'Pull image from ECR'
+ )
+ }
+ } finally {
+ withEnv([
+ "AWS_ACCOUNT_ID=${aws_account_id}",
+ 'AWS_DEFAULT_REGION=us-west-2',
+ "AWS_ECR_REPO=${aws_account_id}.dkr.ecr.us-west-2.amazonaws.com"]) {
+ sh(
+ script: 'docker logout $AWS_ECR_REPO',
+ label: 'Clean up login credentials'
+ )
+ }
+ }
+}
+
+def build_image(image_name) {
+ hash = sh(
+ returnStdout: true,
+ script: 'git log -1 --format=\'%h\''
+ ).trim()
+ def full_name = "${image_name}:${env.BRANCH_NAME}-${hash}-${env.BUILD_NUMBER}"
+ sh(
+ script: "${docker_build} ${image_name} --spec ${full_name}",
+ label: 'Build docker image'
+ )
+ return ecr_push(full_name)
+}
+
+def update_docker(ecr_image, hub_image) {
+ if (ecr_image == null) {
+ sh("image was not rebuilt, skipping")
+ return
+ }
+ if (!ecr_image.contains("amazonaws.com")) {
+ sh("echo \"Skipping '${ecr_image}' -> '${hub_image}' since it doesn\'t look like an ECR image\"")
+ return
+ }
+ docker_init(ecr_image)
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ docker tag \
+ ${ecr_image} \
+ ${hub_image}
+ retry 5 docker push ${hub_image}
+ """,
+ label: "Update ${hub_image} on Docker Hub",
+ )
+}
+
+stage('Docker Image Build') {
Review Comment:
This seems to be outside of a method. Are we ok with that?
##########
ci/jenkins/generated/arm_jenkinsfile.groovy:
##########
@@ -0,0 +1,1042 @@
+#!groovy
+// -*- mode: groovy -*-
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Jenkins pipeline
+// See documents at https://jenkins.io/doc/book/pipeline/jenkinsfile/
+
+// Docker env used for testing
+// Different image may have different version tag
+// because some of them are more stable than anoter.
+//
+// Docker images are maintained by PMC, cached in dockerhub
+// and remains relatively stable over the time.
+// Flow for upgrading docker env(need commiter)
+//
+// - Send PR to upgrade build script in the repo
+// - Build the new docker image
+// - Tag the docker image with a new version and push to a binary cache.
+// - Update the version in the Jenkinsfile, send a PR
+// - Fix any issues wrt to the new image version in the PR
+// - Merge the PR and now we are in new version
+// - Tag the new version as the lates
+// - Periodically cleanup the old versions on local workers
+//
+
+// ============================= IMPORTANT NOTE =============================
+// This file is generated by 'jenkins/generate.py'. Do not edit this file directly!
+// Make edits to 'jenkins/Jenkinsfile.j2' and regenerate this with
+// 'python3 jenkins/generate.py'
+// Note: This timestamp is here to ensure that updates to the Jenkinsfile are
+// always rebased on main before merging:
+// Generated at 2022-11-03T15:11:02.702503
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+// NOTE: these lines are scanned by docker/dev_common.sh. Please update the regex as needed. -->
+ci_lint = 'tlcpack/ci-lint:20221013-060115-61c9742ea'
+ci_gpu = 'tlcpack/ci-gpu:20221019-060125-0b4836739'
+ci_cpu = 'tlcpack/ci-cpu:20221013-060115-61c9742ea'
+ci_minimal = 'tlcpack/ci-minimal:20221013-060115-61c9742ea'
+ci_wasm = 'tlcpack/ci-wasm:20221013-060115-61c9742ea'
+ci_i386 = 'tlcpack/ci-i386:20221013-060115-61c9742ea'
+ci_cortexm = 'tlcpack/ci-cortexm:20221013-060115-61c9742ea'
+ci_arm = 'tlcpack/ci-arm:20221013-060115-61c9742ea'
+ci_hexagon = 'tlcpack/ci-hexagon:20221013-060115-61c9742ea'
+ci_riscv = 'tlcpack/ci-riscv:20221013-060115-61c9742ea'
+// <--- End of regex-scanned config.
+
+// Parameters to allow overriding (in Jenkins UI), the images
+// to be used by a given build. When provided, they take precedence
+// over default values above.
+properties([
+ parameters([
+ string(name: 'ci_arm_param', defaultValue: ''),
+ string(name: 'ci_cortexm_param', defaultValue: ''),
+ string(name: 'ci_cpu_param', defaultValue: ''),
+ string(name: 'ci_gpu_param', defaultValue: ''),
+ string(name: 'ci_hexagon_param', defaultValue: ''),
+ string(name: 'ci_i386_param', defaultValue: ''),
+ string(name: 'ci_lint_param', defaultValue: ''),
+ string(name: 'ci_minimal_param', defaultValue: ''),
+ string(name: 'ci_riscv_param', defaultValue: ''),
+ string(name: 'ci_wasm_param', defaultValue: ''),
+ ])
+])
+
+// Placeholders for newly built Docker image names (if rebuild_docker_images
+// is used)
+ built_ci_arm = null;
+ built_ci_cortexm = null;
+ built_ci_cpu = null;
+ built_ci_gpu = null;
+ built_ci_hexagon = null;
+ built_ci_i386 = null;
+ built_ci_lint = null;
+ built_ci_minimal = null;
+ built_ci_riscv = null;
+ built_ci_wasm = null;
+
+// Global variable assigned during Sanity Check that holds the sha1 which should be
+// merged into the PR in all branches.
+upstream_revision = null
+
+// command to start a docker container
+docker_run = 'docker/bash.sh --env CI --env TVM_SHARD_INDEX --env TVM_NUM_SHARDS --env RUN_DISPLAY_URL --env PLATFORM --env SKIP_SLOW_TESTS --env TEST_STEP_NAME'
+docker_build = 'docker/build.sh'
+// timeout in minutes
+max_time = 180
+rebuild_docker_images = false
+
+s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
+
+// General note: Jenkins has limits on the size of a method (or top level code)
+// that are pretty strict, so most usage of groovy methods in these templates
+// are purely to satisfy the JVM
+def per_exec_ws(folder) {
+ return "workspace/exec_${env.EXECUTOR_NUMBER}/" + folder
+}
+
+// initialize source codes
+def init_git() {
+ retry(5) {
+ checkout scm
+ }
+
+ // Add more info about job node
+ sh (
+ script: './tests/scripts/task_show_node_info.sh',
+ label: 'Show executor node info',
+ )
+
+ // Determine merge commit to use for all stages
+ sh (
+ script: 'git fetch origin main',
+ label: 'Fetch upstream',
+ )
+ if (upstream_revision == null) {
+ upstream_revision = sh(
+ script: 'git log -1 FETCH_HEAD --format=\'%H\'',
+ label: 'Determine upstream revision',
+ returnStdout: true,
+ ).trim()
+ }
+ sh (
+ script: "git -c user.name=TVM-Jenkins -c user.email=jenkins@tvm.apache.org merge ${upstream_revision}",
+ label: 'Merge to origin/main'
+ )
+
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 3 timeout 5m git submodule update --init -f --jobs 0
+ """,
+ label: 'Update git submodules',
+ )
+ checkout_trusted_files()
+}
+
+def docker_init(image) {
+ // Clear out all Docker images that aren't going to be used
+ sh(
+ script: """
+ set -eux
+ docker image ls --all
+ IMAGES=\$(docker image ls --all --format '{{.Repository}}:{{.Tag}} {{.ID}}')
+
+ echo -e "Found images:\\n\$IMAGES"
+ echo "\$IMAGES" | { grep -vE '${image}' || test \$? = 1; } | { xargs docker rmi || test \$? = 123; }
+
+ docker image ls --all
+ """,
+ label: 'Clean old Docker images',
+ )
+
+ if (image.contains("amazonaws.com")) {
+ // If this string is in the image name it's from ECR and needs to be pulled
+ // with the right credentials
+ ecr_pull(image)
+ } else {
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${image}
+ """,
+ label: 'Pull docker image',
+ )
+ }
+}
+
+def should_skip_slow_tests(pr_number) {
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run slow tests, exit code of 0 means skip slow tests
+ result = sh (
+ returnStatus: true,
+ script: "./ci/scripts/should_run_slow_tests.py --pr '${pr_number}'",
+ label: 'Check if CI should run slow tests',
+ )
+ }
+ return result == 0
+}
+
+def cancel_previous_build() {
+ // cancel previous build if it is not on main.
+ if (env.BRANCH_NAME != 'main') {
+ def buildNumber = env.BUILD_NUMBER as int
+ // Milestone API allows us to cancel previous build
+ // with the same milestone number
+ if (buildNumber > 1) milestone(buildNumber - 1)
+ milestone(buildNumber)
+ }
+}
+
+def checkout_trusted_files() {
+ // trust everything from branch builds
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ return;
+ }
+
+ // trust peoople listed in CONTRIBUTING.md
+ grep_code = sh(
+ returnStatus: true,
+ script: "git show '${upstream_revision}:CONTRIBUTORS.md' | grep '@${env.CHANGE_AUTHOR}'",
+ label: 'Check if change is from a contributor',
+ )
+
+ if (grep_code == 1) {
+ // Any scripts that run on the bare host and not inside a Docker container
+ // (especially those that access secrets) should be checked out here so
+ // only trusted versions are used in CI
+ sh(
+ script: "git checkout ${upstream_revision} ci/scripts/.",
+ label: 'Check out trusted files',
+ )
+ }
+}
+
+def should_skip_ci(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ glob_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci_globs.py",
+ label: 'Check if CI should be skipped due to changed files',
+ )
+ if (glob_skip_ci_code == 0) {
+ return true
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run full CI (or the script had an error, so run
+ // full CI just in case). Exit code of 0 means skip CI.
+ git_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci.py --pr '${pr_number}'",
+ label: 'Check if CI should be skipped',
+ )
+ }
+ return git_skip_ci_code == 0
+}
+
+def check_pr(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ sh (
+ script: "python3 ci/scripts/check_pr.py --pr ${pr_number}",
+ label: 'Check PR title and body',
+ )
+ }
+
+}
+
+def prepare() {
+ stage('Prepare') {
+ node('CPU-SMALL') {
+ ws("workspace/exec_${env.EXECUTOR_NUMBER}/tvm/prepare") {
+ init_git()
+
+ check_pr(env.CHANGE_ID)
+
+ if (env.DETERMINE_DOCKER_IMAGES == 'yes') {
+ sh(
+ script: "./ci/scripts/determine_docker_images.py ci_arm=${ci_arm} ci_cortexm=${ci_cortexm} ci_cpu=${ci_cpu} ci_gpu=${ci_gpu} ci_hexagon=${ci_hexagon} ci_i386=${ci_i386} ci_lint=${ci_lint} ci_minimal=${ci_minimal} ci_riscv=${ci_riscv} ci_wasm=${ci_wasm} ",
+ label: 'Decide whether to use tlcpack or tlcpackstaging for Docker images',
+ )
+ // Pull image names from the results of should_rebuild_docker.py
+ ci_arm = sh(
+ script: "cat .docker-image-names/ci_arm",
+ label: "Find docker image name for ci_arm",
+ returnStdout: true,
+ ).trim()
+ ci_cortexm = sh(
+ script: "cat .docker-image-names/ci_cortexm",
+ label: "Find docker image name for ci_cortexm",
+ returnStdout: true,
+ ).trim()
+ ci_cpu = sh(
+ script: "cat .docker-image-names/ci_cpu",
+ label: "Find docker image name for ci_cpu",
+ returnStdout: true,
+ ).trim()
+ ci_gpu = sh(
+ script: "cat .docker-image-names/ci_gpu",
+ label: "Find docker image name for ci_gpu",
+ returnStdout: true,
+ ).trim()
+ ci_hexagon = sh(
+ script: "cat .docker-image-names/ci_hexagon",
+ label: "Find docker image name for ci_hexagon",
+ returnStdout: true,
+ ).trim()
+ ci_i386 = sh(
+ script: "cat .docker-image-names/ci_i386",
+ label: "Find docker image name for ci_i386",
+ returnStdout: true,
+ ).trim()
+ ci_lint = sh(
+ script: "cat .docker-image-names/ci_lint",
+ label: "Find docker image name for ci_lint",
+ returnStdout: true,
+ ).trim()
+ ci_minimal = sh(
+ script: "cat .docker-image-names/ci_minimal",
+ label: "Find docker image name for ci_minimal",
+ returnStdout: true,
+ ).trim()
+ ci_riscv = sh(
+ script: "cat .docker-image-names/ci_riscv",
+ label: "Find docker image name for ci_riscv",
+ returnStdout: true,
+ ).trim()
+ ci_wasm = sh(
+ script: "cat .docker-image-names/ci_wasm",
+ label: "Find docker image name for ci_wasm",
+ returnStdout: true,
+ ).trim()
+ }
+
+ ci_arm = params.ci_arm_param ?: ci_arm
+ ci_cortexm = params.ci_cortexm_param ?: ci_cortexm
+ ci_cpu = params.ci_cpu_param ?: ci_cpu
+ ci_gpu = params.ci_gpu_param ?: ci_gpu
+ ci_hexagon = params.ci_hexagon_param ?: ci_hexagon
+ ci_i386 = params.ci_i386_param ?: ci_i386
+ ci_lint = params.ci_lint_param ?: ci_lint
+ ci_minimal = params.ci_minimal_param ?: ci_minimal
+ ci_riscv = params.ci_riscv_param ?: ci_riscv
+ ci_wasm = params.ci_wasm_param ?: ci_wasm
+
+ sh (script: """
+ echo "Docker images being used in this build:"
+ echo " ci_arm = ${ci_arm}"
+ echo " ci_cortexm = ${ci_cortexm}"
+ echo " ci_cpu = ${ci_cpu}"
+ echo " ci_gpu = ${ci_gpu}"
+ echo " ci_hexagon = ${ci_hexagon}"
+ echo " ci_i386 = ${ci_i386}"
+ echo " ci_lint = ${ci_lint}"
+ echo " ci_minimal = ${ci_minimal}"
+ echo " ci_riscv = ${ci_riscv}"
+ echo " ci_wasm = ${ci_wasm}"
+ """, label: 'Docker image names')
+
+ is_docs_only_build = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docs.sh',
+ label: 'Check for docs only changes',
+ )
+ skip_ci = should_skip_ci(env.CHANGE_ID)
+ skip_slow_tests = should_skip_slow_tests(env.CHANGE_ID)
+ rebuild_docker_images = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docker.sh',
+ label: 'Check for any docker changes',
+ )
+
+ if (skip_ci) {
+ // Don't rebuild when skipping CI
+ rebuild_docker_images = false
+ }
+ }
+ }
+ }
+}
+def ci_setup(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_ci_setup.sh",
+ label: 'Set up CI environment',
+ )
+}
+
+def python_unittest(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_unittest.sh",
+ label: 'Run Python unit tests',
+ )
+}
+
+def fsim_test(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_vta_fsim.sh",
+ label: 'Run VTA tests in FSIM',
+ )
+}
+
+def cmake_build(image, path, make_flag) {
Review Comment:
I think `path` and `make_flag` are never used here
##########
ci/jenkins/generated/arm_jenkinsfile.groovy:
##########
@@ -0,0 +1,1042 @@
+#!groovy
+// -*- mode: groovy -*-
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Jenkins pipeline
+// See documents at https://jenkins.io/doc/book/pipeline/jenkinsfile/
+
+// Docker env used for testing
+// Different image may have different version tag
+// because some of them are more stable than anoter.
+//
+// Docker images are maintained by PMC, cached in dockerhub
+// and remains relatively stable over the time.
+// Flow for upgrading docker env(need commiter)
+//
+// - Send PR to upgrade build script in the repo
+// - Build the new docker image
+// - Tag the docker image with a new version and push to a binary cache.
+// - Update the version in the Jenkinsfile, send a PR
+// - Fix any issues wrt to the new image version in the PR
+// - Merge the PR and now we are in new version
+// - Tag the new version as the lates
+// - Periodically cleanup the old versions on local workers
+//
+
+// ============================= IMPORTANT NOTE =============================
+// This file is generated by 'jenkins/generate.py'. Do not edit this file directly!
+// Make edits to 'jenkins/Jenkinsfile.j2' and regenerate this with
+// 'python3 jenkins/generate.py'
+// Note: This timestamp is here to ensure that updates to the Jenkinsfile are
+// always rebased on main before merging:
+// Generated at 2022-11-03T15:11:02.702503
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+// NOTE: these lines are scanned by docker/dev_common.sh. Please update the regex as needed. -->
+ci_lint = 'tlcpack/ci-lint:20221013-060115-61c9742ea'
+ci_gpu = 'tlcpack/ci-gpu:20221019-060125-0b4836739'
+ci_cpu = 'tlcpack/ci-cpu:20221013-060115-61c9742ea'
+ci_minimal = 'tlcpack/ci-minimal:20221013-060115-61c9742ea'
+ci_wasm = 'tlcpack/ci-wasm:20221013-060115-61c9742ea'
+ci_i386 = 'tlcpack/ci-i386:20221013-060115-61c9742ea'
+ci_cortexm = 'tlcpack/ci-cortexm:20221013-060115-61c9742ea'
+ci_arm = 'tlcpack/ci-arm:20221013-060115-61c9742ea'
+ci_hexagon = 'tlcpack/ci-hexagon:20221013-060115-61c9742ea'
+ci_riscv = 'tlcpack/ci-riscv:20221013-060115-61c9742ea'
+// <--- End of regex-scanned config.
+
+// Parameters to allow overriding (in Jenkins UI), the images
+// to be used by a given build. When provided, they take precedence
+// over default values above.
+properties([
+ parameters([
+ string(name: 'ci_arm_param', defaultValue: ''),
+ string(name: 'ci_cortexm_param', defaultValue: ''),
+ string(name: 'ci_cpu_param', defaultValue: ''),
+ string(name: 'ci_gpu_param', defaultValue: ''),
+ string(name: 'ci_hexagon_param', defaultValue: ''),
+ string(name: 'ci_i386_param', defaultValue: ''),
+ string(name: 'ci_lint_param', defaultValue: ''),
+ string(name: 'ci_minimal_param', defaultValue: ''),
+ string(name: 'ci_riscv_param', defaultValue: ''),
+ string(name: 'ci_wasm_param', defaultValue: ''),
+ ])
+])
+
+// Placeholders for newly built Docker image names (if rebuild_docker_images
+// is used)
+ built_ci_arm = null;
+ built_ci_cortexm = null;
+ built_ci_cpu = null;
+ built_ci_gpu = null;
+ built_ci_hexagon = null;
+ built_ci_i386 = null;
+ built_ci_lint = null;
+ built_ci_minimal = null;
+ built_ci_riscv = null;
+ built_ci_wasm = null;
+
+// Global variable assigned during Sanity Check that holds the sha1 which should be
+// merged into the PR in all branches.
+upstream_revision = null
+
+// command to start a docker container
+docker_run = 'docker/bash.sh --env CI --env TVM_SHARD_INDEX --env TVM_NUM_SHARDS --env RUN_DISPLAY_URL --env PLATFORM --env SKIP_SLOW_TESTS --env TEST_STEP_NAME'
+docker_build = 'docker/build.sh'
+// timeout in minutes
+max_time = 180
+rebuild_docker_images = false
+
+s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
+
+// General note: Jenkins has limits on the size of a method (or top level code)
+// that are pretty strict, so most usage of groovy methods in these templates
+// are purely to satisfy the JVM
+def per_exec_ws(folder) {
+ return "workspace/exec_${env.EXECUTOR_NUMBER}/" + folder
+}
+
+// initialize source codes
+def init_git() {
+ retry(5) {
+ checkout scm
+ }
+
+ // Add more info about job node
+ sh (
+ script: './tests/scripts/task_show_node_info.sh',
+ label: 'Show executor node info',
+ )
+
+ // Determine merge commit to use for all stages
+ sh (
+ script: 'git fetch origin main',
+ label: 'Fetch upstream',
+ )
+ if (upstream_revision == null) {
+ upstream_revision = sh(
+ script: 'git log -1 FETCH_HEAD --format=\'%H\'',
+ label: 'Determine upstream revision',
+ returnStdout: true,
+ ).trim()
+ }
+ sh (
+ script: "git -c user.name=TVM-Jenkins -c user.email=jenkins@tvm.apache.org merge ${upstream_revision}",
+ label: 'Merge to origin/main'
+ )
+
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 3 timeout 5m git submodule update --init -f --jobs 0
+ """,
+ label: 'Update git submodules',
+ )
+ checkout_trusted_files()
+}
+
+def docker_init(image) {
+ // Clear out all Docker images that aren't going to be used
+ sh(
+ script: """
+ set -eux
+ docker image ls --all
+ IMAGES=\$(docker image ls --all --format '{{.Repository}}:{{.Tag}} {{.ID}}')
+
+ echo -e "Found images:\\n\$IMAGES"
+ echo "\$IMAGES" | { grep -vE '${image}' || test \$? = 1; } | { xargs docker rmi || test \$? = 123; }
+
+ docker image ls --all
+ """,
+ label: 'Clean old Docker images',
+ )
+
+ if (image.contains("amazonaws.com")) {
+ // If this string is in the image name it's from ECR and needs to be pulled
+ // with the right credentials
+ ecr_pull(image)
+ } else {
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${image}
+ """,
+ label: 'Pull docker image',
+ )
+ }
+}
+
+def should_skip_slow_tests(pr_number) {
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run slow tests, exit code of 0 means skip slow tests
+ result = sh (
+ returnStatus: true,
+ script: "./ci/scripts/should_run_slow_tests.py --pr '${pr_number}'",
+ label: 'Check if CI should run slow tests',
+ )
+ }
+ return result == 0
+}
+
+def cancel_previous_build() {
+ // cancel previous build if it is not on main.
+ if (env.BRANCH_NAME != 'main') {
+ def buildNumber = env.BUILD_NUMBER as int
+ // Milestone API allows us to cancel previous build
+ // with the same milestone number
+ if (buildNumber > 1) milestone(buildNumber - 1)
+ milestone(buildNumber)
+ }
+}
+
+def checkout_trusted_files() {
+ // trust everything from branch builds
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ return;
+ }
+
+ // trust peoople listed in CONTRIBUTING.md
+ grep_code = sh(
+ returnStatus: true,
+ script: "git show '${upstream_revision}:CONTRIBUTORS.md' | grep '@${env.CHANGE_AUTHOR}'",
+ label: 'Check if change is from a contributor',
+ )
+
+ if (grep_code == 1) {
+ // Any scripts that run on the bare host and not inside a Docker container
+ // (especially those that access secrets) should be checked out here so
+ // only trusted versions are used in CI
+ sh(
+ script: "git checkout ${upstream_revision} ci/scripts/.",
+ label: 'Check out trusted files',
+ )
+ }
+}
+
+def should_skip_ci(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ glob_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci_globs.py",
+ label: 'Check if CI should be skipped due to changed files',
+ )
+ if (glob_skip_ci_code == 0) {
+ return true
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run full CI (or the script had an error, so run
+ // full CI just in case). Exit code of 0 means skip CI.
+ git_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci.py --pr '${pr_number}'",
+ label: 'Check if CI should be skipped',
+ )
+ }
+ return git_skip_ci_code == 0
+}
+
+def check_pr(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ sh (
+ script: "python3 ci/scripts/check_pr.py --pr ${pr_number}",
+ label: 'Check PR title and body',
+ )
+ }
+
+}
+
+def prepare() {
+ stage('Prepare') {
+ node('CPU-SMALL') {
+ ws("workspace/exec_${env.EXECUTOR_NUMBER}/tvm/prepare") {
+ init_git()
+
+ check_pr(env.CHANGE_ID)
+
+ if (env.DETERMINE_DOCKER_IMAGES == 'yes') {
+ sh(
+ script: "./ci/scripts/determine_docker_images.py ci_arm=${ci_arm} ci_cortexm=${ci_cortexm} ci_cpu=${ci_cpu} ci_gpu=${ci_gpu} ci_hexagon=${ci_hexagon} ci_i386=${ci_i386} ci_lint=${ci_lint} ci_minimal=${ci_minimal} ci_riscv=${ci_riscv} ci_wasm=${ci_wasm} ",
+ label: 'Decide whether to use tlcpack or tlcpackstaging for Docker images',
+ )
+ // Pull image names from the results of should_rebuild_docker.py
+ ci_arm = sh(
+ script: "cat .docker-image-names/ci_arm",
+ label: "Find docker image name for ci_arm",
+ returnStdout: true,
+ ).trim()
+ ci_cortexm = sh(
+ script: "cat .docker-image-names/ci_cortexm",
+ label: "Find docker image name for ci_cortexm",
+ returnStdout: true,
+ ).trim()
+ ci_cpu = sh(
+ script: "cat .docker-image-names/ci_cpu",
+ label: "Find docker image name for ci_cpu",
+ returnStdout: true,
+ ).trim()
+ ci_gpu = sh(
+ script: "cat .docker-image-names/ci_gpu",
+ label: "Find docker image name for ci_gpu",
+ returnStdout: true,
+ ).trim()
+ ci_hexagon = sh(
+ script: "cat .docker-image-names/ci_hexagon",
+ label: "Find docker image name for ci_hexagon",
+ returnStdout: true,
+ ).trim()
+ ci_i386 = sh(
+ script: "cat .docker-image-names/ci_i386",
+ label: "Find docker image name for ci_i386",
+ returnStdout: true,
+ ).trim()
+ ci_lint = sh(
+ script: "cat .docker-image-names/ci_lint",
+ label: "Find docker image name for ci_lint",
+ returnStdout: true,
+ ).trim()
+ ci_minimal = sh(
+ script: "cat .docker-image-names/ci_minimal",
+ label: "Find docker image name for ci_minimal",
+ returnStdout: true,
+ ).trim()
+ ci_riscv = sh(
+ script: "cat .docker-image-names/ci_riscv",
+ label: "Find docker image name for ci_riscv",
+ returnStdout: true,
+ ).trim()
+ ci_wasm = sh(
+ script: "cat .docker-image-names/ci_wasm",
+ label: "Find docker image name for ci_wasm",
+ returnStdout: true,
+ ).trim()
+ }
+
+ ci_arm = params.ci_arm_param ?: ci_arm
+ ci_cortexm = params.ci_cortexm_param ?: ci_cortexm
+ ci_cpu = params.ci_cpu_param ?: ci_cpu
+ ci_gpu = params.ci_gpu_param ?: ci_gpu
+ ci_hexagon = params.ci_hexagon_param ?: ci_hexagon
+ ci_i386 = params.ci_i386_param ?: ci_i386
+ ci_lint = params.ci_lint_param ?: ci_lint
+ ci_minimal = params.ci_minimal_param ?: ci_minimal
+ ci_riscv = params.ci_riscv_param ?: ci_riscv
+ ci_wasm = params.ci_wasm_param ?: ci_wasm
+
+ sh (script: """
+ echo "Docker images being used in this build:"
+ echo " ci_arm = ${ci_arm}"
+ echo " ci_cortexm = ${ci_cortexm}"
+ echo " ci_cpu = ${ci_cpu}"
+ echo " ci_gpu = ${ci_gpu}"
+ echo " ci_hexagon = ${ci_hexagon}"
+ echo " ci_i386 = ${ci_i386}"
+ echo " ci_lint = ${ci_lint}"
+ echo " ci_minimal = ${ci_minimal}"
+ echo " ci_riscv = ${ci_riscv}"
+ echo " ci_wasm = ${ci_wasm}"
+ """, label: 'Docker image names')
+
+ is_docs_only_build = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docs.sh',
+ label: 'Check for docs only changes',
+ )
+ skip_ci = should_skip_ci(env.CHANGE_ID)
+ skip_slow_tests = should_skip_slow_tests(env.CHANGE_ID)
+ rebuild_docker_images = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docker.sh',
+ label: 'Check for any docker changes',
+ )
+
+ if (skip_ci) {
+ // Don't rebuild when skipping CI
+ rebuild_docker_images = false
+ }
+ }
+ }
+ }
+}
+def ci_setup(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_ci_setup.sh",
+ label: 'Set up CI environment',
+ )
+}
+
+def python_unittest(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_unittest.sh",
+ label: 'Run Python unit tests',
+ )
+}
+
+def fsim_test(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_vta_fsim.sh",
+ label: 'Run VTA tests in FSIM',
+ )
+}
+
+def cmake_build(image, path, make_flag) {
+ sh (
+ script: "${docker_run} --env CI_NUM_EXECUTORS ${image} ./tests/scripts/task_build.py --sccache-bucket tvm-sccache-prod",
+ label: 'Run cmake build',
+ )
+}
+
+def cpp_unittest(image) {
+ sh (
+ script: "${docker_run} --env CI_NUM_EXECUTORS ${image} ./tests/scripts/task_cpp_unittest.sh",
+ label: 'Build and run C++ tests',
+ )
+}
+
+def add_microtvm_permissions() {
+ sh(
+ script: 'find build/microtvm_template_projects -type f | grep qemu-hack | xargs chmod +x',
+ label: 'Add execute permissions for microTVM files',
+ )
+}
+
+def add_hexagon_permissions() {
+ sh(
+ script: 'find build/hexagon_api_output -type f | xargs chmod +x',
+ label: 'Add execute permissions for hexagon files',
+ )
+}
+
+// Run make. First try to do an incremental make from a previous workspace in hope to
+// accelerate the compilation. If something is wrong, clean the workspace and then
+// build from scratch.
+def make(docker_type, path, make_flag) {
Review Comment:
I think `make_flag` is never used
##########
ci/jenkins/templates/utils/base.groovy.j2:
##########
@@ -91,41 +91,15 @@ docker_build = 'docker/build.sh'
max_time = 180
rebuild_docker_images = false
-// Filenames for stashing between build and test steps
-{% set tvm_runtime = ['build/libtvm_runtime.so', 'build/config.cmake'] %}
-{% set tvm_lib = ['build/libtvm.so'] + tvm_runtime %}
-{% set tvm_multilib = ['build/libtvm.so', 'build/libvta_fsim.so'] + tvm_runtime %}
-{% set tvm_multilib_tsim = ['build/libvta_tsim.so'] + tvm_multilib %}
-{% set microtvm_template_projects = ['build/microtvm_template_projects',] %}
-{% set hexagon_api = ['build/hexagon_api_output',] %}
s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
-{% set aws_default_region = "us-west-2" %}
-{% set aws_ecr_url = "dkr.ecr." + aws_default_region + ".amazonaws.com" %}
-
// General note: Jenkins has limits on the size of a method (or top level code)
// that are pretty strict, so most usage of groovy methods in these templates
// are purely to satisfy the JVM
-{% include "ci/jenkins/Prepare.groovy.j2" %}
-{% include "ci/jenkins/DockerBuild.groovy.j2" %}
-{% include "ci/jenkins/Lint.groovy.j2" %}
-{% include "ci/jenkins/Build.groovy.j2" %}
-{% include "ci/jenkins/Test.groovy.j2" %}
-{% include "ci/jenkins/Deploy.groovy.j2" %}
+{% include "utils/Prepare.groovy.j2" %}
+{% include "utils/Build.groovy.j2" %}
cancel_previous_build()
prepare()
Review Comment:
We could add a newline here
##########
ci/jenkins/generated/arm_jenkinsfile.groovy:
##########
@@ -0,0 +1,1042 @@
+#!groovy
+// -*- mode: groovy -*-
+
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Jenkins pipeline
+// See documents at https://jenkins.io/doc/book/pipeline/jenkinsfile/
+
+// Docker env used for testing
+// Different image may have different version tag
+// because some of them are more stable than anoter.
+//
+// Docker images are maintained by PMC, cached in dockerhub
+// and remains relatively stable over the time.
+// Flow for upgrading docker env(need commiter)
+//
+// - Send PR to upgrade build script in the repo
+// - Build the new docker image
+// - Tag the docker image with a new version and push to a binary cache.
+// - Update the version in the Jenkinsfile, send a PR
+// - Fix any issues wrt to the new image version in the PR
+// - Merge the PR and now we are in new version
+// - Tag the new version as the lates
+// - Periodically cleanup the old versions on local workers
+//
+
+// ============================= IMPORTANT NOTE =============================
+// This file is generated by 'jenkins/generate.py'. Do not edit this file directly!
+// Make edits to 'jenkins/Jenkinsfile.j2' and regenerate this with
+// 'python3 jenkins/generate.py'
+// Note: This timestamp is here to ensure that updates to the Jenkinsfile are
+// always rebased on main before merging:
+// Generated at 2022-11-03T15:11:02.702503
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+// NOTE: these lines are scanned by docker/dev_common.sh. Please update the regex as needed. -->
+ci_lint = 'tlcpack/ci-lint:20221013-060115-61c9742ea'
+ci_gpu = 'tlcpack/ci-gpu:20221019-060125-0b4836739'
+ci_cpu = 'tlcpack/ci-cpu:20221013-060115-61c9742ea'
+ci_minimal = 'tlcpack/ci-minimal:20221013-060115-61c9742ea'
+ci_wasm = 'tlcpack/ci-wasm:20221013-060115-61c9742ea'
+ci_i386 = 'tlcpack/ci-i386:20221013-060115-61c9742ea'
+ci_cortexm = 'tlcpack/ci-cortexm:20221013-060115-61c9742ea'
+ci_arm = 'tlcpack/ci-arm:20221013-060115-61c9742ea'
+ci_hexagon = 'tlcpack/ci-hexagon:20221013-060115-61c9742ea'
+ci_riscv = 'tlcpack/ci-riscv:20221013-060115-61c9742ea'
+// <--- End of regex-scanned config.
+
+// Parameters to allow overriding (in Jenkins UI), the images
+// to be used by a given build. When provided, they take precedence
+// over default values above.
+properties([
+ parameters([
+ string(name: 'ci_arm_param', defaultValue: ''),
+ string(name: 'ci_cortexm_param', defaultValue: ''),
+ string(name: 'ci_cpu_param', defaultValue: ''),
+ string(name: 'ci_gpu_param', defaultValue: ''),
+ string(name: 'ci_hexagon_param', defaultValue: ''),
+ string(name: 'ci_i386_param', defaultValue: ''),
+ string(name: 'ci_lint_param', defaultValue: ''),
+ string(name: 'ci_minimal_param', defaultValue: ''),
+ string(name: 'ci_riscv_param', defaultValue: ''),
+ string(name: 'ci_wasm_param', defaultValue: ''),
+ ])
+])
+
+// Placeholders for newly built Docker image names (if rebuild_docker_images
+// is used)
+ built_ci_arm = null;
+ built_ci_cortexm = null;
+ built_ci_cpu = null;
+ built_ci_gpu = null;
+ built_ci_hexagon = null;
+ built_ci_i386 = null;
+ built_ci_lint = null;
+ built_ci_minimal = null;
+ built_ci_riscv = null;
+ built_ci_wasm = null;
+
+// Global variable assigned during Sanity Check that holds the sha1 which should be
+// merged into the PR in all branches.
+upstream_revision = null
+
+// command to start a docker container
+docker_run = 'docker/bash.sh --env CI --env TVM_SHARD_INDEX --env TVM_NUM_SHARDS --env RUN_DISPLAY_URL --env PLATFORM --env SKIP_SLOW_TESTS --env TEST_STEP_NAME'
+docker_build = 'docker/build.sh'
+// timeout in minutes
+max_time = 180
+rebuild_docker_images = false
+
+s3_prefix = "tvm-jenkins-artifacts-prod/tvm/${env.BRANCH_NAME}/${env.BUILD_NUMBER}"
+
+// General note: Jenkins has limits on the size of a method (or top level code)
+// that are pretty strict, so most usage of groovy methods in these templates
+// are purely to satisfy the JVM
+def per_exec_ws(folder) {
+ return "workspace/exec_${env.EXECUTOR_NUMBER}/" + folder
+}
+
+// initialize source codes
+def init_git() {
+ retry(5) {
+ checkout scm
+ }
+
+ // Add more info about job node
+ sh (
+ script: './tests/scripts/task_show_node_info.sh',
+ label: 'Show executor node info',
+ )
+
+ // Determine merge commit to use for all stages
+ sh (
+ script: 'git fetch origin main',
+ label: 'Fetch upstream',
+ )
+ if (upstream_revision == null) {
+ upstream_revision = sh(
+ script: 'git log -1 FETCH_HEAD --format=\'%H\'',
+ label: 'Determine upstream revision',
+ returnStdout: true,
+ ).trim()
+ }
+ sh (
+ script: "git -c user.name=TVM-Jenkins -c user.email=jenkins@tvm.apache.org merge ${upstream_revision}",
+ label: 'Merge to origin/main'
+ )
+
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 3 timeout 5m git submodule update --init -f --jobs 0
+ """,
+ label: 'Update git submodules',
+ )
+ checkout_trusted_files()
+}
+
+def docker_init(image) {
+ // Clear out all Docker images that aren't going to be used
+ sh(
+ script: """
+ set -eux
+ docker image ls --all
+ IMAGES=\$(docker image ls --all --format '{{.Repository}}:{{.Tag}} {{.ID}}')
+
+ echo -e "Found images:\\n\$IMAGES"
+ echo "\$IMAGES" | { grep -vE '${image}' || test \$? = 1; } | { xargs docker rmi || test \$? = 123; }
+
+ docker image ls --all
+ """,
+ label: 'Clean old Docker images',
+ )
+
+ if (image.contains("amazonaws.com")) {
+ // If this string is in the image name it's from ECR and needs to be pulled
+ // with the right credentials
+ ecr_pull(image)
+ } else {
+ sh(
+ script: """
+ set -eux
+ . ci/scripts/retry.sh
+ retry 5 docker pull ${image}
+ """,
+ label: 'Pull docker image',
+ )
+ }
+}
+
+def should_skip_slow_tests(pr_number) {
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run slow tests, exit code of 0 means skip slow tests
+ result = sh (
+ returnStatus: true,
+ script: "./ci/scripts/should_run_slow_tests.py --pr '${pr_number}'",
+ label: 'Check if CI should run slow tests',
+ )
+ }
+ return result == 0
+}
+
+def cancel_previous_build() {
+ // cancel previous build if it is not on main.
+ if (env.BRANCH_NAME != 'main') {
+ def buildNumber = env.BUILD_NUMBER as int
+ // Milestone API allows us to cancel previous build
+ // with the same milestone number
+ if (buildNumber > 1) milestone(buildNumber - 1)
+ milestone(buildNumber)
+ }
+}
+
+def checkout_trusted_files() {
+ // trust everything from branch builds
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ return;
+ }
+
+ // trust peoople listed in CONTRIBUTING.md
+ grep_code = sh(
+ returnStatus: true,
+ script: "git show '${upstream_revision}:CONTRIBUTORS.md' | grep '@${env.CHANGE_AUTHOR}'",
+ label: 'Check if change is from a contributor',
+ )
+
+ if (grep_code == 1) {
+ // Any scripts that run on the bare host and not inside a Docker container
+ // (especially those that access secrets) should be checked out here so
+ // only trusted versions are used in CI
+ sh(
+ script: "git checkout ${upstream_revision} ci/scripts/.",
+ label: 'Check out trusted files',
+ )
+ }
+}
+
+def should_skip_ci(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ glob_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci_globs.py",
+ label: 'Check if CI should be skipped due to changed files',
+ )
+ if (glob_skip_ci_code == 0) {
+ return true
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ // Exit code of 1 means run full CI (or the script had an error, so run
+ // full CI just in case). Exit code of 0 means skip CI.
+ git_skip_ci_code = sh (
+ returnStatus: true,
+ script: "./ci/scripts/git_skip_ci.py --pr '${pr_number}'",
+ label: 'Check if CI should be skipped',
+ )
+ }
+ return git_skip_ci_code == 0
+}
+
+def check_pr(pr_number) {
+ if (env.BRANCH_NAME == null || !env.BRANCH_NAME.startsWith('PR-')) {
+ // never skip CI on build sourced from a branch
+ return false
+ }
+ withCredentials([string(
+ credentialsId: 'tvm-bot-jenkins-reader',
+ variable: 'GITHUB_TOKEN',
+ )]) {
+ sh (
+ script: "python3 ci/scripts/check_pr.py --pr ${pr_number}",
+ label: 'Check PR title and body',
+ )
+ }
+
+}
+
+def prepare() {
+ stage('Prepare') {
+ node('CPU-SMALL') {
+ ws("workspace/exec_${env.EXECUTOR_NUMBER}/tvm/prepare") {
+ init_git()
+
+ check_pr(env.CHANGE_ID)
+
+ if (env.DETERMINE_DOCKER_IMAGES == 'yes') {
+ sh(
+ script: "./ci/scripts/determine_docker_images.py ci_arm=${ci_arm} ci_cortexm=${ci_cortexm} ci_cpu=${ci_cpu} ci_gpu=${ci_gpu} ci_hexagon=${ci_hexagon} ci_i386=${ci_i386} ci_lint=${ci_lint} ci_minimal=${ci_minimal} ci_riscv=${ci_riscv} ci_wasm=${ci_wasm} ",
+ label: 'Decide whether to use tlcpack or tlcpackstaging for Docker images',
+ )
+ // Pull image names from the results of should_rebuild_docker.py
+ ci_arm = sh(
+ script: "cat .docker-image-names/ci_arm",
+ label: "Find docker image name for ci_arm",
+ returnStdout: true,
+ ).trim()
+ ci_cortexm = sh(
+ script: "cat .docker-image-names/ci_cortexm",
+ label: "Find docker image name for ci_cortexm",
+ returnStdout: true,
+ ).trim()
+ ci_cpu = sh(
+ script: "cat .docker-image-names/ci_cpu",
+ label: "Find docker image name for ci_cpu",
+ returnStdout: true,
+ ).trim()
+ ci_gpu = sh(
+ script: "cat .docker-image-names/ci_gpu",
+ label: "Find docker image name for ci_gpu",
+ returnStdout: true,
+ ).trim()
+ ci_hexagon = sh(
+ script: "cat .docker-image-names/ci_hexagon",
+ label: "Find docker image name for ci_hexagon",
+ returnStdout: true,
+ ).trim()
+ ci_i386 = sh(
+ script: "cat .docker-image-names/ci_i386",
+ label: "Find docker image name for ci_i386",
+ returnStdout: true,
+ ).trim()
+ ci_lint = sh(
+ script: "cat .docker-image-names/ci_lint",
+ label: "Find docker image name for ci_lint",
+ returnStdout: true,
+ ).trim()
+ ci_minimal = sh(
+ script: "cat .docker-image-names/ci_minimal",
+ label: "Find docker image name for ci_minimal",
+ returnStdout: true,
+ ).trim()
+ ci_riscv = sh(
+ script: "cat .docker-image-names/ci_riscv",
+ label: "Find docker image name for ci_riscv",
+ returnStdout: true,
+ ).trim()
+ ci_wasm = sh(
+ script: "cat .docker-image-names/ci_wasm",
+ label: "Find docker image name for ci_wasm",
+ returnStdout: true,
+ ).trim()
+ }
+
+ ci_arm = params.ci_arm_param ?: ci_arm
+ ci_cortexm = params.ci_cortexm_param ?: ci_cortexm
+ ci_cpu = params.ci_cpu_param ?: ci_cpu
+ ci_gpu = params.ci_gpu_param ?: ci_gpu
+ ci_hexagon = params.ci_hexagon_param ?: ci_hexagon
+ ci_i386 = params.ci_i386_param ?: ci_i386
+ ci_lint = params.ci_lint_param ?: ci_lint
+ ci_minimal = params.ci_minimal_param ?: ci_minimal
+ ci_riscv = params.ci_riscv_param ?: ci_riscv
+ ci_wasm = params.ci_wasm_param ?: ci_wasm
+
+ sh (script: """
+ echo "Docker images being used in this build:"
+ echo " ci_arm = ${ci_arm}"
+ echo " ci_cortexm = ${ci_cortexm}"
+ echo " ci_cpu = ${ci_cpu}"
+ echo " ci_gpu = ${ci_gpu}"
+ echo " ci_hexagon = ${ci_hexagon}"
+ echo " ci_i386 = ${ci_i386}"
+ echo " ci_lint = ${ci_lint}"
+ echo " ci_minimal = ${ci_minimal}"
+ echo " ci_riscv = ${ci_riscv}"
+ echo " ci_wasm = ${ci_wasm}"
+ """, label: 'Docker image names')
+
+ is_docs_only_build = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docs.sh',
+ label: 'Check for docs only changes',
+ )
+ skip_ci = should_skip_ci(env.CHANGE_ID)
+ skip_slow_tests = should_skip_slow_tests(env.CHANGE_ID)
+ rebuild_docker_images = sh (
+ returnStatus: true,
+ script: './ci/scripts/git_change_docker.sh',
+ label: 'Check for any docker changes',
+ )
+
+ if (skip_ci) {
+ // Don't rebuild when skipping CI
+ rebuild_docker_images = false
+ }
+ }
+ }
+ }
+}
+def ci_setup(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_ci_setup.sh",
+ label: 'Set up CI environment',
+ )
+}
+
+def python_unittest(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_unittest.sh",
+ label: 'Run Python unit tests',
+ )
+}
+
+def fsim_test(image) {
+ sh (
+ script: "${docker_run} ${image} ./tests/scripts/task_python_vta_fsim.sh",
+ label: 'Run VTA tests in FSIM',
+ )
+}
+
+def cmake_build(image, path, make_flag) {
Review Comment:
Edit: Sorry, it's the same in main so it could be addressed in a different PR
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org