From e53db8563180712ec5f1759ec9d52b844c86fa30 Mon Sep 17 00:00:00 2001 From: Greg Tucker Date: Wed, 19 Jul 2023 13:09:27 -0700 Subject: [PATCH] doc: Add notes on reentrancy and threading Fixes #249 Change-Id: Id56464436aeeb2c16bab2cbc0efeb4fded80dc4f Signed-off-by: Greg Tucker --- doc/functions.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/functions.md b/doc/functions.md index 0029b71..c598873 100644 --- a/doc/functions.md +++ b/doc/functions.md @@ -183,6 +183,13 @@ platform features. All functions also have base functions, written in portable C, which the multibinary function will call if none of the required instruction sets are enabled. +### Threading + +All ISA-L library functions are single threaded but reentrant and thread-safe +making it easy for users to incorporate with any threading library. The igzip +command line utility has threaded compression but not built by default. To add +to an automake build do `$ make D="-DHAVE_THREADS"`. + ### Included Tests and Utilities ISA-L source [repo] includes unit tests, performance tests and other utilities.