Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaoyangnz/gava
🚀 A sandboxed VM any Java developer can afford
https://github.com/chaoyangnz/gava
bytecode go golang interpreter java vm
Last synced: 21 days ago
JSON representation
🚀 A sandboxed VM any Java developer can afford
- Host: GitHub
- URL: https://github.com/chaoyangnz/gava
- Owner: chaoyangnz
- License: mit
- Created: 2017-06-02T09:53:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-07T08:43:46.000Z (over 1 year ago)
- Last Synced: 2024-10-21T04:05:23.179Z (27 days ago)
- Topics: bytecode, go, golang, interpreter, java, vm
- Language: Go
- Homepage: https://gava.netlify.app
- Size: 63.3 MB
- Stars: 174
- Watchers: 8
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gava
**NOTE**: (previously named `Javo/Jago`)
> This project is not supposed to extend the features, more focus will be moved to its sister project [zava](https://github.com/chaoyangnz/zava) - a rewrite in Zig
A simplified Java virtual machine written in Go language. One aim is to learn JVM specification in depth and try to understand the behind-the-scene behaviour when a Java program runs. This VM can be used for the educational purpose, for example, for a course about how to design a runtime for a language with the complete specification.
I only refer to "Java Virtual Machine Specification" and then look into how we should design one.
Some production-level features are intentionally ignored and it is supposed to make it as simplified as possible so as to
demonstrate the general idea. For the educational purpose, it is more than enough.
If you have no time to read OpenJDK source code or always guess the JVM behaviour when you need to tune your program, then your right here to be the lord of your universe.
A overview presentation can be found: https://drive.google.com/file/d/1gESJTwm_tJL8pA7WBxJfhz4iUW7KwihP/view?usp=sharing
Any thought is welcome and I am happy to be wrong.
# Roadmap
- [x] Java class file reader
- [x] Interpreter engine
- [x] Class loader delegation
- [x] multi-threading support
- [x] monitor, `sleep`, `wait`, `notify` support
- [x] JDK native methods
- [ ] GC
- [ ] JIT
# How to run
## build and install
```bash
❯ cd ~/gava
❯ ./build.sh
```
By default, gava will be installed to `/usr/local/gava`
```text
/usr/local/gava
├── bin
│ └── gava
├── jdk
│ └── classes
│ ├── META-INF
│ ├── apple
│ ├── com
│ ├── java
│ ├── javax
│ ├── jdk
│ ├── org
│ └── sun
└── log
├── classloader.log
├── io.log
├── misc.log
├── thread-bootstrap.log
├── thread-main.log
└── threads.log
```
## gava command
```bash
❯ gava -h
NAME:
Gava - A simplified Java Virtual Machine for the educational purpose
USAGE:
gava [-options] class [args...]
VERSION:
1.0.0
DESCRIPTION:
A Java* Virtual Machine demonstrating the basic features of execution engine, class loading, type/value system, exception handling, native methods etc.
AUTHOR:
Chao Yang
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--classpath value, --cp value application classpath separated by colon
--noLogo, --nl don't show logo
--debug, -d debug mode
--trace, -t trace mode
--log:thread value log level of instruction execution in a thread context, options: info, debug, trace
--log:classloader value log level of class loading, options: info, debug, trace
--profile, -p profile gava
--help, -h show help
--version, -v print the version
```
### Run a calendar program
```bash
❯ gava -nl -cp . Calendar 8 2018
```
### Run a pyramid program
```bash
❯ gava -nl -cp . Pyramid
```
### run a program traversing a tree in the level order
```bash
❯ gava -nl -cp . TreeLevelOrderTraverse
```
### Run a program into exception
```bash
❯ gava -nl . test/test_athrow
```
### More examples to demonstrate features
- Print system properties
```bash
gava -d test.test_system_properties
```
- Multi-threading
```bash
gava -d test.test_thread
```
```bash
gava -d Multithread
```
- Thread sleep or `wait` / `interrupt`
```bash
gava -d SleepInterrupt
```
```bash
gava -d WaitInterrupt
```
- Java monitor lock with `synchronized`
```bash
gava -d Counter
```
- Java wait() and `notify()`, `notifyAll()`
```bash
gava -d ProducerConsumer
```
## trace the execution
### log/thread-[name].log
This log file records the each instruction execution and method call hierarchy within a thread context. Set the log level to info to view call hierarchy more clearly.
The blue diamond symbol 🔹 means pure Java methods while the yellow one 🔸 means native methods which is implemented within Gava internally.
The fire symbol 🔥 means exception throwing (thrown by `athrow` bytecode, rethrown if uncaught or thrown by VM internally), while the blue water symbol 💧 means an exception is caught by a method.
- TRACE: log all low level bytecode instructions, method call and exception thrown/caught
- DEBUG: only method call and exception thrown/caught
- INFO: only exception thrown/caught info
### log/classloader.log
This log file records the class loading process, including what triggers a class loading and when its class initialization method \ is invoked.
The trigger reason can be viewed after a class name.
### log/threads.log
This log file records thread creation/exit information and object monitor enter/exit, thread sleep(), wait(), notify() etc.
### log/io.log
This log file records I/O details around system interactions.
### log/misc.log
Other trivial logs
# Profiling
https://flaviocopes.com/golang-profiling/
- install Graphviz
- run gava with `-p` option
- `go tool pprof --pdf /usr/local/bin/gava /var/../cpu.pprof > cpu.pdf`
# Documentation
Really sorry, I have no time to write documentation but it is in my plan.
The Ebook about how it works internally is in progress: https://www.gitbook.com/book/chaoyangnz/go-my-jvm
# Testing
I am really keen to get missing tests done if I have time. Another reason I didn't enjoy writing tests in Go is that I cannot find an awesome unit test library like Jest. For some libraries I looked into, it requires me to change my code just for testing. I don't like the idea about breaking the encapsulation just for testing.