Skip to content

Commit

Permalink
(DOCS) README note mimalloc Bus Error
Browse files Browse the repository at this point in the history
  • Loading branch information
jtmoon79 committed Jun 23, 2024
1 parent 55b8777 commit c463f6d
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,15 @@ Allocator `mimalloc` [is the fastest according to `mimalloc` project benchmarks]
cargo install --locked super_speedy_syslog_searcher --features mimalloc
```

Error `Bus error` is a known issue on some `aarch64-unknown-linux-gnu` systems.

```lang-text
$ s4 --version
Bus error
```

Either use `jemalloc` or the default System allocator.

<br/>

`jemalloc`
Expand Down Expand Up @@ -740,15 +749,16 @@ See directory results in [`compare-log-mergers.txt`].
Function [`slice_contains_X_2_unroll` is a custom implementation] of `slice.contains`. It is used for string searching and specifically to bypass unnecessary regular expression matches.
According to the [flamegraph], regular expression matches are very expensive.

`slice_contains_X_2_unroll` fares as well as `memchr` and `stringzilla` according to the criterion benchmark report.
`slice_contains_X_2_unroll` fares as well as `memchr` and `stringzilla` in some cases according to
this criterion benchmark report.

<img width="95%" src="releases/0.7.74/criterion/slice_contains/report/violin.svg" style="background-color:white;padding:5px;"/>

See the [0.7.74 criterion benchmark report].
See the [full 0.7.74 criterion benchmark report].

[`slice_contains_X_2_unroll` is a custom implementation]: https://docs.rs/super_speedy_syslog_searcher/0.7.74/s4lib/data/datetime/fn.slice_contains_X_2_unroll.html
[flamegraph]: https://raw.githubusercontent.com/jtmoon79/super-speedy-syslog-searcher/0.7.74/releases/0.7.74/flamegraph-syslog.svg
[0.7.74 criterion benchmark report]: https://html-preview.github.io/?url=https://github.com/jtmoon79/super-speedy-syslog-searcher/blob/main/releases/0.7.74/criterion/report/index.html
[full 0.7.74 criterion benchmark report]: https://html-preview.github.io/?url=https://github.com/jtmoon79/super-speedy-syslog-searcher/blob/main/releases/0.7.74/criterion/report/index.html

---

Expand Down

0 comments on commit c463f6d

Please sign in to comment.