Merge pull request #82 from mythril-hypervisor/adam-dev

Remove mythril_core/mythril_multiboot2 split

Author: dlrobertson

.github/workflows/rust.yml

@@ -36,4 +36,4 @@ jobs:
         submodules: true
     - name: Multiboot2 Image Build
       run: |
-        RUSTFLAGS="-D warnings" make multiboot2
+        RUSTFLAGS="-D warnings" make mythril

.gitignore

@@ -1,5 +1,6 @@
 /boot
 /target
+mythril/target
 _boot.img
 **/*.rs.bk
 debug.log

.mythril_githooks/pre-commit

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-diff=$(cargo fmt -- --check)
+diff=$(make check-fmt)
 result=$?
 
 if [[ ${result} -ne 0 ]] ; then
@@ -10,4 +10,4 @@ EOF
     exit 1
 fi
 
-exit 0
+exit 0

Cargo.toml

@@ -1,10 +1,9 @@
 CARGO?=cargo
-MULTIBOOT2_TARGET?=multiboot2_target
 BUILD_TYPE?=release
-DOCKER_IMAGE=adamschwalm/hypervisor-build:10
+DOCKER_IMAGE=adamschwalm/hypervisor-build:12
 
-multiboot2_binary = target/$(MULTIBOOT2_TARGET)/$(BUILD_TYPE)/mythril_multiboot2
-mythril_src = $(shell find mythril_* -type f -name '*.rs' -or -name '*.S' -or -name '*.ld' \
+mythril_binary = mythril/target/mythril_target/$(BUILD_TYPE)/mythril
+mythril_src = $(shell find mythril* -type f -name '*.rs' -or -name '*.S' -or -name '*.ld' \
 	                   -name 'Cargo.toml')
 kernel = linux/arch/x86_64/boot/bzImage
 seabios = seabios/out/bios.bin
@@ -16,22 +15,24 @@ ifneq (,$(filter qemu%, $(firstword $(MAKECMDGOALS))))
     $(eval $(QEMU_EXTRA):;@:)
 endif
 
+CARGO_MANIFEST?=--manifest-path mythril/Cargo.toml
+
 ifeq ($(BUILD_TYPE), release)
-    CARGO_FLAGS := --release
+    CARGO_BUILD_FLAGS := --release
 endif
 
 .PHONY: all
-all: multiboot2 $(seabios) $(kernel)
+all: mythril $(seabios) $(kernel)
 
-.PHONY: multiboot2
-multiboot2: $(multiboot2_binary)
+.PHONY: mythril
+mythril: $(mythril_binary)
 
-.PHONY: multiboot2-debug
-multiboot2-debug: BUILD_TYPE=debug
-multiboot2-debug: $(multiboot2_binary)
+.PHONY: mythril-debug
+mythril-debug: BUILD_TYPE=debug
+mythril-debug: $(mythril_binary)
 
 docker-%:
-	docker run --rm -w $(CURDIR) -v $(CURDIR):$(CURDIR) \
+	docker run --privileged -it --rm -w $(CURDIR) -v $(CURDIR):$(CURDIR) \
 	   -u $(shell id -u):$(shell id -g) $(DOCKER_IMAGE) \
 	   /bin/bash -c '$(MAKE) $*'
 
@@ -44,35 +45,38 @@ $(kernel):
 	make -C linux bzImage
 
 .PHONY: qemu
-qemu: multiboot2 $(seabios) $(kernel)
-	./scripts/mythril-run.sh $(multiboot2_binary) $(QEMU_EXTRA)
+qemu: mythril $(seabios) $(kernel)
+	./scripts/mythril-run.sh $(mythril_binary) $(QEMU_EXTRA)
 
 .PHONY: qemu-debug
-qemu-debug: multiboot2-debug $(seabios) $(kernel)
-	./scripts/mythril-run.sh $(multiboot2_binary) \
+qemu-debug: mythril-debug $(seabios) $(kernel)
+	./scripts/mythril-run.sh $(mythril_binary) \
 	    -gdb tcp::1234 -S $(QEMU_EXTRA)
 
-$(multiboot2_binary): $(mythril_src)
-	$(CARGO) build $(CARGO_FLAGS) -Z build-std=core,alloc \
-	    --target mythril_multiboot2/$(MULTIBOOT2_TARGET).json \
-	    --manifest-path mythril_multiboot2/Cargo.toml
+$(mythril_binary): $(mythril_src)
+	$(CARGO) build $(CARGO_BUILD_FLAGS) $(CARGO_MANIFEST) \
+	    -Z build-std=core,alloc \
+	    --target mythril/mythril_target.json \
+
+.PHONY: check-fmt
+check-fmt:
+	$(CARGO) fmt $(CARGO_MANIFEST) --all -- --check
 
 .PHONY: fmt
 fmt:
-	$(CARGO) fmt --all -- --check
+	$(CARGO) fmt $(CARGO_MANIFEST) --all
 
 .PHONY: test_core
-test_core:
-	$(CARGO) test \
-	    --manifest-path mythril_core/Cargo.toml \
-	    --lib
+test_common:
+	$(CARGO) test $(CARGO_MANIFEST) --lib \
+	    --features=test \
 
 .PHONY: test
-test: test_core
+test: test_common
 
 .PHONY: clean
 clean:
-	$(CARGO) clean
+	$(CARGO) clean $(CARGO_MANIFEST)
 	make -C seabios clean
 	make -C linux clean
 
@@ -89,7 +93,8 @@ $(git_hooks): $(git_hooks_src)
 help:
 	@echo " Make Targets:"
 	@echo "   all            build everything to run mythril, but do not start qemu"
-	@echo "   fmt            run rustfmt"
+	@echo "   check-fmt      run cargo fmt --check"
+	@echo "   fmt            run cargo fmt"
 	@echo "   qemu           run mythril in a VM"
 	@echo "   qemu-debug     run mythril in a VM, but halt for a debugger connection"
 	@echo "   test           run the mythril tests"

Makefile

@@ -12,7 +12,7 @@ using this image. For example, to build the multiboot application, run:
 make docker-all
 ```
 
-This will create the multiboot2 application in `target/multiboot2_target/release/mythril_multiboot2`.
+This will create the hypervisor in `mythril/target/mythril_target/release/mythril`.
 It will also compile the patched versions for seabios and the linux kernel that
 are currently required to use `mythril`. Unittests can be executed like:
 
@@ -27,26 +27,26 @@ After running the build steps as described above, an initramfs must be added to
 can be executed with:
 
 ```
-make qemu
+make docker-qemu
 ```
 
 Note that this has only been tested on relatively recent versions of QEMU (v4.1.0+).
 Older versions may contain bugs that could cause issues running the image.
 
 ## Debugging
 
-To debug mythril, first build the multiboot application as described above. Then
-run `make qemu-debug`. This will start start QEMU but not launch mythril. You can
-then run `gdb target/multiboot2_target/debug/mythril_multiboot2` to launch gdb with
-the debug info from the application. You can then attach to the qemu instance with
-`target remote localhost:1234`.
+To debug mythril, run `BUILD_TYPE=debug make qemu-debug`. This will build a debug version
+of the hypervisor then start start QEMU in a paused state. You can then run
+`gdb mythril/target/mythril_target/debug/mythril` to launch gdb with the debug info from
+the application. You can attach to the qemu instance with `target remote :1234`. Note that
+debugging the hypervisor is generally not supported under docker.
 
 Because the virtualization is hardware accelerated, remember to use `hbreak` instead
 of `break` in gdb. For example, to put a breakpoint at the start of `kmain` and start
 mythril, run:
 
 ```
-(gdb) target remote localhost:1234
+(gdb) target remote :1234
 Remote debugging using localhost:1234
 0x000000000000fff0 in ?? ()
 (gdb) hbreak kmain