X-Git-Url: http://git.lttng.org/?p=urcu.git;a=blobdiff_plain;f=README.md;fp=README.md;h=1f7aaaf258db7118e3900a2e7a740048bb6f63c3;hp=58db299018deb07f36fbdd1bad863ed35f82b3e0;hb=aad674a9a583e09e854145f18c5d8854269dce8c;hpb=3d003c571cd461aba1935e5d21e1e04da7183970 diff --git a/README.md b/README.md index 58db299..1f7aaaf 100644 --- a/README.md +++ b/README.md @@ -170,7 +170,6 @@ There are multiple flavors of liburcu available: - `memb`, - `qsbr`, - `mb`, - - `signal`, - `bp`. The API members start with the prefix `urcu__`, where @@ -215,16 +214,6 @@ and reader sides. This results in faster grace-period detection, but results in slower reads. -### Usage of `liburcu-signal` - - 1. `#include ` - 2. Link the application with `-lurcu-signal` - -NOTE: The `liburcu-signal` flavor is *deprecated* and will be removed in the -future. It is now identical to `liburcu-mb` at the exception of the symbols and -public header files. It is therefore slower than previous versions. Users are -encouraged to migrate to the `liburcu-memb` flavor. - ### Usage of `liburcu-bp` 1. `#include ` @@ -274,7 +263,7 @@ the grace period has completed, false otherwise. ### Usage of `liburcu-defer` - Follow instructions for either `liburcu-memb`, `liburcu-qsbr`, - `liburcu-mb`, `liburcu-signal`, or `liburcu-bp` above. + `liburcu-mb`, or `liburcu-bp` above. The `liburcu-defer` functionality is pulled into each of those library modules. - Provides `urcu__defer_rcu()` primitive to enqueue delayed @@ -293,7 +282,7 @@ Its API is currently experimental. It may change in future library releases. ### Usage of `urcu-call-rcu` - Follow instructions for either `liburcu-memb`, `liburcu-qsbr`, - `liburcu-mb`, `liburcu-signal`, or `liburcu-bp` above. + `liburcu-mb`, or `liburcu-bp` above. The `urcu-call-rcu` functionality is pulled into each of those library modules. - Provides the `urcu__call_rcu()` primitive to enqueue delayed @@ -311,13 +300,6 @@ Its API is currently experimental. It may change in future library releases. ### Being careful with signals -The `liburcu-signal` library uses signals internally. The signal handler is -registered with the `SA_RESTART` flag. However, these signals may cause -some non-restartable system calls to fail with `errno = EINTR`. Care -should be taken to restart system calls manually if they fail with this -error. A list of non-restartable system calls may be found in -`signal(7)`. - Read-side critical sections are allowed in a signal handler, except those setup with `sigaltstack(2)`, with `liburcu-memb` and `liburcu-mb`. Be careful, however, to disable these signals