Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
wenyuzhao committed Jul 2, 2024
1 parent 3d7833f commit 8bd609c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 20 deletions.
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,13 @@ $ env DYLD_INSERT_LIBRARIES=./target/release/libhoard.dylib cargo --help # or so
$ cargo test
```

## Benchmarking

[[_Latest benchmark results_]](https://github.com/wenyuzhao/MallocKit/blob/main/bench/visual.ipynb)

Please use a linux distribution (e.g. Ubuntu or Fedora) and run `cd bench && make setup` to fetch and build all the benchmarks and third-party malloc algorithms.

```
python3 -m bench -a mi hd sys hoard -i 10 -e duration_time cycles cache-misses cache-references dTLB-load-misses dTLB-loads instructions page-faults --build
```

After the benchmark run is finished, please use `bench/visual.ipynb` for visualization.

_Other usages of the benchmark tool:_

* `python3 -m bench -a hoard -b cfrac --build --record -e dTLB-loads` followed by `perf report` to record and analyze perf event data.
* `python3 -m bench -a hoard -b cfrac --build --test` for a quick run of a single benchmark.
* `python3 -m bench -a hoard -b cfrac --build --lldb` to run the benchmark binary with _lldb_.

## TODO

- [x] Linux/x86_64 support
- [x] MacOS/x86_64 support
- [ ] Windows/x86_64 support
- [ ] Performance
- [x] Performance
- [x] Linux/aarch64 support
- [x] MacOS/aarch64 support
- [ ] Windows/aarch64 support
- [ ] Rust allocator interface
- [x] Rust allocator interface
8 changes: 8 additions & 0 deletions bench/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Benchmarking Instructions

1. Clone the mimalloc-bench repo: `git submodule update --init`
2. Install the benchmarking tool: `cargo install harness-cli`
3. Build benchmarks and mallocs: `docker compose up --build`
4. Run: `cd bench && cargo harness run --upload`

[latest results](https://r.harness.rs/?p=7A5saxywVxwz2i5P)

0 comments on commit 8bd609c

Please sign in to comment.