1 #!/bin/bash 1 #!/bin/bash
2 # SPDX-License-Identifier: GPL-2.0 2 # SPDX-License-Identifier: GPL-2.0
3 3
4 set -u 4 set -u
5 set -e 5 set -e
6 6
7 # This script currently only works for x86_64 7 # This script currently only works for x86_64
8 ARCH="$(uname -m)" 8 ARCH="$(uname -m)"
9 case "${ARCH}" in 9 case "${ARCH}" in
10 x86_64) 10 x86_64)
11 QEMU_BINARY=qemu-system-x86_64 11 QEMU_BINARY=qemu-system-x86_64
12 BZIMAGE="arch/x86/boot/bzImage" 12 BZIMAGE="arch/x86/boot/bzImage"
13 ;; 13 ;;
14 *) 14 *)
15 echo "Unsupported architecture" 15 echo "Unsupported architecture"
16 exit 1 16 exit 1
17 ;; 17 ;;
18 esac 18 esac
19 SCRIPT_DIR="$(dirname $(realpath $0))" 19 SCRIPT_DIR="$(dirname $(realpath $0))"
20 OUTPUT_DIR="$SCRIPT_DIR/results" 20 OUTPUT_DIR="$SCRIPT_DIR/results"
21 KCONFIG_REL_PATHS=("${SCRIPT_DIR}/config" "${S 21 KCONFIG_REL_PATHS=("${SCRIPT_DIR}/config" "${SCRIPT_DIR}/config.common" "${SCRIPT_DIR}/config.${ARCH}")
22 B2C_URL="https://gitlab.freedesktop.org/gfx-ci !! 22 B2C_URL="https://gitlab.freedesktop.org/mupuf/boot2container/-/raw/master/vm2c.py"
23 NUM_COMPILE_JOBS="$(nproc)" 23 NUM_COMPILE_JOBS="$(nproc)"
24 LOG_FILE_BASE="$(date +"hid_selftests.%Y-%m-%d 24 LOG_FILE_BASE="$(date +"hid_selftests.%Y-%m-%d_%H-%M-%S")"
25 LOG_FILE="${LOG_FILE_BASE}.log" 25 LOG_FILE="${LOG_FILE_BASE}.log"
26 EXIT_STATUS_FILE="${LOG_FILE_BASE}.exit_status 26 EXIT_STATUS_FILE="${LOG_FILE_BASE}.exit_status"
27 CONTAINER_IMAGE="registry.freedesktop.org/bent !! 27 CONTAINER_IMAGE="registry.freedesktop.org/libevdev/hid-tools/fedora/37:2023-02-17.1"
28 28
29 TARGETS="${TARGETS:=$(basename ${SCRIPT_DIR})} 29 TARGETS="${TARGETS:=$(basename ${SCRIPT_DIR})}"
30 DEFAULT_COMMAND="pip3 install hid-tools; make 30 DEFAULT_COMMAND="pip3 install hid-tools; make -C tools/testing/selftests TARGETS=${TARGETS} run_tests"
31 31
32 usage() 32 usage()
33 { 33 {
34 cat <<EOF 34 cat <<EOF
35 Usage: $0 [-j N] [-s] [-b] [-d <output_dir>] - !! 35 Usage: $0 [-i] [-s] [-d <output_dir>] -- [<command>]
36 36
37 <command> is the command you would normally ru 37 <command> is the command you would normally run when you are in
38 the source kernel direcory. e.g: 38 the source kernel direcory. e.g:
39 39
40 $0 -- ./tools/testing/selftests/hid/hi 40 $0 -- ./tools/testing/selftests/hid/hid_bpf
41 41
42 If no command is specified and a debug shell ( 42 If no command is specified and a debug shell (-s) is not requested,
43 "${DEFAULT_COMMAND}" will be run by default. 43 "${DEFAULT_COMMAND}" will be run by default.
44 44
45 If you build your kernel using KBUILD_OUTPUT= 45 If you build your kernel using KBUILD_OUTPUT= or O= options, these
46 can be passed as environment variables to the 46 can be passed as environment variables to the script:
47 47
48 O=<kernel_build_path> $0 -- ./tools/testing/ 48 O=<kernel_build_path> $0 -- ./tools/testing/selftests/hid/hid_bpf
49 49
50 or 50 or
51 51
52 KBUILD_OUTPUT=<kernel_build_path> $0 -- ./to 52 KBUILD_OUTPUT=<kernel_build_path> $0 -- ./tools/testing/selftests/hid/hid_bpf
53 53
54 Options: 54 Options:
55 55
56 -u) Update the boot2contai 56 -u) Update the boot2container script to a newer version.
57 -d) Update the output dire 57 -d) Update the output directory (default: ${OUTPUT_DIR})
58 -b) Run only the build ste <<
59 -j) Number of jobs for com 58 -j) Number of jobs for compilation, similar to -j in make
60 (default: ${NUM_COMPIL 59 (default: ${NUM_COMPILE_JOBS})
61 -s) Instead of powering of 60 -s) Instead of powering off the VM, start an interactive
62 shell. If <command> is 61 shell. If <command> is specified, the shell runs after
63 the command finishes e 62 the command finishes executing
64 EOF 63 EOF
65 } 64 }
66 65
67 download() 66 download()
68 { 67 {
69 local file="$1" 68 local file="$1"
70 69
71 echo "Downloading $file..." >&2 70 echo "Downloading $file..." >&2
72 curl -Lsf "$file" -o "${@:2}" 71 curl -Lsf "$file" -o "${@:2}"
73 } 72 }
74 73
75 recompile_kernel() 74 recompile_kernel()
76 { 75 {
77 local kernel_checkout="$1" 76 local kernel_checkout="$1"
78 local make_command="$2" 77 local make_command="$2"
79 78
80 cd "${kernel_checkout}" 79 cd "${kernel_checkout}"
81 80
82 ${make_command} olddefconfig 81 ${make_command} olddefconfig
83 ${make_command} headers <<
84 ${make_command} 82 ${make_command}
85 } 83 }
86 84
87 update_selftests() 85 update_selftests()
88 { 86 {
89 local kernel_checkout="$1" 87 local kernel_checkout="$1"
90 local selftests_dir="${kernel_checkout 88 local selftests_dir="${kernel_checkout}/tools/testing/selftests/hid"
91 89
92 cd "${selftests_dir}" 90 cd "${selftests_dir}"
93 ${make_command} 91 ${make_command}
94 } 92 }
95 93
96 run_vm() 94 run_vm()
97 { 95 {
98 local run_dir="$1" 96 local run_dir="$1"
99 local b2c="$2" 97 local b2c="$2"
100 local kernel_bzimage="$3" 98 local kernel_bzimage="$3"
101 local command="$4" 99 local command="$4"
102 local post_command="" 100 local post_command=""
103 101
104 cd "${run_dir}" 102 cd "${run_dir}"
105 103
106 if ! which "${QEMU_BINARY}" &> /dev/nu 104 if ! which "${QEMU_BINARY}" &> /dev/null; then
107 cat <<EOF 105 cat <<EOF
108 Could not find ${QEMU_BINARY} 106 Could not find ${QEMU_BINARY}
109 Please install qemu or set the QEMU_BINARY env 107 Please install qemu or set the QEMU_BINARY environment variable.
110 EOF 108 EOF
111 exit 1 109 exit 1
112 fi 110 fi
113 111
114 # alpine (used in post-container requi 112 # alpine (used in post-container requires the PATH to have /bin
115 export PATH=$PATH:/bin 113 export PATH=$PATH:/bin
116 114
117 if [[ "${debug_shell}" != "yes" ]] 115 if [[ "${debug_shell}" != "yes" ]]
118 then 116 then
119 touch ${OUTPUT_DIR}/${LOG_FILE 117 touch ${OUTPUT_DIR}/${LOG_FILE}
120 command="mount bpffs -t bpf /s 118 command="mount bpffs -t bpf /sys/fs/bpf/; set -o pipefail ; ${command} 2>&1 | tee ${OUTPUT_DIR}/${LOG_FILE}"
121 post_command="cat ${OUTPUT_DIR 119 post_command="cat ${OUTPUT_DIR}/${LOG_FILE}"
122 else 120 else
123 command="mount bpffs -t bpf /s 121 command="mount bpffs -t bpf /sys/fs/bpf/; ${command}"
124 fi 122 fi
125 123
126 set +e 124 set +e
127 $b2c --command "${command}" \ 125 $b2c --command "${command}" \
128 --kernel ${kernel_bzimage} \ 126 --kernel ${kernel_bzimage} \
129 --workdir ${OUTPUT_DIR} \ 127 --workdir ${OUTPUT_DIR} \
130 --image ${CONTAINER_IMAGE} 128 --image ${CONTAINER_IMAGE}
131 129
132 echo $? > ${OUTPUT_DIR}/${EXIT_STATUS_ 130 echo $? > ${OUTPUT_DIR}/${EXIT_STATUS_FILE}
133 131
134 set -e 132 set -e
135 133
136 ${post_command} 134 ${post_command}
137 } 135 }
138 136
139 is_rel_path() 137 is_rel_path()
140 { 138 {
141 local path="$1" 139 local path="$1"
142 140
143 [[ ${path:0:1} != "/" ]] 141 [[ ${path:0:1} != "/" ]]
144 } 142 }
145 143
146 do_update_kconfig() 144 do_update_kconfig()
147 { 145 {
148 local kernel_checkout="$1" 146 local kernel_checkout="$1"
149 local kconfig_file="$2" 147 local kconfig_file="$2"
150 148
151 rm -f "$kconfig_file" 2> /dev/null 149 rm -f "$kconfig_file" 2> /dev/null
152 150
153 for config in "${KCONFIG_REL_PATHS[@]} 151 for config in "${KCONFIG_REL_PATHS[@]}"; do
154 local kconfig_src="${config}" 152 local kconfig_src="${config}"
155 cat "$kconfig_src" >> "$kconfi 153 cat "$kconfig_src" >> "$kconfig_file"
156 done 154 done
157 } 155 }
158 156
159 update_kconfig() 157 update_kconfig()
160 { 158 {
161 local kernel_checkout="$1" 159 local kernel_checkout="$1"
162 local kconfig_file="$2" 160 local kconfig_file="$2"
163 161
164 if [[ -f "${kconfig_file}" ]]; then 162 if [[ -f "${kconfig_file}" ]]; then
165 local local_modified="$(stat - 163 local local_modified="$(stat -c %Y "${kconfig_file}")"
166 164
167 for config in "${KCONFIG_REL_P 165 for config in "${KCONFIG_REL_PATHS[@]}"; do
168 local kconfig_src="${c 166 local kconfig_src="${config}"
169 local src_modified="$( 167 local src_modified="$(stat -c %Y "${kconfig_src}")"
170 # Only update the conf 168 # Only update the config if it has been updated after the
171 # previously cached co 169 # previously cached config was created. This avoids
172 # unnecessarily compil 170 # unnecessarily compiling the kernel and selftests.
173 if [[ "${src_modified} 171 if [[ "${src_modified}" -gt "${local_modified}" ]]; then
174 do_update_kcon 172 do_update_kconfig "$kernel_checkout" "$kconfig_file"
175 # Once we have 173 # Once we have found one outdated configuration
176 # there is no 174 # there is no need to check other ones.
177 break 175 break
178 fi 176 fi
179 done 177 done
180 else 178 else
181 do_update_kconfig "$kernel_che 179 do_update_kconfig "$kernel_checkout" "$kconfig_file"
182 fi 180 fi
183 } 181 }
184 182
185 main() 183 main()
186 { 184 {
187 local script_dir="$(cd -P -- "$(dirnam 185 local script_dir="$(cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P)"
188 local kernel_checkout=$(realpath "${sc 186 local kernel_checkout=$(realpath "${script_dir}"/../../../../)
189 # By default the script searches for t 187 # By default the script searches for the kernel in the checkout directory but
190 # it also obeys environment variables 188 # it also obeys environment variables O= and KBUILD_OUTPUT=
191 local kernel_bzimage="${kernel_checkou 189 local kernel_bzimage="${kernel_checkout}/${BZIMAGE}"
192 local command="${DEFAULT_COMMAND}" 190 local command="${DEFAULT_COMMAND}"
193 local update_b2c="no" 191 local update_b2c="no"
194 local debug_shell="no" 192 local debug_shell="no"
195 local build_only="no" <<
196 193
197 while getopts ':hsud:j:b' opt; do !! 194 while getopts ':hsud:j:' opt; do
198 case ${opt} in 195 case ${opt} in
199 u) 196 u)
200 update_b2c="yes" 197 update_b2c="yes"
201 ;; 198 ;;
202 d) 199 d)
203 OUTPUT_DIR="$OPTARG" 200 OUTPUT_DIR="$OPTARG"
204 ;; 201 ;;
205 j) 202 j)
206 NUM_COMPILE_JOBS="$OPT 203 NUM_COMPILE_JOBS="$OPTARG"
207 ;; 204 ;;
208 s) 205 s)
209 command="/bin/sh" 206 command="/bin/sh"
210 debug_shell="yes" 207 debug_shell="yes"
211 ;; 208 ;;
212 b) <<
213 build_only="yes" <<
214 ;; <<
215 h) 209 h)
216 usage 210 usage
217 exit 0 211 exit 0
218 ;; 212 ;;
219 \? ) 213 \? )
220 echo "Invalid Option: 214 echo "Invalid Option: -$OPTARG"
221 usage 215 usage
222 exit 1 216 exit 1
223 ;; 217 ;;
224 : ) 218 : )
225 echo "Invalid Option: 219 echo "Invalid Option: -$OPTARG requires an argument"
226 usage 220 usage
227 exit 1 221 exit 1
228 ;; 222 ;;
229 esac 223 esac
230 done 224 done
231 shift $((OPTIND -1)) 225 shift $((OPTIND -1))
232 226
233 # trap 'catch "$?"' EXIT 227 # trap 'catch "$?"' EXIT
234 if [[ "${build_only}" == "no" && "${de !! 228
>> 229 if [[ "${debug_shell}" == "no" ]]; then
235 if [[ $# -eq 0 ]]; then 230 if [[ $# -eq 0 ]]; then
236 echo "No command speci 231 echo "No command specified, will run ${DEFAULT_COMMAND} in the vm"
237 else 232 else
238 command="$@" 233 command="$@"
239 234
240 if [[ "${command}" == 235 if [[ "${command}" == "/bin/bash" || "${command}" == "bash" ]]
241 then 236 then
242 debug_shell="y 237 debug_shell="yes"
243 fi 238 fi
244 fi 239 fi
245 fi 240 fi
246 241
247 local kconfig_file="${OUTPUT_DIR}/late 242 local kconfig_file="${OUTPUT_DIR}/latest.config"
248 local make_command="make -j ${NUM_COMP 243 local make_command="make -j ${NUM_COMPILE_JOBS} KCONFIG_CONFIG=${kconfig_file}"
249 244
250 # Figure out where the kernel is being 245 # Figure out where the kernel is being built.
251 # O takes precedence over KBUILD_OUTPU 246 # O takes precedence over KBUILD_OUTPUT.
252 if [[ "${O:=""}" != "" ]]; then 247 if [[ "${O:=""}" != "" ]]; then
253 if is_rel_path "${O}"; then 248 if is_rel_path "${O}"; then
254 O="$(realpath "${PWD}/ 249 O="$(realpath "${PWD}/${O}")"
255 fi 250 fi
256 kernel_bzimage="${O}/${BZIMAGE 251 kernel_bzimage="${O}/${BZIMAGE}"
257 make_command="${make_command} 252 make_command="${make_command} O=${O}"
258 elif [[ "${KBUILD_OUTPUT:=""}" != "" ] 253 elif [[ "${KBUILD_OUTPUT:=""}" != "" ]]; then
259 if is_rel_path "${KBUILD_OUTPU 254 if is_rel_path "${KBUILD_OUTPUT}"; then
260 KBUILD_OUTPUT="$(realp 255 KBUILD_OUTPUT="$(realpath "${PWD}/${KBUILD_OUTPUT}")"
261 fi 256 fi
262 kernel_bzimage="${KBUILD_OUTPU 257 kernel_bzimage="${KBUILD_OUTPUT}/${BZIMAGE}"
263 make_command="${make_command} 258 make_command="${make_command} KBUILD_OUTPUT=${KBUILD_OUTPUT}"
264 fi 259 fi
265 260
266 local b2c="${OUTPUT_DIR}/vm2c.py" 261 local b2c="${OUTPUT_DIR}/vm2c.py"
267 262
268 echo "Output directory: ${OUTPUT_DIR}" 263 echo "Output directory: ${OUTPUT_DIR}"
269 264
270 mkdir -p "${OUTPUT_DIR}" 265 mkdir -p "${OUTPUT_DIR}"
271 update_kconfig "${kernel_checkout}" "$ 266 update_kconfig "${kernel_checkout}" "${kconfig_file}"
272 267
273 recompile_kernel "${kernel_checkout}" 268 recompile_kernel "${kernel_checkout}" "${make_command}"
274 update_selftests "${kernel_checkout}" <<
275 <<
276 if [[ "${build_only}" == "no" ]]; then <<
277 if [[ "${update_b2c}" == "no" <<
278 echo "vm2c script not <<
279 update_b2c="yes" <<
280 fi <<
281 269
282 if [[ "${update_b2c}" == "yes" !! 270 if [[ "${update_b2c}" == "no" && ! -f "${b2c}" ]]; then
283 download $B2C_URL $b2c !! 271 echo "vm2c script not found in ${b2c}"
284 chmod +x $b2c !! 272 update_b2c="yes"
285 fi !! 273 fi
286 274
287 run_vm "${kernel_checkout}" $b !! 275 if [[ "${update_b2c}" == "yes" ]]; then
288 if [[ "${debug_shell}" != "yes !! 276 download $B2C_URL $b2c
289 echo "Logs saved in ${ !! 277 chmod +x $b2c
290 fi !! 278 fi
291 279
292 exit $(cat ${OUTPUT_DIR}/${EXI !! 280 update_selftests "${kernel_checkout}" "${make_command}"
>> 281 run_vm "${kernel_checkout}" $b2c "${kernel_bzimage}" "${command}"
>> 282 if [[ "${debug_shell}" != "yes" ]]; then
>> 283 echo "Logs saved in ${OUTPUT_DIR}/${LOG_FILE}"
293 fi 284 fi
>> 285
>> 286 exit $(cat ${OUTPUT_DIR}/${EXIT_STATUS_FILE})
294 } 287 }
295 288
296 main "$@" 289 main "$@"
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.