diff mbox

[ovs-dev,v2] dpdk: announce deprecation of vhost-user server ports

Message ID 20170608204132.9376-1-aconole@redhat.com
State Accepted
Delegated to: Darrell Ball
Headers show

Commit Message

Aaron Conole June 8, 2017, 8:41 p.m. UTC
Since vhost-user server mode ports are the preferred mechanism for
interconnecting Open vSwitch with VMs when using DPDK, and since there
are currently no known use cases for vhost-user server mode ports apart
from version incompatibilities with QEMU, announce that server mode ports
are considered deprecated and will be removed in a future release.

v1->v2:
* Verbiage changes as suggested by Kevin Traynor, and Darrell Ball.

Cc: Ciara Loftus <ciara.loftus@intel.com>
Cc: Kevin Traynor <ktraynor@redhat.com>
Suggested-by: Darrell Ball <dball@vmware.com>
Signed-off-by: Aaron Conole <aconole@redhat.com>
---
Previous version can be found at:
https://mail.openvswitch.org/pipermail/ovs-dev/2017-June/333609.html

 Documentation/topics/dpdk/vhost-user.rst | 26 ++++++++++++++++++--------
 NEWS                                     |  2 ++
 lib/netdev-dpdk.c                        |  2 ++
 3 files changed, 22 insertions(+), 8 deletions(-)

Comments

Darrell Ball June 8, 2017, 8:59 p.m. UTC | #1
Thanks for doing this.

Acked-by: Darrell Ball <dlu998@gmail.com>

On 6/8/17, 1:41 PM, "Aaron Conole" <aconole@redhat.com> wrote:

    Since vhost-user server mode ports are the preferred mechanism for
    interconnecting Open vSwitch with VMs when using DPDK, and since there
    are currently no known use cases for vhost-user server mode ports apart
    from version incompatibilities with QEMU, announce that server mode ports
    are considered deprecated and will be removed in a future release.
    
    v1->v2:
    * Verbiage changes as suggested by Kevin Traynor, and Darrell Ball.
    
    Cc: Ciara Loftus <ciara.loftus@intel.com>
    Cc: Kevin Traynor <ktraynor@redhat.com>
    Suggested-by: Darrell Ball <dball@vmware.com>
    Signed-off-by: Aaron Conole <aconole@redhat.com>
    ---
    Previous version can be found at:
    https://urldefense.proofpoint.com/v2/url?u=https-3A__mail.openvswitch.org_pipermail_ovs-2Ddev_2017-2DJune_333609.html&d=DwIBAg&c=uilaK90D4TOVoH58JNXRgQ&r=BVhFA09CGX7JQ5Ih-uZnsw&m=M6rZdq8NlOfvmS7wgOavwyKNcKLJS2-FkF9vRM2DLS0&s=ALZOeECMUJeDQbpppAE_9VUn3QYYFLb9iK4sHzfzif4&e= 
    
     Documentation/topics/dpdk/vhost-user.rst | 26 ++++++++++++++++++--------
     NEWS                                     |  2 ++
     lib/netdev-dpdk.c                        |  2 ++
     3 files changed, 22 insertions(+), 8 deletions(-)
    
    diff --git a/Documentation/topics/dpdk/vhost-user.rst b/Documentation/topics/dpdk/vhost-user.rst
    index a1c19fd..3b11c4d 100644
    --- a/Documentation/topics/dpdk/vhost-user.rst
    +++ b/Documentation/topics/dpdk/vhost-user.rst
    @@ -32,13 +32,20 @@ documentation`_ on same.
     Quick Example
     -------------
     
    -This example demonstrates how to add two ``dpdkvhostuser`` ports to an existing
    -bridge called ``br0``::
    +This example demonstrates how to add two ``dpdkvhostuserclient`` ports to an
    +existing bridge called ``br0``::
     
    -    $ ovs-vsctl add-port br0 dpdkvhostuser0 \
    -        -- set Interface dpdkvhostuser0 type=dpdkvhostuser
    -    $ ovs-vsctl add-port br0 dpdkvhostuser1 \
    -        -- set Interface dpdkvhostuser1 type=dpdkvhostuser
    +    $ ovs-vsctl add-port br0 dpdkvhostclient0 \
    +        -- set Interface dpdkvhostclient0 type=dpdkvhostuserclient \
    +           options:vhost-server-path=/tmp/dpdkvhostclient0
    +    $ ovs-vsctl add-port br0 dpdkvhostclient1 \
    +        -- set Interface dpdkvhostclient1 type=dpdkvhostuserclient \
    +           options:vhost-server-path=/tmp/dpdkvhostclient1
    +
    +For the above examples to work, an appropriate server socket must be created
    +at the paths specified (``/tmp/dpdkvhostclient0`` and
    +``/tmp/dpdkvhostclient0``).  These sockets can be created with QEMU; see the
    +:ref:`vhost-user client <dpdk-vhost-user-client>` section for details.
     
     vhost-user vs. vhost-user-client
     --------------------------------
    @@ -59,7 +66,9 @@ means if OVS dies, all VMs **must** be restarted. On the other hand, for
     vhost-user-client ports, OVS acts as the client and QEMU the server. This means
     OVS can die and be restarted without issue, and it is also possible to restart
     an instance itself. For this reason, vhost-user-client ports are the preferred
    -type for most use cases.
    +type for all known use cases; the only limitation is that vhost-user client
    +mode ports require QEMU version 2.7.  Ports of type vhost-user are currently
    +deprecated and will be removed in a future release.
     
     .. _dpdk-vhost-user:
     
    @@ -68,7 +77,8 @@ vhost-user
     
     .. important::
     
    -   Use of vhost-user ports requires QEMU >= 2.2
    +   Use of vhost-user ports requires QEMU >= 2.2;  vhost-user ports are
    +   *deprecated*.
     
     To use vhost-user ports, you must first add said ports to the switch. DPDK
     vhost-user ports can have arbitrary names with the exception of forward and
    diff --git a/NEWS b/NEWS
    index 82004c8..b81d033 100644
    --- a/NEWS
    +++ b/NEWS
    @@ -16,6 +16,8 @@ Post-v2.7.0
            Log level can be changed in a usual OVS way using
            'ovs-appctl vlog' commands for 'dpdk' module. Lower bound
            still can be configured via extra arguments for DPDK EAL.
    +     * dpdkvhostuser ports are marked as deprecated.  They will be removed
    +       in an upcoming release.
        - IPFIX now provides additional counters:
          * Total counters since metering process startup.
          * Per-flow TCP flag counters.
    diff --git a/lib/netdev-dpdk.c b/lib/netdev-dpdk.c
    index b770b70..9ab4aeb 100644
    --- a/lib/netdev-dpdk.c
    +++ b/lib/netdev-dpdk.c
    @@ -966,6 +966,8 @@ netdev_dpdk_vhost_construct(struct netdev *netdev)
         err = vhost_common_construct(netdev);
     
         ovs_mutex_unlock(&dpdk_mutex);
    +    VLOG_WARN_ONCE("dpdkvhostuser ports are considered deprecated;  "
    +                   "please migrate to dpdkvhostuserclient ports.");
         return err;
     }
     
    -- 
    2.9.4
Ben Pfaff June 8, 2017, 9:33 p.m. UTC | #2
Thanks Aaron and Darrell, I applied this to master.

On Thu, Jun 08, 2017 at 08:59:25PM +0000, Darrell Ball wrote:
> Thanks for doing this.
> 
> Acked-by: Darrell Ball <dlu998@gmail.com>
> 
> On 6/8/17, 1:41 PM, "Aaron Conole" <aconole@redhat.com> wrote:
> 
>     Since vhost-user server mode ports are the preferred mechanism for
>     interconnecting Open vSwitch with VMs when using DPDK, and since there
>     are currently no known use cases for vhost-user server mode ports apart
>     from version incompatibilities with QEMU, announce that server mode ports
>     are considered deprecated and will be removed in a future release.
>     
>     v1->v2:
>     * Verbiage changes as suggested by Kevin Traynor, and Darrell Ball.
>     
>     Cc: Ciara Loftus <ciara.loftus@intel.com>
>     Cc: Kevin Traynor <ktraynor@redhat.com>
>     Suggested-by: Darrell Ball <dball@vmware.com>
>     Signed-off-by: Aaron Conole <aconole@redhat.com>
>     ---
>     Previous version can be found at:
>     https://urldefense.proofpoint.com/v2/url?u=https-3A__mail.openvswitch.org_pipermail_ovs-2Ddev_2017-2DJune_333609.html&d=DwIBAg&c=uilaK90D4TOVoH58JNXRgQ&r=BVhFA09CGX7JQ5Ih-uZnsw&m=M6rZdq8NlOfvmS7wgOavwyKNcKLJS2-FkF9vRM2DLS0&s=ALZOeECMUJeDQbpppAE_9VUn3QYYFLb9iK4sHzfzif4&e= 
>     
>      Documentation/topics/dpdk/vhost-user.rst | 26 ++++++++++++++++++--------
>      NEWS                                     |  2 ++
>      lib/netdev-dpdk.c                        |  2 ++
>      3 files changed, 22 insertions(+), 8 deletions(-)
>     
>     diff --git a/Documentation/topics/dpdk/vhost-user.rst b/Documentation/topics/dpdk/vhost-user.rst
>     index a1c19fd..3b11c4d 100644
>     --- a/Documentation/topics/dpdk/vhost-user.rst
>     +++ b/Documentation/topics/dpdk/vhost-user.rst
>     @@ -32,13 +32,20 @@ documentation`_ on same.
>      Quick Example
>      -------------
>      
>     -This example demonstrates how to add two ``dpdkvhostuser`` ports to an existing
>     -bridge called ``br0``::
>     +This example demonstrates how to add two ``dpdkvhostuserclient`` ports to an
>     +existing bridge called ``br0``::
>      
>     -    $ ovs-vsctl add-port br0 dpdkvhostuser0 \
>     -        -- set Interface dpdkvhostuser0 type=dpdkvhostuser
>     -    $ ovs-vsctl add-port br0 dpdkvhostuser1 \
>     -        -- set Interface dpdkvhostuser1 type=dpdkvhostuser
>     +    $ ovs-vsctl add-port br0 dpdkvhostclient0 \
>     +        -- set Interface dpdkvhostclient0 type=dpdkvhostuserclient \
>     +           options:vhost-server-path=/tmp/dpdkvhostclient0
>     +    $ ovs-vsctl add-port br0 dpdkvhostclient1 \
>     +        -- set Interface dpdkvhostclient1 type=dpdkvhostuserclient \
>     +           options:vhost-server-path=/tmp/dpdkvhostclient1
>     +
>     +For the above examples to work, an appropriate server socket must be created
>     +at the paths specified (``/tmp/dpdkvhostclient0`` and
>     +``/tmp/dpdkvhostclient0``).  These sockets can be created with QEMU; see the
>     +:ref:`vhost-user client <dpdk-vhost-user-client>` section for details.
>      
>      vhost-user vs. vhost-user-client
>      --------------------------------
>     @@ -59,7 +66,9 @@ means if OVS dies, all VMs **must** be restarted. On the other hand, for
>      vhost-user-client ports, OVS acts as the client and QEMU the server. This means
>      OVS can die and be restarted without issue, and it is also possible to restart
>      an instance itself. For this reason, vhost-user-client ports are the preferred
>     -type for most use cases.
>     +type for all known use cases; the only limitation is that vhost-user client
>     +mode ports require QEMU version 2.7.  Ports of type vhost-user are currently
>     +deprecated and will be removed in a future release.
>      
>      .. _dpdk-vhost-user:
>      
>     @@ -68,7 +77,8 @@ vhost-user
>      
>      .. important::
>      
>     -   Use of vhost-user ports requires QEMU >= 2.2
>     +   Use of vhost-user ports requires QEMU >= 2.2;  vhost-user ports are
>     +   *deprecated*.
>      
>      To use vhost-user ports, you must first add said ports to the switch. DPDK
>      vhost-user ports can have arbitrary names with the exception of forward and
>     diff --git a/NEWS b/NEWS
>     index 82004c8..b81d033 100644
>     --- a/NEWS
>     +++ b/NEWS
>     @@ -16,6 +16,8 @@ Post-v2.7.0
>             Log level can be changed in a usual OVS way using
>             'ovs-appctl vlog' commands for 'dpdk' module. Lower bound
>             still can be configured via extra arguments for DPDK EAL.
>     +     * dpdkvhostuser ports are marked as deprecated.  They will be removed
>     +       in an upcoming release.
>         - IPFIX now provides additional counters:
>           * Total counters since metering process startup.
>           * Per-flow TCP flag counters.
>     diff --git a/lib/netdev-dpdk.c b/lib/netdev-dpdk.c
>     index b770b70..9ab4aeb 100644
>     --- a/lib/netdev-dpdk.c
>     +++ b/lib/netdev-dpdk.c
>     @@ -966,6 +966,8 @@ netdev_dpdk_vhost_construct(struct netdev *netdev)
>          err = vhost_common_construct(netdev);
>      
>          ovs_mutex_unlock(&dpdk_mutex);
>     +    VLOG_WARN_ONCE("dpdkvhostuser ports are considered deprecated;  "
>     +                   "please migrate to dpdkvhostuserclient ports.");
>          return err;
>      }
>      
>     -- 
>     2.9.4
>     
>     
> 
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Mark Kavanagh June 9, 2017, 8:42 a.m. UTC | #3
>From: ovs-dev-bounces@openvswitch.org [mailto:ovs-dev-bounces@openvswitch.org] On Behalf Of
>Ben Pfaff
>Sent: Thursday, June 8, 2017 10:34 PM
>To: Darrell Ball <dball@vmware.com>
>Cc: dev@openvswitch.org; Flavio Leitner <fbl@sysclose.org>
>Subject: Re: [ovs-dev] [PATCH v2] dpdk: announce deprecation of vhost-user server ports
>
>Thanks Aaron and Darrell, I applied this to master.
>
>On Thu, Jun 08, 2017 at 08:59:25PM +0000, Darrell Ball wrote:
>> Thanks for doing this.
>>
>> Acked-by: Darrell Ball <dlu998@gmail.com>
>>
>> On 6/8/17, 1:41 PM, "Aaron Conole" <aconole@redhat.com> wrote:
>>
>>     Since vhost-user server mode ports are the preferred mechanism for

I realize that this patch has already been applied, but I believe that this sentence should read 'Since vhost-user client mode ports are the preferred mechanism...".

I don't suppose it's possible to update the commit message at this stage?

Thanks,
Mark


>>     interconnecting Open vSwitch with VMs when using DPDK, and since there
>>     are currently no known use cases for vhost-user server mode ports apart
>>     from version incompatibilities with QEMU, announce that server mode ports
>>     are considered deprecated and will be removed in a future release.
>>
>>     v1->v2:
>>     * Verbiage changes as suggested by Kevin Traynor, and Darrell Ball.
>>
>>     Cc: Ciara Loftus <ciara.loftus@intel.com>
>>     Cc: Kevin Traynor <ktraynor@redhat.com>
>>     Suggested-by: Darrell Ball <dball@vmware.com>
>>     Signed-off-by: Aaron Conole <aconole@redhat.com>
>>     ---
>>     Previous version can be found at:
>>     https://urldefense.proofpoint.com/v2/url?u=https-
>3A__mail.openvswitch.org_pipermail_ovs-2Ddev_2017-
>2DJune_333609.html&d=DwIBAg&c=uilaK90D4TOVoH58JNXRgQ&r=BVhFA09CGX7JQ5Ih-
>uZnsw&m=M6rZdq8NlOfvmS7wgOavwyKNcKLJS2-
>FkF9vRM2DLS0&s=ALZOeECMUJeDQbpppAE_9VUn3QYYFLb9iK4sHzfzif4&e=
>>
>>      Documentation/topics/dpdk/vhost-user.rst | 26 ++++++++++++++++++--------
>>      NEWS                                     |  2 ++
>>      lib/netdev-dpdk.c                        |  2 ++
>>      3 files changed, 22 insertions(+), 8 deletions(-)
>>
>>     diff --git a/Documentation/topics/dpdk/vhost-user.rst
>b/Documentation/topics/dpdk/vhost-user.rst
>>     index a1c19fd..3b11c4d 100644
>>     --- a/Documentation/topics/dpdk/vhost-user.rst
>>     +++ b/Documentation/topics/dpdk/vhost-user.rst
>>     @@ -32,13 +32,20 @@ documentation`_ on same.
>>      Quick Example
>>      -------------
>>
>>     -This example demonstrates how to add two ``dpdkvhostuser`` ports to an existing
>>     -bridge called ``br0``::
>>     +This example demonstrates how to add two ``dpdkvhostuserclient`` ports to an
>>     +existing bridge called ``br0``::
>>
>>     -    $ ovs-vsctl add-port br0 dpdkvhostuser0 \
>>     -        -- set Interface dpdkvhostuser0 type=dpdkvhostuser
>>     -    $ ovs-vsctl add-port br0 dpdkvhostuser1 \
>>     -        -- set Interface dpdkvhostuser1 type=dpdkvhostuser
>>     +    $ ovs-vsctl add-port br0 dpdkvhostclient0 \
>>     +        -- set Interface dpdkvhostclient0 type=dpdkvhostuserclient \
>>     +           options:vhost-server-path=/tmp/dpdkvhostclient0
>>     +    $ ovs-vsctl add-port br0 dpdkvhostclient1 \
>>     +        -- set Interface dpdkvhostclient1 type=dpdkvhostuserclient \
>>     +           options:vhost-server-path=/tmp/dpdkvhostclient1
>>     +
>>     +For the above examples to work, an appropriate server socket must be created
>>     +at the paths specified (``/tmp/dpdkvhostclient0`` and
>>     +``/tmp/dpdkvhostclient0``).  These sockets can be created with QEMU; see the
>>     +:ref:`vhost-user client <dpdk-vhost-user-client>` section for details.
>>
>>      vhost-user vs. vhost-user-client
>>      --------------------------------
>>     @@ -59,7 +66,9 @@ means if OVS dies, all VMs **must** be restarted. On the other hand,
>for
>>      vhost-user-client ports, OVS acts as the client and QEMU the server. This means
>>      OVS can die and be restarted without issue, and it is also possible to restart
>>      an instance itself. For this reason, vhost-user-client ports are the preferred
>>     -type for most use cases.
>>     +type for all known use cases; the only limitation is that vhost-user client
>>     +mode ports require QEMU version 2.7.  Ports of type vhost-user are currently
>>     +deprecated and will be removed in a future release.
>>
>>      .. _dpdk-vhost-user:
>>
>>     @@ -68,7 +77,8 @@ vhost-user
>>
>>      .. important::
>>
>>     -   Use of vhost-user ports requires QEMU >= 2.2
>>     +   Use of vhost-user ports requires QEMU >= 2.2;  vhost-user ports are
>>     +   *deprecated*.
>>
>>      To use vhost-user ports, you must first add said ports to the switch. DPDK
>>      vhost-user ports can have arbitrary names with the exception of forward and
>>     diff --git a/NEWS b/NEWS
>>     index 82004c8..b81d033 100644
>>     --- a/NEWS
>>     +++ b/NEWS
>>     @@ -16,6 +16,8 @@ Post-v2.7.0
>>             Log level can be changed in a usual OVS way using
>>             'ovs-appctl vlog' commands for 'dpdk' module. Lower bound
>>             still can be configured via extra arguments for DPDK EAL.
>>     +     * dpdkvhostuser ports are marked as deprecated.  They will be removed
>>     +       in an upcoming release.
>>         - IPFIX now provides additional counters:
>>           * Total counters since metering process startup.
>>           * Per-flow TCP flag counters.
>>     diff --git a/lib/netdev-dpdk.c b/lib/netdev-dpdk.c
>>     index b770b70..9ab4aeb 100644
>>     --- a/lib/netdev-dpdk.c
>>     +++ b/lib/netdev-dpdk.c
>>     @@ -966,6 +966,8 @@ netdev_dpdk_vhost_construct(struct netdev *netdev)
>>          err = vhost_common_construct(netdev);
>>
>>          ovs_mutex_unlock(&dpdk_mutex);
>>     +    VLOG_WARN_ONCE("dpdkvhostuser ports are considered deprecated;  "
>>     +                   "please migrate to dpdkvhostuserclient ports.");
>>          return err;
>>      }
>>
>>     --
>>     2.9.4
>>
>>
>>
>> _______________________________________________
>> dev mailing list
>> dev@openvswitch.org
>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>_______________________________________________
>dev mailing list
>dev@openvswitch.org
>https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Gregory Rose June 9, 2017, 8:21 p.m. UTC | #4
On 06/09/2017 01:42 AM, Kavanagh, Mark B wrote:
> 
> 
>> From: ovs-dev-bounces@openvswitch.org [mailto:ovs-dev-bounces@openvswitch.org] On Behalf Of
>> Ben Pfaff
>> Sent: Thursday, June 8, 2017 10:34 PM
>> To: Darrell Ball <dball@vmware.com>
>> Cc: dev@openvswitch.org; Flavio Leitner <fbl@sysclose.org>
>> Subject: Re: [ovs-dev] [PATCH v2] dpdk: announce deprecation of vhost-user server ports
>>
>> Thanks Aaron and Darrell, I applied this to master.
>>
>> On Thu, Jun 08, 2017 at 08:59:25PM +0000, Darrell Ball wrote:
>>> Thanks for doing this.
>>>
>>> Acked-by: Darrell Ball <dlu998@gmail.com>
>>>
>>> On 6/8/17, 1:41 PM, "Aaron Conole" <aconole@redhat.com> wrote:
>>>
>>>      Since vhost-user server mode ports are the preferred mechanism for
> 
> I realize that this patch has already been applied, but I believe that this sentence should read 'Since vhost-user client mode ports are the preferred mechanism...".
> 
> I don't suppose it's possible to update the commit message at this stage?

That would be messing with the history... I don't think that's generally preferred.

- Greg

> 
> Thanks,
> Mark
> 
> 
>>>      interconnecting Open vSwitch with VMs when using DPDK, and since there
>>>      are currently no known use cases for vhost-user server mode ports apart
>>>      from version incompatibilities with QEMU, announce that server mode ports
>>>      are considered deprecated and will be removed in a future release.
>>>
>>>      v1->v2:
>>>      * Verbiage changes as suggested by Kevin Traynor, and Darrell Ball.
>>>
>>>      Cc: Ciara Loftus <ciara.loftus@intel.com>
>>>      Cc: Kevin Traynor <ktraynor@redhat.com>
>>>      Suggested-by: Darrell Ball <dball@vmware.com>
>>>      Signed-off-by: Aaron Conole <aconole@redhat.com>
>>>      ---
>>>      Previous version can be found at:
>>>      https://urldefense.proofpoint.com/v2/url?u=https-
>> 3A__mail.openvswitch.org_pipermail_ovs-2Ddev_2017-
>> 2DJune_333609.html&d=DwIBAg&c=uilaK90D4TOVoH58JNXRgQ&r=BVhFA09CGX7JQ5Ih-
>> uZnsw&m=M6rZdq8NlOfvmS7wgOavwyKNcKLJS2-
>> FkF9vRM2DLS0&s=ALZOeECMUJeDQbpppAE_9VUn3QYYFLb9iK4sHzfzif4&e=
>>>
>>>       Documentation/topics/dpdk/vhost-user.rst | 26 ++++++++++++++++++--------
>>>       NEWS                                     |  2 ++
>>>       lib/netdev-dpdk.c                        |  2 ++
>>>       3 files changed, 22 insertions(+), 8 deletions(-)
>>>
>>>      diff --git a/Documentation/topics/dpdk/vhost-user.rst
>> b/Documentation/topics/dpdk/vhost-user.rst
>>>      index a1c19fd..3b11c4d 100644
>>>      --- a/Documentation/topics/dpdk/vhost-user.rst
>>>      +++ b/Documentation/topics/dpdk/vhost-user.rst
>>>      @@ -32,13 +32,20 @@ documentation`_ on same.
>>>       Quick Example
>>>       -------------
>>>
>>>      -This example demonstrates how to add two ``dpdkvhostuser`` ports to an existing
>>>      -bridge called ``br0``::
>>>      +This example demonstrates how to add two ``dpdkvhostuserclient`` ports to an
>>>      +existing bridge called ``br0``::
>>>
>>>      -    $ ovs-vsctl add-port br0 dpdkvhostuser0 \
>>>      -        -- set Interface dpdkvhostuser0 type=dpdkvhostuser
>>>      -    $ ovs-vsctl add-port br0 dpdkvhostuser1 \
>>>      -        -- set Interface dpdkvhostuser1 type=dpdkvhostuser
>>>      +    $ ovs-vsctl add-port br0 dpdkvhostclient0 \
>>>      +        -- set Interface dpdkvhostclient0 type=dpdkvhostuserclient \
>>>      +           options:vhost-server-path=/tmp/dpdkvhostclient0
>>>      +    $ ovs-vsctl add-port br0 dpdkvhostclient1 \
>>>      +        -- set Interface dpdkvhostclient1 type=dpdkvhostuserclient \
>>>      +           options:vhost-server-path=/tmp/dpdkvhostclient1
>>>      +
>>>      +For the above examples to work, an appropriate server socket must be created
>>>      +at the paths specified (``/tmp/dpdkvhostclient0`` and
>>>      +``/tmp/dpdkvhostclient0``).  These sockets can be created with QEMU; see the
>>>      +:ref:`vhost-user client <dpdk-vhost-user-client>` section for details.
>>>
>>>       vhost-user vs. vhost-user-client
>>>       --------------------------------
>>>      @@ -59,7 +66,9 @@ means if OVS dies, all VMs **must** be restarted. On the other hand,
>> for
>>>       vhost-user-client ports, OVS acts as the client and QEMU the server. This means
>>>       OVS can die and be restarted without issue, and it is also possible to restart
>>>       an instance itself. For this reason, vhost-user-client ports are the preferred
>>>      -type for most use cases.
>>>      +type for all known use cases; the only limitation is that vhost-user client
>>>      +mode ports require QEMU version 2.7.  Ports of type vhost-user are currently
>>>      +deprecated and will be removed in a future release.
>>>
>>>       .. _dpdk-vhost-user:
>>>
>>>      @@ -68,7 +77,8 @@ vhost-user
>>>
>>>       .. important::
>>>
>>>      -   Use of vhost-user ports requires QEMU >= 2.2
>>>      +   Use of vhost-user ports requires QEMU >= 2.2;  vhost-user ports are
>>>      +   *deprecated*.
>>>
>>>       To use vhost-user ports, you must first add said ports to the switch. DPDK
>>>       vhost-user ports can have arbitrary names with the exception of forward and
>>>      diff --git a/NEWS b/NEWS
>>>      index 82004c8..b81d033 100644
>>>      --- a/NEWS
>>>      +++ b/NEWS
>>>      @@ -16,6 +16,8 @@ Post-v2.7.0
>>>              Log level can be changed in a usual OVS way using
>>>              'ovs-appctl vlog' commands for 'dpdk' module. Lower bound
>>>              still can be configured via extra arguments for DPDK EAL.
>>>      +     * dpdkvhostuser ports are marked as deprecated.  They will be removed
>>>      +       in an upcoming release.
>>>          - IPFIX now provides additional counters:
>>>            * Total counters since metering process startup.
>>>            * Per-flow TCP flag counters.
>>>      diff --git a/lib/netdev-dpdk.c b/lib/netdev-dpdk.c
>>>      index b770b70..9ab4aeb 100644
>>>      --- a/lib/netdev-dpdk.c
>>>      +++ b/lib/netdev-dpdk.c
>>>      @@ -966,6 +966,8 @@ netdev_dpdk_vhost_construct(struct netdev *netdev)
>>>           err = vhost_common_construct(netdev);
>>>
>>>           ovs_mutex_unlock(&dpdk_mutex);
>>>      +    VLOG_WARN_ONCE("dpdkvhostuser ports are considered deprecated;  "
>>>      +                   "please migrate to dpdkvhostuserclient ports.");
>>>           return err;
>>>       }
>>>
>>>      --
>>>      2.9.4
>>>
>>>
>>>
>>> _______________________________________________
>>> dev mailing list
>>> dev@openvswitch.org
>>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>> _______________________________________________
>> dev mailing list
>> dev@openvswitch.org
>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
diff mbox

Patch

diff --git a/Documentation/topics/dpdk/vhost-user.rst b/Documentation/topics/dpdk/vhost-user.rst
index a1c19fd..3b11c4d 100644
--- a/Documentation/topics/dpdk/vhost-user.rst
+++ b/Documentation/topics/dpdk/vhost-user.rst
@@ -32,13 +32,20 @@  documentation`_ on same.
 Quick Example
 -------------
 
-This example demonstrates how to add two ``dpdkvhostuser`` ports to an existing
-bridge called ``br0``::
+This example demonstrates how to add two ``dpdkvhostuserclient`` ports to an
+existing bridge called ``br0``::
 
-    $ ovs-vsctl add-port br0 dpdkvhostuser0 \
-        -- set Interface dpdkvhostuser0 type=dpdkvhostuser
-    $ ovs-vsctl add-port br0 dpdkvhostuser1 \
-        -- set Interface dpdkvhostuser1 type=dpdkvhostuser
+    $ ovs-vsctl add-port br0 dpdkvhostclient0 \
+        -- set Interface dpdkvhostclient0 type=dpdkvhostuserclient \
+           options:vhost-server-path=/tmp/dpdkvhostclient0
+    $ ovs-vsctl add-port br0 dpdkvhostclient1 \
+        -- set Interface dpdkvhostclient1 type=dpdkvhostuserclient \
+           options:vhost-server-path=/tmp/dpdkvhostclient1
+
+For the above examples to work, an appropriate server socket must be created
+at the paths specified (``/tmp/dpdkvhostclient0`` and
+``/tmp/dpdkvhostclient0``).  These sockets can be created with QEMU; see the
+:ref:`vhost-user client <dpdk-vhost-user-client>` section for details.
 
 vhost-user vs. vhost-user-client
 --------------------------------
@@ -59,7 +66,9 @@  means if OVS dies, all VMs **must** be restarted. On the other hand, for
 vhost-user-client ports, OVS acts as the client and QEMU the server. This means
 OVS can die and be restarted without issue, and it is also possible to restart
 an instance itself. For this reason, vhost-user-client ports are the preferred
-type for most use cases.
+type for all known use cases; the only limitation is that vhost-user client
+mode ports require QEMU version 2.7.  Ports of type vhost-user are currently
+deprecated and will be removed in a future release.
 
 .. _dpdk-vhost-user:
 
@@ -68,7 +77,8 @@  vhost-user
 
 .. important::
 
-   Use of vhost-user ports requires QEMU >= 2.2
+   Use of vhost-user ports requires QEMU >= 2.2;  vhost-user ports are
+   *deprecated*.
 
 To use vhost-user ports, you must first add said ports to the switch. DPDK
 vhost-user ports can have arbitrary names with the exception of forward and
diff --git a/NEWS b/NEWS
index 82004c8..b81d033 100644
--- a/NEWS
+++ b/NEWS
@@ -16,6 +16,8 @@  Post-v2.7.0
        Log level can be changed in a usual OVS way using
        'ovs-appctl vlog' commands for 'dpdk' module. Lower bound
        still can be configured via extra arguments for DPDK EAL.
+     * dpdkvhostuser ports are marked as deprecated.  They will be removed
+       in an upcoming release.
    - IPFIX now provides additional counters:
      * Total counters since metering process startup.
      * Per-flow TCP flag counters.
diff --git a/lib/netdev-dpdk.c b/lib/netdev-dpdk.c
index b770b70..9ab4aeb 100644
--- a/lib/netdev-dpdk.c
+++ b/lib/netdev-dpdk.c
@@ -966,6 +966,8 @@  netdev_dpdk_vhost_construct(struct netdev *netdev)
     err = vhost_common_construct(netdev);
 
     ovs_mutex_unlock(&dpdk_mutex);
+    VLOG_WARN_ONCE("dpdkvhostuser ports are considered deprecated;  "
+                   "please migrate to dpdkvhostuserclient ports.");
     return err;
 }