<h1 align="center">
  Disarmv7
</h1>

Disarmv7 is a disassembler for the ArmV7-M instruction set. It provides a fast enough disassembler that lifts [most](#footnotes)$^1$ of the ArmV7-m instructions to a rust `enum` which is ideal if you want to do semantic analysis, [symbolic execution](https://github.com/ivario123/symex) or similar on
the assembly/machine code level. As of now, it does not provide a textual representation of the assembly instructions.
This project is mainly written as a support project for the [Symex](https://github.com/ivario123/symex) project which is a symbolic execution engine that provides safe-to-use execution time estimates for each possible path through the program. But can be used as a standalone project for parsing ArmV7-M binaries.

## Usage

### Using the library

Assuming that you have placed the instructions in a slice of `u8`s (buff) you can call the disassembler like this :

```rust
use disarmv7::prelude::*;

let mut buff: disarmv7::buffer::PeekableBuffer<u8, _> = buff.iter().cloned().into();
let asm = Asm::parse(&mut buff);
println!("Assembly : {asm:?}");
```

## Limitations

This project does not load binaries, nor does it generate a textual representation of the assembly, this is outside of the scope of the project.
And for things that require textual representations of the program, we refer the user to projects like [Capstone](https://github.com/capstone-engine/capstone) which provide a more complete experience.

## Contributing

If you find this project interesting and or useful feel free to contribute by either finding an open issue in the [issue tracker](https://github.com/ivario123/dissarmv7/issues) or opening a [`PR`](https://github.com/ivario123/dissarmv7/pulls) with fixes or features that you find useful.
Before contributing you should read the short [documentation](./CONTRIBUTING.md) on contributions.

## License

This repository is licensed under the [MIT](./LICENSE) license and any contributions shall be licensed under the same license unless explicitly stated otherwise.

## Footnotes

- [1] The disassembler does not support the floating point extensions as of now.
- [2] For further documentation on this please read the documentation for [Object](https://docs.rs/object/latest/object/).