stack: add lock-free implementation
authorGage Eads <gage.eads@intel.com>
Wed, 3 Apr 2019 23:20:17 +0000 (18:20 -0500)
committerThomas Monjalon <thomas@monjalon.net>
Thu, 4 Apr 2019 20:06:16 +0000 (22:06 +0200)
commit3340202f5954a4fbba62332c4aad29af67701188
treeedae5af2a2be4cb186ba19fdeada558cefad4f0b
parentcfe6fab0295cfa744d3f9034069edfa34ae87aa1
stack: add lock-free implementation

This commit adds support for a lock-free (linked list based) stack to the
stack API. This behavior is selected through a new rte_stack_create() flag,
RTE_STACK_F_LF.

The stack consists of a linked list of elements, each containing a data
pointer and a next pointer, and an atomic stack depth counter.

The lock-free push operation enqueues a linked list of pointers by pointing
the tail of the list to the current stack head, and using a CAS to swing
the stack head pointer to the head of the list. The operation retries if it
is unsuccessful (i.e. the list changed between reading the head and
modifying it), else it adjusts the stack length and returns.

The lock-free pop operation first reserves num elements by adjusting the
stack length, to ensure the dequeue operation will succeed without
blocking. It then dequeues pointers by walking the list -- starting from
the head -- then swinging the head pointer (using a CAS as well). While
walking the list, the data pointers are recorded in an object table.

This algorithm stack uses a 128-bit compare-and-swap instruction, which
atomically updates the stack top pointer and a modification counter, to
protect against the ABA problem.

The linked list elements themselves are maintained in a lock-free LIFO
list, and are allocated before stack pushes and freed after stack pops.
Since the stack has a fixed maximum depth, these elements do not need to be
dynamically created.

Signed-off-by: Gage Eads <gage.eads@intel.com>
Reviewed-by: Olivier Matz <olivier.matz@6wind.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
doc/guides/prog_guide/stack_lib.rst
doc/guides/rel_notes/release_19_05.rst
lib/librte_stack/Makefile
lib/librte_stack/meson.build
lib/librte_stack/rte_stack.c
lib/librte_stack/rte_stack.h
lib/librte_stack/rte_stack_lf.c [new file with mode: 0644]
lib/librte_stack/rte_stack_lf.h [new file with mode: 0644]
lib/librte_stack/rte_stack_lf_generic.h [new file with mode: 0644]