ring: refactor exported headers
authorFeifei Wang <feifei.wang2@arm.com>
Fri, 29 Jan 2021 05:59:05 +0000 (13:59 +0800)
committerDavid Marchand <david.marchand@redhat.com>
Fri, 29 Jan 2021 10:37:14 +0000 (11:37 +0100)
commit1fc73390bcf533d19c9c3f0fc3859845a9d0502a
tree3b700e7148d74ffce80aa04f26c67c2e6462a4c7
parentd310d64271459624c2c06995827e7e9b419f39cb
ring: refactor exported headers

For legacy modes, rename ring_generic/c11 to ring_generic/c11_pvt.
Furthermore, add new file ring_elem_pvt.h which includes ring_do_eq/deq
and ring element copy/delete APIs.

The update_tail internal helper has been prefixed with the library prefix.

For other modes, rename xx_c11_mem to xx_elem_pvt. Move all private APIs
into these new header files.

Finally, the external APIs and internal APIs will be separated from each
other. This can remind users not to use internal APIs and make ring
library easier to maintain.

Suggested-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Signed-off-by: Feifei Wang <feifei.wang2@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
17 files changed:
lib/librte_ring/meson.build
lib/librte_ring/rte_ring_c11_mem.h [deleted file]
lib/librte_ring/rte_ring_c11_pvt.h [new file with mode: 0644]
lib/librte_ring/rte_ring_elem.h
lib/librte_ring/rte_ring_elem_pvt.h [new file with mode: 0644]
lib/librte_ring/rte_ring_generic.h [deleted file]
lib/librte_ring/rte_ring_generic_pvt.h [new file with mode: 0644]
lib/librte_ring/rte_ring_hts.h
lib/librte_ring/rte_ring_hts_c11_mem.h [deleted file]
lib/librte_ring/rte_ring_hts_elem_pvt.h [new file with mode: 0644]
lib/librte_ring/rte_ring_peek.h
lib/librte_ring/rte_ring_peek_c11_mem.h [deleted file]
lib/librte_ring/rte_ring_peek_elem_pvt.h [new file with mode: 0644]
lib/librte_ring/rte_ring_peek_zc.h
lib/librte_ring/rte_ring_rts.h
lib/librte_ring/rte_ring_rts_c11_mem.h [deleted file]
lib/librte_ring/rte_ring_rts_elem_pvt.h [new file with mode: 0644]