From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <john.mcnamara@intel.com>
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
 by dpdk.org (Postfix) with ESMTP id 2FDFB12A8
 for <dev@dpdk.org>; Thu, 24 Nov 2016 18:38:37 +0100 (CET)
Received: from fmsmga006.fm.intel.com ([10.253.24.20])
 by fmsmga105.fm.intel.com with ESMTP; 24 Nov 2016 09:38:36 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.31,543,1473145200"; d="scan'208";a="35278998"
Received: from irsmsx151.ger.corp.intel.com ([163.33.192.59])
 by fmsmga006.fm.intel.com with ESMTP; 24 Nov 2016 09:38:34 -0800
Received: from irsmsx111.ger.corp.intel.com (10.108.20.4) by
 IRSMSX151.ger.corp.intel.com (163.33.192.59) with Microsoft SMTP Server (TLS)
 id 14.3.248.2; Thu, 24 Nov 2016 17:38:34 +0000
Received: from irsmsx103.ger.corp.intel.com ([169.254.3.91]) by
 irsmsx111.ger.corp.intel.com ([169.254.2.55]) with mapi id 14.03.0248.002;
 Thu, 24 Nov 2016 17:38:33 +0000
From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Maxime Coquelin <maxime.coquelin@redhat.com>,
 "yuanhan.liu@linux.intel.com" <yuanhan.liu@linux.intel.com>,
 "thomas.monjalon@6wind.com" <thomas.monjalon@6wind.com>, "Yang, Zhiyong"
 <zhiyong.yang@intel.com>, "dev@dpdk.org" <dev@dpdk.org>
CC: "fbaudin@redhat.com" <fbaudin@redhat.com>
Thread-Topic: [PATCH] doc: introduce PVP reference benchmark
Thread-Index: AQHSRcyeZNRmFiTN8US7t0mllzrTNqDoZWEw
Date: Thu, 24 Nov 2016 17:38:32 +0000
Message-ID: <B27915DBBA3421428155699D51E4CFE20266939E@IRSMSX103.ger.corp.intel.com>
References: <20161123210006.7113-1-maxime.coquelin@redhat.com>
In-Reply-To: <20161123210006.7113-1-maxime.coquelin@redhat.com>
Accept-Language: en-GB, en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
x-ctpclassification: CTP_IC
x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNTY2ZDU0NjEtZjdkNS00ODY2LWFmZjQtNDY4Y2EzODNkOTM0IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IlZBNjVaZGIwQVRsdlNQUHpsOGJQbFFKbU42aXBMK3pMaUE2YmIrb2pxU2c9In0=
x-originating-ip: [163.33.239.182]
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Subject: Re: [dpdk-dev] [PATCH] doc: introduce PVP reference benchmark
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 24 Nov 2016 17:38:37 -0000

> -----Original Message-----
> From: Maxime Coquelin [mailto:maxime.coquelin@redhat.com]
> Sent: Wednesday, November 23, 2016 9:00 PM
> To: yuanhan.liu@linux.intel.com; thomas.monjalon@6wind.com; Mcnamara, Joh=
n
> <john.mcnamara@intel.com>; Yang, Zhiyong <zhiyong.yang@intel.com>;
> dev@dpdk.org
> Cc: fbaudin@redhat.com; Maxime Coquelin <maxime.coquelin@redhat.com>
> Subject: [PATCH] doc: introduce PVP reference benchmark
>=20
> Having reference benchmarks is important in order to obtain reproducible
> performance figures.
>=20
> This patch describes required steps to configure a PVP setup using testpm=
d
> in both host and guest.
>=20
> Not relying on external vSwitch ease integration in a CI loop by not bein=
g
> impacted by DPDK API changes.

Hi Maxime,

Thanks for the detailed doc and this initiative. Some minor documentation
comments below.



> +
> +Setup overview
> +..............

This level header should be ---------, even if it looks like dots in the
contribution guide:

    http://dpdk.org/doc/guides/contributing/documentation.html#section-head=
ers


> +
> +.. figure:: img/pvp_2nics.svg
> +
> +  PVP setup using 2 NICs
> +

The figure needs a target so it can be used with :numref:, like this:

.. _figure_pvp_2nics:

.. figure:: img/pvp_2nics.*

   PVP setup using 2 NICs


> +DPDK build
> +~~~~~~~~~~
> +

Put a one line description at the start of each section, even if it is just=
: Build DPDK:



> +Testpmd launch
> +~~~~~~~~~~~~~~
> +
> +#. Assign NICs to DPDK:
> +
> +   .. code-block:: console
> +
> +    modprobe vfio-pci
> +    $RTE_SDK/install/sbin/dpdk-devbind -b vfio-pci 0000:11:00.0
> + 0000:11:00.1
> +
> +*Note: Sandy Bridge family seems to have some limitations wrt its
> +IOMMU, giving poor performance results. To achieve good performance on
> +these machines, consider using UIO instead.*

This would be better as an RST note:

#. Assign NICs to DPDK:

   .. code-block:: console

      modprobe vfio-pci
      $RTE_SDK/install/sbin/dpdk-devbind -b vfio-pci 0000:11:00.0 0000:11:0=
0.1

   .. Note::

      The Sandy Bridge family seems to have some IOMMU limitations giving p=
oor
      performance results. To achieve good performance on these machines
      consider using UIO instead.



> +First, SELinux policy needs to be set to permissiven, as testpmd is run
> +as root (reboot required):

s/permissiven/permissive/


There are a couple of trailing whitespace errors as well at build as well.


John