update README

README.md

+# Endhost
+
 Code structure:
  - `proto/`: protocol definitions for PCIe and Ethernet channels
  - `nicsim_common/`: helper library for NIC simulations
+ - `dummy_nic/`: dummy device illustrating PIO with cosim-pci interface
  - `corundum/`: verilator-based cycle accurate Corundum model
  - `corundum_bm/`: C++ behavioral model for Corundum
  - `netsim_common/`: helper library for network simulations
  - `net_tap/`: Linux tap interface connector for Ethernet channel
  - `net_wire/`: Ethernet wire, connects to Ethernet channels together:w
+
+## Running Qemu
+1. Clone from here: `github.com:FreakyPenguin/qemu-cosim.git`
+2. Build with `./configure --target-list=x86_64-softmmu --disable-werror --extra-cflags="-I$PATH_TO_THIS_REPO/proto" --enable-cosim-pci`
+3. run dummy nic: `rm -rf /tmp/cosim-pci; ./dummy_nic`
+4. To run for example (only the last two lines are specific to this project):
+```
+x86_64-softmmu/qemu-system-x86_64 \
+    -machine q35 -cpu host \
+    -drive file=/local/endhostsim/vm-image.qcow2,if=virtio \
+    -serial mon:stdio -m 2048 -smp 2 -display none -enable-kvm \
+    -chardev socket,path=/tmp/cosim-pci,id=cosimcd \
+    -device cosim-pci,chardev=cosimcd
+```
+5. in vm test with:
+    * `for read: dd if=/sys/bus/pci/devices/0000\:00\:03.0/resource2 bs=1 skip=64 count=1`
+    * `for write: echo a | dd of=/sys/bus/pci/devices/0000\:00\:03.0/resource2 bs=1 seek=64 count=1`
+
+## Running Gem5
+1. Clone from here: `git@github.com:nicklijl/gem5.git`
+2. Build with: `scons build/X86/gem5.opt -jX` (with `X` set to # cores)
+3. run dummy nic: `rm -rf /tmp/cosim-pci; ./dummy_nic`
+4. To run for example:
+```
+./build/X86/gem5.opt \
+    configs/cosim/cosim.py \
+    --termport=3456 --kernel=$EHSIM/images/vmlinux \
+    --disk-image=$EHSIM/images/output-ubuntu1804/ubuntu1804.raw \
+    --cpu-type=X86KvmCPU --mem-size=4GB \
+    --cosim-pci=/tmp/cosim-pci --cosim-shm=/dev/shm/dummy_nic_shm
+```
+5. Attach to gem5 terminal: `./util/term/m5term localhost 3456`

qemu/README.md

-1. Clone from here: `github.com:FreakyPenguin/qemu-cosim.git`
-2. Build with `./configure --target-list=x86_64-softmmu --disable-werror --extra-cflags="-I$PATH_TO_THIS_REPO/proto" --enable-cosim-pci`
-3. run dummy nic: rm -rf /tmp/cosim-pci; ./dummy_nic
-4. To run for example (only the last line is specific to this project):
-```
-x86_64-softmmu/qemu-system-x86_64 \
-    -machine q35 -cpu host \
-    -drive file=/local/endhostsim/vm-image.qcow2,if=virtio \
-    -serial mon:stdio -m 2048 -smp 2 -display none -enable-kvm \
-    -chardev socket,path=/tmp/cosim-pci,id=cosimcd \
-    -device cosim-pci,chardev=cosimcd
-```
-5. in vm test with:
-    * `for read: dd if=/sys/bus/pci/devices/0000\:00\:03.0/resource2 bs=1 skip=64 count=1`
-    * `for write: echo a | dd of=/sys/bus/pci/devices/0000\:00\:03.0/resource2 bs=1 seek=64 count=1`