b75d93aa363dad83c1696b06d921c672c040b093 - emulators/v86

commit	b75d93aa363dad83c1696b06d921c672c040b093	[log] [download]
author	copy <copy@copy.sh>	Sat Jan 24 01:47:05 2015 +0100
committer	copy <copy@copy.sh>	Sat Jan 24 01:47:05 2015 +0100
tree	b51df74b8b454ae65e849c6508486d33af4aa029
parent	db7b7c258b2ffd2d2fa6140bd14129e79bd72428 [diff]

tree: b51df74b8b454ae65e849c6508486d33af4aa029

Readme.md

Demos

API examples

Using v86 for your own purposes is as easy as:

var emulator = new V86Starter({
    screen_container: document.getElementById("screen_container"),
    bios: {
        url: "../../bios/seabios.bin",
    },
    vga_bios: {
        url: "../../bios/vgabios.bin",
    },
    cdrom: {
        url: "../../images/linux.iso",
    },
    autostart: true,
});

See API.

How does it work?

v86 emulates an x86-compatible CPU and hardware. Here's a list of emulated hardware:

An x86 compatible CPU. The instruction set is around Pentium 1 level. Some features are missing, more specifically:
- Task gates, far calls in protected mode
- 16 bit protected mode features
- Single stepping
- MMX, SSE
- A bunch of FPU instructions
- Some exceptions
A floating point unit (FPU). Calculations are done with JavaScript's double precision numbers (64 bit), so they are not as precise as calculations on a real FPU (80 bit).
A floppy disk controller (8272A).
An 8042 Keyboard Controller, PS2. With mouse support.
An 8254 Programmable Interval Timer (PIT).
An 8259 Programmable Interrupt Controller (PIC).
A CMOS Real Time Clock (RTC).
A VGA controller with SVGA support and Bochs VBE Extensions.
A PCI bus. This one is partly incomplete and not used by every device.
An IDE disk controller.
An NE2000 (8390) PCI network card.
A virtio filesystem.

How to build, run and embed?

In order to build the cpu.js file, you need make and cpp (the C preprocessor). Run: make build/cpu.js.
If you want a compressed and fast (i.e. with debug code removed) version, you need Closure Compiler. Pull the submodule using git submodule update --init --recursive closure-compiler and run make build/v86_all.js.
ROM and disk images are loaded via XHR, so if you want to try out index.html locally, make sure to serve it from a local webserver. You can use make run to serve the files using Python's SimpleHTTPServer.
If you want only want to embed v86 on website you can use libv86.js. For usage, check out the API and examples.
A couple of disk images are provided for testing. You can check them out using wget -P images/ http://copy.sh/v86/images/{linux.iso,kolibri.img,windows101.img,os8.dsk,freedos722.img,openbsd.img}.

Summary:

# grab the main repo
git clone https://github.com/copy/v86.git                     

cd v86

# grab the disk images
wget -P images/ http://copy.sh/v86/images/{linux.iso,kolibri.img,windows101.img,os8.dsk,freedos722.img,openbsd.img}

# grab closure compiler
git submodule update --init --recursive closure-compiler

Rebuild compiled version:

make

Rebuild only debug version (only necessary after changing .macro.js files):

make build/cpu.js

Why?

Similiar projects have been done before, but I decided to work on this as a fun project and learn something about the x86 architecture. It has grown pretty advanced and I got Linux and KolibriOS working, so there might be some actual uses.

If you build something interesting, let me know.

Compatibility

Here's an overview of the operating systems supported in v86:

Linux works pretty well. Graphical boot fails in many versions, but you mostly get a shell. The mouse is often not detected automatically.
- Damn Small Linux (2.4 Kernel): Run with lowram and choose PS2 mouse in xsetup. Takes circa 10 minutes to boot.
- Tinycore (3.0 kernel): udev and X fail, but you get a terminal.
- Nanolinux works.
- Archlinux works. Add atkbd to MODULES in /etc/mkinitcpio.conf.
FreeDOS and Windows 1.01 run very well.
KolibriOS works. A few applications need SSE.
Haiku boots, but takes very long (around 30 minutes). Set the memory size to 128MB.
ReactOS doesn't work.
No Android version seems to work, you still get a shell.

You can get some infos on the disk images here: https://github.com/copy/images.

How can I contribute?

Add new features (hardware devices, fill holes in the CPU), fix bugs. Check out the issues section and contact me if you need help.
Report bugs.
Donate. Via Bitcoin: 14KBXSoewGzbQY8VoznJ5MZXGxoia8RxC9. If you want to donate elsewhere, let me know.

License

Simplified BSD License, see LICENSE, unless otherwise noted.

Credits

Test cases via QEMU, http://wiki.qemu.org/Main_Page
Disk Images
The jor1k project for 9p and filesystem drivers

Author

Fabian Hemmer (http://copy.sh/, copy@copy.sh)