143 lines
4.2 KiB
Bash
Executable File
143 lines
4.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# exit script if any command fails
|
|
set -e
|
|
set -o pipefail
|
|
|
|
SKIP_VALIDATE=false
|
|
|
|
function usage
|
|
{
|
|
echo "Usage: $0 [--skip-validate]"
|
|
echo "Initialize Chipyard submodules and setup initial env.sh script."
|
|
echo ""
|
|
echo " --skip-validate Skip prompt checking for tagged release"
|
|
}
|
|
|
|
while test $# -gt 0
|
|
do
|
|
case "$1" in
|
|
--skip-validate)
|
|
SKIP_VALIDATE=true;
|
|
;;
|
|
-h | -H | --help)
|
|
usage
|
|
exit 1
|
|
;;
|
|
*) echo "ERROR: bad argument $1"
|
|
usage
|
|
exit 2
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
# Check that git version is at least 1.7.8
|
|
MYGIT=$(git --version)
|
|
MYGIT=${MYGIT#'git version '} # Strip prefix
|
|
case ${MYGIT} in
|
|
[1-9]*) ;;
|
|
*) echo 'warning: unknown git version' ;;
|
|
esac
|
|
MINGIT="1.8.5"
|
|
if [ "$MINGIT" != "$(echo -e "$MINGIT\n$MYGIT" | sort -V | head -n1)" ]; then
|
|
echo "This script requires git version $MINGIT or greater. Exiting."
|
|
false
|
|
fi
|
|
|
|
# before doing anything verify that you are on a release branch/tag
|
|
set +e
|
|
tag=$(git describe --exact-match --tags)
|
|
tag_ret_code=$?
|
|
set -e
|
|
if [ $tag_ret_code -ne 0 ]; then
|
|
if [ "$SKIP_VALIDATE" = false ]; then
|
|
read -p "WARNING: You are not on an official release of Chipyard."$'\n'"Type \"y\" to continue if this is intended, otherwise see https://chipyard.readthedocs.io/en/stable/Chipyard-Basics/Initial-Repo-Setup.html#setting-up-the-chipyard-repo: " validate
|
|
[[ $validate == [yY] ]] || exit 3
|
|
echo "Setting up non-official Chipyard release"
|
|
fi
|
|
else
|
|
echo "Setting up official Chipyard release: $tag"
|
|
fi
|
|
|
|
# On macOS, use GNU readlink from 'coreutils' package in Homebrew/MacPorts
|
|
if [ "$(uname -s)" = "Darwin" ] ; then
|
|
READLINK=greadlink
|
|
else
|
|
READLINK=readlink
|
|
fi
|
|
|
|
# If BASH_SOURCE is undefined we may be running under zsh, in that case
|
|
# provide a zsh-compatible alternative
|
|
DIR="$(dirname "$($READLINK -f "${BASH_SOURCE[0]:-${(%):-%x}}")")"
|
|
CHIPYARD_DIR="$(dirname "$DIR")"
|
|
|
|
cd "$CHIPYARD_DIR"
|
|
|
|
(
|
|
# Blocklist of submodules to initially skip:
|
|
# - Toolchain submodules
|
|
# - Generators with huge submodules (e.g., linux sources)
|
|
# - FireSim until explicitly requested
|
|
# - Hammer tool plugins
|
|
git_submodule_exclude() {
|
|
# Call the given subcommand (shell function) on each submodule
|
|
# path to temporarily exclude during the recursive update
|
|
for name in \
|
|
toolchains/*-tools/*/ \
|
|
toolchains/libgloss \
|
|
toolchains/qemu \
|
|
generators/sha3 \
|
|
generators/gemmini \
|
|
sims/firesim \
|
|
software/nvdla-workload \
|
|
software/coremark \
|
|
software/firemarshal \
|
|
software/spec2017 \
|
|
vlsi/hammer-cadence-plugins \
|
|
vlsi/hammer-synopsys-plugins \
|
|
vlsi/hammer-mentor-plugins \
|
|
fpga/fpga-shells
|
|
do
|
|
"$1" "${name%/}"
|
|
done
|
|
}
|
|
|
|
_skip() { git config --local "submodule.${1}.update" none ; }
|
|
_unskip() { git config --local --unset-all "submodule.${1}.update" || : ; }
|
|
|
|
trap 'git_submodule_exclude _unskip' EXIT INT TERM
|
|
set -x
|
|
git_submodule_exclude _skip
|
|
git submodule update --init --recursive #--jobs 8
|
|
set +x
|
|
)
|
|
|
|
set -x
|
|
|
|
# Non-recursive clone to exclude riscv-linux
|
|
git submodule update --init generators/sha3
|
|
|
|
# Non-recursive clone to exclude gemmini-software
|
|
git submodule update --init generators/gemmini
|
|
git -C generators/gemmini/ submodule update --init --recursive software/gemmini-rocc-tests
|
|
|
|
# Minimal non-recursive clone to initialize sbt dependencies
|
|
git submodule update --init sims/firesim
|
|
git config --local submodule.sims/firesim.update none
|
|
|
|
# Only shallow clone needed for basic SW tests
|
|
git submodule update --init software/firemarshal
|
|
|
|
set +x
|
|
|
|
# Configure firemarshal to know where our firesim installation is
|
|
if [ ! -f ./software/firemarshal/marshal-config.yaml ]; then
|
|
echo "firesim-dir: '../../sims/firesim/'" > ./software/firemarshal/marshal-config.yaml
|
|
fi
|
|
|
|
echo "# line auto-generated by init-submodules-no-riscv-tools.sh" >> env.sh
|
|
echo '__DIR="$(dirname "$(readlink -f "${BASH_SOURCE[0]:-${(%):-%x}}")")"' >> env.sh
|
|
echo "PATH=\$__DIR/bin:\$PATH" >> env.sh
|
|
echo "PATH=\$__DIR/software/firemarshal:\$PATH" >> env.sh
|