strop 0.2.0

stochastically generates machine code
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# strop
[![Build Status](https://github.com/omarandlorraine/strop/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/omarandlorraine/strop/actions?workflow=Rust)
[![crates.io](https://img.shields.io/crates/v/strop)](https://crates.io/crates/strop)

strop, the *st*ochastic *op*timizer, written in *R*ust.

Like a compiler, strop generates assembly that computes a given function. But
unlike a compiler, it generates assembly-language subroutines by a random
search or a brute-force search.

### Ancillary documents:

 * [LICENSE](LICENSE.md) It's just the MIT license.
 * [Theory of operation](THEORY_OF_OPERATION.md) High-level documentation explaining how strop works.

### What it's for

To see what strop could be used for:

 * [opt](examples/opt.rs) optimizes an existing machine code function
 * [gen](examples/gen.rs) generates a Z80 function matching the Rust function, after a fashion compiling Rust to Z80.
 * [peephole](examples/peephole.rs) discovers lacunae in the peephole optimizers and other constraints

### Supported instruction sets:

Strop currently has the following back-ends:

 * **armv4t**, which targets the ARMv4T processors, such as the ARM7TDMI
    * [![Build Status](https://github.com/omarandlorraine/strop/actions/workflows/armv4t.yml/badge.svg?branch=master)](https://github.com/omarandlorraine/strop/actions?workflow=armv4t)
 * **m68000**, which targets the Motorola 68000
    * [![Build Status](https://github.com/omarandlorraine/strop/actions/workflows/m68000.yml/badge.svg?branch=master)](https://github.com/omarandlorraine/strop/actions?workflow=m68000)
    * NB. This back-end is gated by the `m68k` feature since it requires nightly Rust
 * **m6502**, targets various models of the MOS 6502
    * [![Build Status](https://github.com/omarandlorraine/strop/actions/workflows/mos6502.yml/badge.svg?branch=master)](https://github.com/omarandlorraine/strop/actions?workflow=mos6502)
    * Supports the NMOS and CMOS variants and others, thanks to the
      [mos6502](https://github.com/mre/mos6502) dependency.
 * **m6809**, which targets the Motorola 6809
    * [![Build Status](https://github.com/omarandlorraine/strop/actions/workflows/m6809.yml/badge.svg?branch=master)](https://github.com/omarandlorraine/strop/actions?workflow=m6809)
 * **z80**, which targets the Zilog Z80
    * [![Build Status](https://github.com/omarandlorraine/strop/actions/workflows/z80.yml/badge.svg?branch=master)](https://github.com/omarandlorraine/strop/actions?workflow=z80)