|
| 1 | +#!/bin/bash |
| 2 | +# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 3 | +# All rights reserved. |
| 4 | +# |
| 5 | +# This source code is licensed under the BSD-style license found in the |
| 6 | +# LICENSE file in the root directory of this source tree. |
| 7 | +# |
| 8 | +# Download and install the licensed Cadence Xtensa toolchain + core config for |
| 9 | +# a given backend, then export the environment that |
| 10 | +# backends/cadence/cadence.cmake and xt-run need. |
| 11 | +# |
| 12 | +# The artifacts (host tools, the core tarball, and the bundled license) cannot |
| 13 | +# be hosted publicly, so they are fetched at runtime from an auth-gated object |
| 14 | +# store. The store location is provided by the caller via XTENSA_S3_BUCKET (set |
| 15 | +# from a CI variable); credentials are obtained out of band before this runs. |
| 16 | +# |
| 17 | +# Usage: |
| 18 | +# XTENSA_S3_BUCKET=<bucket> .ci/scripts/setup-xtensa-tools.sh <backend> |
| 19 | +# backend = hifi4 | vision | fusion_g3 |
| 20 | +# |
| 21 | +# In GitHub Actions this appends the toolchain env to $GITHUB_ENV so later |
| 22 | +# steps inherit it. Run locally to populate a workspace for manual builds. |
| 23 | +# |
| 24 | +# Modeled on .ci/scripts/setup-arm-baremetal-tools.sh. |
| 25 | + |
| 26 | +set -euo pipefail |
| 27 | + |
| 28 | +BACKEND="${1:-}" |
| 29 | +if [[ -z "${BACKEND}" ]]; then |
| 30 | + echo "ERROR: usage: XTENSA_S3_BUCKET=<bucket> $0 <hifi4|vision|fusion_g3>" >&2 |
| 31 | + exit 1 |
| 32 | +fi |
| 33 | + |
| 34 | +S3_BUCKET="${XTENSA_S3_BUCKET:-}" |
| 35 | +if [[ -z "${S3_BUCKET}" ]]; then |
| 36 | + echo "ERROR: XTENSA_S3_BUCKET is not set (provide it from a CI variable)." >&2 |
| 37 | + exit 1 |
| 38 | +fi |
| 39 | +# Objects live flat at the bucket root by default; set these to put toolchains |
| 40 | +# and cores under key prefixes instead. |
| 41 | +S3_TOOLCHAIN_PREFIX="${XTENSA_S3_TOOLCHAIN_PREFIX:-}" |
| 42 | +S3_CORE_PREFIX="${XTENSA_S3_CORE_PREFIX:-}" |
| 43 | + |
| 44 | +# Per-backend mapping: core tarball, toolchain tarball, core name, OPT flag. |
| 45 | +# The toolchain's clang major must match the core's codegen plugin: |
| 46 | +# hifi4 / fusion_g3 cores (RI-2022.10, clang 10) -> RI-2022.9 host tools |
| 47 | +# vision core (RJ-2025.5, clang 15) -> RJ-2025.5 host tools |
| 48 | +case "${BACKEND}" in |
| 49 | + hifi4) |
| 50 | + CORE_NAME="hifi4_ss_spfpu_7_et_ci2" |
| 51 | + CORE_TARBALL="hifi4_ss_spfpu_7_et_ci2_linux.tgz" |
| 52 | + TOOLCHAIN_TARBALL="XtensaTools_RI_2022_9_linux.tgz" |
| 53 | + TOOLCHAIN_VER="RI-2022.9-linux" |
| 54 | + OPT_FLAG="EXECUTORCH_NNLIB_OPT" |
| 55 | + ;; |
| 56 | + fusion_g3) |
| 57 | + CORE_NAME="XRC_FuG3_TYP_SPVFPU_et_c2" |
| 58 | + CORE_TARBALL="XRC_FuG3_TYP_SPVFPU_et_c2_linux.tgz" |
| 59 | + TOOLCHAIN_TARBALL="XtensaTools_RI_2022_9_linux.tgz" |
| 60 | + TOOLCHAIN_VER="RI-2022.9-linux" |
| 61 | + OPT_FLAG="EXECUTORCH_FUSION_G3_OPT" |
| 62 | + ;; |
| 63 | + vision) |
| 64 | + CORE_NAME="XRC_Vision_110_AO_et_ci2" |
| 65 | + CORE_TARBALL="XRC_Vision_110_AO_et_ci2_linux.tgz" |
| 66 | + TOOLCHAIN_TARBALL="XtensaTools_RJ_2025_5_linux.tgz" |
| 67 | + TOOLCHAIN_VER="RJ-2025.5-linux" |
| 68 | + OPT_FLAG="EXECUTORCH_VISION_OPT" |
| 69 | + ;; |
| 70 | + *) |
| 71 | + echo "ERROR: unknown backend '${BACKEND}' (expected hifi4|vision|fusion_g3)" >&2 |
| 72 | + exit 1 |
| 73 | + ;; |
| 74 | +esac |
| 75 | + |
| 76 | +XTENSA_ROOT="${XTENSA_ROOT:-/tmp/xtensa}" |
| 77 | +TOOLS_ROOT="${XTENSA_ROOT}/tools" # contains <ver>-linux/XtensaTools |
| 78 | +CORES_ROOT="${XTENSA_ROOT}/cores" # contains <corever>-linux/<core> |
| 79 | +REGISTRY_ROOT="${XTENSA_ROOT}/registry/${CORE_NAME}" |
| 80 | +DL_DIR="${XTENSA_ROOT}/download" |
| 81 | +mkdir -p "${TOOLS_ROOT}" "${CORES_ROOT}" "${REGISTRY_ROOT}" "${DL_DIR}" |
| 82 | + |
| 83 | +s3_get() { |
| 84 | + # $1 = s3 key, $2 = local dest |
| 85 | + local key="$1" dest="$2" |
| 86 | + echo "Downloading s3://${S3_BUCKET}/${key} ..." |
| 87 | + aws s3 cp "s3://${S3_BUCKET}/${key}" "${dest}" --only-show-errors |
| 88 | +} |
| 89 | + |
| 90 | +extract_tgz() { |
| 91 | + # $1 = .tgz, $2 = dest dir. Some vendor core tarballs carry trailing bytes |
| 92 | + # after a valid gzip stream; gzip then exits 2 ("trailing garbage ignored") |
| 93 | + # even though the archive decompressed fully, which aborts `tar xzf`. Key the |
| 94 | + # success check off tar's exit, not gzip's. |
| 95 | + local tgz="$1" dest="$2" rc |
| 96 | + set +o pipefail |
| 97 | + gzip -dc "${tgz}" 2>/dev/null | tar xf - -C "${dest}" |
| 98 | + rc=${PIPESTATUS[1]} |
| 99 | + set -o pipefail |
| 100 | + [[ "${rc}" -eq 0 ]] || { echo "ERROR: failed to extract ${tgz} (tar rc=${rc})" >&2; exit 1; } |
| 101 | +} |
| 102 | + |
| 103 | +# 1. Toolchain (host xt-clang/xt-run). Skip re-extract if already present. |
| 104 | +if [[ ! -d "${TOOLS_ROOT}/${TOOLCHAIN_VER}/XtensaTools" ]]; then |
| 105 | + s3_get "${S3_TOOLCHAIN_PREFIX:+${S3_TOOLCHAIN_PREFIX}/}${TOOLCHAIN_TARBALL}" "${DL_DIR}/${TOOLCHAIN_TARBALL}" |
| 106 | + extract_tgz "${DL_DIR}/${TOOLCHAIN_TARBALL}" "${TOOLS_ROOT}" |
| 107 | +fi |
| 108 | +TOOLCHAIN_HOME="${TOOLS_ROOT}/${TOOLCHAIN_VER}/XtensaTools" |
| 109 | +if [[ ! -x "${TOOLCHAIN_HOME}/bin/xt-clang" ]]; then |
| 110 | + echo "ERROR: xt-clang not found at ${TOOLCHAIN_HOME}/bin after extract" >&2 |
| 111 | + exit 1 |
| 112 | +fi |
| 113 | + |
| 114 | +# 2. Core config (ISA libs, params, examples, bundled magic-key license). |
| 115 | +s3_get "${S3_CORE_PREFIX:+${S3_CORE_PREFIX}/}${CORE_TARBALL}" "${DL_DIR}/${CORE_TARBALL}" |
| 116 | +extract_tgz "${DL_DIR}/${CORE_TARBALL}" "${CORES_ROOT}" |
| 117 | +CORE_DIR=$(echo "${CORES_ROOT}"/*/"${CORE_NAME}") |
| 118 | +if [[ ! -d "${CORE_DIR}" ]]; then |
| 119 | + echo "ERROR: core dir for ${CORE_NAME} not found under ${CORES_ROOT}" >&2 |
| 120 | + exit 1 |
| 121 | +fi |
| 122 | + |
| 123 | +# 3. Build a local Xtensa core registry with the XPG-internal build paths in |
| 124 | +# the params file rewritten to our extracted toolchain + core locations. |
| 125 | +# The vendor ships params referencing /././home/xpgcust/... build paths. |
| 126 | +PARAMS_SRC="${CORE_DIR}/config/${CORE_NAME}-params" |
| 127 | +TOOLS_PFX=$(sed -n 's/^install-prefix = //p' "${PARAMS_SRC}" | head -1) |
| 128 | +TOOLSUB_PFX=$(sed -n 's/^xtensa-tools = //p' "${PARAMS_SRC}" | head -1) |
| 129 | +CFG_PFX=$(sed -n 's/^config-prefix = //p' "${PARAMS_SRC}" | head -1) |
| 130 | +sed \ |
| 131 | + -e "s|${TOOLS_PFX}|${TOOLCHAIN_HOME}|g" \ |
| 132 | + -e "s|${TOOLSUB_PFX}|${TOOLCHAIN_HOME}/Tools|g" \ |
| 133 | + -e "s|${CFG_PFX}|${CORE_DIR}|g" \ |
| 134 | + "${PARAMS_SRC}" > "${REGISTRY_ROOT}/${CORE_NAME}-params" |
| 135 | +ln -sf "${CORE_NAME}-params" "${REGISTRY_ROOT}/default-params" |
| 136 | + |
| 137 | +LICENSE_FILE="${CORE_DIR}/misc/license.dat" |
| 138 | + |
| 139 | +# 4. Export environment. cadence.cmake reads XTENSA_TOOLCHAIN/TOOLCHAIN_VER; |
| 140 | +# xt-clang/xt-run read XTENSA_SYSTEM/XTENSA_CORE; xtensad reads |
| 141 | +# XTENSAD_LICENSE_FILE (the bundled uncounted magic key, no server needed). |
| 142 | +emit() { |
| 143 | + # Export into the current shell (so callers that `source` this script get the |
| 144 | + # vars) and append to $GITHUB_ENV (so later workflow steps inherit them too). |
| 145 | + echo "$1" |
| 146 | + export "${1?}" |
| 147 | + if [[ -n "${GITHUB_ENV:-}" ]]; then echo "$1" >> "${GITHUB_ENV}"; fi |
| 148 | +} |
| 149 | +echo "=== Xtensa env for backend '${BACKEND}' (core ${CORE_NAME}) ===" |
| 150 | +emit "XTENSA_TOOLCHAIN=${TOOLS_ROOT}" |
| 151 | +emit "TOOLCHAIN_VER=${TOOLCHAIN_VER}" |
| 152 | +emit "XTENSA_SYSTEM=${REGISTRY_ROOT}" |
| 153 | +emit "XTENSA_CORE=${CORE_NAME}" |
| 154 | +emit "XTENSAD_LICENSE_FILE=${LICENSE_FILE}" |
| 155 | +emit "CADENCE_OPT_FLAG=${OPT_FLAG}" |
| 156 | +if [[ -n "${GITHUB_PATH:-}" ]]; then |
| 157 | + echo "${TOOLCHAIN_HOME}/bin" >> "${GITHUB_PATH}" |
| 158 | +fi |
| 159 | +export PATH="${TOOLCHAIN_HOME}/bin:${PATH}" |
| 160 | + |
| 161 | +echo "=== sanity ===" |
| 162 | +xt-clang --version 2>&1 | head -1 |
| 163 | +xt-run --show-config=cores 2>&1 | sed -n '/available/,/registry/p' | head -6 |
| 164 | +echo "Xtensa toolchain ready for ${BACKEND}." |
0 commit comments