-
Notifications
You must be signed in to change notification settings - Fork 1
/
vitis_setup.sh
292 lines (256 loc) · 9.82 KB
/
vitis_setup.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# Amazon FPGA Hardware Development Kit
#
# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Amazon Software License (the "License"). You may not use
# this file except in compliance with the License. A copy of the License is
# located at
#
# http://aws.amazon.com/asl/
#
# or in the "license" file accompanying this file. This file is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or
# implied. See the License for the specific language governing permissions and
# limitations under the License.
# Script must be sourced from a bash shell or it will not work
# When being sourced $0 will be the interactive shell and $BASH_SOURCE_ will contain the script being sourced
# When being run $0 and $_ will be the same.
script=${BASH_SOURCE[0]}
if [ $script == $0 ]; then
echo "ERROR: You must source this script"
exit 2
fi
full_script=$(readlink -f $script)
script_name=$(basename $full_script)
script_dir=$(dirname $full_script)
current_dir=$(pwd)
source $script_dir/shared/bin/set_common_functions.sh
source $script_dir/shared/bin/set_common_env_vars.sh
source $VITIS_DIR/Runtime/xrt_common_functions.sh
# Source sdk_setup.sh
info_msg "Sourcing sdk_setup.sh"
if ! source $AWS_FPGA_REPO_DIR/sdk_setup.sh; then
return 1
fi
if [ -z "$SDK_DIR" ]; then
err_msg "SDK_DIR environment variable is not set. Please use 'source sdk_setup.sh' from the aws-fpga directory."
return 1
fi
debug=0
function usage {
echo -e "USAGE: source [\$AWS_FPGA_REPO_DIR/]$script_name [-d|-debug] [-h|-help]"
}
function help {
info_msg "$script_name"
info_msg " "
info_msg "Sets up the environment for AWS FPGA Vitis tools."
info_msg " "
info_msg "vitis_setup.sh script will:"
info_msg " (1) install FPGA Management Tools,"
info_msg " (2) check if Xilinx tools are available,"
info_msg " (3) check if required packages are installed,"
info_msg " (4) Download lastest AWS Platform,"
info_msg " (5) Install Runtime drivers "
echo " "
usage
}
function check_set_xilinx_vitis {
if [[ ":$XILINX_VITIS" == ':' ]]; then
debug_msg "XILINX_VITIS is not set"
which vitis
RET=$?
if [ $RET != 0 ]; then
debug_msg "vitis not found in path."
err_msg "XILINX_VITIS variable not set and vitis not in the path"
err_msg "Please set XILINX_VITIS variable to point to your location of your Xilinx installation or add location of vitis exectuable to your PATH variable"
return $RET
else
export XILINX_VITIS=`which vitis | sed 's:/bin/vitis::'`
info_msg "Setting XILINX_VITIS to $XILINX_VITIS"
fi
else
info_msg "XILINX_VITIS is already set to $XILINX_VITIS"
fi
# get Vitis release version, i.e. "2019.2"
RELEASE_VER=$(basename $XILINX_VITIS)
RELEASE_VER=${RELEASE_VER:0:6}
export RELEASE_VER=$RELEASE_VER
echo "RELEASE_VER equals $RELEASE_VER"
}
function check_install_packages_centos {
#TODO: Check required packages are installed or install them
#TODO: Check version of gcc is above 4.8.5 (4.6.3 does not work)
for pkg in `cat $VITIS_DIR/packages.txt`; do
if yum list installed "$pkg" >/dev/null 2>&1; then
true
else
warn_msg " $pkg not installed - please run: sudo yum install $pkg "
fi
done
}
function check_install_packages_ubuntu {
for pkg in `cat $VITIS_DIR/packages.txt`; do
if apt -qq list "$pkg" >/dev/null 2>&1; then
true
else
warn_msg " $pkg not installed - please run: sudo apt-get install $pkg "
fi
done
}
function check_internet {
curl --silent --head -m 30 http://www.amazon.com
RET=$?
if [ $RET != 0 ]; then
err_msg "curl cannot connect to the internet using please check your internet connection or proxy settings"
err_msg "To check your connection run: curl --silent --head -m 30 http://www.amazon.com "
return $RET
else
info_msg "Internet Access OK"
fi
}
function check_icd {
info_msg "Checking ICD is installed"
if grep -q 'libxilinxopencl.so' /etc/OpenCL/vendors/xilinx.icd; then
info_msg "Found 'libxilinxopencl.so"
else
info_msg "/etc/OpenCL/vendors/xilinx.icd does not exist or does not contain lbixilinxopencl.so creating and adding libxilinxopencl.so to it"
sudo sh -c "echo libxilinxopencl.so > /etc/OpenCL/vendors/xilinx.icd"
RET=$?
if [ $RET != 0 ]; then
err_msg "/etc/OpenCL/vendors/xilinx.icd does not exist and cannot be created, sudo permissions needed to update it."
err_msg "Run the following with sudo permissions: sudo sh -c \"echo libxilinxopencl.so > /etc/OpenCL/vendors/xilinx.icd\" "
return $RET
else
echo "Done with ICD installation"
fi
fi
}
# Process command line args
args=( "$@" )
for (( i = 0; i < ${#args[@]}; i++ )); do
arg=${args[$i]}
case $arg in
-d|-debug)
debug=1
;;
-h|-help)
help
return 0
;;
*)
err_msg "Invalid option: $arg\n"
usage
return 1
esac
done
# Check XILINX_VITIS is set
if ! check_set_xilinx_vitis; then
return 1
fi
info_msg " XILINX_VITIS is set to $XILINX_VITIS"
# Install patches as required.
info_msg "Setting up Vitis patches if required."
setup_patches
# Update Xilinx Vitis Examples from GitHub
info_msg "Using Vitis $RELEASE_VER"
if [[ $RELEASE_VER =~ .*2019\.2.* || $RELEASE_VER =~ .*2020\.1.* || $RELEASE_VER =~ .*2020\.2.* || $RELEASE_VER =~ .*2021\.1.* ]]; then
info_msg "Updating Xilinx Vitis Examples $RELEASE_VER"
git submodule update --init -- Vitis/examples/xilinx_$RELEASE_VER
export VIVADO_TOOL_VER=$RELEASE_VER
if [ -e $VITIS_DIR/examples/xilinx ]; then
if [ ! -L $VITIS_DIR/examples/xilinx ]; then
err_msg "ERROR: Vitis/examples/xilinx is not a symbolic link. Backup any data and remove Vitis/examples/xilinx directory. The setup needs to create a symbolic link from Vitis/examples/xilinx to Vitis/examples/xilinx_$RELEASE_VER"
return 1
fi
fi
ln -sf $VITIS_DIR/examples/xilinx_$RELEASE_VER $VITIS_DIR/examples/xilinx
else
echo " $RELEASE_VER is not supported (2019.2, 2020.1, 2020.2 or 2021.1 are supported).\n"
return 2
fi
# Check if internet connection is available
if ! check_internet; then
return 1
fi
# Check ICD is installed
if ! check_icd; then
return 1
fi
# Check correct packages are installed
if [[ $(lsb_release -si) == "Centos" ]]; then
if ! check_install_packages_centos; then
return 1
fi
elif [[ $(lsb_release -si) == "Ubuntu" ]]; then
if ! check_install_packages_ubuntu; then
return 1
fi
#elif [[ $(lsb_release -si) == "Ubuntu" ]]; then
# if ! check_install_packages_ubuntu; then
# return 1
# fi
fi
function setup_xsa {
if [ "$#" -ne 3 ]; then
err_msg "Illegal number of parameters sent to the setup_xsa function!"
return 1
fi
XSA=$1
XSA_S3_BASE_DIR=$2
PLATFORM_ENV_VAR_NAME=$3
xsa_dir=$VITIS_DIR/aws_platform/$XSA/hw/
vitis_xsa=$xsa_dir/$XSA.xsa
vitis_xsa_s3_bucket=aws-fpga-hdk-resources
s3_vitis_xsa=$vitis_xsa_s3_bucket/Vitis/$XSA_S3_BASE_DIR/$XSA/$XSA.xsa
# set a variable to point to the platform for build and emulation runs
export "$PLATFORM_ENV_VAR_NAME"=$VITIS_DIR/aws_platform/$XSA/$XSA.xpfm
# Download the sha256
if [ ! -e $xsa_dir ]; then
mkdir -p $xsa_dir || { err_msg "Failed to create $xsa_dir"; return 2; }
fi
# Use curl instead of AWS CLI so that credentials aren't required.
curl -s https://s3.amazonaws.com/$s3_vitis_xsa.sha256 -o $vitis_xsa.sha256 || { err_msg "Failed to download XSA version from $s3_vitis_xsa.sha256 -o $vitis_xsa.sha256"; return 2; }
if grep -q '<?xml version' $vitis_xsa.sha256; then
err_msg "Failed to download VITIS XSA version from $s3_vitis_xsa.sha256"
cat vitis_xsa.sha256
return 2
fi
exp_sha256=$(cat $vitis_xsa.sha256)
debug_msg " latest version=$exp_sha256"
# If XSA already downloaded check its sha256
if [ -e $vitis_xsa ]; then
act_sha256=$( sha256sum $vitis_xsa | awk '{ print $1 }' )
debug_msg " existing version=$act_sha256"
if [[ $act_sha256 != $exp_sha256 ]]; then
info_msg "VITIS XSA version is incorrect"
info_msg " Saving old XSA to $vitis_xsa.back"
mv $vitis_xsa $vitis_xsa.back
fi
else
info_msg "VITIS XSA hasn't been downloaded yet."
fi
if [ ! -e $vitis_xsa ]; then
info_msg "Downloading latest VITIS XSA from $s3_vitis_xsa"
# Use curl instead of AWS CLI so that credentials aren't required.
curl -s https://s3.amazonaws.com/$s3_vitis_xsa -o $vitis_xsa || { err_msg "VITIS XSA download failed"; return 2; }
fi
# Check sha256
act_sha256=$( sha256sum $vitis_xsa | awk '{ print $1 }' )
if [[ $act_sha256 != $exp_sha256 ]]; then
err_msg "Incorrect VITIS XSA version:"
err_msg " expected version=$exp_sha256"
err_msg " actual version=$act_sha256"
err_msg " There may be an issue with the uploaded XSA or the download failed."
return 2
fi
}
#-------------------201920_2 Vitis Platform----------------------
setup_xsa xilinx_aws-vu9p-f1_shell-v04261818_201920_2 xsa_v121319_shell_v04261818 AWS_PLATFORM_201920_2
info_msg "AWS Platform: 201920_2 Vitis Platform is up-to-date"
#-------------------201920_2 Vitis Platform----------------------
# Setup XRT as we need it for building
setup_runtime
export AWS_PLATFORM=$AWS_PLATFORM_201920_2
info_msg "The default AWS Platform has been set to: \"AWS_PLATFORM=\$AWS_PLATFORM_201920_2\" "
info_msg "Vitis Setup PASSED"
info_msg "To run a runtime example, start the MPD service by calling: \`systemctl is-active --quiet mpd || sudo systemctl start mpd\`"