forked from aws/aws-fpga
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathcreate_sdaccel_afi.sh
executable file
·296 lines (254 loc) · 14.7 KB
/
create_sdaccel_afi.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
293
294
295
#!/bin/bash
# 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.
set -e
script=${BASH_SOURCE[0]}
full_script=$(readlink -f $script)
script_name=$(basename $full_script)
source $AWS_FPGA_REPO_DIR/shared/bin/set_common_functions.sh
source $AWS_FPGA_REPO_DIR/shared/bin/set_common_env_vars.sh
debug=0
function usage {
info_msg "USAGE: $script_name [-h|-help] [-s3_bucket=<bucket_name>] [-s3_dcp_key=<S3_folder_of_dcp>] [-s3_logs_key=<S3_folder_of_logs>] [-xclbin=<xclbin_filename>] [-o=<awsxclbin_filename>] [-awsprofile=<aws_profile_name>]"
}
function help {
info_msg "$script_name"
info_msg " "
info_msg "SDAccel AFI Creation"
info_msg " "
info_msg "create_sdaccel_afi.sh assumes you have:"
info_msg " (*) Read the README on Github and understand the SDAccel workflow (SDAccel/README.md)"
info_msg " (*) Generated an XCLBIN using the SDAccel Build flow"
info_msg " (*) Ready to create an AFI and test on F1. Your kernel has been validated using SW/HW Emulation."
info_msg "create_sdaccel_afi.sh will:"
info_msg " (1) Split your XCLBIN into two parts: DCP (.bit) and Metadata (.xml)"
info_msg " (2) Generates a Manifest file for AFI creation that sets the clocks based on your achieved target freq from your build"
info_msg " (3) Prepares tar file for AFI creation process"
info_msg " (4) Calls aws ec2 create-fpga-image"
info_msg " (5) Creates new XCLBIN (called AWSXCLBIN) that is composed of: Metadata and AGFI-ID"
echo " "
usage
}
if [ "$1" == "" ]
then
err_msg "Invalid usage"
usage
exit 1
fi
while [ "$1" != "" ]; do
PARAM=`echo $1 | awk -F= '{print $1}'`
VALUE=`echo $1 | awk -F= '{print $2}'`
case $PARAM in
-h | --help)
help
exit
;;
-xclbin)
xclbin=$VALUE
;;
-o)
awsxclbin=$VALUE
;;
-aws_profile_name)
aws_profile_name=$VALUE
;;
-s3_bucket)
s3_bucket=$VALUE
;;
-s3_logs_key)
s3_logs=$VALUE
;;
-s3_dcp_key)
s3_dcps=$VALUE
;;
*)
err_msg "Unknown parameter \"$PARAM\""
usage
exit 1
;;
esac
shift
done
if [ "$HDK_DIR" == "" ]
then
err_msg "Env HDK_DIR not set"
exit 1
fi
if [ "$RELEASE_VER" == "" ]
then
err_msg "Env variable RELEASE_VER not set, did you source sdaccel_setup.sh?"
exit 1
fi
if [[ -e "$xclbin" ]]
then
info_msg "Found xclbin '$xclbin'"
else
err_msg "File '$xclbin' not found"
exit 1
fi
stripped_xclbin=$(basename $xclbin)
ext_xclbin=${stripped_xclbin##*.}
stripped_xclbin=${stripped_xclbin%.*}
info_msg "$stripped_xclbin"
if [ "$awsxclbin" == "" ]
then
awsxclbin=$stripped_xclbin
fi
if [ "$awsxclbin" != "$stripped_xclbin" ]
then
warn_msg "$awsxclbin does not match $stripped_xclbin"
warn_msg "For github examples, -o <xclbin_filename> must be equal to $stripped_xclbin"
fi
if [[ -e "$awsxclbin" ]]
then
err_msg "File '$awsxclbin' already exists"
exit 1
fi
if [ ":$s3_bucket" == ":" ]
then
err_msg "Invalid s3_bucket"
usage
exit 1
fi
# s3 logs is not required
# s3 dcp key is required
if [ "$s3_dcps" == "" ]
then
err_msg "Invalid s3_dcps key"
usage
exit 1
fi
timestamp=$(date +"%y_%m_%d-%H%M%S")
#Steps
#1. Strip XCLBIN to get DCP for ingestion
#2. Create Manifest file
#3. Prepare ingestion tar file
#4. Call create-fpga-image
#5. Manipulate the AFI ID
#6. Create awsxclbin
#STEP 1
#Strip XCLBIN to get DCP for ingestion
$XILINX_SDX/runtime/bin/xclbinsplit -o ${timestamp} $xclbin
if [[ -e "${timestamp}-primary.bit" ]]
then
info_msg "Split DCP from xclbin: ${timestamp}-primary.bit"
else
err_msg "File ${timestamp}-primary.bit not found"
exit 1
fi
if [[ -e "${timestamp}-xclbin.xml" ]]
then
info_msg "Split Metadata from xclbin: ${timestamp}-primary.bit"
else
err_msg "File ${timestamp}-xclbin.xml not found"
exit 1
fi
if [[ -d "to_aws" ]]
then
err_msg "Directory to_aws already exists"
exit 1
fi
mkdir to_aws
cp ${timestamp}-primary.bit to_aws/${timestamp}_SH_CL_routed.dcp
#STEP 2
#Create Manifest file
strategy=DEFAULT
hdk_version=$(grep 'HDK_VERSION' $HDK_DIR/hdk_version.txt | sed 's/=/ /g' | awk '{print $2}')
shell_version=0x04261818
tool_version=v$RELEASE_VER
device_id=0xF010
vendor_id=0x1D0F
subsystem_id=0x1D51
subsystem_vendor_id=0xFEDD
board_id=$(echo 'cat //project/platform/@boardid' | xmllint --shell "${timestamp}-xclbin.xml" | grep -v ">" | cut -f 2 -d "=" | tr -d \");
plat_name=$(echo 'cat //project/platform/@name' | xmllint --shell "${timestamp}-xclbin.xml" | grep -v ">" | cut -f 2 -d "=" | tr -d \");
clock_main_a0=$(echo 'cat //project/platform/device/systemClocks/clock/@frequency' | xmllint --shell "${timestamp}-xclbin.xml" | grep -v ">" | cut -f 2 -d "=" | tr -d MHz\" | xargs printf "%.0f");
clock_extra_b0=$(echo 'cat //project/platform/device/core/kernelClocks/clock[@port="DATA_CLK"]/@frequency' | xmllint --shell "${timestamp}-xclbin.xml" | grep -v ">" | cut -f 2 -d "=" | tr -d MHz\" | xargs printf "%.0f");
if [ "$plat_name" == "dynamic" ]
then
clock_extra_c0=$(echo 'cat //project/platform/device/core/kernelClocks/clock[@port="KERNEL_CLK"]/@frequency' | xmllint --shell "${timestamp}-xclbin.xml" | grep -v ">" | cut -f 2 -d "=" | tr -d MHz\" | xargs printf "%.0f");
else
clock_extra_c0=$(echo 'cat //project/platform/device/core/kernelClocks/clock[@port="KERNEL_CLK2"]/@frequency' | xmllint --shell "${timestamp}-xclbin.xml" | grep -v ">" | cut -f 2 -d "=" | tr -d MHz\" | xargs printf "%.0f");
fi
#id0_version=$(grep 'CL_SH_ID0' $CL_DIR/design/cl_id_defines.vh | grep 'define' | sed 's/_//g' | awk -F "h" '{print $2}')
#device_id="0x${id0_version:0:4}";
#vendor_id="0x${id0_version:4:4}";
#id1_version=$(grep 'CL_SH_ID1' $CL_DIR/design/cl_id_defines.vh | grep 'define' | sed 's/_//g' | awk -F "h" '{print $2}')
#subsystem_id="0x${id1_version:0:4}";
#subsystem_vendor_id="0x${id1_version:4:4}";
if [[ "$board_id" != "aws-vu9p-f1-04261818" ]]
then
err_msg "Platform $board_id used to create xclbin is not correct, you should be using aws-vu9p-f1-04261818"
exit
fi
#Write Manifest File here
hash=$( sha256sum to_aws/${timestamp}_SH_CL_routed.dcp | awk '{ print $1 }' )
manifest_file="${timestamp}_manifest.txt"
exec 3<>$manifest_file
echo "manifest_format_version=2" >&3
echo "pci_vendor_id=$vendor_id" >&3
echo "pci_device_id=$device_id" >&3
echo "pci_subsystem_id=$subsystem_id" >&3
echo "pci_subsystem_vendor_id=$subsystem_vendor_id" >&3
echo "dcp_hash=$hash" >&3
echo "shell_version=$shell_version" >&3
echo "dcp_file_name=${timestamp}_SH_CL_routed.dcp" >&3
echo "hdk_version=$hdk_version" >&3
echo "tool_version=$tool_version" >&3
echo "date=$timestamp" >&3
echo "clock_main_a0=$clock_main_a0" >&3
echo "clock_extra_b0=$clock_extra_b0" >&3
echo "clock_extra_c0=$clock_extra_c0" >&3
exec 3>&-
exec 3>&-
if [[ -e "$manifest_file" ]]
then
info_msg "Generated manifest file '$manifest_file'"
else
err_msg "File '$manifest_file' not found"
exit 1
fi
cp $manifest_file to_aws/$manifest_file
#STEP 3
#Prepare ingestion
tar -cf ${timestamp}_Developer_SDAccel_Kernel.tar to_aws/${timestamp}_SH_CL_routed.dcp to_aws/${timestamp}_manifest.txt
#STEP 4
#Call create-fpga-image
profile_text=""
if [ "$aws_profile_name" != "" ]
then
profile_text="--profile ${aws_profile_name}"
fi
log_storage_text=""
if [ "${s3_logs}" != "" ]
then
log_storage_text="--logs-storage-location Bucket=${s3_bucket},Key=${s3_logs}"
fi
aws s3 ${profile_text} cp ${timestamp}_Developer_SDAccel_Kernel.tar s3://${s3_bucket}/${s3_dcps}/
aws ec2 ${profile_text} create-fpga-image --name ${stripped_xclbin} --description ${stripped_xclbin} --input-storage-location Bucket=${s3_bucket},Key=${s3_dcps}/${timestamp}_Developer_SDAccel_Kernel.tar ${log_storage_text} > ${timestamp}_afi_id.txt
#STEP 5
#Manipulate the AFI ID
test=`grep agfi ${timestamp}_afi_id.txt | awk -F: '{print $2}' | sed 's/ \"//g' | sed 's/\".*//g' | sed ':a;N;$!ba;s/\n/ /g'`
echo -n $test > ${timestamp}_agfi_id.txt
echo ${timestamp}_agfi_id.txt
#STEP 6
#Create .awsxclbin
command="$XILINX_SDX/runtime/bin/xclbincat -b ${timestamp}_agfi_id.txt -m ${timestamp}-xclbin.xml -n header.bin -o ${awsxclbin}.awsxclbin"
if [ "$plat_name" == "dynamic" ]
then
command="$command -k mode:hw_pr -k featureRomTimestamp:0 -r runtime_data.rtd"
fi
info_msg "Calling $command"
$command