From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-pf0-f181.google.com (mail-pf0-f181.google.com [209.85.192.181]) by dpdk.org (Postfix) with ESMTP id AE0B07E7F for ; Wed, 9 May 2018 02:26:12 +0200 (CEST) Received: by mail-pf0-f181.google.com with SMTP id p12so24718069pff.13 for ; Tue, 08 May 2018 17:26:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=7xEJgwGZjL5AVWyvfd5jpnzPMGl1ujTGgwbqxAn30gU=; b=1TkLvtYrUZvL97/2mpGUhcuyh75FpuCLA5sdhw81omgD7ysjPugGExEXtkbS7DL+SA TPyxZ/WTUHs45CkK2XNDuVpOvpo7QFSw5Zd0+6BUFIzEYUH+92zqvdK9qnD4UIIh6Nev zuYHuDF/K4tzBjkNr5CftGq2CHHf6LWuUEsxRkgcJ1fNLR1sIkWsseBEx00lZtMpsMmQ 0yLopqW5lW0onXkJEnhmdJLYg5WpsE6pbCT3liZTHO9W9rYraOw+TKJIfNiFm27j3m5X ny0xf2O0mK418iFov2DAAFNY/Sx0CLsM9Tb/qdJYUuPOAu6DmDP48/8qYmoTDPYvXSUz qCPQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=7xEJgwGZjL5AVWyvfd5jpnzPMGl1ujTGgwbqxAn30gU=; b=RfIp03ACPzzErZpwXsnzY4iq/QzB5RhYJOw2jda8rsD9daLBdQeNxHHX3nsVXMmsZX sjhB9JbZddlqEXk9xiq0R8bp3mAEA8HZ7R0h16CTI41+PAZ3xffuzlC7/QdjE5XEpyp6 6cKn3mtBKFkO9e5h8XUZfLn7SWtsYygaWnM7VnYRzJsfCWzGnPxwWBheIyl1z0zrTzEh RPwJ6VF9PQ3sm/rX+E2QRTVf5oNOfXoxHUwXEtTQo2ew5MoHz2Z29DBd5A0BGetmikUN +egBO9Yfvv9rKDQv4ifqP4JbWXQKp8nR3wODozBsvbBz6A/YgZJtOJ4LSBWm74W6b63/ uVKg== X-Gm-Message-State: ALQs6tBkjHslfU7KDhhq/WuLWGXclE+jAz9d/CwHkpb55l3MZw5hL63Y RiBfUjLvxJLdYXbGBdeNp3Mm/AdpblU= X-Google-Smtp-Source: AB8JxZo2TLGmRroEluSVV8uWI+6Tsw2hU74XC7V3CTLIoCzVYy00LYI00UCaXHI3GfzhwUf/+m4S4w== X-Received: by 10.98.192.80 with SMTP id x77mr41752743pff.67.1525825571512; Tue, 08 May 2018 17:26:11 -0700 (PDT) Received: from xeon-e3.lan (204-195-35-107.wavecable.com. [204.195.35.107]) by smtp.gmail.com with ESMTPSA id f29sm52486712pff.169.2018.05.08.17.26.10 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 08 May 2018 17:26:10 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Date: Tue, 8 May 2018 17:26:04 -0700 Message-Id: <20180509002605.30996-4-stephen@networkplumber.org> X-Mailer: git-send-email 2.17.0 In-Reply-To: <20180509002605.30996-1-stephen@networkplumber.org> References: <20180509002605.30996-1-stephen@networkplumber.org> Subject: [dpdk-dev] [PATCH v6 3/4] net/netvsc: add documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 09 May 2018 00:26:13 -0000 From: Stephen Hemminger Matching documentation for new netvsc device. Signed-off-by: Stephen Hemminger --- doc/guides/nics/features/netvsc.ini | 23 ++++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/netvsc.rst | 98 ++++++++++++++++++++++++++ doc/guides/rel_notes/release_18_05.rst | 5 ++ 4 files changed, 127 insertions(+) create mode 100644 doc/guides/nics/features/netvsc.ini create mode 100644 doc/guides/nics/netvsc.rst diff --git a/doc/guides/nics/features/netvsc.ini b/doc/guides/nics/features/netvsc.ini new file mode 100644 index 000000000000..2ff6042bf47b --- /dev/null +++ b/doc/guides/nics/features/netvsc.ini @@ -0,0 +1,23 @@ +; +; Supported features of the 'netvsc' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Speed capabilities = P +Link status = Y +Queue start/stop = Y +Scattered Rx = Y +Promiscuous mode = Y +Allmulticast mode = Y +Basic stats = Y +Stats per queue = Y +Extended stats = Y +Multiprocess aware = Y +Other kdrv = Y +ARMv7 = Y +ARMv8 = Y +x86-32 = Y +x86-64 = Y +Usage doc = Y +MTU update = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index ddb9eb7a922e..d4eae2b8f046 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -33,6 +33,7 @@ Network Interface Controller Drivers mlx4 mlx5 mvpp2 + netvsc nfp octeontx qede diff --git a/doc/guides/nics/netvsc.rst b/doc/guides/nics/netvsc.rst new file mode 100644 index 000000000000..d469bd6dd78b --- /dev/null +++ b/doc/guides/nics/netvsc.rst @@ -0,0 +1,98 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) Microsoft Corporation. + +Netvsc (Hyper-V) poll mode driver +================================= + +Hyper-V is a hypervisor integrated into Window Server 2008, Windows 10 +and later versions. It supports a para-virtualized network interface +called netvsc that is visible on the virtual machine bus (VMBUS). In +the Data Plane Development Kit (DPDK), we provide a Network Virtual +Service Client (NetVSC) Poll Mode Driver (PMD). The NetVSC PMD +supports Windows Server 2016 and Microsoft Azure cloud. + +NetVSC Implementation in DPDK +----------------------------- + +The Netvsc PMD is a standalone driver. VMBus network devices that are +being used by DPDK must be unbound from the Linux kernel driver +(hv_netvsc) and bound to the Userspace IO driver for Hyper-V +(uio_hv_generic). + +This is most conveniently done with the +.. _`driverctl`: https://gitlab.com/driverctl/driverctl +script. + +To list all VMBus network devices: + + .. code-block:: console + + driverctl -b vmbus -v list-devices | grep netvsc + + +To override default kernel device with DPDK uio it is necessary to first determine the GUID associated with a particular existing Ethernet device then pass that to ``driverctl``. + + .. code-block:: console + + GUID=$(basename $(readlink /sys/class/net/eth1/device)) + driverctl -b vmbus set-override $GUID uio_hv_generic + + +The kernel must be version 4.18 or later to allow driver_override to work. +With older kernels ethernet must be rebound manually using sysfs bind and unbind. + + .. code-block:: console + + NET_GUID="f8615163-df3e-46c5-913f-f2d2f965ed0e" + DEV_GUID=$(basename $(readlink /sys/class/net/eth1/device)) + modprobe uio_hv_generic + echo $NET_GUID > /sys/bus/vmbus/drivers/uio_hv_generic/new_id + echo $DEV_GUID > /sys/bus/vmbus/drivers/hv_netvsc/unbind + echo $DEV_GUID > /sys/bus/vmbus/drivers/uio_hv_generic/bind + +.. Note:: + + The dpkd-devbind.py script should not be used. It only handles PCI devices. + + + +Features and Limitations of Hyper-V PMD +--------------------------------------- + +In this release, the hyper PMD driver provides the basic functionality of packet reception and transmission. + +* It supports merge-able buffers per packet when receiving packets and scattered buffer per packet + when transmitting packets. The packet size supported is from 64 to 65536. + +* It supports multicast packets and promiscuous mode. In order to this to work, the guest network + configuration on Hyper-V must be configured to allow this as well. + +* Hyper-V driver does not support MAC or VLAN filtering because the host does not support it. + The device has only a single MAC address. + +* VLAN tags are always stripped and presented in mbuf tci field. + +* The Hyper-V driver does not use or support Link State or Rx interrupt. + +* The maximum number of queues is limited by the host (currently 64). + When used with 4.16 kernel only a single queue is available. + +* This driver is intended for use with synthetic path only. + Accelerated Networking (SR-IOV) acceleration is not supported yet. + Use the VDEV_NETVSC device for accelerated networking instead. + + +Prerequisites +------------- + +The following prerequisites apply: + +* Linux kernel support for UIO on vmbus is done with the uio_hv_generic driver. + This driver was originally added in 4.14 kernel, but that version lacks necessary + features for networking. The 4.16 kernel will work but is limited to a single queue. + Supporting multiple queues (subchannels) required additional changes + which will be added in 4.18. + +* VMBus uses Universal Unique Identifiers (UUID) to identify devices. + Therefore the netvsc and vmbus drivers require the libuuid library + to be installed. diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst index 7187348520cf..ab6126dc3b66 100644 --- a/doc/guides/rel_notes/release_18_05.rst +++ b/doc/guides/rel_notes/release_18_05.rst @@ -183,6 +183,11 @@ New Features stats/xstats on shared memory from secondary process, and also pdump packets on those virtual devices. +* **Added experimental support for Hyper-V netvsc PMD.** + + The new experimntal ``netvsc`` poll mode driver provides native support for + networking on Hyper-V. See the :doc:`../nics/netvsc` nic driver guide + for more details on this new driver. API Changes ----------- -- 2.17.0