doc: add a note for multi-process in mempool guide
authorGage Eads <gage.eads@intel.com>
Thu, 20 Jun 2019 22:07:35 +0000 (17:07 -0500)
committerThomas Monjalon <thomas@monjalon.net>
Thu, 4 Jul 2019 21:14:28 +0000 (23:14 +0200)
commit4ae9f32eccef0e12ec7282889fc2a2e444b8ec4d
tree37d97d49affcf3482b6fa3a0b96206eec8ba360c
parent93b93beb123d96e5acbbb24491c491bec47da60d
doc: add a note for multi-process in mempool guide

The mempool library assigns handler ops indexes based on the dynamic load
order of mempool handlers. Indexes are used so a mempool can be used by
multiple processes, but this only works if all processes agree on the
mapping from index to mempool handler.

When using the '-d' argument, it's possible for different processes to load
mempool handlers in different orders, and thus have different
index->handler mappings. Using a mempool in multiple of such processes will
result in undefined behavior.

This commit adds a note to the mempool library programmer's guide warning
users against this.

Fixes: 449c49b93a6b ("mempool: support handler operations")
Cc: stable@dpdk.org
Signed-off-by: Gage Eads <gage.eads@intel.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
doc/guides/prog_guide/mempool_lib.rst