forked from firecracker-microvm/firecracker
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdevtool
executable file
·1842 lines (1577 loc) · 60.5 KB
/
devtool
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env bash
# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
# Firecracker devtool
#
# Use this script to build and test Firecracker.
#
# TL;DR
# Make sure you have Docker installed and properly configured
# (http://docker.com). Then,
# building: `./devtool build`
# Then find the binaries under build/debug/
# testing: `./devtool test`
# Will run the entire test battery; will take several minutes to complete.
# deep-dive: `./devtool shell`
# Open a shell prompt inside the container. Then build or test (or do
# anything, really) manually.
#
# Still TL;DR: have Docker; ./devtool build; ./devtool test; ./devtool help.
#
#
# Both building and testing are done inside a Docker container. Please make sure
# you have Docker up and running on your system (see http:/docker.com) and your
# user has permission to run Docker containers.
#
# The Firecracker sources dir will be bind-mounted inside the development
# container (under /firecracker) and any files generated by the build process
# will show up under the build/ dir. This includes the final binaries, as well
# as any intermediate or cache files.
#
# By default, all devtool commands run the container transparently, removing
# it after the command completes. Any persisting files will be stored under
# build/.
# If, for any reason, you want to access the container directly, please use
# `devtool shell`. This will perform the initial setup (bind-mounting the
# sources dir, setting privileges) and will then drop into a BASH shell inside
# the container.
#
# Building:
# Run `./devtool build`.
# By default, the debug binaries are built and placed under build/debug/.
# To build the release version, run `./devtool build --release` instead.
# You can then find the binaries under build/release/.
#
# Testing:
# Run `./devtool test`.
# This will run the entire integration test battery. The testing system is
# based on pytest (http://pytest.org).
#
# Opening a shell prompt inside the development container:
# Run `./devtool shell`.
#
# Additional information:
# Run `./devtool help`.
#
#
# TODO:
# - Cache test binaries, preserving them across `./devtool test` invocations.
# At the moment, Firecracker is rebuilt everytime a test is run.
# - List tests by parsing the `pytest --collect-only` output.
# - Implement test filtering with `./devtool test --filter <filter>`
# - Find an easier way to run individual tests on existing binaries.
# - Add a `./devtool run` command to set up and run Firecracker.
# - Add a `./devtool diag` command to help with troubleshooting, by checking
# the most common failure conditions.
# - Look into caching the Cargo registry within the container and if that
# would help with reproducible builds (in addition to pinning Cargo.lock)
# Development container image (without tag)
DEVCTR_IMAGE_NO_TAG="public.ecr.aws/firecracker/fcuvm"
# Development container tag
DEVCTR_IMAGE_TAG="v31"
# Development container image (name:tag)
# This should be updated whenever we upgrade the development container.
# (Yet another step on our way to reproducible builds.)
DEVCTR_IMAGE="${DEVCTR_IMAGE_NO_TAG}:${DEVCTR_IMAGE_TAG}"
# Naming things is hard
MY_NAME="Firecracker $(basename "$0")"
# Full path to the Firecracker tools dir on the host.
FC_TOOLS_DIR=$(cd "$(dirname "$0")" && pwd)
# Full path to the Firecracker sources dir on the host.
FC_ROOT_DIR=$(cd "${FC_TOOLS_DIR}/.." && pwd)
# Full path to the build dir on the host.
FC_BUILD_DIR="${FC_ROOT_DIR}/build"
# Full path to devctr dir on the host.
FC_DEVCTR_DIR="${FC_ROOT_DIR}/tools/devctr"
# Path to the linux kernel directory on the host.
KERNEL_DIR="${FC_ROOT_DIR}/.kernel"
# Full path to the cargo registry dir on the host. This appears on the host
# because we want to persist the cargo registry across container invocations.
# Otherwise, any rust crates from crates.io would be downloaded again each time
# we build or test.
CARGO_REGISTRY_DIR="${FC_BUILD_DIR}/cargo_registry"
# Full path to the cargo git registry on the host. This serves the same purpose
# as CARGO_REGISTRY_DIR, for crates downloaded from GitHub repos instead of
# crates.io.
CARGO_GIT_REGISTRY_DIR="${FC_BUILD_DIR}/cargo_git_registry"
# Full path to the cargo target dir on the host.
CARGO_TARGET_DIR="${FC_BUILD_DIR}/cargo_target"
# Full path to the seccompiler cargo target dir on the host.
CARGO_SECCOMPILER_TARGET_DIR="${FC_BUILD_DIR}/seccompiler"
# Full path to the Firecracker sources dir, as bind-mounted in the container.
CTR_FC_ROOT_DIR="/firecracker"
# Full path to the build dir, as bind-mounted in the container.
CTR_FC_BUILD_DIR="${CTR_FC_ROOT_DIR}/build"
# Full path to the cargo target dir, as bind-mounted in the container.
CTR_CARGO_TARGET_DIR="$CTR_FC_BUILD_DIR/cargo_target"
# Full path to the seccompiler cargo target dir, as bind-mounted in the container.
CTR_CARGO_SECCOMPILER_TARGET_DIR="$CTR_FC_BUILD_DIR/seccompiler"
# Full path to the microVM images cache dir
CTR_MICROVM_IMAGES_DIR="$CTR_FC_BUILD_DIR/img"
# Full path to the public key mapping on the guest
PUB_KEY_PATH=/root/.ssh/id_rsa.pub
# Full path to the private key mapping on the guest
PRIV_KEY_PATH=/root/.ssh/id_rsa
# Path to the linux kernel directory, as bind-mounted in the container.
CTR_KERNEL_DIR="${CTR_FC_ROOT_DIR}/.kernel"
# Global options received by $0
# These options are not command-specific, so we store them as global vars
OPT_UNATTENDED=false
# Get the target prefix to avoid repeated calls to uname -m
TARGET_PREFIX="$(uname -m)-unknown-linux-"
DEFAULT_TEST_SESSION_ROOT_PATH=/srv
DEFAULT_RAMDISK_PATH=/mnt/devtool-ramdisk
# Send a decorated message to stdout, followed by a new line
#
say() {
[ -t 1 ] && [ -n "$TERM" ] \
&& echo "$(tput setaf 2)[$MY_NAME]$(tput sgr0) $*" \
|| echo "[$MY_NAME] $*"
}
# Send a decorated message to stdout, without a trailing new line
#
say_noln() {
[ -t 1 ] && [ -n "$TERM" ] \
&& echo -n "$(tput setaf 2)[$MY_NAME]$(tput sgr0) $*" \
|| echo "[$MY_NAME] $*"
}
# Send a text message to stderr
#
say_err() {
[ -t 2 ] && [ -n "$TERM" ] \
&& echo -e "$(tput setaf 1)[$MY_NAME] $*$(tput sgr0)" 1>&2 \
|| echo -e "[$MY_NAME] $*" 1>&2
}
# Send a warning-highlighted text to stdout
say_warn() {
[ -t 1 ] && [ -n "$TERM" ] \
&& echo "$(tput setaf 3)[$MY_NAME] $*$(tput sgr0)" \
|| echo "[$MY_NAME] $*"
}
# Exit with an error message and (optional) code
# Usage: die [-c <error code>] <error message>
#
die() {
code=1
[[ "$1" = "-c" ]] && {
code="$2"
shift 2
}
say_err "$@"
exit $code
}
# Exit with an error message if the last exit code is not 0
#
ok_or_die() {
code=$?
[[ $code -eq 0 ]] || die -c $code "$@"
}
# Check if Docker is available and exit if it's not.
# Upon returning from this call, the caller can be certain Docker is available.
#
ensure_docker() {
NEWLINE=$'\n'
output=$(which docker 2>&1)
ok_or_die "Docker not found. Aborting." \
"Please make sure you have Docker (http://docker.com) installed" \
"and properly configured.${NEWLINE}" \
"Error: $?, command output: ${output}"
output=$(docker ps 2>&1)
ok_or_die "Error accessing Docker. Please make sure the Docker daemon" \
"is running and that you are part of the docker group.${NEWLINE}" \
"Error: $?, command output: ${output}${NEWLINE}" \
"For more information, see" \
"https://docs.docker.com/install/linux/linux-postinstall/"
}
# Run a command and retry multiple times if it fails. Once it stops
# failing return to normal execution. If there are "retry count"
# failures, set the last error code.
# $1 - command
# $2 - retry count
# $3 - sleep interval between retries
retry_cmd() {
command=$1
retry_cnt=$2
sleep_int=$3
{
$command
} || {
# Command failed, substract one from retry_cnt
retry_cnt=$((retry_cnt - 1))
# If retry_cnt is larger than 0, sleep and call again
if [ "$retry_cnt" -gt 0 ]; then
echo "$command failed, retrying..."
sleep "$sleep_int"
retry_cmd "$command" "$retry_cnt" "$sleep_int"
fi
}
}
# Attempt to download our Docker image. Exit if that fails.
# Upon returning from this call, the caller can be certain our Docker image is
# available on this system.
#
ensure_devctr() {
# We depend on having Docker present.
ensure_docker
# Check if we have the container image available locally. Attempt to
# download it, if we don't.
[[ $(docker images -q "$DEVCTR_IMAGE" | wc -l) -gt 0 ]] || {
say "About to pull docker image $DEVCTR_IMAGE"
get_user_confirmation || die "Aborted."
# Run docker pull 5 times in case it fails - sleep 3 seconds
# between attempts
retry_cmd "docker pull $DEVCTR_IMAGE" 5 3
ok_or_die "Error pulling docker image. Aborting."
}
}
# Check if /dev/kvm exists. Exit if it doesn't.
# Upon returning from this call, the caller can be certain /dev/kvm is
# available.
#
ensure_kvm() {
[[ -c /dev/kvm ]] || die "/dev/kvm not found. Aborting."
}
# Make sure the build/ dirs are available. Exit if we can't create them.
# Upon returning from this call, the caller can be certain the build/ dirs exist.
#
ensure_build_dir() {
for dir in "$FC_BUILD_DIR" "$CARGO_TARGET_DIR" \
"$CARGO_REGISTRY_DIR" "$CARGO_GIT_REGISTRY_DIR"; do
create_dir "$dir"
done
}
# Makes sure that Firecracker release binaries were built.
# This is relevant in the context of stripping the already built release binaries.
ensure_release_binaries_exist() {
target=$1
profile=$2
firecracker_bin_path="$CARGO_TARGET_DIR/$target/$profile/firecracker"
jailer_bin_path="$CARGO_TARGET_DIR/$target/$profile/jailer"
seccompiler_bin_path="$CARGO_SECCOMPILER_TARGET_DIR/$target/$profile/seccompiler-bin"
# Both binaries must exist for the stripping to be successful.
[ -f "$firecracker_bin_path" ] && [ -f "$jailer_bin_path" ] && [ -f "$seccompiler_bin_path" ] || \
die "Missing release binaries. Needed files:\n" \
"* $firecracker_bin_path\n" \
"* $jailer_bin_path\n" \
"* $seccompiler_bin_path\n" \
"To build the binaries, run:\n\t$0 build --$profile"
}
# Fix build/ dir permissions after a privileged container run.
# Since the privileged container runs as root, any files it creates will be
# owned by root. This fixes that by recursively changing the ownership of build/
# to the current user.
#
cmd_fix_perms() {
# Yes, running Docker to get elevated privileges, just to chown some files
# is a dirty hack.
run_devctr \
-- \
chown -R "$(id -u):$(id -g)" "$CTR_FC_BUILD_DIR"
}
# Builds the development container from its Dockerfile.
#
cmd_build_devctr() {
arch=$(uname -m)
docker_file_name="Dockerfile.$arch"
should_update_python_packages=true
build_args=""
while [ $# -gt 0 ]; do
case "$1" in
"-h"|"--help") { cmd_help; exit 1; } ;;
"-n"|"--no-python-package-update")
shift
should_update_python_packages=false
build_args="--build-arg POETRY_LOCK_PATH=tools/devctr/poetry.lock"
;;
"--") { shift; break; } ;;
*)
die "Unknown argument: $1. Please use --help for help."
;;
esac
shift
done
docker build -t "$DEVCTR_IMAGE_NO_TAG" -f "$FC_DEVCTR_DIR/$docker_file_name" $build_args .
if [ "$should_update_python_packages" = true ]; then
update_python_package_version
fi
}
# Prompt the user for confirmation before proceeding.
# Args:
# $1 prompt text.
# Default: Continue? (y/n)
# $2 confirmation input.
# Default: y
# Return:
# exit code 0 for successful confirmation
# exit code != 0 if the user declined
#
get_user_confirmation() {
# Pass if running unattended
[[ "$OPT_UNATTENDED" = true ]] && return 0
# Fail if STDIN is not a terminal (there's no user to confirm anything)
[[ -t 0 ]] || return 1
# Otherwise, ask the user
#
msg=$([ -n "$1" ] && echo -n "$1" || echo -n "Continue? (y/n) ")
yes=$([ -n "$2" ] && echo -n "$2" || echo -n "y")
say_noln "$msg"
read c && [ "$c" = "$yes" ] && return 0
return 1
}
# Validate the user supplied version number.
# It must be composed of 3 groups of integers separated by dot.
#
validate_version() {
declare version_regex="^([0-9]+.){2}[0-9]+$"
version="$1"
if [ -z "$version" ]; then
die "Version cannot be empty."
elif [[ ! "$version" =~ $version_regex ]]; then
die "Invalid version number: $version (expected: \$Major.\$Minor.\$Build)."
fi
}
# Validate that the repo targetted for a release exists.
#
validate_repo() {
user="$1"
repo="$2"
if [ -z "$user" ]; then
die "GitHub user cannot be empty."
fi
git_link="https://api.github.com/repos/$user/$repo"
status_code=$(curl --write-out %{http_code} --silent --output /dev/null $git_link)
if [[ "$status_code" -ne 200 ]] ; then
die "GitHub repo $git_link is not valid. Please provide a valid user/org and repository."
fi
}
# Validate there is no tag currently associated with the version provided.
#
check_release_tag() {
say "Fetching remote tags..."
git fetch upstream --tags
if git rev-parse v$1 >/dev/null 2>&1; then
say_err "Seems that tag provided is already associated with a release! "
say "Will skip drafting a new release for now."
return 1
fi
return 0
}
# Validate the user supplied kernel version number.
# It must be composed of 2 groups of integers separated by dot, with an optional third group.
validate_kernel_version() {
local version_regex="^([0-9]+.)[0-9]+(.[0-9]+)?$"
version="$1"
if [ -z "$version" ]; then
die "Kernel version cannot be empty."
elif [[ ! "$version" =~ $version_regex ]]; then
die "Invalid version number: $version (expected: \$Major.\$Minor.\$Patch(optional))."
fi
}
# Compose the text for a new release tag using the information in the changelog,
# between the two specified releases. Section headers (`###`) are removed.
# Args:
# $1 previous version.
# $2 new version.
#
compose_tag_text() {
release_text=$(compose_release_text "$1" "$2") || die "Could not compose release description."
echo "$release_text" | sed "s/^###\s//g"
}
# Compose the text for a new release using the information in the changelog,
# between the two specified releases.
# Args:
# $1 previous version.
# $2 new version.
#
compose_release_text() {
declare curr_ver="$1"
declare prev_ver="$2"
declare changelog="$FC_ROOT_DIR/CHANGELOG.md"
# Patterns for the sections in the changelog corresponding to the versions.
pat_curr="^##\s\[$curr_ver\]"
pat_prev="^##\s\[$prev_ver\]"
# Extract the section enclosed between the 2 headers and strip off the first
# 2 and last 2 lines (one is blank and one contains the header `## [A.B.C]`).
# Then, replace `-` with `*` and remove section headers.
sed "/$pat_curr/,/$pat_prev/!d" "$changelog" \
| sed '1,2d;$d' \
| sed "s/^-/*/g"
}
get_prev_release() {
declare version=$1
declare pat_release="^## \[([0-9]+\.){2}[0-9]+\]"
declare changelog="$FC_ROOT_DIR/CHANGELOG.md"
grep -q "\[$version\]" "$changelog"
ok_or_die "No changelog entry for release $version can be found. Make sure you have run ./devtool prepare_release."
# We work with the assumption that the changelog has already been updated
# and contains a header (and a corresponding section) for the new release.
# Step 1: Get all release numbers.
all_releases=($(grep -E "$pat_release" "$changelog"))
# Step 2: Trim out headers (`##`).
all_releases=(${all_releases[@]//##*})
# Step 3: Walk the array until we come across the desired release number,
# then pick up the next one. Since the latest releases are at the top of the
# changelog, the next one in line will be the previous one chronologically.
# The array now contains all the release numbers in the changelog, enclosed
# in square brackets.
for release in "${all_releases[@]}"; do
if [ -n "$found" ]; then
# Trim out square brackets.
prev_version=$(echo "$release" | awk -F"[][]" "{print \$2}")
break
elif [ "$release" == "[$version]" ]; then
found=1
fi
done
if [ -z "$prev_version" ]; then
die "Could not find a previous release for v$version."
fi
echo $prev_version
}
# Auxiliary function for creating the JSON for calling into
# GitHub's API for posting a release.
generate_release_post_data() {
cat <<EOF
{
"tag_name": "v$1",
"target_commitish": "$2",
"name": "Firecracker v$1",
"body": "$4",
"draft": $draft,
"prerelease": $3
}
EOF
}
# Call into GitHub's API to draft a release.
post_release() {
version="$1"
branch="$2"
user="$3"
repo="$4"
token="$5"
prerelease="$6"
release_text="$7"
# Will always create a draft release.
draft="true"
# We need to replace the newlines from the changelog content with
# literal newlines (i.e \n).
# Second pass: escape quotation marks.
json_changelog_content=$(echo "$release_text" | awk '{printf "%s\\n", $0}' | sed 's/\"/\\"/g')
API_JSON="$(generate_release_post_data $version $branch $prerelease "$json_changelog_content")"
API_RESPONSE_STATUS=$(curl -H "Authorization: token $token" --data "$API_JSON" -s -i https://api.github.com/repos/$3/$4/releases)
if [[ ! "$API_RESPONSE_STATUS" == *"HTTP/2 201"* ]]; then
die "Could not post release: $API_RESPONSE_STATUS"
fi
}
get_branch() {
echo `git rev-parse --abbrev-ref HEAD`
}
# Helper function to run the dev container.
# Usage: run_devctr <docker args> -- <container args>
# Example: run_devctr --privileged -- bash -c "echo 'hello world'"
run_devctr() {
docker_args=()
ctr_args=()
docker_args_done=false
while [[ $# -gt 0 ]]; do
[[ "$1" = "--" ]] && {
docker_args_done=true
shift
continue
}
[[ $docker_args_done = true ]] && ctr_args+=("$1") || docker_args+=("$1")
shift
done
# If we're running in a terminal, pass the terminal to Docker and run
# the container interactively
[[ -t 0 ]] && docker_args+=("-i")
[[ -t 1 ]] && docker_args+=("-t")
# Try to pass these environments from host into container for network proxies
proxies=(http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY)
for i in "${proxies[@]}"; do
if [[ ! -z ${!i} ]]; then
docker_args+=("--env") && docker_args+=("$i=${!i}")
fi
done
# Finally, run the dev container
# Use 'z' on the --volume parameter for docker to automatically relabel the
# content and allow sharing between containers.
docker run "${docker_args[@]}" \
--rm \
--volume /dev:/dev \
--volume "$FC_ROOT_DIR:$CTR_FC_ROOT_DIR:z" \
--env OPT_LOCAL_IMAGES_PATH="$(dirname "$CTR_MICROVM_IMAGES_DIR")" \
--env PYTHONDONTWRITEBYTECODE=1 \
"$DEVCTR_IMAGE" "${ctr_args[@]}"
}
# Helper function to test that the argument provided is a valid path to a SSH key.
#
test_key() {
ssh-keygen -lf "$1" &>/dev/null
ret=$?
[ $ret -ne 0 ] && die "$1 is not a valid key file."
}
# Tries to update any outdated python packages on the container,
# locks the new versions and copies back the ```poetry.lock```
# file to the host.
#
update_python_package_version() {
say "Updating python packages..."
# defined in Dockerfile
poetry_dir_on_container="/tmp/poetry"
lock_file_location_on_host="$FC_DEVCTR_DIR/poetry.lock"
image_id=$(docker images -q "$DEVCTR_IMAGE_NO_TAG" | head -n 1)
dummy_container_name=$(uuidgen)
dummy_container_id=$(docker create -ti --name \
"$dummy_container_name" \
"$image_id" \
bash)
docker start "$dummy_container_id"
cmd="cd "$poetry_dir_on_container"; poetry update"
docker exec -ti "$dummy_container_id" /bin/bash -c "${cmd}"
docker cp \
"$dummy_container_id":/tmp/poetry/poetry.lock \
"$lock_file_location_on_host"
docker commit "$dummy_container_id" "$DEVCTR_IMAGE_NO_TAG"
docker stop "$dummy_container_id"
docker rm -f "$dummy_container_name"
}
create_dir() {
# Create a dir for the provided path.
dir="$1"
mkdir -p "$dir" || die "Error: cannot create dir $dir"
[ -x "$dir" ] && [ -w "$dir" ] || \
{
say "Wrong permissions for $dir. Attempting to fix them ..."
chmod +x+w "$dir"
} || \
die "Error: wrong permissions for $dir. Should be +x+w"
}
# `$0 help`
# Show the detailed devtool usage information.
#
cmd_help() {
echo ""
echo "Firecracker $(basename $0)"
echo "Usage: $(basename $0) [<args>] <command> [<command args>]"
echo ""
echo "Global arguments"
echo " -y, --unattended Run unattended. Assume the user would always"
echo " answer \"yes\" to any confirmation prompt."
echo ""
echo "Available commands:"
echo ""
echo " build [--debug|--release] [-l|--libc musl|gnu] [-- [<cargo args>]]"
echo " Build the Firecracker binaries."
echo " Firecracker is built using the Rust build system (cargo). All arguments after --"
echo " will be passed through to cargo."
echo " --debug Build the debug binaries. This is the default."
echo " --release Build the release binaries."
echo " -l, --libc musl|gnu Choose the libc flavor against which Firecracker will"
echo " be linked. Default is musl."
echo " --ssh-keys Provide the paths to the public and private SSH keys on the host"
echo " (in this particular order) required for the git authentication."
echo " It is mandatory that both keys are specified."
echo ""
echo " build_devctr [--no-python-package-update]"
echo " Builds the development container from its Dockerfile."
echo " -n, --no-python-package-update Do not update python packages."
echo ""
echo " build_kernel -c|--config [-n|--nproc]"
echo " Builds a kernel image custom-tailored for our CI."
echo " -c, --config Path to the config file."
echo " -n, --nproc Number of cores to use for building kernel."
echo " build_rootfs -s|--size [--partuuid]"
echo " Builds a rootfs image custom-tailored for use in our CI."
echo " -s, --size Size of the rootfs image. Defaults to 300M."
echo " -p, --partuuid Whether to build a partuuid image."
echo ""
echo " checkenv"
echo " Performs prerequisites checks needed to execute firecracker."
echo ""
echo " ci"
echo " Run a continuous integration test run that executes the integration tests and"
echo " checks that the release process works."
echo ""
echo " distclean"
echo " Clean up the build tree and remove the docker container."
echo ""
echo " fix_perms"
echo " Fixes permissions when devtool dies in the middle of a privileged session."
echo ""
echo " fmt"
echo " Auto-format all Rust source files, to match the Firecracker requirements."
echo " This should be used as the last step in every commit, to ensure that the"
echo " Rust style tests pass."
echo ""
echo " generate_syscall_tables <version>"
echo " Generates the syscall tables for seccompiler, according to a given kernel version."
echo " Release candidate (rc) linux versions are not allowed."
echo " Outputs a rust file for each supported arch: src/seccompiler/src/syscall_table/{arch}.rs"
echo " Supported architectures: x86_64 and aarch64."
echo ""
echo " install [-p|--path] [--debug|--release]"
echo " Install firecracker, jailer and seccomp binaries to /usr/local/bin or a given path."
echo " Only the musl linked binaries are supported."
echo " --path Install binaries to a specified path."
echo " --debug Install the debug binaries."
echo " --release Install the release binaries. This is the default."
echo ""
echo " help"
echo " Display this help message."
echo ""
echo " prepare_release <version>"
echo " Prepare a new Firecracker release by updating the version number, crate "
echo " dependencies and credits."
echo ""
help_release
echo ""
echo " shell [--privileged]"
echo " Launch the development container and open an interactive BASH shell."
echo " -p, --privileged Run the container as root, in privileged mode."
echo " Running Firecracker via the jailer requires elevated"
echo " privileges, though the build phase does not."
echo ""
echo " tag <version>"
echo " Create a git tag for the specified version. The tag message will contain "
echo " the contents of CHANGELOG.md enclosed between the header corresponding to "
echo " the specified version and the one corresponding to the previous version."
echo ""
echo " test [-- [<pytest args>]]"
echo " Run the Firecracker integration tests."
echo " The Firecracker testing system is based on pytest. All arguments after --"
echo " will be passed through to pytest."
echo " -c, --cpuset-cpus cpulist Set a dedicated cpulist to be used by the tests."
echo " -m, --cpuset-mems memlist Set a dedicated memlist to be used by the tests."
echo " -r, --ramdisk size[k|m|g] Use a ramdisk of `size` MB for
the entire test session (e.g
stored artifacts, Firecracker
binaries, logs/metrics FIFOs
and test created device files)."
echo ""
echo " strip"
echo " Strip debug symbols from the Firecracker release binaries."
echo ""
}
help_release() {
echo " release -v <val> -u <val> [-t <val> -r <val> -m <val> -p]"
echo " Draft a GitHub release by calling into its API."
echo " Firstly, a tag will be created for the release number provided, together with a"
echo " description obtained from the CHANGELOG file. The tag will be pushed to a provided remote."
echo " Secondly, the script will call into GitHub's API for programatically posting a draft release."
echo " For authentication reasons, one needs to pass a GitHub API access token."
echo " You can find instructions on how to create one: https://github.blog/2013-05-16-personal-api-tokens/."
echo " -v, --version The targeted release version."
echo " -u, --username The GitHub owner of the targeted repo."
echo " -t, --token A GitHub Access token with "repo" permissions"
echo " -r, --repo The name of the repository where the release will be posted."
echo " -m, --remote The name of the remote where the release tag will be pushed."
echo " -p, --prerelease Marks the release as a pre-release."
}
# `$0 build` - build Firecracker
# Please see `$0 help` for more information.
#
cmd_build() {
# By default, we'll build the debug binaries.
profile="debug"
libc="musl"
# Parse any command line args.
while [ $# -gt 0 ]; do
case "$1" in
"-h"|"--help") { cmd_help; exit 1; } ;;
"--debug") { profile="debug"; } ;;
"--release") { profile="release"; } ;;
"--ssh-keys")
shift
[[ -z "$1" ]] && \
die "Please provide the path to the public SSH key."
[[ ! -f "$1" ]] && die "The public key file does not exist: $1."
test_key "$1"
host_pub_key_path="$1"
shift
[[ -z "$1" ]] && \
die "Please provide the path to the private SSH key."
[[ ! -f "$1" ]] && die "The private key file does not exist: $1."
test_key "$1"
host_priv_key_path="$1"
;;
"-l"|"--libc")
shift
[[ "$1" =~ ^(musl|gnu)$ ]] || \
die "Invalid libc: $1. Valid options are \"musl\" and \"gnu\"."
libc="$1"
;;
"--") { shift; break; } ;;
*)
die "Unknown argument: $1. Please use --help for help."
;;
esac
shift
done
target="$TARGET_PREFIX${libc}"
# Check prerequisites
ensure_devctr
ensure_build_dir
say "Starting build ($profile, $libc) ..."
# Cargo uses the debug profile by default. If we're building the release
# binaries, we need to pass an extra argument to cargo.
cargo_args=("$@")
# Add the default target if we did not get that argument in the build command.
add_default_target=true
for flag in "${@}"; do
if [[ "$flag" == "--" ]]; then
break
elif [[ "$flag" == "--target" || "$flag" =~ --target=.* ]]; then
add_default_target=false
fi
done
if [ "$add_default_target" = true ]; then
cargo_args+=(--target "$target")
fi
[ $profile = "release" ] && cargo_args+=("--release")
# Map the public and private keys to the guest if they are specified.
[ ! -z "$host_pub_key_path" ] && [ ! -z "$host_priv_key_path" ] &&
extra_args="--volume $host_pub_key_path:$PUB_KEY_PATH:z \
--volume $host_priv_key_path:$PRIV_KEY_PATH:z"
# Artificially trigger a re-run of the build script,
# to make sure that `firecracker --version` reports the latest changes.
touch "$FC_ROOT_DIR/build.rs"
# Run the cargo build process inside the container.
# We don't need any special privileges for the build phase, so we run the
# container as the current user/group.
# Build seccompiler-bin.
run_devctr \
--user "$(id -u):$(id -g)" \
--workdir "$CTR_FC_ROOT_DIR" \
${extra_args} \
-- \
cargo build -p seccompiler --bin seccompiler-bin \
--target-dir "$CTR_CARGO_SECCOMPILER_TARGET_DIR" \
"${cargo_args[@]}"
ret=$?
[ $ret -ne 0 ] && return $ret
# Build Firecracker.
run_devctr \
--user "$(id -u):$(id -g)" \
--workdir "$CTR_FC_ROOT_DIR" \
${extra_args} \
-- \
cargo build \
--target-dir "$CTR_CARGO_TARGET_DIR" \
"${cargo_args[@]}"
ret=$?
[ $ret -ne 0 ] && return $ret
# Build jailer only in case of musl for compatibility reasons.
if [ "$libc" == "musl" ];then
run_devctr \
--user "$(id -u):$(id -g)" \
--workdir "$CTR_FC_ROOT_DIR" \
${extra_args} \
-- \
cargo build -p jailer \
--target-dir "$CTR_CARGO_TARGET_DIR" \
"${cargo_args[@]}"
fi
ret=$?
# If `cargo build` was successful, output a message.
[ $ret -eq 0 ] && {
cargo_bin_dir="$CARGO_TARGET_DIR/$target/$profile"
seccompiler_bin_dir="$CARGO_SECCOMPILER_TARGET_DIR/$target/$profile"
# Seccompiler has a different build folder, we need to output two
# messages.
say "Build successful."
say "Firecracker and Jailer binaries placed under $cargo_bin_dir"
say "Seccompiler-bin binary placed under $seccompiler_bin_dir"
}
return $ret
}
cmd_distclean() {
# List of folders to remove.
dirs=("build" "test_results")
for dir in "${dirs[@]}"; do
if [ -d "$dir" ]; then
say "Removing $dir"
rm -rf "$dir"
fi
done
# Remove devctr if it exists
if [ $(docker images -q "$DEVCTR_IMAGE" | wc -l) -eq "1" ]; then
say "Removing $DEVCTR_IMAGE"
docker rmi -f "$DEVCTR_IMAGE"
fi
}
cmd_strip() {
profile="release"
target="$TARGET_PREFIX""musl"
# Parse any command line args.
while [ $# -gt 0 ]; do
case "$1" in
"-h"|"--help") { cmd_help; exit 1; } ;;
*)
die "Unknown argument: $1. Please use --help for help."
;;
esac
shift
done
# Check prerequisites
ensure_devctr
ensure_build_dir
ensure_release_binaries_exist $target $profile
say "Starting stripping the debug symbols for $profile binaries built against $target target."
strip_flags="--strip-debug"
say "Strip flags: $strip_flags."
run_devctr \
--user "$(id -u):$(id -g)" \
-- \
strip $strip_flags\
"$CTR_CARGO_TARGET_DIR/$target/$profile/firecracker" \
"$CTR_CARGO_TARGET_DIR/$target/$profile/jailer" \
"$CTR_CARGO_SECCOMPILER_TARGET_DIR/$target/$profile/seccompiler-bin"
ret=$?
[ $ret -eq 0 ] && {
say "Stripping was successful."
say "Stripped Firecracker and Jailer binaries placed under $CARGO_TARGET_DIR/$target/$profile."
say "Stripped seccompiler-bin binary placed under $CARGO_SECCOMPILER_TARGET_DIR/$target/$profile."
}
return $ret
}
mount_ramdisk() {
say "Using ramdisk ..."
local ramdisk_size="$1"
umount_ramdisk
mkdir -p ${DEFAULT_RAMDISK_PATH} && \
mount -t tmpfs -o size=${ramdisk_size} tmpfs ${DEFAULT_RAMDISK_PATH}
ok_or_die "Failed to mount ramdisk to ${DEFAULT_RAMDISK_PATH}. Check the permission."
mkdir -p ${DEFAULT_RAMDISK_PATH}/srv
mkdir -p ${DEFAULT_RAMDISK_PATH}/tmp
}
umount_ramdisk() {
if [ ! -e "${DEFAULT_RAMDISK_PATH}" ]; then
return 0
fi
if [ ! -d "${DEFAULT_RAMDISK_PATH}" ]; then
die "${DEFAULT_RAMDISK_PATH} is not a directory."
fi
if [ ! -w "${DEFAULT_RAMDISK_PATH}" ]; then
die "Failed to unmount ${DEFAULT_RAMDISK_PATH}. Check the permission."
fi
umount ${DEFAULT_RAMDISK_PATH} &>/dev/null
rmdir ${DEFAULT_RAMDISK_PATH} &>/dev/null
}
# `$0 test` - run integration tests
# Please see `$0 help` for more information.
#
cmd_test() {
# Parse any command line args.
while [ $# -gt 0 ]; do
case "$1" in
"-h"|"--help") { cmd_help; exit 1; } ;;
"-c"|"--cpuset-cpus")
shift