Debian Codegraph @

kas-container

raw
1 #!/bin/sh
2 #
3 # kas - setup tool for bitbake based projects
4 #
5 # Copyright (c) Siemens AG, 2018-2025
6 #
7 # Authors:
8 # Jan Kiszka <[email protected]>
9 #
10 # Permission is hereby granted, free of charge, to any person obtaining a copy
11 # of this software and associated documentation files (the "Software"), to deal
12 # in the Software without restriction, including without limitation the rights
13 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 # copies of the Software, and to permit persons to whom the Software is
15 # furnished to do so, subject to the following conditions:
16 #
17 # The above copyright notice and this permission notice shall be
18 # included in all copies or substantial portions of the Software.
19 #
20 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 # SOFTWARE.
27
28 set -e
29
30 KAS_CONTAINER_SCRIPT_VERSION="5.4"
31 KAS_IMAGE_VERSION_DEFAULT="${KAS_CONTAINER_SCRIPT_VERSION}"
32 KAS_CONTAINER_IMAGE_DISTRO_DEFAULT=""
33 KAS_CONTAINER_IMAGE_PATH_DEFAULT="ghcr.io/siemens/kas"
34 KAS_CONTAINER_IMAGE_NAME_DEFAULT="kas"
35 KAS_CONTAINER_SELF_NAME="$(basename "$0")"
36
37 # usage [exit_code]
38 usage()
39 {
40 EXIT_CODE="$1"
41 SELF="${KAS_CONTAINER_SELF_NAME}"
42
43 printf "%b" "Usage: ${SELF} [OPTIONS] { build | shell } [KASOPTIONS] [KASFILE]\n"
44 printf "%b" " ${SELF} [OPTIONS] { checkout | dump | lock } [KASOPTIONS] [KASFILE]\n"
45 printf "%b" " ${SELF} [OPTIONS] { diff } [KASOPTIONS] config1 config2\n"
46 printf "%b" " ${SELF} [OPTIONS] for-all-repos [KASOPTIONS] [KASFILE] COMMAND\n"
47 printf "%b" " ${SELF} [OPTIONS] { clean | cleansstate | cleanall | purge} [KASFILE]\n"
48 printf "%b" " ${SELF} [OPTIONS] menu [KCONFIG]\n"
49 printf "%b" "\nPositional arguments:\n"
50 printf "%b" "build\t\t\tCheck out repositories and build target.\n"
51 printf "%b" "checkout\t\tCheck out repositories but do not build.\n"
52 printf "%b" "diff\t\t\tCompare two kas configurations.\n"
53 printf "%b" "dump\t\t\tCheck out repositories and write flat version\n"
54 printf "%b" " \t\t\tof config to stdout.\n"
55 printf "%b" "lock\t\t\tCreate and update kas project lockfiles.\n"
56 printf "%b" "shell\t\t\tRun a shell in the build environment.\n"
57 printf "%b" "for-all-repos\t\tRun specified command in each repository.\n"
58 printf "%b" "clean\t\t\tClean build artifacts, keep sstate cache and " \
59 "downloads.\n"
60 printf "%b" "cleansstate\t\tClean build artifacts and sstate cache, " \
61 "keep downloads.\n"
62 printf "%b" "cleanall\t\tClean build artifacts, sstate cache and " \
63 "downloads.\n"
64 printf "%b" "purge\t\t\tRemove all data managed by kas. Run with '--dry-run'\n"
65 printf "%b" " \t\t\tto check what would be removed.\n"
66 printf "%b" "menu\t\t\tProvide configuration menu and trigger " \
67 "configured build.\n"
68 printf "%b" "\nOptional arguments:\n"
69 printf "%b" "--isar-privileged\tRun an Isar build in privileged mode. " \
70 "To force the use\n"
71 printf "%b" "\t\t\tof run0 over sudo, set KAS_SUDO_CMD=run0.\n"
72 printf "%b" "--isar-rootless\t\tRun an Isar build in rootless mode.\n"
73 printf "%b" "--runtime-args\t\tAdditional arguments to pass to the " \
74 "container runtime.\n"
75 printf "%b" "\t\t\tfor running the build.\n"
76 printf "%b" "-l, --log-level\t\tSet log level (default=info).\n"
77 printf "%b" "--version\t\tPrint program version.\n"
78 printf "%b" "--ssh-dir\t\tDirectory containing SSH configurations.\n"
79 printf "%b" "\t\t\tAvoid \$HOME/.ssh unless you fully trust the " \
80 "container.\n"
81 printf "%b" "--ssh-agent\t\tForward ssh-agent socket to the container.\n"
82 printf "%b" "--aws-dir\t\tDirectory containing AWScli configuration.\n"
83 printf "%b" "\t\t\tAvoid \$HOME/.aws unless you fully trust the " \
84 "container.\n"
85 printf "%b" "--git-credential-store\tFile path to the git credential " \
86 "store.\n"
87 printf "%b" "--git-credential-socket\tPath to the git credential cache " \
88 "socket.\n"
89 printf "%b" "--no-proxy-from-env\tDo not inherit proxy settings from " \
90 "environment.\n"
91 printf "%b" "--repo-ro\t\tMount current repository read-only\n" \
92 "\t\t\t(default for build command).\n"
93 printf "%b" "--repo-rw\t\tMount current repository writable\n" \
94 "\t\t\t(default for shell command).\n"
95 printf "%b" "-h, --help\t\tShow this help message and exit.\n"
96 printf "%b" "\n"
97 printf "%b" "You can force the use of podman over docker using " \
98 "KAS_CONTAINER_ENGINE=podman.\n"
99
100 exit "${EXIT_CODE:-1}"
101 }
102
103 fatal_error()
104 {
105 echo "${KAS_CONTAINER_SELF_NAME}: Error: $*" >&2
106 exit 1
107 }
108
109 warning()
110 {
111 echo "${KAS_CONTAINER_SELF_NAME}: Warning: $*" >&2
112 }
113
114 debug(){
115 if [ -n "${KAS_VERBOSE}" ]; then
116 echo "${KAS_CONTAINER_SELF_NAME}: Debug: $*" >&2
117 fi
118 }
119
120 trace()
121 {
122 [ -n "${KAS_VERBOSE}" ] && echo "+ $*" >&2
123 "$@"
124 }
125
126 prepare_sudo_cmd()
127 {
128 if [ -z "${KAS_SUDO_CMD}" ]; then
129 # Try to auto-detect a privileged executor
130 if command -v sudo >/dev/null; then
131 KAS_SUDO_CMD="sudo"
132 elif command -v run0 >/dev/null; then
133 KAS_SUDO_CMD="run0"
134 else
135 fatal_error "No privileged executor found, need sudo or run0."
136 fi
137 fi
138
139 case "$KAS_SUDO_CMD" in
140 sudo) _KAS_SUDO_CMD="sudo --preserve-env";;
141 run0) _KAS_SUDO_CMD="run0 --background= --unit=kas-container@$$";;
142 *) fatal_error "Unsupported KAS_SUDO_CMD ('${KAS_SUDO_CMD}'), use sudo or run0.";;
143 esac
144 }
145
146 enable_isar_mode()
147 {
148 KAS_CONTAINER_IMAGE_NAME_DEFAULT="kas-isar"
149 KAS_ISAR_ARGS="--privileged"
150
151 if [ "${KAS_CONTAINER_ENGINE}" = "podman" ]; then
152 prepare_sudo_cmd
153 # sudo is needed for a privileged podman container
154 KAS_CONTAINER_COMMAND="${_KAS_SUDO_CMD} ${KAS_CONTAINER_COMMAND}"
155 # preserved user PATH may lack sbin needed by privileged podman
156 export PATH="${PATH}:/usr/sbin"
157 elif [ "${KAS_DOCKER_ROOTLESS}" = "1" ]; then
158 prepare_sudo_cmd
159 DOCKER_HOST_DEFAULT="$(docker context inspect default --format '{{.Endpoints.docker.Host}}')"
160 export DOCKER_HOST="${DOCKER_HOST:-$DOCKER_HOST_DEFAULT}"
161 debug "kas-isar does not support rootless docker. Using system docker in $DOCKER_HOST"
162 # force use of well-known system docker socket
163 KAS_CONTAINER_COMMAND="${_KAS_SUDO_CMD} ${KAS_CONTAINER_COMMAND}"
164 KAS_DOCKER_ROOTLESS=0
165 fi
166 }
167
168 enable_isar_rootless_mode()
169 {
170 KAS_CONTAINER_IMAGE_NAME_DEFAULT="kas-isar"
171
172 # Use --privileged to pass the ambient capabilities into the container.
173 # When calling from the user session (podman or docker-rootless), this
174 # is fundamentally different from the system docker run --privileged
175 if [ "${KAS_CONTAINER_ENGINE}" = "podman" ]; then
176 KAS_RUNTIME_ARGS="${KAS_RUNTIME_ARGS} --userns=keep-id --privileged"
177 elif [ "${KAS_DOCKER_ROOTLESS}" = "1" ]; then
178 KAS_ISAR_ARGS="--privileged"
179 else
180 # we don't need --privileged, but we need to run with SYS_ADMIN
181 # to be able to unshare.
182 KAS_ISAR_ARGS=" \
183 --security-opt seccomp=unconfined \
184 --security-opt apparmor=unconfined \
185 --security-opt systempaths=unconfined \
186 --cap-add=SYS_ADMIN \
187 "
188 fi
189 }
190
191 enable_oe_mode()
192 {
193 if [ "${KAS_CONTAINER_ENGINE}" = "podman" ]; then
194 # The container entry point expects that the current userid
195 # calling "podman run" has a 1:1 mapping
196 KAS_RUNTIME_ARGS="${KAS_RUNTIME_ARGS} --userns=keep-id"
197 fi
198 BUILD_SYSTEM="openembedded"
199 }
200
201 enable_unpriv_userns_docker()
202 {
203 if [ -f /etc/os-release ] && grep -q 'NAME="Ubuntu"' /etc/os-release &&
204 [ -f /proc/sys/kernel/apparmor_restrict_unprivileged_userns ] &&
205 [ "$(cat /proc/sys/kernel/apparmor_restrict_unprivileged_userns)" = "1" ]; then
206 if [ -f /etc/apparmor.d/rootlesskit ]; then
207 debug "AppArmor restricts unprivileged userns, using \"rootlesskit\" profile"
208 KAS_RUNTIME_ARGS="${KAS_RUNTIME_ARGS} --security-opt apparmor=rootlesskit"
209 else
210 warning "AppArmor restricts unprivileged userns but no suitable apparmor " \
211 "profile found. Consider setting apparmor_restrict_unprivileged_userns=0"
212 fi
213 fi
214 }
215
216 # Params: NAME CREATE_MODE
217 check_and_expand()
218 {
219 eval _varval=\"\$"$1"\"
220 [ -z "$_varval" ] && return
221 case "$2" in
222 required)
223 [ ! -d "$_varval" ] && fatal_error "Variable $1 set, but \"$_varval\" is not a directory."
224 ;;
225 create)
226 [ ! -d "$_varval" ] && trace mkdir "$_varval"
227 ;;
228 createrec)
229 trace mkdir -p "$_varval"
230 ;;
231 esac
232 realpath -e "$_varval"
233 }
234
235 # SC2034: DIR appears unused (ignore, as they are used inside eval)
236 # shellcheck disable=2034
237 setup_kas_dirs()
238 {
239 KAS_WORK_DIR="${KAS_WORK_DIR:-$(pwd)}"
240 KAS_WORK_DIR="$(check_and_expand KAS_WORK_DIR required)"
241 KAS_BUILD_DIR="$(check_and_expand KAS_BUILD_DIR create)"
242 KAS_REPO_REF_DIR="$(check_and_expand KAS_REPO_REF_DIR required)"
243 DL_DIR="$(check_and_expand DL_DIR createrec)"
244 SSTATE_DIR="$(check_and_expand SSTATE_DIR createrec)"
245 KAS_BUILDTOOLS_DIR="$(check_and_expand KAS_BUILDTOOLS_DIR createrec)"
246 }
247
248 # Params: FILE
249 # Returns: root repo dir of file
250 repo_path_of_file()
251 {
252 _DIR="$(dirname "$1")"
253 _REPO_DIR=$(git -C "${_DIR}" rev-parse --show-toplevel 2>/dev/null) \
254 || _REPO_DIR=$(hg --cwd "${_DIR}" root 2>/dev/null) \
255 || _REPO_DIR=${_DIR}
256 echo "$_REPO_DIR"
257 }
258
259 # Params: ARG
260 process_file_arg()
261 {
262 _KAS_FILES=
263 _KAS_FIRST_FILE=
264 _KAS_REPO_DIR=
265 # SC2086: Double quote to prevent globbing and word splitting.
266 # shellcheck disable=2086
267 for FILE in $(IFS=':'; echo $ARG); do
268 if ! KAS_REAL_FILE="$(realpath -qe "$FILE")"; then
269 fatal_error "configuration file '${FILE}' not found"
270 fi
271 if [ -z "${_KAS_FILES}" ]; then
272 _KAS_FIRST_FILE="${KAS_REAL_FILE}"
273 _KAS_FILES="${KAS_REAL_FILE}"
274 _KAS_REPO_DIR=$(repo_path_of_file "${_KAS_FIRST_FILE}")
275 else
276 _KAS_FILES="${_KAS_FILES}:${KAS_REAL_FILE}"
277 fi
278 done
279 KAS_FILES="${KAS_FILES} ${_KAS_FILES}"
280 KAS_FIRST_FILES="${KAS_FIRST_FILES} ${_KAS_FIRST_FILE}"
281 KAS_REPO_DIRS="${KAS_REPO_DIRS} ${_KAS_REPO_DIR}"
282 }
283
284 # Params: NAME CONTAINER_PATH MODE
285 # If the dir is not below KAS_WORK_DIR, the dir is mounted into the container.
286 forward_dir()
287 {
288 eval _varval=\"\$"$1"\"
289 [ -z "$_varval" ] && return
290 FW_DIR_REL=$(realpath -q --relative-base="${KAS_WORK_DIR}" "$_varval")
291 if [ "${FW_DIR_REL}" = "$_varval" ]; then
292 KAS_RUNTIME_ARGS="${KAS_RUNTIME_ARGS} -v ${FW_DIR_REL}:$2:$3 -e $1=$2"
293 else
294 KAS_RUNTIME_ARGS="${KAS_RUNTIME_ARGS} -e $1=/work/${FW_DIR_REL}"
295 fi
296 }
297
298 enable_docker_rootless()
299 {
300 warning "Rootless docker used, only limited functionality available."
301 if [ "${KAS_WORK_DIR}" = "${KAS_REPO_DIR}" ]; then
302 warning "On docker rootless a exclusive KAS_WORK_DIR should be used" \
303 "as kas temporarily changes the ownership of this directory."
304 fi
305 if [ "${KAS_REPO_MOUNT_OPT}" = "rw" ]; then
306 fatal_error "Docker rootless requires read-only repo."
307 fi
308 KAS_RUNTIME_ARGS="${KAS_RUNTIME_ARGS} -e KAS_DOCKER_ROOTLESS=1"
309 }
310
311 set_container_image_var()
312 {
313 # if the image is explicitly set, use that
314 if [ -n "${KAS_CONTAINER_IMAGE}" ]; then
315 return
316 fi
317 KAS_IMAGE_VERSION="${KAS_IMAGE_VERSION:-${KAS_IMAGE_VERSION_DEFAULT}}"
318 KAS_CONTAINER_IMAGE_DISTRO="${KAS_CONTAINER_IMAGE_DISTRO:-${KAS_CONTAINER_IMAGE_DISTRO_DEFAULT}}"
319 KAS_CONTAINER_IMAGE_NAME="${KAS_CONTAINER_IMAGE_NAME:-${KAS_CONTAINER_IMAGE_NAME_DEFAULT}}"
320 KAS_CONTAINER_IMAGE_PATH="${KAS_CONTAINER_IMAGE_PATH:-${KAS_CONTAINER_IMAGE_PATH_DEFAULT}}"
321 KAS_CONTAINER_IMAGE="${KAS_CONTAINER_IMAGE_PATH}/${KAS_CONTAINER_IMAGE_NAME}:${KAS_IMAGE_VERSION}"
322 if [ -n "${KAS_CONTAINER_IMAGE_DISTRO}" ]; then
323 KAS_CONTAINER_IMAGE="${KAS_CONTAINER_IMAGE}-${KAS_CONTAINER_IMAGE_DISTRO}"
324 fi
325 }
326
327 # parse kas-container options, leave build system empty to distinguish between
328 # explicitly set via flag and implicitly via config.
329 BUILD_SYSTEM=""
330 KAS_OPTIONS_DIRECT=""
331 KAS_EXTRA_RUNTIME_ARGS=""
332 while [ $# -gt 0 ]; do
333 case "$1" in
334 --isar | --isar-privileged)
335 if [ "$1" = "--isar" ]; then
336 warning "The semantic of '--isar' might change in the" \
337 "future. Please use '--isar-privileged' instead."
338 fi
339 BUILD_SYSTEM="isar-privileged"
340 shift 1
341 ;;
342 --isar-rootless)
343 BUILD_SYSTEM="isar-rootless"
344 shift 1
345 ;;
346 --runtime-args | --docker-args)
347 [ $# -gt 0 ] || usage
348 KAS_EXTRA_RUNTIME_ARGS=" $2"
349 shift 2
350 ;;
351 --ssh-dir)
352 [ $# -gt 2 ] || usage
353 KAS_SSH_DIR="$2"
354 shift 2
355 ;;
356 --ssh-agent)
357 if [ -z "${SSH_AUTH_SOCK}" ]; then
358 fatal_error "no SSH agent running"
359 fi
360 KAS_SSH_AUTH_SOCK=$(realpath -e "$SSH_AUTH_SOCK")
361 shift 1
362 ;;
363 --aws-dir)
364 [ $# -gt 2 ] || usage
365 KAS_AWS_DIR="$2"
366 shift 2
367 ;;
368 --git-credential-store)
369 [ $# -gt 2 ] || usage
370 KAS_GIT_CREDENTIAL_STORE="$2"
371 shift 2
372 ;;
373
374 --git-credential-socket)
375 [ $# -gt 2 ] || usage
376 KAS_GIT_CREDENTIAL_SOCKET="$2"
377 shift 2
378 ;;
379
380 --no-proxy-from-env)
381 KAS_NO_PROXY_FROM_ENV=1
382 shift 1
383 ;;
384 --repo-ro)
385 KAS_REPO_MOUNT_OPT="ro"
386 shift 1
387 ;;
388 --repo-rw)
389 KAS_REPO_MOUNT_OPT="rw"
390 shift 1
391 ;;
392 -l | --log-level)
393 if [ "$2" = "debug" ]; then
394 KAS_VERBOSE=1
395 fi
396 KAS_OPTIONS_DIRECT="${KAS_OPTIONS_DIRECT} -l $2"
397 shift 2
398 ;;
399 --version)
400 echo "${KAS_CONTAINER_SELF_NAME} $KAS_IMAGE_VERSION_DEFAULT"
401 exit 0
402 ;;
403 -h | --help)
404 usage 0
405 ;;
406 --*)
407 usage
408 ;;
409 clean | cleansstate | cleanall | purge)
410 KAS_REPO_MOUNT_OPT_DEFAULT="ro"
411 KAS_CMD=$1
412 shift 1
413 break
414 ;;
415 shell | lock)
416 KAS_REPO_MOUNT_OPT_DEFAULT="rw"
417 KAS_CMD=$1
418 shift 1
419 break
420 ;;
421 build | checkout | for-all-repos | menu)
422 KAS_REPO_MOUNT_OPT_DEFAULT="ro"
423 KAS_CMD=$1
424 shift 1
425 break
426 ;;
427 diff)
428 KAS_REPO_MOUNT_OPT_DEFAULT="ro"
429 KAS_CMD=$1
430 shift 1
431 break
432 ;;
433 dump)
434 if printf '%s\0' "$@" | grep -xqz -- '--inplace\|-i'; then
435 KAS_REPO_MOUNT_OPT_DEFAULT="rw"
436 else
437 KAS_REPO_MOUNT_OPT_DEFAULT="ro"
438 fi
439 KAS_CMD=$1
440 shift 1
441 break
442 ;;
443 *)
444 usage
445 ;;
446 esac
447 done
448
449 KAS_RUNTIME_ARGS="--log-driver=none --user=root"
450
451 setup_kas_dirs
452
453 [ -n "${KAS_CMD}" ] || usage
454
455 KAS_EXTRA_BITBAKE_ARGS=0
456 KAS_FILES=
457
458 # parse kas sub-command options
459 while [ $# -gt 0 ] && [ $KAS_EXTRA_BITBAKE_ARGS -eq 0 ]; do
460 case "$1" in
461 --format | --indent | --provenance | --skip | --target | --task)
462 KAS_OPTIONS="${KAS_OPTIONS} $1 $2"
463 shift 1
464 shift 1 || KAS_OPTIONS="--help"
465 ;;
466 -c | --cmd | --command)
467 KAS_BITBAKE_C_OPTION_ARGS="$2"
468 shift 1
469 shift 1 || KAS_OPTIONS="--help"
470 ;;
471 -E | --preserve-env)
472 fatal_error "$1 is not supported with ${KAS_CONTAINER_SELF_NAME}"
473 ;;
474 --)
475 KAS_EXTRA_BITBAKE_ARGS=$#
476 ;;
477 -*)
478 KAS_OPTIONS="${KAS_OPTIONS} $1"
479 shift 1
480 ;;
481 *)
482 ARG="$1"
483 shift 1
484 if [ "$KAS_CMD" = "for-all-repos" ]; then
485 if [ $# -gt 0 ]; then
486 KAS_REPO_CMD="$1"
487 shift 1
488 else
489 KAS_REPO_CMD="$ARG"
490 unset ARG
491 fi
492 fi
493 process_file_arg "$ARG"
494 ;;
495 esac
496 done
497
498 if [ -n "${KAS_FIRST_FILES}" ]; then
499 KAS_REPO_DIR=$(echo "${KAS_REPO_DIRS}" | awk '{print $1}')
500 else
501 KAS_REPO_DIR=$(pwd)
502 fi
503
504 SOURCE_DIR_HOST=$(
505 grep -e "^_source_dir_host: " "${KAS_WORK_DIR}/.config.yaml" 2>/dev/null | \
506 sed 's/_source_dir_host:[ ]\+//')
507 if [ -n "${SOURCE_DIR_HOST}" ]; then
508 KAS_REPO_DIR="${SOURCE_DIR_HOST}"
509 fi
510
511 if [ "${KAS_CMD}" = "menu" ]; then
512 if [ -z "${KAS_FIRST_FILES}" ]; then
513 KAS_FIRST_FILES="Kconfig"
514 fi
515
516 # When using the menu plugin, we need to track the KAS_REPO_DIR outside
517 # of the container to later allow a simple `kas-container build`. For
518 # that, we tell the kas menu plugin via an env-var about the location
519 # on the host. This data is then added to the .config.yaml where it can
520 # be evaluated by the next invocation of kas-container.
521
522 KAS_REPO_DIR=$(check_and_expand KAS_REPO_DIR required)
523 if ! [ "${KAS_REPO_DIR}" = "${KAS_WORK_DIR}" ]; then
524 set -- "$@" -e _KAS_REPO_DIR_HOST="${KAS_REPO_DIR}"
525 fi
526
527 if [ "$(echo "${KAS_FIRST_FILES}" | wc -w)" -ne "1" ]; then
528 fatal_error "menu plugin only supports a single Kconfig file"
529 fi
530 BUILD_SYSTEM=${BUILD_SYSTEM:-$(tr '\n' '\f' 2>/dev/null < "${KAS_FIRST_FILES}" |
531 sed -e 's/\(.*\fconfig KAS_BUILD_SYSTEM\f\(.*\)\|.*\)/\2/' \
532 -e 's/\f\([[:alpha:]].*\|$\)//' \
533 -e 's/.*default \"\(.*\)\".*/\1/')}
534 else
535 if [ -z "${KAS_FIRST_FILES}" ]; then
536 KAS_FIRST_FILES="${KAS_WORK_DIR}/.config.yaml"
537 fi
538
539 # We only get the first build system and let kas check if mixed
540 _KAS_FIRST_FILE=$(echo "${KAS_FIRST_FILES}" | awk '{print $1}')
541 BUILD_SYSTEM=${BUILD_SYSTEM:-$(grep -e "^build_system: " "${_KAS_FIRST_FILE}" 2>/dev/null |
542 sed 's/build_system:[ ]\+//')}
543 fi
544
545 KAS_CONTAINER_ENGINE="${KAS_CONTAINER_ENGINE:-${KAS_DOCKER_ENGINE}}"
546 if [ -z "${KAS_CONTAINER_ENGINE}" ]; then
547 # Try to auto-detect a container engine
548 # Defaults if there are multiple options:
549 # podman if build system is isar-rootless, docker otherwise
550 if [ "${BUILD_SYSTEM}" = "isar-rootless" ] && command -v podman >/dev/null 2>&1; then
551 KAS_CONTAINER_ENGINE=podman
552 elif command -v docker >/dev/null 2>&1 && docker -v 2>/dev/null | grep -q '^Docker'; then
553 KAS_CONTAINER_ENGINE=docker
554 elif command -v podman >/dev/null 2>&1; then
555 KAS_CONTAINER_ENGINE=podman
556 else
557 fatal_error "no container engine found, need docker or podman"
558 fi
559 fi
560
561 KAS_DOCKER_ROOTLESS=0
562 case "${KAS_CONTAINER_ENGINE}" in
563 docker)
564 KAS_CONTAINER_COMMAND="docker"
565 enable_unpriv_userns_docker
566 if [ "$(docker context show)" = "rootless" ]; then
567 KAS_DOCKER_ROOTLESS=1
568 fi
569 ;;
570 podman)
571 KAS_CONTAINER_COMMAND="podman"
572 KAS_RUNTIME_ARGS="${KAS_RUNTIME_ARGS} --security-opt label=disable"
573 ;;
574 *)
575 fatal_error "unknown container engine '${KAS_CONTAINER_ENGINE}'"
576 ;;
577 esac
578
579 if [ "${BUILD_SYSTEM}" = "isar" ] || [ "${BUILD_SYSTEM}" = "isar-privileged" ]; then
580 enable_isar_mode
581 elif [ "${BUILD_SYSTEM}" = "isar-rootless" ]; then
582 enable_isar_rootless_mode
583 else
584 enable_oe_mode
585 fi
586
587 # clean can be executed without config, hence manually forward the build system
588 case "${BUILD_SYSTEM}" in
589 isar*)
590 if echo "${KAS_CMD}" | grep -qe "^clean\|purge"; then
591 KAS_OPTIONS="${KAS_OPTIONS} --${BUILD_SYSTEM}"
592 fi
593 ;;
594 esac
595
596 set_container_image_var
597
598 if [ "${KAS_DOCKER_ROOTLESS}" = "1" ]; then
599 KAS_REPO_MOUNT_OPT_DEFAULT="ro"
600 fi
601 KAS_REPO_MOUNT_OPT="${KAS_REPO_MOUNT_OPT:-${KAS_REPO_MOUNT_OPT_DEFAULT}}"
602
603 if [ "$(id -u)" -eq 0 ] && [ "${KAS_ALLOW_ROOT}" != "yes" ] ; then
604 fatal_error "Running as root - may break certain recipes." \
605 "Better give a regular user docker access. Set" \
606 "KAS_ALLOW_ROOT=yes to override."
607 fi
608
609 if [ "${KAS_DOCKER_ROOTLESS}" = "1" ]; then
610 enable_docker_rootless
611 fi
612
613 if [ "${KAS_CMD}" = "diff" ]; then
614 if [ "$(echo "${KAS_FILES}" | wc -w)" -eq "2" ]; then
615 _KAS_REPO_DIR1="$(echo "${KAS_REPO_DIRS}" | awk '{print $1}')"
616 _KAS_REPO_DIR2="$(echo "${KAS_REPO_DIRS}" | awk '{print $2}')"
617 _KAS_FILES1="$(echo "${KAS_FILES}" | awk '{print $1}' | sed 's|'"${_KAS_REPO_DIR1}"'/|/repo/|g')"
618 _KAS_FILES2="$(echo "${KAS_FILES}" | awk '{print $2}' | sed 's|'"${_KAS_REPO_DIR2}"'/|/repo2/|g')"
619 KAS_FILES="${_KAS_FILES1} ${_KAS_FILES2}"
620 set -- "$@" -v "${_KAS_REPO_DIR2}:/repo2:${KAS_REPO_MOUNT_OPT}"
621 fi
622 else
623 KAS_FILES="$(echo "${KAS_FILES}" | sed 's|'"${KAS_REPO_DIR}"'/|/repo/|g')"
624 fi
625 set -- "$@" -v "${KAS_REPO_DIR}:/repo:${KAS_REPO_MOUNT_OPT}" \
626 -v "${KAS_WORK_DIR}":/work:rw -e KAS_WORK_DIR=/work \
627 --workdir=/repo \
628 -e KAS_CONTAINER_SCRIPT_VERSION="${KAS_CONTAINER_SCRIPT_VERSION}" \
629 -e USER_ID="$(id -u)" -e GROUP_ID="$(id -g)" --rm --init
630
631 forward_dir KAS_BUILD_DIR "/build" "rw"
632 forward_dir DL_DIR "/downloads" "rw"
633 forward_dir KAS_REPO_REF_DIR "/repo-ref" "rw"
634 forward_dir SSTATE_DIR "/sstate" "rw"
635 forward_dir KAS_BUILDTOOLS_DIR "/buildtools" "rw"
636
637 if git_com_dir=$(git -C "${KAS_REPO_DIR}" rev-parse --git-common-dir 2>/dev/null) \
638 && [ "$git_com_dir" != "$(git -C "${KAS_REPO_DIR}" rev-parse --git-dir)" ]; then
639
640 KAS_GIT_OVERLAY_FILE=""
641 kas_container_cleanup()
642 {
643 if [ -f "${KAS_GIT_OVERLAY_FILE}" ]; then
644 trace rm -f "${KAS_GIT_OVERLAY_FILE}"
645 fi
646 }
647 trap kas_container_cleanup EXIT INT TERM
648
649 # If (it's a git repo) and the common dir isn't the git-dir, it is shared worktree and
650 # we have to mount the common dir in the container to make git work
651 # The mount path inside the container is different from the host path. Hence, we over-mount
652 # the .git file to point to the correct path.
653 KAS_GIT_OVERLAY_FILE=$(mktemp)
654 sed "s|gitdir: ${git_com_dir}/|gitdir: /repo-common/|" "${KAS_REPO_DIR}/.git" > "${KAS_GIT_OVERLAY_FILE}"
655 set -- "$@" -v "${git_com_dir}:/repo-common:${KAS_REPO_MOUNT_OPT}" \
656 -v "${KAS_GIT_OVERLAY_FILE}:/repo/.git:ro"
657 # if the workdir is the same as the repo dir, it is the same shared worktree
658 if [ "${KAS_WORK_DIR}" = "${KAS_REPO_DIR}" ]; then
659 set -- "$@" -v "${KAS_GIT_OVERLAY_FILE}:/work/.git:ro"
660 fi
661 fi
662
663 KAS_SSH_DIR="$(check_and_expand KAS_SSH_DIR required)"
664 if [ -n "${KAS_SSH_DIR}" ] ; then
665 set -- "$@" -v "${KAS_SSH_DIR}":/var/kas/userdata/.ssh:ro
666 fi
667
668 if [ -n "${KAS_SSH_AUTH_SOCK}" ]; then
669 if [ ! -S "${KAS_SSH_AUTH_SOCK}" ]; then
670 fatal_error "passed SSH_AUTH_SOCK '${KAS_SSH_AUTH_SOCK}' is not a socket"
671 fi
672 set -- "$@" -v "${KAS_SSH_AUTH_SOCK}":/ssh-agent/ssh-auth-sock \
673 -e SSH_AUTH_SOCK=/ssh-agent/ssh-auth-sock
674 fi
675
676 KAS_AWS_DIR="$(check_and_expand KAS_AWS_DIR required)"
677 if [ -n "${KAS_AWS_DIR}" ] ; then
678 set -- "$@" -v "${KAS_AWS_DIR}":/var/kas/userdata/.aws:ro \
679 -e AWS_CONFIG_FILE="${AWS_CONFIG_FILE:-/var/kas/userdata/.aws/config}" \
680 -e AWS_SHARED_CREDENTIALS_FILE="${AWS_SHARED_CREDENTIALS_FILE:-/var/kas/userdata/.aws/credentials}"
681 fi
682 if [ -n "${AWS_WEB_IDENTITY_TOKEN_FILE}" ] ; then
683 if [ ! -f "${AWS_WEB_IDENTITY_TOKEN_FILE}" ]; then
684 echo "Passed AWS_WEB_IDENTITY_TOKEN_FILE '${AWS_WEB_IDENTITY_TOKEN_FILE}' is not a file"
685 exit 1
686 fi
687 set -- "$@" -v "$(realpath -e "${AWS_WEB_IDENTITY_TOKEN_FILE}")":/var/kas/userdata/.aws/web_identity_token:ro \
688 -e AWS_WEB_IDENTITY_TOKEN_FILE="${AWS_CONFIG_FILE:-/var/kas/userdata/.aws/web_identity_token}" \
689 -e AWS_ROLE_ARN="${AWS_ROLE_ARN}"
690 fi
691
692 KAS_GIT_CREDENTIAL_HELPER_DEFAULT=""
693
694 if [ -n "${KAS_GIT_CREDENTIAL_STORE}" ] ; then
695 if [ ! -f "${KAS_GIT_CREDENTIAL_STORE}" ]; then
696 fatal_error "passed KAS_GIT_CREDENTIAL_STORE '${KAS_GIT_CREDENTIAL_STORE}' is not a file"
697 fi
698 KAS_GIT_CREDENTIAL_HELPER_DEFAULT="store --file=/var/kas/userdata/.git-credentials"
699 set -- "$@" -v "$(realpath -e "${KAS_GIT_CREDENTIAL_STORE}")":/var/kas/userdata/.git-credentials:ro
700 fi
701
702 if [ -n "${KAS_GIT_CREDENTIAL_SOCKET}" ] ; then
703 if [ ! -S "${KAS_GIT_CREDENTIAL_SOCKET}" ]; then
704 fatal_error "passed KAS_GIT_CREDENTIAL_SOCKET '${KAS_GIT_CREDENTIAL_SOCKET}' is not a socket"
705 fi
706 KAS_GIT_CREDENTIAL_HELPER_DEFAULT="cache --socket=/var/kas/userdata/.git-cache-socket"
707 set -- "$@" -v "$(realpath -e "${KAS_GIT_CREDENTIAL_SOCKET}")":/var/kas/userdata/.git-cache-socket
708 fi
709
710 GIT_CREDENTIAL_HELPER="${GIT_CREDENTIAL_HELPER:-${KAS_GIT_CREDENTIAL_HELPER_DEFAULT}}"
711
712 if [ -n "${GIT_CREDENTIAL_HELPER}" ] ; then
713 set -- "$@" -e GIT_CREDENTIAL_HELPER="${GIT_CREDENTIAL_HELPER}"
714 fi
715
716 if [ -f "${NETRC_FILE}" ]; then
717 set -- "$@" -v "$(realpath -e "${NETRC_FILE}")":/var/kas/userdata/.netrc:ro \
718 -e NETRC_FILE="/var/kas/userdata/.netrc"
719 fi
720
721 if [ -f "${NPMRC_FILE}" ]; then
722 set -- "$@" -v "$(realpath -e "${NPMRC_FILE}")":/var/kas/userdata/.npmrc:ro \
723 -e NPMRC_FILE="/var/kas/userdata/.npmrc"
724 fi
725
726 if [ -f "${GITCONFIG_FILE}" ]; then
727 set -- "$@" -v "$(realpath -e "${GITCONFIG_FILE}")":/var/kas/userdata/.gitconfig:ro \
728 -e GITCONFIG_FILE="/var/kas/userdata/.gitconfig"
729 fi
730
731 if [ -f "${REGISTRY_AUTH_FILE}" ]; then
732 set -- "$@" -v "$(realpath -e "${REGISTRY_AUTH_FILE}")":/var/kas/userdata/.docker/config.json:ro \
733 -e REGISTRY_AUTH_FILE="/var/kas/userdata/.docker/config.json"
734 fi
735
736 if [ -t 1 ]; then
737 set -- "$@" -t -i
738 fi
739
740 if [ -n "${SSTATE_MIRRORS}" ]; then
741 if echo "${SSTATE_MIRRORS}" | grep -q "file:///"; then
742 warning "SSTATE_MIRRORS contains a local path." \
743 "Make sure to make this path available inside the container."
744 fi
745 set -- "$@" -e "SSTATE_MIRRORS=${SSTATE_MIRRORS}"
746 fi
747
748 # propagate timezone information to entrypoint (requires systemd 239)
749 if command -v timedatectl >/dev/null; then
750 set -- "$@" -e "KAS_HOST_TZ=$(timedatectl show -p Timezone --value 2>/dev/null)"
751 fi
752
753 for var in TERM KAS_DISTRO KAS_MACHINE KAS_TARGET KAS_TASK KAS_CLONE_DEPTH \
754 KAS_PREMIRRORS DISTRO_APT_PREMIRRORS BB_NUMBER_THREADS PARALLEL_MAKE \
755 GIT_CREDENTIAL_USEHTTPPATH \
756 TZ; do
757 if [ -n "$(eval echo \$${var})" ]; then
758 set -- "$@" -e "${var}=$(eval echo \"\$${var}\")"
759 fi
760 done
761
762 # propagate only supported SHELL settings
763 case "$SHELL" in
764 /bin/sh | /bin/bash | /bin/dash)
765 set -- "$@" -e "SHELL=$SHELL"
766 ;;
767 *)
768 set -- "$@" -e "SHELL=/bin/bash"
769 ;;
770 esac
771
772 if [ -z "${KAS_NO_PROXY_FROM_ENV+x}" ]; then
773 for var in http_proxy https_proxy ftp_proxy no_proxy NO_PROXY; do
774 if [ -n "$(eval echo \$${var})" ]; then
775 set -- "$@" -e "${var}=$(eval echo \$${var})"
776 fi
777 done
778 fi
779
780 # SC2086: Double quote to prevent globbing and word splitting.
781 # shellcheck disable=2086
782 set -- "$@" ${KAS_ISAR_ARGS} ${KAS_RUNTIME_ARGS} ${KAS_EXTRA_RUNTIME_ARGS} \
783 ${KAS_CONTAINER_IMAGE} ${KAS_OPTIONS_DIRECT} ${KAS_CMD} ${KAS_OPTIONS}
784 if [ -n "${KAS_BITBAKE_C_OPTION_ARGS}" ]; then
785 set -- "$@" -c "${KAS_BITBAKE_C_OPTION_ARGS}"
786 fi
787 # SC2086: Double quote to prevent globbing and word splitting.
788 # shellcheck disable=2086
789 set -- "$@" ${KAS_FILES}
790 if [ "$KAS_CMD" = "for-all-repos" ]; then
791 set -- "$@" "${KAS_REPO_CMD}"
792 fi
793
794 # rotate any extra bitbake args from the front to the end of the argument list
795 while [ $KAS_EXTRA_BITBAKE_ARGS -gt 0 ]; do
796 arg="$1"
797 shift 1
798 set -- "$@" "$arg"
799 KAS_EXTRA_BITBAKE_ARGS=$((KAS_EXTRA_BITBAKE_ARGS - 1))
800 done
801
802 # shellcheck disable=SC2086
803 trace ${KAS_CONTAINER_COMMAND} run "$@"