Skip to content

Commit 685c9e8

Browse files
committed
Update README
1 parent 5131896 commit 685c9e8

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ using this image. For example, to build the multiboot application, run:
1212
make docker-all
1313
```
1414

15-
This will create the multiboot2 application in `target/multiboot2_target/release/mythril_multiboot2`.
15+
This will create the hypervisor in `mythril/target/mythril_target/release/mythril`.
1616
It will also compile the patched versions for seabios and the linux kernel that
1717
are currently required to use `mythril`. Unittests can be executed like:
1818

@@ -27,26 +27,26 @@ After running the build steps as described above, an initramfs must be added to
2727
can be executed with:
2828

2929
```
30-
make qemu
30+
make docker-qemu
3131
```
3232

3333
Note that this has only been tested on relatively recent versions of QEMU (v4.1.0+).
3434
Older versions may contain bugs that could cause issues running the image.
3535

3636
## Debugging
3737

38-
To debug mythril, first build the multiboot application as described above. Then
39-
run `make qemu-debug`. This will start start QEMU but not launch mythril. You can
40-
then run `gdb target/multiboot2_target/debug/mythril_multiboot2` to launch gdb with
41-
the debug info from the application. You can then attach to the qemu instance with
42-
`target remote localhost:1234`.
38+
To debug mythril, run `BUILD_TYPE=debug make qemu-debug`. This will build a debug version
39+
of the hypervisor then start start QEMU in a paused state. You can then run
40+
`gdb mythril/target/mythril_target/debug/mythril` to launch gdb with the debug info from
41+
the application. You can attach to the qemu instance with `target remote :1234`. Note that
42+
debugging the hypervisor is generally not supported under docker.
4343

4444
Because the virtualization is hardware accelerated, remember to use `hbreak` instead
4545
of `break` in gdb. For example, to put a breakpoint at the start of `kmain` and start
4646
mythril, run:
4747

4848
```
49-
(gdb) target remote localhost:1234
49+
(gdb) target remote :1234
5050
Remote debugging using localhost:1234
5151
0x000000000000fff0 in ?? ()
5252
(gdb) hbreak kmain

0 commit comments

Comments
 (0)