-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathrun_debugger.sh
executable file
·222 lines (205 loc) · 8.03 KB
/
run_debugger.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
#!/bin/bash -e
volumes_file=""
dry_run=""
do_source_build="."
builder_build="y"
runner_build="y"
runner_run="y"
runner_systemd=""
runner_mount_cgroup=""
OS_NAME="ubuntu22"
DEVROOT=""
NO_CACHE=""
BUILD_OPTIONS="
"
DOCKER_OPTIONS="
-d -i -t "
RUNNER_SHM="256m"
RUNNER_ARGS="
"
DEBUG_OPTIONS="
--cap-add SYS_PTRACE
--security-opt seccomp=unconfined
--privileged "
CACHE_DIR="${XDG_CACHE_HOME:-$HOME/.cache}/irods"
usage()
{
[ $# -gt 0 ] && echo "$*";
echo "Usage: bash '$0' --volume-ro /outside /inside --volume-rw /outside_rw /inside_rw --dry-run"
echo " abbreviated forms : -r => --volume-ro"
echo " : -w => --volume-rw"
echo " : -d => --devroot"
echo " : -p => --platform-os (set to '$OS_NAME')"
echo " : -V => --volumes-file"
echo " : -b => --skip-builder-build"
echo " : -s => --skip-source-build"
echo " : -e => --skip-runner-build"
echo " : -u => --skip-runner-run"
echo " : -g => --debug-source-build"
echo " : -m => --runner-shm"
echo " : -i => --runner-systemd"
echo " : -c => --ccache"
echo " : -j => --jobs"
echo " : -P => --port"
exit 127
} >&2
declare -A volumes_ro=() volumes_rw=()
vol_mounts=()
while [[ $1 = -* ]]; do
case $1 in
-h|--help) usage ;;
--dry*) dry_run=1;;
-p|--platform-os) shift; OS_NAME="$1";;
-V|--volumes-file) shift; volumes_file="$1";;
-r|--volume-ro) shift; vol_mounts+=( "-v" "$1":"$2":ro ); shift ;;
-w|--volume-rw) shift; vol_mounts+=( "-v" "$1":"$2" ) ; shift ;;
-d|--devroot) shift; DEVROOT="$1";;
-b|--skip-builder-build) builder_build="";;
-s|--skip-source-build) do_source_build="";;
-e|--skip-runner-build) runner_build="";;
-u|--skip-runner-run) runner_run="";;
-n|--no-cache) NO_CACHE="--no-cache";;
-g|--debug*) do_source_build=".--debug";;
-N|--ninja) BUILD_OPTIONS+=" --ninja";;
-c|--ccache) BUILD_OPTIONS+=" --ccache";;
-m|--runner-shm) RUNNER_SHM="$2"; shift;;
-i|--runner-systemd) runner_systemd="y";;
-j|--jobs) BUILD_OPTIONS+=" --jobs $2"; shift;;
-P|--port) DOCKER_OPTIONS+=" -p $2"; shift;;
--runner-mount-cgroup) runner_mount_cgroup="y";;
*) usage bad option "'$1'" ;;
esac
shift
done
declare -A Os_Map=( ['ubuntu20']='ubuntu:20.04'
['ubuntu22']='ubuntu:22.04'
['ubuntu24']='ubuntu:24.04'
['debian11']='debian:11'
['debian12']='debian:12'
['almalinux8']='almalinux:8'
['rocky9']='rockylinux:9'
)
base_image=${Os_Map["$OS_NAME"]}
if [ -n "$volumes_file" ]
then
source "$volumes_file"
[ -n "$exit_code" ] && exit $((0+exit_code))
else
# -----------------------------------------------------
# For a custom setup of host-guest volume directories:
# copy this section into a volumes_file.XYZ and add own custom paths.
# Example file: ./volumes.include.sh
volumes_ro=( # add read-only container mounts, eg:
# ['/path_to_source'] = '/full/host/path/to/source'
# ...
)
volumes_rw=( # add read-write container mounts, eg:
# ['/container/path/to/packages'] = '/host/path/to/packages_output'
)
# ---------------------------------------------------
fi
# -- assemble -v options for Docker commands
if [ "${#vol_mounts[@]}" -eq 0 ]; then
for d in "${!volumes_rw[@]}"; do # read-write mounts
rlpath=$(realpath "${volumes_rw[$d]}")
vol_mounts+=("-v" "$rlpath:$d")
done
for d in "${!volumes_ro[@]}"; do # read-only mounts
rlpath=$(realpath "${volumes_ro[$d]}")
vol_mounts+=("-v" "$rlpath:$d:ro")
done
fi
DOCKER_OPTIONS+=" --shm-size=${RUNNER_SHM}"
DEBUGGER_IMAGE="irods_debuggers.${OS_NAME}"
BUILDER_IMAGE="irods_core_builder.${OS_NAME}"
RUNNER_IMAGE="irods_runner.${OS_NAME}"
DEBUGGER_DOCKERFILE="build_debuggers.${OS_NAME}.Dockerfile"
BUILDER_DOCKERFILE="irods_core_builder.${OS_NAME}.Dockerfile"
RUNNER_DOCKERFILE="irods_runner.${OS_NAME}.Dockerfile"
# get/init runner number
RUNNER_INT_FILE="${CACHE_DIR}/new_runner_number.${OS_NAME}"
RUNNER_INT="0"
RUNNER_NUMBER="0000"
mkdir -p "${CACHE_DIR}"
if [ -f "${RUNNER_INT_FILE}" ]; then
RUNNER_INT="$(<"${RUNNER_INT_FILE}")"
RUNNER_NUMBER=$(printf "%04d" "${RUNNER_INT}")
fi
RUNNER_NAME="irods_runner.${RUNNER_NUMBER}.${OS_NAME}"
while [ "$(docker ps -aq -f name=${RUNNER_NAME})" ]; do
RUNNER_INT=$((RUNNER_INT+1))
RUNNER_NUMBER=$(printf "%04d" "${RUNNER_INT}")
RUNNER_NAME="irods_runner.${RUNNER_NUMBER}.${OS_NAME}"
done
if [ -n "$runner_mount_cgroup" ]; then
if [ -e "/sys/fs/cgroup/cgroup.controllers" ]; then
# cgroups2
DOCKER_OPTIONS+=" --cgroupns=host"
vol_mounts+=("-v" "/sys/fs/cgroup:/sys/fs/cgroup:rw")
else
# cgroups1?
vol_mounts+=("-v" "/sys/fs/cgroup:/sys/fs/cgroup:ro")
fi
fi
if [ -n "$runner_systemd" ]; then
if [ -z "$runner_mount_cgroup" ]; then
DOCKER_OPTIONS+=" --cgroup-parent=docker.slice"
DOCKER_OPTIONS+=" --cgroupns=private"
fi
DOCKER_OPTIONS+=" --cap-add SYS_ADMIN"
DOCKER_OPTIONS+=" --tmpfs /tmp"
DOCKER_OPTIONS+=" --tmpfs /run"
DOCKER_OPTIONS+=" --tmpfs /run/lock"
DOCKER_OPTIONS+=" --env container=docker"
DOCKER_OPTIONS+=" --workdir /"
DOCKER_OPTIONS+=" --entrypoint /lib/systemd/systemd"
DOCKER_OPTIONS+=" --stop-signal SIGRTMIN+3"
RUNNER_ARGS+=" log-level=info unit=sysinit.target"
fi
if [ -n "$dry_run" ]; then # -- print mount options for the debugger run
echo "--- using OS_NAME='$OS_NAME' base_image='$base_image' ---"
if [ -e "${DEBUGGER_DOCKERFILE}" ]; then
echo " DEBUGGER_IMAGE: '${DEBUGGER_IMAGE}'"
fi
echo " BUILDER_IMAGE: '${BUILDER_IMAGE}'"
if [ -e "${RUNNER_DOCKERFILE}" ]; then
echo " RUNNER_IMAGE: '${RUNNER_IMAGE}'"
echo " RUNNER_CONTAINER: '${RUNNER_NAME}'"
fi
echo -e "\ndocker run \n"
n=0; echo $'\t'$n
for x in "${vol_mounts[@]}"; do
echo $'\t'$((++n))$'\t'$x
done
echo -e "\nBUILD_OPTIONS:${BUILD_OPTIONS}"
if [ -e "${RUNNER_DOCKERFILE}" ]; then
echo -e "DOCKER_OPTIONS:${DOCKER_OPTIONS}" \
"\nDEBUG_OPTIONS:${DEBUG_OPTIONS}" \
"\nRUNNER_ARGS:${RUNNER_ARGS}"
fi
exit 1
else
build_dir=$(dirname "$0")
cd "$build_dir" || { echo >&2 "cannot cd to docker build environment"; exit 2; }
if [ -e "${DEBUGGER_DOCKERFILE}" ]; then
DOCKER_BUILDKIT=1 BUILDKIT_PROGRESS=plain docker build --build-arg debugger_base=${base_image} -f "${DEBUGGER_DOCKERFILE}" -t "${DEBUGGER_IMAGE}" . ${NO_CACHE}
RUNNER_BASE="${DEBUGGER_IMAGE}"
else
RUNNER_BASE="${base_image}"
fi
if [ -n "$builder_build" ] || [ -n "$do_source_build" ]; then
DOCKER_BUILDKIT=1 BUILDKIT_PROGRESS=plain docker build -t "${BUILDER_IMAGE}" -f "${BUILDER_DOCKERFILE}" . ${NO_CACHE}
fi
if [ -n "$do_source_build" ]; then
docker run --rm "${vol_mounts[@]}" -it -e "TERM=$TERM" "${BUILDER_IMAGE}" ${do_source_build:1} ${BUILD_OPTIONS}
fi
if [ -e "${RUNNER_DOCKERFILE}" ]; then
if [ -n "$runner_build" ]; then
DOCKER_BUILDKIT=1 BUILDKIT_PROGRESS=plain docker build --build-arg runner_base="${RUNNER_BASE}" -t "${RUNNER_IMAGE}" -f "${RUNNER_DOCKERFILE}" . ${NO_CACHE}
fi
if [ -n "$runner_run" ]; then
echo -n "$((RUNNER_INT+1))" > "${RUNNER_INT_FILE}"
docker run "${vol_mounts[@]}" ${DOCKER_OPTIONS} ${DEBUG_OPTIONS} --name "${RUNNER_NAME}" "${RUNNER_IMAGE}" ${RUNNER_ARGS}
fi
fi
fi