@aptre/v86 0.5.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012, The v86 contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/LICENSE.MIT

@@ -0,0 +1,22 @@
+QEMU Floppy disk emulator (Intel 82078)
+
+Copyright (c) 2003, 2007 Jocelyn Mayer
+Copyright (c) 2008 Hervé Poussineau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/Readme.md

@@ -0,0 +1,237 @@
+This is a fork of [copy/v86][upstream]. This fork migrates the JavaScript
+frontend to TypeScript, replaces Closure Compiler with esbuild + tsgo, and
+publishes as [`@aptre/v86`](https://www.npmjs.com/package/@aptre/v86) on npm
+with ESM and TypeScript declarations. The Rust/WASM backend is unchanged.
+
+[upstream]: https://github.com/copy/v86
+
+---
+
+[![Join the chat at https://gitter.im/copy/v86](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/copy/v86) or #v86 on [irc.libera.chat](https://libera.chat/)
+
+v86 emulates an x86-compatible CPU and hardware. Machine code is translated to
+WebAssembly modules at runtime in order to achieve decent performance. Here's a
+list of emulated hardware:
+
+- An x86-compatible CPU. The instruction set is around Pentium 4 level,
+  including full SSE3 support. Some features are missing, in particular:
+  - Task gates, far calls in protected mode
+  - Some 16 bit protected mode features
+  - Single stepping (trap flag, debug registers)
+  - Some exceptions, especially floating point and SSE
+  - Multicore
+  - 64-bit extensions
+- A floating point unit (FPU). Calculations are done using the Berkeley
+  SoftFloat library and therefore should be precise (but slow). Trigonometric
+  and log functions are emulated using 64-bit floats and may be less precise.
+  Not all FPU exceptions are supported.
+- 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).
+- Partial APIC support.
+- A CMOS Real Time Clock (RTC).
+- A generic VGA card 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.
+  - A built-in ISO 9660 CD-ROM generator.
+- An NE2000 (RTL8390) PCI network card.
+- Various virtio devices: Filesystem, network and balloon.
+- A SoundBlaster 16 sound card.
+
+## Demos
+
+[9front](https://copy.sh/v86/?profile=9front) —
+[Arch Linux](https://copy.sh/v86/?profile=archlinux) —
+[Android-x86 1.6-r2](https://copy.sh/v86?profile=android) —
+[Android-x86 4.4-r2](https://copy.sh/v86?profile=android4) —
+[BasicLinux](https://copy.sh/v86/?profile=basiclinux) —
+[Buildroot Linux](https://copy.sh/v86/?profile=buildroot) —
+[Damn Small Linux](https://copy.sh/v86/?profile=dsl) —
+[ELKS](https://copy.sh/v86/?profile=elks) —
+[FreeDOS](https://copy.sh/v86/?profile=freedos) —
+[FreeBSD](https://copy.sh/v86/?profile=freebsd) —
+[FiwixOS](https://copy.sh/v86/?profile=fiwix) —
+[Haiku](https://copy.sh/v86/?profile=haiku) —
+[SkiffOS](https://copy.sh/v86/?profile=copy/skiffos) —
+[ReactOS](https://copy.sh/v86/?profile=reactos) —
+[Windows 2000](https://copy.sh/v86/?profile=windows2000) —
+[Windows 98](https://copy.sh/v86/?profile=windows98) —
+[Windows 95](https://copy.sh/v86/?profile=windows95) —
+[Windows 1.01](https://copy.sh/v86/?profile=windows1) —
+[MS-DOS 6.22](https://copy.sh/v86/?profile=msdos) —
+[OpenBSD](https://copy.sh/v86/?profile=openbsd) —
+[Oberon](https://copy.sh/v86/?profile=oberon) —
+[KolibriOS](https://copy.sh/v86/?profile=kolibrios) —
+[SkiftOS](https://copy.sh/v86?profile=skift) —
+[QNX](https://copy.sh/v86/?profile=qnx)
+
+## Documentation
+
+[How it works](docs/how-it-works.md) —
+[Networking](docs/networking.md) —
+[Alpine Linux guest setup](tools/docker/alpine/) —
+[Arch Linux guest setup](docs/archlinux.md) —
+[Windows NT guest setup](docs/windows-nt.md) —
+[Windows 9x guest setup](docs/windows-9x.md) —
+[9p filesystem](docs/filesystem.md) —
+[Linux rootfs on 9p](docs/linux-9p-image.md) —
+[Profiling](docs/profiling.md) —
+[CPU Idling](docs/cpu-idling.md)
+
+## Compatibility
+
+Here's an overview of the operating systems supported in v86:
+
+- Linux works pretty well. 64-bit kernels are not supported.
+  - [Buildroot](https://buildroot.org/) can be used to build a minimal image.
+    [humphd/browser-vm](https://github.com/humphd/browser-vm) and
+    [darin755/browser-buildroot](https://github.com/Darin755/browser-buildroot) have some useful scripts for building one.
+  - [SkiffOS](https://github.com/skiffos/SkiffOS/tree/master/configs/browser/v86) (based on Buildroot) can cross-compile a custom image.
+  - Ubuntu and other Debian derivatives works up to the latest version that supported i386 (16.04 LTS or 18.04 LTS for some variants).
+  - Alpine Linux works. An image can be built from a Dockerfile, see [tools/docker/alpine/](tools/docker/alpine/).
+  - Arch Linux 32 works. See [archlinux.md](docs/archlinux.md) for building an image.
+- ReactOS works.
+- FreeDOS, Windows 1.01 and MS-DOS run very well.
+- KolibriOS works.
+- Haiku works.
+- Android-x86 has been tested up to 4.4-r2.
+- Windows 1, 3.x, 95, 98, ME, NT and 2000 work reasonably well.
+  - In Windows 2000 and higher the PC type has to be changed from ACPI PC to Standard PC
+  - There are some known boot issues ([#250](https://github.com/copy/v86/issues/250), [#433](https://github.com/copy/v86/issues/433), [#507](https://github.com/copy/v86/issues/507), [#555](https://github.com/copy/v86/issues/555), [#620](https://github.com/copy/v86/issues/620), [#645](https://github.com/copy/v86/issues/645))
+  - See [Windows 9x guest setup](docs/windows-9x.md)
+- Windows XP, Vista and 8 work under certain conditions (see [#86](https://github.com/copy/v86/issues/86), [#208](https://github.com/copy/v86/issues/208))
+  - See [Windows NT guest setup](docs/windows-nt.md)
+- Many hobby operating systems work.
+- 9front works.
+- Plan 9 doesn't work.
+- QNX works.
+- OS/2 doesn't work.
+- FreeBSD works.
+- OpenBSD works with a specific boot configuration. At the `boot>` prompt type
+  `boot -c`, then at the `UKC>` prompt `disable mpbios` and `exit`.
+- NetBSD works only with a custom kernel, see [#350](https://github.com/copy/v86/issues/350).
+- SerenityOS works (only 32-bit versions).
+- [SkiftOS](https://skiftos.org/) works.
+
+You can get some information on the disk images here: https://github.com/copy/images.
+
+## How to build, run and embed?
+
+You need:
+
+- [bun](https://bun.sh/) (runtime and package manager)
+- Rust with the wasm32-unknown-unknown target (for the WASM backend)
+- A version of clang compatible with Rust
+- To run tests: nasm, gdb, qemu-system, gcc, libc-i386 and rustfmt
+
+```bash
+bun install        # install dependencies
+bun run build      # production build (ESM + browser bundle in dist/)
+bun run build:debug # debug build (with DEBUG=true)
+bun run typecheck  # type-check with tsgo
+bun run lint       # lint with eslint
+bun run format     # format with prettier
+bun run test       # run tests with vitest
+```
+
+See [tools/docker/test-image/Dockerfile](tools/docker/test-image/Dockerfile)
+for a full setup on Debian or
+[WSL](https://docs.microsoft.com/en-us/windows/wsl/install).
+
+The WASM backend is still built with `make` (Rust toolchain required).
+Run `make` for the debug build (`debug.html`) or `make all` for the optimized
+build (`index.html`). The TypeScript/JavaScript frontend is built with the bun
+commands above.
+
+ROM and disk images are loaded via XHR, so if you want to try out the HTML
+files locally, make sure to serve them from a local webserver. You can use
+`make run` to serve the files using Python's http module.
+
+If you only want to embed v86 in a webpage, check out the
+[examples](examples/). For bundler-based setups, install from npm:
+`bun add @aptre/v86`
+
+### Alternatively, to build using Docker
+
+- If you have Docker installed, you can run the whole system inside a container.
+- See `tools/docker/exec` to find the Dockerfile required for this.
+- You can run `docker build -f tools/docker/exec/Dockerfile -t v86:alpine-3.19 .` from the root directory to generate docker image.
+- Then you can simply run `docker run -it -p 8000:8000 v86:alpine-3.19` to start the server.
+- Check `localhost:8000` for hosted server.
+
+### Running via Dev Container
+
+- If you are using an IDE that supports Dev Containers, such as GitHub Codespaces, the Visual Studio Code Remote Container extension, or possibly others such as Jetbrains' IntelliJ IDEA, you can setup the development environment in a Dev Container.
+- Follow the instructions from your development environment to setup the container.
+- Run the Task "Fetch images" in order to download images for testing.
+
+## Testing
+
+The disk images for testing are not included in this repository. You can
+download them directly from the website using:
+
+`curl --compressed --output-dir images/ --remote-name-all https://i.copy.sh/{linux.iso,linux3.iso,linux4.iso,buildroot-bzimage68.bin,TinyCore-11.0.iso,oberon.img,msdos.img,openbsd-floppy.img,kolibri.img,windows101.img,os8.img,freedos722.img,mobius-fd-release5.img,msdos622.img}`
+
+Run integration tests: `make tests`
+
+Run all tests: `make jshint rustfmt kvm-unit-test nasmtests nasmtests-force-jit expect-tests jitpagingtests qemutests rust-test tests`
+
+See [tests/Readme.md](tests/Readme.md) for more information.
+
+## API examples
+
+- [Basic](examples/basic.html)
+- [Programatically using the serial terminal](examples/serial.html)
+- [A Lua interpreter](examples/lua.html)
+- [Two instances in one window](examples/two_instances.html)
+- [Networking between browser windows/tabs using the Broadcast Channel API](examples/broadcast-network.html)
+- [TCP Terminal (fetch-based networking)](examples/tcp_terminal.html)
+- [Saving and restoring emulator state](examples/save_restore.html)
+
+Using v86 for your own purposes is as easy as:
+
+```javascript
+var emulator = new V86({
+    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 [starter.js](src/browser/starter.js) for the full API.
+
+## License
+
+v86 is distributed under the terms of the Simplified BSD License, see
+[LICENSE](LICENSE). The following third-party dependencies are included in the
+repository under their own licenses:
+
+- [`lib/softfloat/softfloat.c`](lib/softfloat/softfloat.c)
+- [`lib/zstd/zstddeclib.c`](lib/zstd/zstddeclib.c)
+- [`tests/kvm-unit-tests/`](tests/kvm-unit-tests)
+- [`tests/qemutests/`](tests/qemutests)
+- [`src/floppy.js/`](src/floppy.js) contains parts ported from qemu under the MIT license, see LICENSE.MIT.
+
+## Credits
+
+- CPU test cases via [QEMU](https://wiki.qemu.org/Main_Page)
+- More tests via [kvm-unit-tests](https://www.linux-kvm.org/page/KVM-unit-tests)
+- [zstd](https://github.com/facebook/zstd) support is included for better compression of state images
+- [Berkeley SoftFloat](http://www.jhauser.us/arithmetic/SoftFloat.html) is included to precisely emulate 80-bit floating point numbers
+- [The jor1k project](https://github.com/s-macke/jor1k) for 9p, filesystem and uart drivers
+- [WinWorld](https://winworldpc.com/) sources of some old operating systems
+- [OS/2 Museum](https://www.os2museum.com/) sources of some old operating systems
+- [ArchiveOS](https://archiveos.org/) sources of several operating systems
+
+## More questions?
+
+Shoot me an email to `copy@copy.sh`. Please report bugs on GitHub.