00cc9309cb
de6e324bdseparate emu thread10d3daf86Roms List improvements95d202f37Let's make the rom list process on a separate thread so the emulator doesnt take ages to load.fc306967fWow the ROM Header was just completely busted. Game list view works nowbad1691eefuck this shit2b59e5f46game list in progressd26417b83remappable inputs in progressac4af8106inpute72abc240update readme430139dc9Qt6 frontend3080d4d45Fix this small bug too08cd13b85Cop0 unused functions do not actually pose a threat (as per manual). They don't do anything, so shall we.61bb4fb44make idle loop detection a little more specific with where the load goesb037de4c3SAZDFsdff12e81e73eneed to figure out why n64-systemtest loops indefinitely at some address that appears to be valid (i think it's me not invalidating the cache properly)204f0e13bidle skipping seems to work!cb8bb634asdkfjlasdf58e5c89c1Fix compilation issue on my machine (no idea)24fb2898eattempting more serious idle skipping214719577Place rsp.Step inside cached interpreter. Gains about 3 more fpsbb97dcc23mmmmm920b77d38wjkhasdfjhkasdf430ccdab4it's a start...4f42a673aCached interpreter plays Mario 64. Start looking into RSP as wellc9a030787idle skipping works!5fbda03cenew idea366637abaIdle skipping... maybe?609fa2fb0Cache instructions implemented but broken lmao. Commented out for nowe140a6d12- Stop using inheritance for CPU, instead use composition. - Introduce KAIZEN_JIT_ENABLED optional define instead of relying on __aarch64__ and the like. - More cache work68e613057prep cache impl811b4d809fix clang formatfda755f7didkd5024ebbfsmall MI refactor in preparation of (eventually) implementing the RDRAM interface properly694b45341Merge commit '206dcdedf195fb320913584180edb12c7731e396' as 'external/SDL'206dcdedfSquashed 'external/SDL/' content from commit 4d17b99d0a4d16e1cb4need to update sdl848b19920Fix compilation errordb61b5299Merge commit 'e94a94559f28e49678fbcf72199a5258137b0fe9' as 'external/imgui'e94a94559Squashed 'external/imgui/' content from commit 02e9b8cac52edb3757need to update imguic1a705e86Emulate weird JALR behaviour4b4c32f4bFix exception for "unusable COP1" in 4 instructions i missed accidentally (again)df5828142Bug putting 0s in the log everywheref8b580048Make isviewer a sink to file8241e9735Fix exception for "unusable COP1" in 4 instructions i missed accidentallyb29715f20small changesd9a620bc1make use of my new small utility library0d1aa938eAdd 'external/ircolib/' from commit 'ce3cd726c8df8388d554abf8bb55d55020eb4450'e64eb40b3Fuck git git-subtree-dir: external/ircolib git-subtree-split:de6e324bde
115 lines
4.3 KiB
Markdown
115 lines
4.3 KiB
Markdown
Code structure
|
||
--------------
|
||
|
||
Capstone source is organized as followings.
|
||
|
||
```
|
||
. <- core engine + README.md + BUILDING.md etc
|
||
├── arch <- code handling disasm engine for each arch
|
||
│ ├── AArch64 <- AArch64 engine
|
||
│ ├── Alpha <- Alpha engine
|
||
│ ├── ARM <- ARM engine
|
||
│ ├── BPF <- Berkeley Packet Filter engine
|
||
│ ├── EVM <- Ethereum engine
|
||
│ ├── HPPA <- HPPA engine
|
||
│ ├── M680X <- M680X engine
|
||
│ ├── M68K <- M68K engine
|
||
│ ├── Mips <- Mips engine
|
||
│ ├── MOS65XX <- MOS65XX engine
|
||
│ ├── PowerPC <- PowerPC engine
|
||
│ ├── RISCV <- RISCV engine
|
||
│ ├── SH <- SH engine
|
||
│ ├── Sparc <- Sparc engine
|
||
│ ├── SystemZ <- SystemZ engine
|
||
│ ├── TMS320C64x <- TMS320C64x engine
|
||
│ ├── TriCore <- TriCore engine
|
||
│ └── WASM <- WASM engine
|
||
├── bindings <- all bindings are under this dir
|
||
│ ├── java <- Java bindings
|
||
│ ├── ocaml <- Ocaml bindings
|
||
│ └── python <- Python bindings
|
||
│ └── cstest <- Testing tool for the Python bindings.
|
||
├── suite <- Several tools used for development
|
||
│ ├── cstest <- Testing tool to consume and check the test `yaml` files in `tests`
|
||
│ ├── fuzz <- Fuzzer
|
||
│ └── auto-sync <- The updater for Capstone modules
|
||
├── contrib <- Code contributed by community to help Capstone integration
|
||
├── cstool <- Cstool
|
||
├── docs <- Documentation
|
||
├── include <- API headers in C language (*.h)
|
||
├── packages <- Packages for Linux/OSX/BSD.
|
||
├── windows <- Windows support (for Windows kernel driver compile)
|
||
├── tests <- Unit and itegration tests
|
||
└── xcode <- Xcode support (for MacOSX compile)
|
||
```
|
||
|
||
Building
|
||
--------
|
||
|
||
Follow the instructions in [BUILDING.md](BUILDING.md) for how to compile and run test code.
|
||
|
||
Testing
|
||
-------
|
||
|
||
General testing docs are at [tests/README.md](tests/README.md).
|
||
|
||
You can test single instructions easily with the `cstool`.
|
||
For example:
|
||
|
||
```bash
|
||
$ cstool x32 "90 91"
|
||
```
|
||
|
||
Using `cstool` is also the prefered way for debugging a single instruction.
|
||
|
||
**Bindings**
|
||
|
||
Bindings currently have not equivalent to a `cstool`.
|
||
|
||
The Python bindings have `cstool` implemented.
|
||
|
||
Other bindings are out-of-date for a while because of missing maintainers.
|
||
They only have legacy integration tests.
|
||
|
||
Please check the issues or open a new one if you intent to work on them or need them.
|
||
|
||
Coding style
|
||
------------
|
||
- We provide a `.clang-format` for C code.
|
||
- Python files should be formatted with `black`.
|
||
|
||
Support
|
||
-------
|
||
|
||
**Please always open an issue or leave a comment in one, before starting work on an architecture! We can give support and save you a lot of time.**
|
||
|
||
Updating an Architecture
|
||
------------------------
|
||
|
||
The update tool for Capstone is called `Auto-Sync` and can be found in `suite/auto-sync`.
|
||
|
||
Not all architectures are supported yet.
|
||
Run `suite/auto-sync/Updater/ASUpdater.py -h` to get a list of currently supported architectures.
|
||
|
||
The documentation how to update with `Auto-Sync` or refactor an architecture module
|
||
can be found in [suite/auto-sync/README.md](suite/auto-sync/README.md).
|
||
|
||
If a module does not support `Auto-Sync` yet, it is highly recommended to refactor it
|
||
instead of attempting to update it manually.
|
||
Refactoring will take less time and updates it during the procedure.
|
||
|
||
The one exception is `x86`. In LLVM we use several emitter backends to generate C code.
|
||
One of those LLVM backends (the `DecoderEmitter`) has two versions.
|
||
One for `x86` and another for all the other architectures.
|
||
Until now it was not worth it to refactoring this unique `x86` backend. So `x86` is not
|
||
supported currently.
|
||
|
||
Adding an Architecture
|
||
----------------------
|
||
|
||
If your architecture is supported in LLVM or one of its forks, you can use `Auto-Sync` to
|
||
add the new module.
|
||
Checkout [suite/auto-sync/RefactorGuide.md](suite/auto-sync/RefactorGuide.md).
|
||
|
||
Otherwise, you need to implement the disassembler on your own and make it work with the Capstone API.
|