Dev 0.7.2 (#7)

* Added example scripts for qemu installation/running.

* Update README.md

* Create README.md

Some basic how-to

Author: iangneal

README.md

@@ -277,6 +277,8 @@ specify which extensions to disable via the `-cpu` flag in QEMU, e.g.
 ... -cpu host,-avx2,-bmi1,-bmi2 ...
 ```
 
+We have provided some example scripts in the [scripts][scripts] directory.
+
 2. Not all checkpoints run successfully. For example, checkpoints that attempt
 to invoke syscalls generally end up crashing.
 
@@ -317,3 +319,4 @@ any and all feedback and would like to make this tool as useful as possible.
 [gem5]: http://gem5.org/Main_Page
 [blog]: https://medium.com/@iangneal/lapidary-crafting-more-beautiful-gem5-simulations-4bc6f6aad717
 [smarts]: https://dl.acm.org/citation.cfm?id=859629
+[scripts]: scripts/

scripts/README.md

@@ -0,0 +1,12 @@
+Look at `common-vars.sh` for some variables that can be changed (disk name, amount of memory).
+
+Run `install-vm.sh` to create a new VM.
+- Install with the basic Ubuntu server configuration. I recommend LVM if you decide to resize the image later.
+
+Run `extract-kernel.sh` to get the linux kernel/initrd from the install disk image. This should work for LVM qcow2 images. You'll need to install `libguestfs-tools`.
+
+Run `run-vm.sh` every time you want to start the VM. `^a-x` to kill qemu.
+
+Once you get the VM working, reinstall Lapidary inside the VM and do all of your gem5 work within the VM.
+
+_I know that there are many ways to do this, but I find the raw qemu approach to work the best across a variety of setups._

scripts/common-vars.sh

@@ -0,0 +1,37 @@
+
+# CPU Features
+
+# -- These two configurations don't seem to boot.
+#CPU_FEATURES_DISABLE="-avx,-avx2,-bmi1,-bmi2,-sse,-sse2,-ssse3,-sse4_1,-sse4_2"
+#CPU_FEATURES_DISABLE="-avx,-avx2,-bmi1,-bmi2,-sse4_2,-sse4_1,-ssse3"
+CPU_FEATURES_DISABLE="-avx2,-bmi1,-bmi2"
+echo "CPU_FEATURES_DISABLE=$CPU_FEATURES_DISABLE"
+
+UBUNTU_VERSION=18.04.4
+UBUNTU_ISO=./iso/ubuntu-$UBUNTU_VERSION-server-amd64.iso
+UBUNTU_URL=http://cdimage.ubuntu.com/releases/$UBUNTU_VERSION/release/ubuntu-$UBUNTU_VERSION-server-amd64.iso
+
+NETBOOT_URL=http://archive.ubuntu.com/ubuntu/dists/bionic-updates/main/installer-amd64/current/images/netboot/ubuntu-installer/amd64
+
+BOOT_DIR="./boot"
+KERNEL=$BOOT_DIR/linux
+KERNEL_URL=$NETBOOT_URL/linux
+INITRD=$BOOT_DIR/initrd.gz
+INITRD_URL=$NETBOOT_URL/initrd.gz
+
+# Installation parameters
+
+DISK_SIZE_GB=100
+
+VM_DIR=$(realpath ~/workspace/vms)
+VM_NAME=lapidary-vm
+IMG_NAME=$VM_DIR/$VM_NAME.qcow2
+
+# Runtime parameters
+
+# -- This gives you 75% of the system memory for the VM.
+MEM_FRAC=0.75
+MEM=$(cat /proc/meminfo | grep MemTotal | awk '$3=="kB"{$2='$MEM_FRAC'*$2/1024;$3=""} 1' | tr -d " " | cut -d ":" -f 2 | cut -d "." -f 1)
+echo "MEM=$MEM"
+
+

scripts/extract-kernel.sh

@@ -0,0 +1,19 @@
+#! /usr/bin/sudo /bin/bash
+set -e
+
+source common-vars.sh
+
+# Borrowed from https://gist.github.com/pshchelo/6ffabbffaedc46456b39c037d16e1d8c
+
+echo "Note: this works if you install linux with LVM"
+
+modprobe nbd max_part=8
+qemu-nbd --connect=/dev/nbd0 $IMG_NAME
+mkdir -p /tmp/mnt
+mount /dev/nbd0p1 /tmp/mnt
+
+cp /tmp/mnt/boot/initrd.img-* $BOOT_DIR
+cp /tmp/mnt/boot/vmlinuz-* $BOOT_DIR
+
+umount /tmp/mnt
+qemu-nbd -d /dev/nbd0

scripts/install-vm.sh

@@ -0,0 +1,36 @@
+#! /usr/bin/sudo /bin/bash
+set -e
+
+source common-vars.sh
+
+mkdir -p boot
+if [ ! -f $KERNEL ]; then
+  wget $KERNEL_URL -O $KERNEL
+fi
+if [ ! -f $INITRD ]; then
+  wget $INITRD_URL -O $INITRD
+fi
+
+mkdir -p iso
+if [ ! -f $UBUNTU_ISO ]; then
+  wget $UBUNTU_URL -O $UBUNTU_ISO
+fi
+
+if [ ! -f $IMG_NAME ]; then
+  qemu-img create -f qcow2 $IMG_NAME $DISK_SIZE_GB"G"
+fi
+
+exec qemu-system-x86_64 \
+          -kernel $KERNEL \
+          -initrd $INITRD \
+          -nographic \
+          -enable-kvm \
+          -boot d \
+          -cdrom $UBUNTU_ISO \
+          -hda $IMG_NAME \
+          -m $MEM \
+          --append "console=ttyS0,115200n8" \
+          -balloon virtio \
+          -smp $(nproc) \
+          -cpu host,$CPU_FEATURES_DISABLE \
+          -no-reboot

scripts/run-vm.sh

@@ -0,0 +1,18 @@
+#! /usr/bin/sudo /bin/bash
+set -e
+
+source common-vars.sh
+
+exec qemu-system-x86_64 \
+          -kernel $VM_DIR/vmlinuz-* \
+          -initrd $VM_DIR/initrd.img-* \
+          -nographic \
+          -enable-kvm \
+          -hda $IMG_NAME \
+          -m $MEM \
+          --append "console=ttyS0,115200n8, root=/dev/sda1" \
+          -balloon virtio \
+          -smp $(nproc) \
+          -cpu host,$CPU_FEATURES_DISABLE \
+          -net user,hostfwd=tcp::5000-:22 \
+          -net nic