lkmc v2-rc

Unsquashed version at v2-rc-unsquashed, but that cannot be merged as it
breaks bisects at several points. All bugs will not bisect to this
humongous change.

It all started with a conversion of the Bash scripts to Python, mainly
because I couldn't stand not being able to properly use --options for
run which has a million options.

Then since that required a full testing, I decided to do all the
refactorings that I had in mind at once, and so I did and it became
v2-rc.

This is the largest patch I have ever done! OMG a few weeks of extra time.
I'm never writing a Bash script for anything that starts getting big again.

Some of the features are:

* separate build-qemu and build-gem5 commands
* common: convert scripts to python. Add --option for everything
* rename build to build-buildroot now that we are splitting all the build
  commands, Linux kernel to follow
* move all git submodules to submodules/ and all buildroot packages to
  packages/
* refactor the out/ structure. Keep projects on toplevel, because guest
  projects separate archs and host ones don't, making a toplevel arch wrong
* do-release: rename to just release
  https://stackoverflow.com/questions/16174992/cant-get-argparse-to-read-quoted-string-with-dashes-in-it
* run: add --terminal and explain gem5 pdb
* just track the lvimrc
* store CLI kernel config fragment inside buildlroot to avoid conflicts
* gem5: document m5 initparam
* readme: make a bunch of things awesomer
* readme: fix broken refs
* parsec-benchmark: update to 75d55ac446a43c47efb1044844a108c6c330184c
  Could not fetch otherwise.
* gem5: M5_OVERRIDE_PY_SOURCE

trace-boot

@@ -1,25 +1,63 @@
-#!/usr/bin/env bash
-. "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common"
-while getopts "${common_getopts_flags}" OPT; do
-  case "$OPT" in
-    ?)
-      common_getopts_case "$OPT"
-      ;;
-  esac
-done
-shift "$(($OPTIND - 1))"
-common_setup
-if "$common_gem5"; then
-  time ./run -a "$common_arch" -E 'm5 exit' -g -T 'Exec,-ExecSymbol,-ExecMicro' "$@"
-else
-  time ./run -a "$common_arch" -e 'init=/poweroff.out' -T exec_tb "$@"
-  time ./qemu-trace2txt -a "$common_arch"
-  # Instruction count.
-  # We could put this on a separate script, but it just adds more arch boilerplate to a new script.
-  # So let's just leave it here for now since it did not add a significant processing time.
-  echo "instructions $(wc -l "${common_trace_txt_file}" | cut -d' ' -f1)"
-  entry_addr=$("${common_root_dir}/runtc" readelf -h "${common_build_dir}/linux-custom/vmlinux" | grep 'Entry point address' | sed -E 's/.*: *//')
-  echo "entry_address ${entry_addr}"
-  sed "/${entry_addr}/q" "${common_trace_txt_file}" >"${common_qemu_run_dir}/trace-boot.txt"
-  echo "instructions_firmware $(wc -l "${common_qemu_run_dir}/trace-boot.txt" | cut -d' ' -f1)"
-fi
+#!/usr/bin/env python3
+
+import imp
+import os
+import subprocess
+import re
+
+import common
+run = imp.load_source('run', os.path.join(common.root_dir, 'run'))
+qemu_trace2txt = imp.load_source('qemu_trace2txt', os.path.join(common.root_dir, 'qemu-trace2txt'))
+
+parser = common.get_argparse(argparse_args={
+    'description': '''Trace the PIC addresses executed on a Linux kernel boot.
+
+More information at: https://github.com/cirosantilli/linux-kernel-module-cheat#tracing
+'''
+})
+parser.add_argument(
+    'extra_emulator_args', nargs='*',
+    help='Extra options to append at the end of the emulator command line'
+)
+args = common.setup(parser)
+extra_args = {
+    'extra_emulator_args': args.extra_emulator_args,
+}
+if args.gem5:
+    extra_args.update({
+        'eval': 'm5 exit',
+        'trace': 'Exec,-ExecSymbol,-ExecMicro',
+    })
+    run.main(args, extra_args)
+else:
+    extra_args.update({
+        'kernel_cli_extra': 'init=/poweroff.out',
+        'trace': 'exec_tb',
+    })
+    run.main(args, extra_args)
+    qemu_trace2txt.main()
+    # Instruction count.
+    # We could put this on a separate script, but it just adds more arch boilerplate to a new script.
+    # So let's just leave it here for now since it did not add a significant processing time.
+    kernel_entry_addr = hex(common.get_elf_entry(common.vmlinux))
+    nlines = 0
+    nlines_firmware = 0
+    with open(common.qemu_trace_txt_file, 'r') as trace_file:
+        in_firmware = True
+        for line in trace_file:
+            line = line.rstrip()
+            nlines += 1
+            pc = line.split('=')[-1]
+            if pc == kernel_entry_addr:
+                in_firmware = False
+            if in_firmware:
+                nlines_firmware += 1
+    print('''\
+instructions {}
+entry_address {}
+instructions_firmware {}\
+'''.format(
+        nlines,
+        kernel_entry_addr,
+        nlines_firmware
+    ))