From d3f6d2ad0616a84e1c4672379f9a407f90922160 Mon Sep 17 00:00:00 2001 From: Konstantinos Margaritis Date: Tue, 28 Nov 2023 18:27:08 +0200 Subject: [PATCH] updates to the Readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 095ab8ba..7f7c2f53 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # About Vectorscan A fork of Intel's Hyperscan, modified to run on more platforms. Currently ARM NEON/ASIMD -is 100% functional, and Power VSX are in development. ARM SVE2 support is in ongoing with +and Power VSX are 100% functional. ARM SVE2 support is in ongoing with access to hardware now. More platforms will follow in the future. +Further more, starting 5.4.12 there is now a [SIMDe](https://github.com/simd-everywhere/simde) +port, which can be either used for platforms without official SIMD support, +as SIMDe can emulate SIMD instructions, or as an alternative backend for existing architectures, +for reference and comparison purposes. Vectorscan will follow Intel's API and internal algorithms where possible, but will not hesitate to make code changes where it is thought of giving better performance or better @@ -148,6 +152,11 @@ Common options for Cmake are: * `SANITIZE=[address|memory|undefined]` (experimental) Use `libasan` sanitizer to detect possible bugs. For now only `address` is tested. This will eventually be integrated in the CI. +## SIMDe options + +* `SIMDE_BACKEND=[On|Off]` Enable SIMDe backend. If this is chosen all native (SSE/AVX/AVX512/Neon/SVE/VSX) backends will be disabled and a SIMDe SSE4.2 emulation backend will be enabled. This will enable Vectorscan to build and run on architectures without SIMD. +* `SIMDE_NATIVE=[On|Off]` Enable SIMDe native emulation of x86 SSE4.2 intrinsics on the building platform. That is, SSE4.2 intrinsics will be emulated using Neon on an Arm platform, or VSX on a Power platform, etc. + ## Build If `cmake` has completed successfully you can run `make` in the same directory, if you have a multi-core system with `N` cores, running @@ -177,4 +186,4 @@ the [Developer Reference Guide](http://intel.github.io/hyperscan/dev-reference/) And you can find the source code [on Github](https://github.com/intel/hyperscan). -For Intel Hyperscan related issues and questions, please follow the relevant links there. \ No newline at end of file +For Intel Hyperscan related issues and questions, please follow the relevant links there.