From: Yuanhan Liu Date: Wed, 6 Apr 2016 06:53:55 +0000 (+0800) Subject: doc: announce API changes for vhost refactoring X-Git-Tag: spdx-start~7017 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=f4f136c8c4a29b4f5797bd9c558421d17d72aba7;hp=fcd5106cf14833892cd96412179987ad9ee437ba;p=dpdk.git doc: announce API changes for vhost refactoring We currently exposed way too many fields (or even structures) than necessary. For example, vhost_virtqueue struct should NOT be exposed to user at all: application just need to tell the right queue id to locate a specific queue, and that's all. Instead, the structure should be defined in an internal header file. With that, we could do any changes to it we want, without worrying about that we may offense the painful ABI rules. Similar changes could be done to virtio_net struct as well, just exposing very few fields that are necessary and moving all others to an internal structure. Huawei then suggested a more radical yet much cleaner one: just exposing a virtio_net handle to application, just like the way kernel exposes an fd to user for locating a specific file, and exposing some new functions to access those old fields, such as flags, virt_qp_nb. With this change, we're likely to be free from ABI violations forever (well, except when we have to extend the virtio_net_device_ops struct). For example, following nice cleanup would not be a blocking one then: http://dpdk.org/ml/archives/dev/2016-February/033528.html Suggested-by: Huawei Xie Signed-off-by: Yuanhan Liu Acked-by: Panu Matilainen Acked-by: Thomas Monjalon --- diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 191307d37e..9d2270269a 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -71,3 +71,10 @@ Deprecation Notices support PCAP file reading feature. The release 16.04 contains this ABI change wrapped by RTE_NEXT_ABI macro. Release 16.07 will contain this change, and no backwards compatibility is planned. + +* A librte_vhost public structures refactor is planned for DPDK 16.07 + that requires both ABI and API change. + The proposed refactor would expose DPDK vhost dev to applications as + a handle, like the way kernel exposes an fd to user for locating a + specific file, and to keep all major structures internally, so that + we are likely to be free from ABI violations in future.