From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-pf0-f179.google.com (mail-pf0-f179.google.com [209.85.192.179]) by dpdk.org (Postfix) with ESMTP id 28E1B8E71 for ; Fri, 27 Apr 2018 00:57:44 +0200 (CEST) Received: by mail-pf0-f179.google.com with SMTP id a11so1512159pfn.9 for ; Thu, 26 Apr 2018 15:57:44 -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=O0wgo6TU5Ze52eOSdqCuOn9LaQ76WveRMq+QRYqtMAI=; b=NZNkWqZJishTrcBUBppFZhyQszs0v62KASQD072vg38W+4yJEA+OtRr270BsrSHSzp +qBh7S1vHCYU2YDqE2D/8O2XSvczQTwpFQV/xsN6GXedfvFaTJeALVARQIMdjr8IU0/t kg9k5bH8KQGLrlHS4HDrDIpnjtDyZ4rq8g23D1uMJ/7HZQOJH7AEJLtWj23IqaCwmtUc AxGH4HQkZhBm9kyQEpgmNFlbtpeua0bLACtfhN/12uhDWjv4DqPOw63aDcU1raWAS/M/ mLNTVRvqSJJAmeIQu3sWKYts/9eCn8sgHGFMRjm9X7HOQYl07xS7/IEUdM2NSt+0aEDC 3SdQ== 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=O0wgo6TU5Ze52eOSdqCuOn9LaQ76WveRMq+QRYqtMAI=; b=P05y+tvbQZlt1/M6DQPKuze+atHklez13WnViAux90amD4Jp+oeMNYWvSe3xY5BX6+ eKhQlxSYTns6JHE/9w/OZuBqv/fojimg1cUFocGaXma0CmKpPCNEq1KC7HvcvSQNtanH kHZxpOdsB8uFiyo34pwnT6xwhp8Qv5/Y5ljD4L6faLHhdl9BcCgMgqtaz0efkg8kJtKs 7VSTQht9HMm9SPCR/dKDH0jWEYurMBURLX95fzrURTR5yMSzhYbsB1RE/MV/XVmVxr7G GVcGtDSsACK6lVnGrGkVXHbgkYDPTBamF6w1NvNvECJd7/i+0TEfn6lDgwHizZARHWAK RJ0w== X-Gm-Message-State: ALQs6tAWQaQjcBGMRGMYbHA54t8z3y3a83C6LNY4LURschojSYwHQIBy Xxy4ibVeLF3wg7svuYuPGZbPWppqHJ4= X-Google-Smtp-Source: AIpwx48j3SwUA+IAj0PqVF3hvDA+32j6+yvEG9ZqQgKiqiy4dEatLkBnMdJev4FDAxqoSfwWSQn4Yw== X-Received: by 2002:a17:902:6006:: with SMTP id r6-v6mr35067345plj.70.1524783462839; Thu, 26 Apr 2018 15:57:42 -0700 (PDT) Received: from xeon-e3.lan (204-195-71-95.wavecable.com. [204.195.71.95]) by smtp.gmail.com with ESMTPSA id e4sm41667791pfa.128.2018.04.26.15.57.41 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 26 Apr 2018 15:57:42 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Date: Thu, 26 Apr 2018 15:57:35 -0700 Message-Id: <20180426225736.20295-4-stephen@networkplumber.org> X-Mailer: git-send-email 2.17.0 In-Reply-To: <20180426225736.20295-1-stephen@networkplumber.org> References: <20180426225736.20295-1-stephen@networkplumber.org> Subject: [dpdk-dev] [PATCH v5 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: Thu, 26 Apr 2018 22:57:44 -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 | 97 ++++++++++++++++++++++++++ doc/guides/rel_notes/release_18_05.rst | 5 ++ 4 files changed, 126 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 ea9110c81159..c5d19476bf68 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -32,6 +32,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..1b7f0333fd52 --- /dev/null +++ b/doc/guides/nics/netvsc.rst @@ -0,0 +1,97 @@ +.. 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 VMBusus 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 5.0 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 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 were added in 5.0. + +* 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 f93141b57f89..c4e3ef033088 100644 --- a/doc/guides/rel_notes/release_18_05.rst +++ b/doc/guides/rel_notes/release_18_05.rst @@ -149,6 +149,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