summaryrefslogtreecommitdiff
path: root/tcwg-benchmark.sh
blob: 77921a2012129bfad3884ba6f6b359cbfc1f8f83 (plain)
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
#!/bin/bash

# Clean: shellcheck -e 2001 ./tcwg-benchmark.sh

set -eu

scripts=$(dirname "$0")
# shellcheck source=jenkins-helpers.sh
. $scripts/jenkins-helpers.sh

convert_args_to_variables "$@"
obligatory_variables \
    boardname \
    image_arch \
    toolchain_url \
    bench_list \
    cflags \
    ldflags \
    extension \
    testmode \
    iterations \
    run_profile \
    sysroot \
    forceinstall \
    builder \
    results_id \
    WORKSPACE \
    reboot \
    ignore_errors \
    clean_older_than
declare -g \
	boardname \
	image_arch \
	toolchain_url \
	bench_list \
	cflags \
	ldflags \
	extension \
	testmode \
	iterations \
	run_profile \
	sysroot \
	forceinstall \
	builder \
	results_id \
	WORKSPACE \
	reboot \
	ignore_errors \
	clean_older_than

# Make shellcheck happy and workaround Jenkins not defining variables
# for empty arguments.
bench_container_tag="${bench_container_tag-bionic}"
toolchain_type="${toolchain_type-auto}"
prepare_board="${prepare_board-true}"
verbose="${verbose-true}"

if $verbose; then
    set -x
fi

prepare_toolchain ()
{
# If $toolchain_url is of ssh:// type, don't create a remote build
# container, just use the ssh command as provided.
build_container_host=
build_container_port=
case "$toolchain_url" in
    "ssh://"*)
	ccprefix="${toolchain_url##ssh://}"

	# Extract host:port: specification from ccprefix, we don't
	# need to care about :parallelize here, just pass it to run.sh
	# if present.
	build=${ccprefix%:*}
	build_container_host="$(echo $build | cut -d: -f 1)"
	case ${ccprefix} in
	    *:*:*)
		build_container_port="$(echo $build | cut -s -d: -f 2)"
		;;
	    *:*)
		# If no port is specified, use 22 (ssh default port)
		build_container_port=22
		;;
	esac

	if [ "x$build_container_host" = "x" ]; then
	    echo "ERROR: ssh:// toolchain_url lacks a host: $toolchain_url."
	    exit 1
	fi
	if [ "x$build_container_port" = "x" ]; then
	    echo "ERROR: ssh:// toolchain_url lacks a port: $toolchain_url."
	    exit 1
	fi
	;;
    *)
	if [ x"$builder" = x"bmk_board" ]; then
	    # shellcheck disable=SC2154
	    build_container_host=$run_container_host
	    # shellcheck disable=SC2154
	    build_container_port=$run_container_port
	else
	    build_container_tag="${builder#*:}"
	    builder="${builder%:*}"
	    if echo "$builder" | grep -q ".*-[0-9]\+"; then
		# Builder is a specific node
		docker_host_opt="--arch amd64 --node $builder"
	    else
		docker_host_opt="--label $builder"
	    fi

	    $scripts/start-container-docker.sh $docker_host_opt --distro "$build_container_tag" --task build --prefix build_ > build-container.sh
	    . ./build-container.sh
	fi
	;;
esac

case "$toolchain_url" in
    "ssh://"*)
	if [ x"$sysroot" = x"tarball" ]; then
            echo "ERROR: Unsupported sysroot $sysroot for toolchain_url $toolchain_url"
            exit 1
	fi
	# Last component of ccprefix is the path, keep it
	toolchaindir="$(dirname ${ccprefix##*:})"
	;;
    "http://"*".tar.xz"|"https://"*".tar.xz")
	toolchaindir=$(untar_url "$toolchain_url" "$WORKSPACE" "--strip-components 1")
	;;
    "rsync://"*)
	ccprefix="${toolchain_url##rsync://}"

	# Extract host:port: specification from ccprefix, we don't
	# need to care about :parallelize here, just pass it to run.sh
	# if present.
	rsync_spec=${ccprefix%:*}
	rsync_host="$(echo $rsync_spec | cut -d: -f 1)"
	case ${ccprefix} in
	    *:*:*)
		rsync_port="$(echo $rsync_spec | cut -s -d: -f 2)"
		;;
	    *:*)
		# If no port is specified, use 22 (ssh default port)
		rsync_port=22
		;;
	esac
	# We want to access the remote toolchain via a container, to
	# avoid problems with the hosts's ssh server restrictions on the
	# number of simulaneous connexions.
	# We copy it to the build container (assuming it uses the same
	# architecture as the machine pointed to by $toolchain_url).
	# Assume ccprefix looks like /path/bin/target-triplet-, and
	# compute 'path'.
	src_toolchaindir=$(dirname "$(dirname ${ccprefix##*:})")
	toolchaindir="${WORKSPACE}/toolchain"
	rsync -az --delete -e "ssh -p$rsync_port" \
	      "$rsync_host:$src_toolchaindir/" "$toolchaindir/"
	;;
    *)
	echo "ERROR: Cannot handle toolchain_url: $toolchain_url"
	exit 1
	;;
esac

# Sanity check that toolchain_type is supported
case "$toolchain_type" in
    gnu|llvm) ;;
    *)
	echo "ERROR: Unsupported toolchain type: $toolchain_type"
	exit 1
	;;
esac

# In the ssh:// case, we have to perform the 'find' operations
# remotely.
case "$toolchain_url" in
    "ssh://"*)
	maybe_remote="ssh -p $build_container_port $build_container_host"
	;;
    *)
	maybe_remote=""
	;;
esac

case "$toolchain_type" in
    "gnu"|"llvm") ;;
    "auto")
	if [ x"$($maybe_remote find "$toolchaindir" -path "*bin/*gcc" | wc -l)" != x"0" ]; then
	    toolchain_type="gnu"
	elif [ x"$($maybe_remote find "$toolchaindir" -path "*bin/*clang" | wc -l)" != x"0" ]; then
	    toolchain_type="llvm"
	else
	    echo "ERROR: Cannot autodetect toolchain type"
	    exit 1
	fi
	;;
esac

# Non-ssh:// cases have to copy the just-copied toolchain to
# the remote build container. For ssh://, we'll access the
# toolchain remotely.
case "$toolchain_url" in
    "ssh://"*) ;;
    *)
	case "$toolchain_type" in
	    "gnu") ccname="gcc" ;;
	    "llvm") ccname="clang" ;;
	esac

	ccpath=$($maybe_remote find "$toolchaindir" -path "*bin/*$ccname")
	if [ "$(echo "$ccpath" | wc -w)" -ne 1 ]; then
	    echo "ERROR: found more than one compiler: $ccpath"
	    exit 1
	fi

	ccprefix=$(echo "$ccpath" | sed -e "s/$ccname\$//")
	# Copy toolchain to the build container.
	rsync -a --delete -e "ssh -p$build_container_port" "$toolchaindir/" "$build_container_host:$toolchaindir/"
	if [ x"$builder" != x"bmk_board" ]; then
	    ccprefix="$build_container_host:$build_container_port:$ccprefix"
	fi
	;;
esac

case "$sysroot" in
    "tarball")
	sysroot="$build_container_host:$build_container_port:$(find "$toolchaindir" -name "libc")"
	;;
    "http://"*|"https://"*)
	sysrootdir=$(untar_url "$sysroot" "$WORKSPACE" "--strip-components 1")
	# Copy toolchain to the build container.
	rsync -a --delete -e "ssh -p$build_container_port" "$sysrootdir/" "$build_container_host:$sysrootdir/"
	sysroot="$build_container_host:$build_container_port:$sysrootdir"
	;;
    "ssh://"*)
	sysroot="${sysroot##ssh://}"

	# Check host:port specification from sysroot.
	case ${sysroot} in
	    *:*) ;;
	    *)
		echo "ERROR: ssh:// sysroot lacks a host: $sysroot"
		exit 1
		;;
	esac
	;;

    "")
	# Use system sysroot.
	;;
    *)
	echo "ERROR: Cannot handle sysroot: $sysroot"
	exit 1
	;;
esac
}

if echo "$results_id" | grep -q "\.\."; then
    echo "ERROR: results_id should not escape /home/tcwg-benchmark/results* hierarchy; do not use \"..\""
    exit 1
fi

hw_tag="${results_id%%/*}"
case "$hw_tag:$boardname:$image_arch" in
    apm_32:*-apm-*:armhf) ;;
    apm_64:*-apm-*:arm64) ;;
    sq_32:*-sq-*:armhf) ;;
    sq_64:*-sq-*:arm64) ;;
    stm32:dev-*:amd64) ;;
    tk1_32:*-tk1-*:armhf) ;;
    tx1_64:*-tx1-*:arm64) ;;
    tx1_32:*-tx1-*:armhf) ;;
    *)
	echo "ERROR: results_id does not start with a valid hw_tag: $hw_tag"
	exit 1
	;;
esac

# Check that we can ssh to the board and rsync scripts.  This ensures that
# the board is online and filesystem is good condition.  Try to reboot and/or
# power-cycle the board as needed.
case "$hw_tag:$reboot" in
    stm32:*)
	# 1. If the host machine isn't available on the 1st try -- give up.
	tries_left=1
	reboot=false
	prepare_board=false
	;;
    *:true)
	# 1. Try access after soft reboot
	# 2. Try access after power-cycle
	tries_left=2
	;;
    *)
	# 1. Try access without rebooting
	# 2. Try access after soft reboot
	# 3. Try access after power-cycle
	tries_left=3
	;;
esac
force_power_cycle=false
while [ $tries_left != 0 ]; do
    tries_left=$(($tries_left-1))

    if $reboot; then
	if ! ssh "$boardname" true || $force_power_cycle; then
	    echo "Trying to power-cycle $boardname"
	    (
		pdu_name=$(echo "${boardname%.tcwglab}" \
			       | sed -e 's/^tcwg-bmk-/tcwg-/')
		nvidia-power-cycle.sh "$pdu_name"
		wait_for_ssh_server "$boardname" 22 100
	    ) &
	    wait $! || exit $EXTERNAL_FAIL
	    echo "Successfully powered-cycled $boardname"
	else
	    # Reboot the board.
	    # Ping board every second (ServerAliveInterval=1) to avoid
	    # waiting [default] 5min for ssh to break connection.
	    ssh -Snone -oServerAliveInterval=1 $boardname sudo /sbin/reboot \
		|| true
	    # Wait until the ssh server is ready
	    sleep 30 # Give time to the board to shutdown
	    ret=0
	    wait_for_ssh_server $boardname 22 100 || ret=$?
	    if [ $ret != 0 ]; then
		echo "SSH server did not respond after reboot, exiting."
		exit $EXTERNAL_FAIL
	    fi
	fi
    fi

    rsync -az --delete bmk-scripts/ "$boardname:bmk-scripts/" &
    res=0 && wait $! || res=$?
    if [ $res = 0 ]; then
	break
    else
	reboot=true
	if [ x"$tries_left" = x"1" ]; then
	    force_power_cycle=true
	fi
    fi
done

if [ $res != 0 ]; then
    echo "ERROR: Could not get board online"
    exit $EXTERNAL_FAIL
fi

if $prepare_board; then
    # FIXME: Implement more configurations and checks:
    # disable swap
    # set interrupt affinity
    # check that there are no stray processes
    # test that taskset works
    remote_exec "$boardname:::-t -Snone" \
		sudo /usr/local/bin/benchmark.sh --hw_tag "$hw_tag" \
		--action start_board --verbose \
		--image "linaro/ci-$image_arch-tcwg-build-ubuntu:$bench_container_tag" &

    res=0 && wait $! || res=$?
    if [ $res != 0 ]; then
	echo "ERROR: Could not prepare board for benchmarking"
	exit $EXTERNAL_FAIL
    fi
fi

# Make sure to cleanup build container if something goes
# wrong when preparing the test environment
trap "cleanup_all_containers" EXIT

# Start a container to run the benchmarks in.
# We install SPEC in /home/tcwg-benchmark, so bind-mount it as $WORKSPACE.
WORKSPACE=$HOME $scripts/start-container-docker.sh --session-host "$boardname" --arch "$image_arch" --distro "$bench_container_tag" --task bench --docker_opts "--privileged" --prefix run_ > run-container.sh &

res=0 && wait $! || res=$?
if [ $res != 0 ]; then
    echo "ERROR: Could not start benchmarking container"
    exit $EXTERNAL_FAIL
fi

trap "cleanup_all_containers" EXIT
. ./run-container.sh
declare -g run_container_host run_container_port

prepare_toolchain

case "$bench_list" in
    coremark)
	remote_exec "$run_container_host:$run_container_port:bmk-scripts:-t -Snone" \
		    ./coremark.sh \
		    --ccprefix "$ccprefix" \
		    --cflags "$cflags" \
		    --ldflags "$ldflags" \
		    --forceinstall "true" \
		    --resultsdest "bkp-01.tcwglab:/home/tcwg-benchmark/results-${results_id}/$boardname" \
		    --verbose true
	;;
    *)
	case "$testmode" in
	    build|verify) input_size="test" ;;
	    benchmark) input_size="ref" ;;
	esac
	remote_exec "$run_container_host:$run_container_port::-t -Snone" \
		    bmk-scripts/run.sh \
		    --bench "$bench_list" \
		    --config "$run_profile" \
		    --cflags "$cflags" \
		    --ldflags "$ldflags" \
		    --ccprefix "$ccprefix" \
		    --extension "$extension" \
		    --hw_tag "$hw_tag" \
		    --ignore_errors "$ignore_errors" \
		    --input_size "$input_size" \
		    --iterations "$iterations" \
		    --run_profile "$run_profile" \
		    ${sysroot:+--sysroot "$sysroot"} \
		    --toolchain "$toolchain_type" \
		    --resultsdest "bkp-01.tcwglab:/home/tcwg-benchmark/results-${results_id}/$boardname" \
		    --nodename "$boardname" \
		    --forceinstall "${forceinstall}" \
		    ${clean_older_than:+--clean_older_than "$clean_older_than"} \
		    --verbose true
	;;
esac

if $prepare_board; then
    remote_exec "$boardname:::-t -Snone" \
		sudo /usr/local/bin/benchmark.sh --action stop_board --verbose &
    res=0 && wait $! || res=$?
    if [ $res != 0 ]; then
	echo "Warning: prepare-board.sh did not finish cleanly"
    fi
fi