ivshmem: document a potential crash in rte_ring
authorAnatoly Burakov <anatoly.burakov@intel.com>
Wed, 1 Jun 2016 14:51:57 +0000 (15:51 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Tue, 7 Jun 2016 10:05:36 +0000 (12:05 +0200)
commitfc552cfb14b9a50ccbf8055d9bab2feb55a8e40c
tree35937368a436146eb7639cf70442afd49f8c8633
parenta2113ebba5c5bad6568dcebb9b2bc50027d4affd
ivshmem: document a potential crash in rte_ring

Commit 4768c475 added a pointer to the memzone in rte_ring. However,
all memzones are residing in local mem_config, therefore accessing
the memzone pointer inside the guest in an IVSHMEM-shared rte_ring
will cause segmentation fault. This issue is unlikely to ever get
fixed, as this would require lots of changes for very little benefit,
therefore we're documenting this limitation instead.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
doc/guides/prog_guide/ivshmem_lib.rst