X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=README;h=ca23d43fe3bee6b5e62d5cfcd0489bb93c7ffc2b;hb=a44291d81fd9347fc495cd62ffe3daf3fa783269;hp=b96912e829fc7042d0e2101062ecc454f9c3bd1f;hpb=f075cb10501787e3858f7acaa5fe08a5befee4f5;p=urcu.git diff --git a/README b/README index b96912e..ca23d43 100644 --- a/README +++ b/README @@ -16,14 +16,17 @@ BUILDING * CFLAGS="-m64 -g -O2" ./configure Forcing a 32-bit build with 386 backward compatibility: - * CFLAGS="-m32 -g -O2" ./configure --target=i386-pc-linux-gnu + * CFLAGS="-m32 -g -O2" ./configure --host=i386-pc-linux-gnu + + Forcing a 32-bit build for Sparcv9 (typical for Sparc v9) + * CFLAGS="-m32 -Wa,-Av9a -g -O2" ./configure ARCHITECTURES SUPPORTED ----------------------- -Currently, x86 (i386, i486, i586, i686), x86 64-bit, PowerPC 32/64, S390 and -S390x are supported. Only tested on Linux so far, but should theoretically work -on other operating systems. +Currently, x86 (i386, i486, i586, i686), x86 64-bit, PowerPC 32/64, S390, S390x +and Sparcv9 32/64 are supported. Only tested on Linux so far, but should +theoretically work on other operating systems. QUICK START GUIDE ----------------- @@ -99,11 +102,20 @@ Writing Usage of liburcu-defer * #include - * Link with "-lurcu-defer" - * Provides call_rcu() primitive to enqueue delayed callbacks. Queued + * Link with "-lurcu-defer", and also with one of the urcu library + (either urcu, urcu-bp, urcu-mb or urcu-qsbr). + * Provides defer_rcu() primitive to enqueue delayed callbacks. Queued callbacks are executed in batch periodically after a grace period. - Do _not_ use call_rcu() within a read-side critical section, because + Do _not_ use defer_rcu() within a read-side critical section, because it may call synchronize_rcu() if the thread queue is full. + * Provides defer_rcu_ratelimit() primitive, which acts just like + defer_rcu(), but takes an additional rate limiter callback forcing + synchronized callback execution of the limiter returns non-zero. + * Requires that rcu_defer_barrier() must be called in library destructor + if a library queues callbacks and is expected to be unloaded with + dlclose(). + * Its API is currently experimental. It may change in future library + releases. Being careful with signals