Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlexAltea/unicorn.js
Unicorn CPU emulator framework port for JavaScript
https://github.com/AlexAltea/unicorn.js
Last synced: 12 days ago
JSON representation
Unicorn CPU emulator framework port for JavaScript
- Host: GitHub
- URL: https://github.com/AlexAltea/unicorn.js
- Owner: AlexAltea
- License: gpl-2.0
- Created: 2016-06-18T02:17:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-01T15:15:26.000Z (about 1 year ago)
- Last Synced: 2024-04-14T12:12:14.743Z (7 months ago)
- Language: JavaScript
- Homepage: https://alexaltea.github.io/unicorn.js/
- Size: 15 MB
- Stars: 556
- Watchers: 22
- Forks: 41
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Unicorn.js
==========
[](https://github.com/AlexAltea/unicorn.js/releases)
Port of the [Unicorn](https://github.com/unicorn-engine/unicorn) CPU emulator framework for JavaScript. Powered by [Emscripten](https://github.com/kripken/emscripten).
**Notes:** _Unicorn_ is a lightweight multi-architecture CPU emulator framework originally developed by Nguyen Anh Quynh, Dang Hoang Vu et al. and released under GPLv2 license. More information about contributors and license terms can be found in the files `AUTHORS.TXT`, `CREDITS.TXT` and `COPYING` inside the *unicorn* submodule of this repository.
## Installation
To add Unicorn.js to your web application, include it with:
```html
```
or install it with the Bower command:
```bash
bower install unicornjs
```
## Usage
```javascript
var addr = 0x10000;
var code = [
0x37, 0x00, 0xA0, 0xE3, // mov r0, #0x37
0x03, 0x10, 0x42, 0xE0, // sub r1, r2, r3
];
// Initialize engine
var e = new uc.Unicorn(uc.ARCH_ARM, uc.MODE_ARM);
// Write registers and memory
e.reg_write_i32(uc.ARM_REG_R2, 0x456);
e.reg_write_i32(uc.ARM_REG_R3, 0x123);
e.mem_map(addr, 4*1024, uc.PROT_ALL);
e.mem_write(addr, code)
// Start emulator
var begin = addr;
var until = addr + code.length;
e.emu_start(begin, until, 0, 0);
// Read registers
var r0 = e.reg_read_i32(uc.ARM_REG_R0); // 0x37
var r1 = e.reg_read_i32(uc.ARM_REG_R1); // 0x333
```
## Building
To build the Unicorn.js library, clone the *master* branch of this repository on a Linux machine, and do the following:
1. Initialize the original Unicorn submodule: `git submodule update --init`.
2. Install latest [Emscripten SDK 2.0.21+](https://emscripten.org/docs/getting_started/downloads.html). Follow the respective instructions and make sure all environment variables are configured correctly.
3. Install the latest [Python 3.8+](https://www.python.org/downloads/). Make sure both `python3` and `python` are callable. You can either setup alias or `apt install python-is-python3`
3. Install the development dependencies with: `npm install --also=dev`.
4. Install grunt with: `npm install -g grunt`
5. Finally, build the source with: `grunt build`.