From 9e79b9b06f1fd3fda8100226c405446d5946115e Mon Sep 17 00:00:00 2001
From: Ciro Santilli <ciro.santilli@gmail.com>
Date: Sun, 8 Apr 2018 16:55:06 +0100
Subject: [PATCH] Save .log output files to out/arch/

This is cleaner as it removes yet another .gitignore rule and allows
for one command per arch.

This was prompted by the recent Docker patch creating files as root,
which then breaks future host runs.

Also separate all arguments by newlines. This:

- makes it much easier to minimize when reporting QEMU bugs
- shows the full command on the screen despite line wrapping being turned off
  by one of the annoying emulators, to be investigated.

The commands are not yet pristine, because:

- there are some leading spaces
- options not sorted

but it is already a huge improvement, and those operations are now be easy from Vim.

The general strategy is:

- end every variable containing a command with a newline
- when expanding such variables, don't add an extra newline
---
 .gitignore  |   1 -
 README.adoc |   4 +-
 build       |  36 ++++++++------
 run         | 140 ++++++++++++++++++++++++++++------------------------
 rungdb      |  29 ++++++-----
 5 files changed, 113 insertions(+), 97 deletions(-)

diff --git a/.gitignore b/.gitignore
index 47023f6..7968c2e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,4 @@
 # Extensions and prefixes.
-*.log
 *.tmp
 *~
 ?*.gitignore
diff --git a/README.adoc b/README.adoc
index 887192d..dc49a55 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1436,7 +1436,7 @@ To enable initrd instead of the default ext2 disk image, do:
 Notice how it boots fine, even though this leads to not giving QEMU the `-drive` option, as can be verified with:
 
 ....
-cat ./run.log
+cat ./out/x86_64/run.sh
 ....
 
 Also as expected, there is no filesystem persistency, since we are doing everything in memory:
@@ -3799,7 +3799,7 @@ Stdout shows a line with the full command of type:
 and this line is also saved to a file for convenience:
 
 ....
-cat ./run.log
+cat ./out/arm/run.sh
 ....
 
 Next, you will also want to give the relevant images to save them time. Zip the images with:
diff --git a/build b/build
index b44b05b..77bfeff 100755
--- a/build
+++ b/build
@@ -5,7 +5,7 @@ set -- ${cli_build:-} "$@"
 rm -f br2_cli.gitignore
 touch br2_cli.gitignore
 configure=true
-config_fragments='br2'
+config_fragments=br2
 extra_make_args=
 gem5=false
 j="$(nproc)"
@@ -29,7 +29,8 @@ while getopts 'a:B:b:CGgj:hIiK:klp:qSv' OPT; do
       configure=false
       ;;
     G)
-      extra_make_args="$extra_make_args gem5-reconfigure"
+      extra_make_args="${extra_make_args} gem5-reconfigure \\
+"
       gem5=true
       ;;
     g)
@@ -60,17 +61,20 @@ BR2_TARGET_ROOTFS_INITRAMFS=n
       linux_kernel_custom_config_file="$OPTARG"
       ;;
     k)
-      extra_make_args="$extra_make_args kernel_module-reconfigure"
+      extra_make_args="${extra_make_args} kernel_module-reconfigure \\
+"
       ;;
     l)
       linux_reconfigure=true
-      extra_make_args="$extra_make_args linux-reconfigure"
+      extra_make_args="${extra_make_args} linux-reconfigure \\
+"
       ;;
     p)
       post_script_args="$OPTARG"
       ;;
     q)
-      extra_make_args="$extra_make_args host-qemu-reconfigure"
+      extra_make_args="${extra_make_args} host-qemu-reconfigure \\
+"
       ;;
     S)
       qemu_sdl=
@@ -84,7 +88,7 @@ BR2_TARGET_ROOTFS_INITRAMFS=n
   esac
 done
 shift $(($OPTIND - 1))
-extra_make_args="$extra_make_args $@"
+extra_make_args="${extra_make_args} $@"
 set_common_vars "$arch" "$gem5"
 config_file="${buildroot_out_dir}/.config"
 case "$arch" in
@@ -173,15 +177,15 @@ cd "${buildroot_dir}"
 #
 # BR2_ options may be given on the command line here, and they do have direct "define" effects.
 # But this is generally bad, as it skips the Kconfig mechanism, e.g. it does not set defaults properly.
-cmd="time \
-  env \
-  -u LD_LIBRARY_PATH \
-  make \
-  O='${buildroot_out_dir}' \
-  HOST_QEMU_OPTS='--enable-debug --extra-cflags=-DDEBUG_PL061=1 --enable-trace-backends=simple ${qemu_sdl}' \
-  V='$v' \
-  ${extra_make_args} \
-  all \
+cmd="time \\
+env \\
+-u LD_LIBRARY_PATH \\
+make \\
+O='${buildroot_out_dir}' \\
+HOST_QEMU_OPTS='--enable-debug --extra-cflags=-DDEBUG_PL061=1 --enable-trace-backends=simple ${qemu_sdl}' \\
+V='${v}' \\
+${extra_make_args} \
+all \\
 "
-echo "$cmd" | tee "${root_dir}/build.log"
+echo "$cmd" | tee "${out_arch_dir}/build.sh"
 eval "$cmd"
diff --git a/run b/run
index 9e24c34..026ee55 100755
--- a/run
+++ b/run
@@ -38,11 +38,13 @@ while getopts a:c:DdE:e:f:G:ghIiKkm:T:Vx OPT; do
       cpus="$OPTARG"
       ;;
     D)
-      debug_vm='gdb -q -ex start --args'
+      debug_vm="gdb -q -ex start --args \\
+"
       ;;
     d)
       debug=true
-      extra_flags_qemu="$extra_flags_qemu -S"
+      extra_flags_qemu="$extra_flags_qemu -S \\
+"
       ;;
     E)
       lkmc_eval="$OPTARG"
@@ -54,7 +56,8 @@ while getopts a:c:DdE:e:f:G:ghIiKkm:T:Vx OPT; do
       extra_append_after_dash="$extra_append_after_dash $OPTARG"
       ;;
     G)
-      gem5opts="$OPTARG"
+      gem5opts="$OPTARG \\
+"
       ;;
     g)
       gem5=true
@@ -76,7 +79,8 @@ while getopts a:c:DdE:e:f:G:ghIiKkm:T:Vx OPT; do
       extra_append="$extra_append kgdbwait"
       # For those who want to try KDB.
       #extra_append="$extra_append kgdbwait kgdboc=kbd"
-      extra_flags_qemu="$extra_flags_qemu -serial tcp::1234,server,nowait"
+      extra_flags_qemu="$extra_flags_qemu -serial tcp::1234,server,nowait \\
+"
       kgdb=true
       ;;
     m)
@@ -89,7 +93,8 @@ while getopts a:c:DdE:e:f:G:ghIiKkm:T:Vx OPT; do
       nographic=false
       ;;
     V)
-      vnc='-vnc :0'
+      vnc="-vnc :0 \\
+"
       ;;
     ?)
       exit 2
@@ -119,8 +124,9 @@ if [ -n "$lkmc_eval" ]; then
   extra_append_after_dash="${extra_append_after_dash} lkmc_eval=\"$(printf "$lkmc_eval" | base64)\""
 fi
 if "$nographic" && [ "$arch" = x86_64 ]; then
-  extra_append="$extra_append console=ttyS0"
-  extra_flags_qemu="$extra_flags_qemu -nographic"
+  extra_append="${extra_append} console=ttyS0"
+  extra_flags_qemu="${extra_flags_qemu} -nographic \\
+"
 fi
 if [ -n "$extra_append_after_dash" ]; then
   extra_append="${extra_append} - ${extra_append_after_dash}"
@@ -136,18 +142,18 @@ if "$gem5"; then
     gem5_arch=ARM
   fi
   gem5_common="\
-M5_PATH='${gem5_build_dir}/system' \
+M5_PATH='${gem5_build_dir}/system' \\
 ${debug_vm} \
-'${gem5_src_dir}/build/${gem5_arch}/gem5.opt' \
---debug-file=trace.txt \
+'${gem5_src_dir}/build/${gem5_arch}/gem5.opt' \\
+--debug-file=trace.txt \\
 ${gem5opts} \
--d '${m5out_dir}' \
-'${gem5_src_dir}/configs/example/fs.py' \
---disk-image='${images_dir}/rootfs.ext2' \
---kernel='${buildroot_out_dir}/build/linux-custom/vmlinux' \
---mem-size=${memory} \
---num-cpus='${cpus}' \
---script='${readfile_file}' \
+-d '${m5out_dir}' \\
+'${gem5_src_dir}/configs/example/fs.py' \\
+--disk-image='${images_dir}/rootfs.ext2' \\
+--kernel='${buildroot_out_dir}/build/linux-custom/vmlinux' \\
+--mem-size='${memory}' \\
+--num-cpus='${cpus}' \\
+--script='${readfile_file}' \\
 "
   if [ "$arch" = x86_64 ]; then
     if "$kvm"; then
@@ -155,16 +161,16 @@ ${gem5opts} \
     fi
     cmd="\
 ${gem5_common} \
---command-line='earlyprintk=ttyS0 console=ttyS0 lpj=7999923 root=/dev/hda ${extra_append}' \
+--command-line='earlyprintk=ttyS0 console=ttyS0 lpj=7999923 root=/dev/hda ${extra_append}' \\
 ${extra_flags} \
 "
   elif [ "$arch" = arm ] || [ "$arch" = aarch64 ]; then
     # TODO why is it mandatory to pass mem= here? Not true for QEMU.
     # Anything smaller than physical blows up as expected, but why can't it auto-detect the right value?
     cmd="${gem5_common} \
---command-line='earlyprintk=pl011,0x1c090000 console=ttyAMA0 lpj=19988480 rw loglevel=8 mem=${memory} root=/dev/sda ${extra_append}' \
---dtb-file='${gem5_src_dir}/system/arm/dt/$([ "$arch" = arm ] && echo "armv7_gem5_v1_${cpus}cpu" || echo "armv8_gem5_v1_${cpus}cpu").dtb' \
---machine-type=VExpress_GEM5_V1 \
+--command-line='earlyprintk=pl011,0x1c090000 console=ttyAMA0 lpj=19988480 rw loglevel=8 mem=${memory} root=/dev/sda ${extra_append}' \\
+--dtb-file='${gem5_src_dir}/system/arm/dt/$([ "$arch" = arm ] && echo "armv7_gem5_v1_${cpus}cpu" || echo "armv8_gem5_v1_${cpus}cpu").dtb' \\
+--machine-type=VExpress_GEM5_V1 \\
 ${extra_flags} \
 "
   fi
@@ -175,19 +181,19 @@ else
   extra_flags="${extra_flags_qemu} ${extra_flags}"
   qemu_common="\
 ${debug_vm} \
-'${buildroot_out_dir}/host/usr/bin/qemu-system-${arch}' \
--gdb tcp::1234 \
--m '${memory}' \
--monitor telnet::45454,server,nowait \
--netdev user,hostfwd=tcp::45455-:45455,hostfwd=tcp::45456-:22,id=net0 \
--smp '${cpus}' \
--trace 'enable=${trace_enable},file=${qemu_out_dir}/trace.bin' \
--virtfs 'local,path=${p9_dir},mount_tag=host_scratch,security_model=mapped,id=host_scratch' \
--virtfs 'local,path=${buildroot_out_dir}/build,mount_tag=host_out,security_model=mapped,id=host_out' \
-$vnc \
-"
+'${buildroot_out_dir}/host/usr/bin/qemu-system-${arch}' \\
+-gdb tcp::1234 \\
+-m '${memory}' \\
+-monitor telnet::45454,server,nowait \\
+-netdev user,hostfwd=tcp::45455-:45455,hostfwd=tcp::45456-:22,id=net0 \\
+-smp '${cpus}' \\
+-trace 'enable=${trace_enable},file=${qemu_out_dir}/trace.bin' \\
+-virtfs 'local,path=${p9_dir},mount_tag=host_scratch,security_model=mapped,id=host_scratch' \\
+-virtfs 'local,path=${buildroot_out_dir}/build,mount_tag=host_out,security_model=mapped,id=host_out' \\
+${vnc}"
   if "$initrd"; then
-    extra_flags="${extra_flags} -initrd '${images_dir}/rootfs.cpio'"
+    extra_flags="${extra_flags} -initrd '${images_dir}/rootfs.cpio' \\
+"
   fi
   if "$ramfs"; then
     # TODO why is this needed, and why any string works.
@@ -201,16 +207,17 @@ $vnc \
       fi
       if ! "$ramfs"; then
         root='root=/dev/vda'
-        extra_flags="${extra_flags} -drive file='${images_dir}/rootfs.ext2.qcow2,if=virtio,format=qcow2'"
+        extra_flags="${extra_flags} -drive file='${images_dir}/rootfs.ext2.qcow2,if=virtio,format=qcow2' \\
+"
       fi
       cmd="\
 ${qemu_common} \
--M pc \
--append '${root} nopat ${extra_append}' \
--device edu \
--device lkmc_pci_min \
--device virtio-net-pci,netdev=net0 \
--kernel '${images_dir}/bzImage' \
+-M pc \\
+-append '${root} nopat ${extra_append}' \\
+-device edu \\
+-device lkmc_pci_min \\
+-device virtio-net-pci,netdev=net0 \\
+-kernel '${images_dir}/bzImage' \\
 ${extra_flags} \
 "
     ;;
@@ -219,18 +226,19 @@ ${extra_flags} \
         extra_append="${extra_append} kgdboc=ttyAMA0,115200"
       fi
       if ! "$ramfs"; then
-        extra_flags="${extra_flags} -drive file='${images_dir}/rootfs.ext2.qcow2,if=scsi,format=qcow2'"
+        extra_flags="${extra_flags} -drive file='${images_dir}/rootfs.ext2.qcow2,if=scsi,format=qcow2' \\
+"
         root='root=/dev/sda'
       fi
       cmd="\
-$qemu_common \
--M versatilepb \
--append '${root} ${extra_append}' \
--device rtl8139,netdev=net0 \
--dtb '${images_dir}/versatile-pb.dtb' \
--kernel '${images_dir}/zImage' \
--serial stdio \
-$extra_flags \
+${qemu_common} \
+-M versatilepb \\
+-append '${root} ${extra_append}' \\
+-device rtl8139,netdev=net0 \\
+-dtb '${images_dir}/versatile-pb.dtb' \\
+-kernel '${images_dir}/zImage' \\
+-serial stdio \\
+${extra_flags} \
 "
     ;;
     aarch64)
@@ -239,37 +247,39 @@ $extra_flags \
       fi
       if ! "$ramfs"; then
         root='root=/dev/vda'
-        extra_flags="${extra_flags} -drive file='${images_dir}/rootfs.ext2.qcow2,if=virtio,format=qcow2'"
+        extra_flags="${extra_flags} -drive file='${images_dir}/rootfs.ext2.qcow2,if=virtio,format=qcow2' \\
+"
       fi
       cmd="\
 ${qemu_common} \
--M virt \
--append '${root} ${extra_append}' \
--cpu cortex-a57 \
--device virtio-net-device,netdev=net0 \
--kernel '${images_dir}/Image' \
--nographic \
--serial stdio \
+-M virt \\
+-append '${root} ${extra_append}' \\
+-cpu cortex-a57 \\
+-device virtio-net-device,netdev=net0 \\
+-kernel '${images_dir}/Image' \\
+-nographic \\
+-serial stdio \\
 ${extra_flags} \
 "
     ;;
     mips64)
       if ! "$ramfs"; then
         root='root=/dev/hda'
-        extra_flags="${extra_flags} -drive file='${images_dir}/rootfs.ext2.qcow2,format=qcow2'"
+        extra_flags="${extra_flags} -drive file='${images_dir}/rootfs.ext2.qcow2,format=qcow2' \\
+"
       fi
       cmd="\
 ${qemu_common} \
--M malta \
--append '${root} ${extra_append}' \
--cpu I6400 \
--device pcnet \
--kernel '${images_dir}/vmlinux' \
--nographic \
+-M malta \\
+-append '${root} ${extra_append}' \\
+-cpu I6400 \\
+-device pcnet \\
+-kernel '${images_dir}/vmlinux' \\
+-nographic \\
 ${extra_flags} \
 "
     ;;
   esac
 fi
-echo "$cmd" | tee run.log
+echo "$cmd" | tee "${out_arch_dir}/run.sh"
 eval "$cmd"
diff --git a/rungdb b/rungdb
index 84afc65..15f40f2 100755
--- a/rungdb
+++ b/rungdb
@@ -5,7 +5,8 @@ set -- ${cli_rungdb:-} "$@"
 after=
 before=
 gem5=false
-lx_symbols="-ex 'lx-symbols ../kernel_module-1.0/'"
+lx_symbols="-ex 'lx-symbols ../kernel_module-1.0/' \\
+"
 kgdb=false
 while getopts A:a:b:gkL OPT; do
   case "$OPT" in
@@ -34,7 +35,8 @@ while getopts A:a:b:gkL OPT; do
 done
 shift "$(($OPTIND - 1))"
 if [ "$#" -gt 0 ]; then
-  brk="-ex 'break ${1}'"
+  brk="-ex 'break ${1}' \\
+"
   shift
 else
   brk=
@@ -45,15 +47,16 @@ else
   port=1234
 fi
 set_common_vars "$arch" "$gem5"
-gdb="${host_dir}/usr/bin/${arch}-linux-gdb ${before}"
+gdb="${host_dir}/usr/bin/${arch}-linux-gdb \\
+${before}"
 cd "${build_dir}/linux-custom/"
 if "$kgdb"; then
     cmd="\
 ${gdb} \
--q \
--ex 'add-auto-load-safe-path $(pwd)' \
--ex 'file vmlinux' \
--ex 'target remote localhost:${port}'
+-q \\
+-ex 'add-auto-load-safe-path $(pwd)' \\
+-ex 'file vmlinux' \\
+-ex 'target remote localhost:${port}' \\
 "
 else
   # ## lx-symbols
@@ -77,15 +80,15 @@ else
   # which gets put on the kernel build root when python debugging scripts are enabled.
   cmd="\
 ${gdb} \
--q \
--ex 'add-auto-load-safe-path $(pwd)' \
--ex 'file vmlinux' \
--ex 'target remote localhost:${port}' \
+-q \\
+-ex 'add-auto-load-safe-path $(pwd)' \\
+-ex 'file vmlinux' \\
+-ex 'target remote localhost:${port}' \\
 ${brk} \
--ex 'continue' \
+-ex 'continue' \\
 ${lx_symbols} \
 "
 fi
 cmd="$cmd $after"
-echo "$cmd" | tee "${root_dir}/rungdb.log"
+echo "$cmd" | tee "${out_arch_dir}/rungdb.sh"
 eval "$cmd"