[dpdk-dev,v2] doc:Add performance test guide about how to get DPDK high perf on Intel platform

Message ID 82F45D86ADE5454A95A89742C8D1410E01DDC0AF@shsmsx102.ccr.corp.intel.com
State Not Applicable, archived
Headers show

Commit Message

Xu, Qian Q Sept. 16, 2015, 2:45 a.m.
Thomas
Could you help check my doc patch, and let me know anything needed for the merge? I think it would be very helpful for the users to get high performance with step-by-step guide. Thx. 

Thanks
Qian


-----Original Message-----
From: Xu, Qian Q 

Sent: Thursday, August 13, 2015 11:20 AM
To: dev@dpdk.org
Cc: Xu, Qian Q
Subject: [dpdk-dev][PATCH v2]doc:Add performance test guide about how to get DPDK high perf on Intel platform

v2 changes: 
1. Create a svg picture.
2. Add part about how to check memory channel by dmidecode -t memory.
3. Add the command about how to check PCIe slot's speed.
4. Some doc updates according to the comments.
 
 Add a new guide doc under guides folder. This document is a  step-by-step guide about how to get high performance with DPDK on Intel's  platform and NICs. It is designed for users who are not familiar with DPDK  but would like to measure the best performance. It contains step-by-step  instructions to set the platform and NICs to its best performance. The  document will add more sections with the DPDK features' increment.

Signed-off-by: Qian Xu <qian.q.xu@intel.com>


+* Set the protocols to IPV4.
+* Do not set any L4 protocols, just keep it as none.**Note**: this is very important, if you set UDP or TCP protocol, you may get relative low performance since the l3fwd example default using none protocols for RSS enabling. 
+* The flow's DEST MAC, DEST IP, SRC IP's settings can be seen in the above figure. It's for the user's reference. Set the correct destination IP address according to "ipv4_l3fwd_route_array" in the l3fwd example code, such as 2.1.1.1 for port0, then it will forward the packets to port1. Set the source IP as random, **Note**: this is very important to make sure the packets will be received in multiple queues.
+
+
--
2.1.0

Comments

Thomas Monjalon Sept. 16, 2015, 8:21 a.m. | #1
Hi,

2015-09-16 02:45, Xu, Qian Q:
> Thomas
> Could you help check my doc patch, and let me know anything needed for
> the merge? I think it would be very helpful for the users to get high
> performance with step-by-step guide. Thx.

Yes it is useful.
John and Siobhan are the maintainers for the doc.

> --- /dev/null
> +++ b/doc/guides/perf_test_guide/index.rst

Why creating a new guide?
Can it be included as a chapter of the Linux user guide?

> +    Copyright(c) 2010-2015 Intel Corporation. All rights reserved.

The dates seem wrong.

> +This document is a step-by-step guide about how to get high performance with DPDK on Intel's platform and NICs.

OK to focus on Intel platform (must be reflected in the file name),
but it should be open to other NICs.
It was already commented in previous version:
	http://dpdk.org/ml/archives/dev/2015-August/022704.html

> +This document is a step-by-step guide for getting high DPDK performance with Intel's platform and NICs. For other NICs, e.g. Chelsio, Cisco, Mellanox, the Intel platform/CPU settings could be very similar, but the specific NIC's configurations may differ from each vendor.

Not needed
If something is needed for other NICs, other people will add it.

> +1. Get an high end Intel® NIC,

Intel can be removed here.

> e.g: Intel® XL710. Note: Get an high end NIC means getting a high packet rate, since currently 1G and 10G NICs can achieve line rate easily, but 40G NIC would be more complicated, so take it as an example. 

Yes the Intel NIC is an example.
Mcnamara, John Sept. 16, 2015, 10:43 a.m. | #2
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Wednesday, September 16, 2015 9:22 AM
> To: Xu, Qian Q
> Cc: dev@dpdk.org; Jayakumar, Muthurajan; Mcnamara, John
> Subject: Re: [dpdk-dev][PATCH v2]doc:Add performance test guide about how
> to get DPDK high perf on Intel platform
> 
> Hi,
> 
> 2015-09-16 02:45, Xu, Qian Q:
> > Thomas
> > Could you help check my doc patch, and let me know anything needed for
> > the merge? I think it would be very helpful for the users to get high
> > performance with step-by-step guide. Thx.
> 
> Yes it is useful.
> John and Siobhan are the maintainers for the doc.

Hi Qian,

The idea is good and a performance tuning guide would be very useful. I think that it could be structured a little differently to keep the Intel/non-Intel information separate and allow other maintainers to contribute sections.


> > --- /dev/null
> > +++ b/doc/guides/perf_test_guide/index.rst
> 
> Why creating a new guide?
> Can it be included as a chapter of the Linux user guide?

I think the subject is probably distinct enough to merit its own guide and it is more of an advanced topic than a getting started topic.

+1 on the other comments.

John.
--
Thomas Monjalon Sept. 16, 2015, 1:01 p.m. | #3
2015-09-16 10:43, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > --- /dev/null
> > > +++ b/doc/guides/perf_test_guide/index.rst
> > 
> > Why creating a new guide?
> > Can it be included as a chapter of the Linux user guide?
> 
> I think the subject is probably distinct enough to merit its own
> guide and it is more of an advanced topic than a getting started topic.

I think we should avoid creating too many guides.
This chapter is about using DPDK in Linux. Yes it is a bit more advanced
than the Linux QSG. So why not creating an advanced section?
Xu, Qian Q Sept. 17, 2015, 1:16 a.m. | #4
Thomas/John
Thanks a lot for your comments, and I will update the patch soon. 

Thanks
Qian

-----Original Message-----
From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com] 
Sent: Wednesday, September 16, 2015 9:01 PM
To: Mcnamara, John
Cc: Xu, Qian Q; dev@dpdk.org; Jayakumar, Muthurajan
Subject: Re: [dpdk-dev][PATCH v2]doc:Add performance test guide about how to get DPDK high perf on Intel platform

2015-09-16 10:43, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > --- /dev/null
> > > +++ b/doc/guides/perf_test_guide/index.rst
> > 
> > Why creating a new guide?
> > Can it be included as a chapter of the Linux user guide?
> 
> I think the subject is probably distinct enough to merit its own guide 
> and it is more of an advanced topic than a getting started topic.

I think we should avoid creating too many guides.
This chapter is about using DPDK in Linux. Yes it is a bit more advanced than the Linux QSG. So why not creating an advanced section?

Patch

diff --git a/doc/guides/perf_test_guide/img/intel_perf_test_setup.svg b/doc/guides/perf_test_guide/img/intel_perf_test_setup.svg
new file mode 100644
index 0000000..40bb189
--- /dev/null
+++ b/doc/guides/perf_test_guide/img/intel_perf_test_setup.svg
@@ -0,0 +1,467 @@ 
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="744.09448819"
+   height="1052.3622047"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.48.5 r10040"
+   sodipodi:docname="perf_test_setup.svg">
+  <defs
+     id="defs4">
+    <marker
+       inkscape:stockid="Arrow1Lstart"
+       orient="auto"
+       refY="0.0"
+       refX="0.0"
+       id="Arrow1Lstart"
+       style="overflow:visible">
+      <path
+         id="path4045"
+         d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z "
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1.0pt"
+         transform="scale(0.8) translate(12.5,0)" />
+    </marker>
+    <marker
+       inkscape:stockid="Arrow1Lend"
+       orient="auto"
+       refY="0.0"
+       refX="0.0"
+       id="Arrow1Lend"
+       style="overflow:visible;">
+      <path
+         id="path4048"
+         d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z "
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1.0pt;"
+         transform="scale(0.8) rotate(180) translate(12.5,0)" />
+    </marker>
+    <inkscape:path-effect
+       effect="spiro"
+       id="path-effect4008"
+       is_visible="true" />
+    <inkscape:path-effect
+       effect="spiro"
+       id="path-effect4004"
+       is_visible="true" />
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.5"
+     inkscape:cx="-354.66509"
+     inkscape:cy="529.07915"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="1600"
+     inkscape:window-height="838"
+     inkscape:window-x="-8"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1" />
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1">
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.52869576px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect2987"
+       width="436.71008"
+       height="872.96399"
+       x="286.5914"
+       y="30.066055" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.61013061px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect2989"
+       width="193.05334"
+       height="295.96216"
+       x="286.1077"
+       y="122.3366" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.61014843px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect2989-1"
+       width="193.06462"
+       height="295.96216"
+       x="286.20444"
+       y="501.86459" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.54288393px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect3011"
+       width="30.955555"
+       height="79.586464"
+       x="286.88156"
+       y="178.79324" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.54288393px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect3011-7"
+       width="30.955555"
+       height="79.586464"
+       x="285.62402"
+       y="547.37811" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.54288393px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect3011-4"
+       width="30.955555"
+       height="79.586464"
+       x="286.5914"
+       y="311.10574" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.54288393px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect3011-0"
+       width="30.955555"
+       height="79.586464"
+       x="285.62402"
+       y="686.65436" />
+    <text
+       xml:space="preserve"
+       style="font-size:27.61001205px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="44.773964"
+       y="49.478931"
+       id="text3824"
+       sodipodi:linespacing="125%"
+       transform="scale(0.79295644,1.2611033)"><tspan
+         sodipodi:role="line"
+         id="tspan3826"
+         x="44.773964"
+         y="49.478931">Flow1</tspan><tspan
+         sodipodi:role="line"
+         x="44.773964"
+         y="83.991447"
+         id="tspan3828">DEST MAC=Port0's MAC</tspan><tspan
+         sodipodi:role="line"
+         x="44.773964"
+         y="118.50397"
+         id="tspan3830">DEST IP=2.1.1.1</tspan><tspan
+         sodipodi:role="line"
+         x="44.773964"
+         y="153.01648"
+         id="tspan3832">SRC IP: Random</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:41.80629349px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="-1202.5238"
+       y="120.52851"
+       id="text3834"
+       sodipodi:linespacing="125%"
+       transform="scale(1.0056177,0.99441368)"><tspan
+         sodipodi:role="line"
+         id="tspan3836"
+         x="-1202.5238"
+         y="120.52851" /></text>
+    <text
+       xml:space="preserve"
+       style="font-size:19.98498726px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="519.69171"
+       y="135.73935"
+       id="text3838"
+       sodipodi:linespacing="125%"
+       transform="scale(0.57396666,1.7422615)"><tspan
+         sodipodi:role="line"
+         id="tspan3840"
+         x="519.69171"
+         y="135.73935">0</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:21.71535683px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="475.04053"
+       y="373.95227"
+       id="text3842"
+       sodipodi:linespacing="125%"
+       transform="scale(0.62366259,1.6034311)"><tspan
+         sodipodi:role="line"
+         id="tspan3844"
+         x="475.04053"
+         y="373.95227">1</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:41.80629349px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="-1190.5791"
+       y="284.76752"
+       id="text3846"
+       sodipodi:linespacing="125%"
+       transform="scale(1.0056177,0.99441368)"><tspan
+         sodipodi:role="line"
+         id="tspan3848"
+         x="-1190.5791"
+         y="284.76752" /></text>
+    <text
+       xml:space="preserve"
+       style="font-size:21.71535683px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="475.04053"
+       y="226.59804"
+       id="text3850"
+       sodipodi:linespacing="125%"
+       transform="scale(0.62366259,1.6034311)"><tspan
+         sodipodi:role="line"
+         id="tspan3852"
+         x="475.04053"
+         y="226.59804">X</tspan><tspan
+         sodipodi:role="line"
+         x="475.04053"
+         y="253.74225"
+         id="tspan3854" /></text>
+    <text
+       xml:space="preserve"
+       style="font-size:21.71535683px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="475.04059"
+       y="460.81369"
+       id="text3856"
+       sodipodi:linespacing="125%"
+       transform="scale(0.62366259,1.6034311)"><tspan
+         sodipodi:role="line"
+         id="tspan3858"
+         x="475.04059"
+         y="460.81369">X</tspan><tspan
+         sodipodi:role="line"
+         x="475.04059"
+         y="487.95789"
+         id="tspan3860" /></text>
+    <text
+       xml:space="preserve"
+       style="font-size:28.38339043px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="25.804567"
+       y="356.3833"
+       id="text3824-9"
+       sodipodi:linespacing="125%"
+       transform="scale(0.81516779,1.2267413)"><tspan
+         sodipodi:role="line"
+         id="tspan3826-4"
+         x="25.804567"
+         y="356.3833">Flow2</tspan><tspan
+         sodipodi:role="line"
+         x="25.804567"
+         y="391.86255"
+         id="tspan3828-8">DEST MAC=Port1's MAC</tspan><tspan
+         sodipodi:role="line"
+         x="25.804567"
+         y="427.3418"
+         id="tspan3830-8">DEST IP=1.1.1.1</tspan><tspan
+         sodipodi:role="line"
+         x="25.804567"
+         y="462.82101"
+         id="tspan3832-2">SRC IP: Random</tspan></text>
+    <rect
+       style="fill:none"
+       id="rect3892"
+       width="34.824997"
+       height="499.90247"
+       x="119.23791"
+       y="159.39406" />
+    <rect
+       style="fill:none"
+       id="rect3894"
+       width="48.368057"
+       height="711.30408"
+       x="27.338594"
+       y="27.578979" />
+    <rect
+       style="fill:none"
+       id="rect3896"
+       width="34.824997"
+       height="198.96616"
+       x="36.044872"
+       y="144.47159" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.59728765px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect2989-4"
+       width="79.467979"
+       height="689.0376"
+       x="6.0566335"
+       y="155.66344" />
+    <text
+       xml:space="preserve"
+       style="font-size:39.17754364px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="8.2557735"
+       y="429.93115"
+       id="text3916"
+       sodipodi:linespacing="125%"
+       transform="scale(1.1251746,0.88875095)"><tspan
+         sodipodi:role="line"
+         x="8.2557735"
+         y="429.93115"
+         id="tspan3922">Ixia </tspan></text>
+    <rect
+       style="fill:none"
+       id="rect3924"
+       width="19.347221"
+       height="101.97016"
+       x="51.522629"
+       y="266.33835" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.54288393px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect3011-5"
+       width="30.955555"
+       height="79.586464"
+       x="54.424698"
+       y="194.21313" />
+    <rect
+       style="fill:none;stroke:#000000;stroke-width:0.54288393px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect3011-51"
+       width="30.955555"
+       height="79.586464"
+       x="54.424698"
+       y="562.30054" />
+    <text
+       xml:space="preserve"
+       style="font-size:19.98498726px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="117.97987"
+       y="142.79948"
+       id="text3838-7"
+       sodipodi:linespacing="125%"
+       transform="scale(0.57396667,1.7422615)"><tspan
+         sodipodi:role="line"
+         id="tspan3840-1"
+         x="117.97987"
+         y="142.79948">A</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:21.71535683px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="102.77721"
+       y="384.80991"
+       id="text3972"
+       sodipodi:linespacing="125%"
+       transform="scale(0.62366259,1.6034311)"><tspan
+         sodipodi:role="line"
+         id="tspan3974"
+         x="102.77721"
+         y="384.80991">B</tspan></text>
+    <path
+       style="fill:none;stroke:#c80000;stroke-width:1.08576787;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-start:url(#Arrow1Lstart)"
+       d="m 86.34764,240.47278 258.24651,-2.48709"
+       id="path3978"
+       inkscape:connector-type="polyline"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;stroke:#c80000;stroke-width:1.08576787;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#Arrow1Lend)"
+       d="M 85.863957,585.92775 339.48185,583.44067"
+       id="path3978-1"
+       inkscape:connector-type="polyline"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;stroke:#c80000;stroke-width:1.08576787;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-start:url(#Arrow1Lstart)"
+       d="m 342.69833,237.30174 0.96736,344.8954"
+       id="path4010"
+       inkscape:connector-type="polyline"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;stroke:#000000;stroke-width:1.08576787;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-mid:url(#Arrow1Lend);marker-end:url(#Arrow1Lend)"
+       d="M 87.79868,202.42049 355.75769,199.9334"
+       id="path3978-5"
+       inkscape:connector-type="polyline"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;stroke:#000000;stroke-width:1.08576787;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-start:url(#Arrow1Lstart);marker-end:none"
+       d="M 86.831324,618.25975 354.79034,615.77267"
+       id="path3978-2"
+       inkscape:connector-type="polyline"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;stroke:#000000;stroke-width:1.08576787;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#Arrow1Lend)"
+       d="m 357.01527,201.518 1.93472,410.52405"
+       id="path4039"
+       inkscape:connector-type="polyline"
+       inkscape:connector-curvature="0" />
+    <text
+       xml:space="preserve"
+       style="font-size:28.71281624px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="449.70712"
+       y="551.78284"
+       id="text6681-7"
+       sodipodi:linespacing="125%"
+       transform="scale(0.76524807,1.3067658)"><tspan
+         sodipodi:role="line"
+         id="tspan6683-6"
+         x="449.70712"
+         y="551.78284">40G Ethernet</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:32.53250122px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="321.67871"
+       y="854.98248"
+       id="text6685-1"
+       sodipodi:linespacing="125%"
+       transform="scale(1.1085535,0.90207643)"><tspan
+         sodipodi:role="line"
+         id="tspan6687-4"
+         x="321.67871"
+         y="854.98248">XL710</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:27.69332314px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="825.4895"
+       y="313.36813"
+       id="text6731"
+       sodipodi:linespacing="125%"
+       transform="scale(0.69116553,1.4468314)"><tspan
+         sodipodi:role="line"
+         id="tspan6733"
+         x="825.4895"
+         y="313.36813">IA Platform</tspan><tspan
+         sodipodi:role="line"
+         x="825.4895"
+         y="347.9848"
+         id="tspan6735">Socket1</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:37.97121811px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="364.99954"
+       y="796.67743"
+       id="text6737"
+       sodipodi:linespacing="125%"
+       transform="scale(0.84539779,1.1828751)"><tspan
+         sodipodi:role="line"
+         id="tspan6739"
+         x="364.99954"
+         y="796.67743">Port0 --&gt; Port1</tspan><tspan
+         sodipodi:role="line"
+         x="364.99954"
+         y="844.14148"
+         id="tspan6741">Port1 --&gt; Port0</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:32.53250122px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="327.09131"
+       y="430.92755"
+       id="text6685-1-2"
+       sodipodi:linespacing="125%"
+       transform="scale(1.1085535,0.90207644)"><tspan
+         sodipodi:role="line"
+         id="tspan6687-4-3"
+         x="327.09131"
+         y="430.92755">XL710</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:28.71281624px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="447.63882"
+       y="255.43315"
+       id="text6681-7-2"
+       sodipodi:linespacing="125%"
+       transform="scale(0.76524807,1.3067658)"><tspan
+         sodipodi:role="line"
+         id="tspan6683-6-2"
+         x="447.63882"
+         y="255.43315">40G Ethernet</tspan></text>
+  </g>
+</svg>
diff --git a/doc/guides/perf_test_guide/index.rst b/doc/guides/perf_test_guide/index.rst
new file mode 100644
index 0000000..25c8ee9
--- /dev/null
+++ b/doc/guides/perf_test_guide/index.rst
@@ -0,0 +1,47 @@ 
+..  BSD LICENSE
+    Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of Intel Corporation nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Performance test guide on Intel's Platform 
+==========================================
+
+|today|
+
+Contents
+
+.. toctree::
+    :maxdepth: 2
+    :numbered:
+
+    intro
+    perf_test_intel_platform_nic
+    
+    
+    
+    
diff --git a/doc/guides/perf_test_guide/intro.rst b/doc/guides/perf_test_guide/intro.rst
new file mode 100644
index 0000000..471d15e
--- /dev/null
+++ b/doc/guides/perf_test_guide/intro.rst
@@ -0,0 +1,40 @@ 
+..  BSD LICENSE
+    Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of Intel Corporation nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Introduction
+============
+
+This document is a step-by-step guide about how to get high performance with DPDK on Intel's platform and NICs.
+It is designed for users who are not familiar with DPDK but would like 
+to measure the best performance. It contains step-by-step instructions to set the platform and NICs to its best performance.
+The document will add more sections with the DPDK features' increment. 
+Currently, the document has only one section about PF performance test setup, and will add other performance cases in future. 
+
+
diff --git a/doc/guides/perf_test_guide/perf_test_intel_platform_nic.rst b/doc/guides/perf_test_guide/perf_test_intel_platform_nic.rst
new file mode 100644
index 0000000..4320f13
--- /dev/null
+++ b/doc/guides/perf_test_guide/perf_test_intel_platform_nic.rst
@@ -0,0 +1,220 @@ 
+How to get best performance with Intel's Platform and NICs 
+==========================================================
+
+This document is a step-by-step guide for getting high DPDK performance with Intel's platform and NICs. For other NICs, e.g. Chelsio, Cisco, Mellanox, the Intel platform/CPU settings could be very similar, but the specific NIC's configurations may differ from each vendor.
+
+Prerequisites
+-------------
+
+Hardware platform essential requirements:
+
+1. Use a standard Intel® Xeon® server system (e.g. Ivy Bridge, Haswell or newer).
+
+2. Ensure that each memory channel has at least one memory DIMM inserted, and the memory size for each can be 4GB or above (e.g: 8GB or 16GB). **Note**: This is one important element to impact the performance.You can use ``dmidecode -t memory`` to check the memory status::
+
+      dmidecode -t memory |grep Locator
+      
+      #sample output is as below, and there are memory channels from A to H, totally 8 channels and each channel has 2 DIMMs. 
+        
+        Locator: DIMM_A1
+        Bank Locator: NODE 1
+        Locator: DIMM_A2
+        Bank Locator: NODE 1
+        Locator: DIMM_B1
+        Bank Locator: NODE 1
+        Locator: DIMM_B2
+        Bank Locator: NODE 1
+        Locator: DIMM_C1
+        Bank Locator: NODE 1
+        Locator: DIMM_C2
+        Bank Locator: NODE 1
+        Locator: DIMM_D1
+        Bank Locator: NODE 1
+        Locator: DIMM_D2
+        Bank Locator: NODE 1
+        Locator: DIMM_E1
+        Bank Locator: NODE 2
+        Locator: DIMM_E2
+        Bank Locator: NODE 2
+        Locator: DIMM_F1
+        Bank Locator: NODE 2
+        Locator: DIMM_F2
+        Bank Locator: NODE 2
+        Locator: DIMM_G1
+        Bank Locator: NODE 2
+        Locator: DIMM_G2
+        Bank Locator: NODE 2
+        Locator: DIMM_H1
+        Bank Locator: NODE 2
+        Locator: DIMM_H2
+        Bank Locator: NODE 2
+
+      dmidecode -t memory |grep Speed
+      
+      #sample output is as below. It shows Speed 2133 MHz(DDR4) and Unknown(not exist) alternatively.
+      then align with the above channel's information, we can know each channel has one memory bar.
+        
+        Speed: 2133 MHz
+        Configured Clock Speed: 2134 MHz
+        Speed: Unknown
+        Configured Clock Speed: Unknown
+        Speed: 2133 MHz
+        Configured Clock Speed: 2134 MHz
+        Speed: Unknown
+        Configured Clock Speed: Unknown
+        Speed: 2133 MHz
+        Configured Clock Speed: 2134 MHz
+        Speed: Unknown
+        Configured Clock Speed: Unknown
+        Speed: 2133 MHz
+        Configured Clock Speed: 2134 MHz
+        Speed: Unknown
+        Configured Clock Speed: Unknown
+        Speed: 2133 MHz
+        Configured Clock Speed: 2134 MHz
+        Speed: Unknown
+        Configured Clock Speed: Unknown
+        Speed: 2133 MHz
+        Configured Clock Speed: 2134 MHz
+        Speed: Unknown
+        Configured Clock Speed: Unknown
+        Speed: 2133 MHz
+        Configured Clock Speed: 2134 MHz
+        Speed: Unknown
+        Configured Clock Speed: Unknown
+        Speed: 2133 MHz
+        Configured Clock Speed: 2134 MHz
+        Speed: Unknown
+        Configured Clock Speed: Unknown
+
+
+Hardware platform Network Interface Card Essential requirements:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Get an high end Intel® NIC, e.g: Intel® XL710. Note: Get an high end NIC means getting a high packet rate, since currently 1G and 10G NICs can achieve line rate easily, but 40G NIC would be more complicated, so take it as an example. 
+
+2. Make sure each NIC has flashed the latest version of NVM/firmware, if there is.
+
+3. Use PCIe Gen3 slots, such as Gen3 x8 or Gen3 x16 because PCIe Gen2 slots can't provide enough bandwidth for 2x10G and above.The way to check the PCI slot's speed can be like below:: 
+
+      #lspci -s 03:00.1 -vv |grep LnkSta
+      #LnkSta: Speed 8GT/s, Width x8, TrErr- Train- SlotClk+ DLActive- BWMgmt- ABWMgmt-
+       LnkSta2: Current De-emphasis Level: -6dB, EqualizationComplete+, 
+ EqualizationPhase1+
+
+4. When inserting NICs to the PCI slots, please check the caption on the PCI slot, there would be CPU0 or CPU1 to tell you which socket. Or you can search and download Intel platform board layout in website mark.intel.com. Be careful about the NUMA. If you will use 2 or more ports from different NICs, please make sure these NICs on the same CPU socket. Below session will show you how to check the PCI device locates in which socket by command.
+
+BIOS settings:
+~~~~~~~~~~~~~~
+
+1. To be sure, reset all the BIOS settings to default.
+
+2. Disable all power saving options, and set all options for best performance.
+
+3. Disable Turbo to ensure the performance scaling with core numbers increment.
+
+4. Set memory frequency to the highest number, NOT auto.
+
+5. Disable all Virtualization options when you test physical function of NIC, and turn on VT-d if you wants to use VFIO.
+
+
+Grub Parameters Essential Requirements:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Use the default grub file as a good start.
+
+2. Reserve 1G huge pages via grub configurations, e.g. add ``default_hugepagesz=1G hugepagesz=1G hugepages=8`` to reserve 8 huge pages in 1G size.
+
+3. Isolate CPU cores which will be used for DPDK from scheduler, e.g: 
+isolcpus=2,3,4,5,6,7,8
+
+4. If it wants to use VFIO, additional grub parameters are needed. e.g: 
+``iommu=pt intel_iommu=on``
+
+
+Configurations before running DPDK
+----------------------------------
+
+1. Build DPDK target and reserve huge page, refer to GSG guide for more details. Below scripts are for your reference::
+
+      cd <dpdk_folder>
+      make install T=x86_64-native-linuxapp-gcc -j          # Build DPDK target
+      awk '/Hugepagesize/ {print $2}' /proc/meminfo         # Get the hugepage size
+      awk '/Hugepage_Total/ {print $2} ' /proc/meminfo      # Get the total huge page numbers
+      umount `awk '/hugetlbfs/ {print $2}' /proc/mounts`    # Umount
+      mkdir -p /mnt/huge                                    # Create the hugepage mount folder
+      mount -t hugetlbfs nodev /mnt/huge                    # Mount to the specific folder
+
+2. Check the CPU layout by dpdk tools or system commands ``lscpu``::
+
+      cd <dpdk_folder>/tools
+      ./cpu_layout.py                       #Run the script to check your system's cpu layout.
+
+   Or run ``lscpu`` to check the the cores on each socket
+
+3. Check your NIC id and related socket id::
+
+      lspci -nn|grep Eth                    # List all the NICs with PCI address and device IDs.
+
+   e.g. Suppose your output is as below::
+
+      82:00.0 Ethernet controller [0200]: Intel Corporation Ethernet Controller XL710 for 40GbE QSFP+ [8086:1583] (rev 01)
+      82:00.1 Ethernet controller [0200]: Intel Corporation Ethernet Controller XL710 for 40GbE QSFP+ [8086:1583] (rev 01)
+      85:00.0 Ethernet controller [0200]: Intel Corporation Ethernet Controller XL710 for 40GbE QSFP+ [8086:1583] (rev 01)
+      85:00.1 Ethernet controller [0200]: Intel Corporation Ethernet 
+ Controller XL710 for 40GbE QSFP+ [8086:1583] (rev 01)
+
+   Check the PCI device related numa node id::
+
+      cat /sys/bus/pci/devices/0000\:xx\:00.x/numa_node
+
+   Usually ``8x:00.x`` is on socket 1, ``0x:00.x`` is on socket 0. **Note**: To get best performance, please make sure the core and NICs are in the same socket. Take ``85:00.0`` for example, it's on socket 1, then use cores on socket1 for best performance.
+
+4. Bind the test ports to igb_uio. For example bind two ports to dpdk compatible driver and check the status::
+
+      # Bind ports 82:00.0 and 85:00.0 to dpdk driver
+
+      ./<dpdk_folder>/tools/dpdk_nic_bind.py -b igb_uio 82:00.0 85:00.0
+
+      # Check the port driver status
+
+      ./<dpdk_folder>/tools/dpdk_nic_bind.py --st
+
+5. More details about setup or linux kernel requirements can be referred to GSG guide. 
+
+Example
+-------
+
+Below is an case of running dpdk l3fwd sample to get high performance with Intel platform and Intel(R) XL710 NIC. Any specific 40G NIC configurations please refer to the NIC's(i40e) guide.
+
+**Note**: The scenario is to get best performance with two Intel®XL710 40G ports. See below Figure1 as the performance test setup. 
+
+.. figure:: img/intel_perf_test_setup.*
+
+**Figure 1. PF_Performance_Test_setup**
+
+
+1. Insert two NICs(Intel®XL710) into the platform, and use one port per card to get best performance. The reason using two NICs is the PCIe Gen3's limitations. **Note**: As PCIe Gen3x8 can't provide 80G bandwidth for two 40G ports, but two different PCIe Gen3x8 slot can. Refer to the sample NICs output above, then we can select 82:00.0 and 85:00.0 as test ports::
+
+      82:00.0 Ethernet controller [0200]: Intel Corporation Ethernet Controller XL710 for 40GbE QSFP+ [8086:1583] (rev 01)
+      85:00.0 Ethernet controller [0200]: Intel Corporation Ethernet 
+ Controller XL710 for 40GbE QSFP+ [8086:1583] (rev 01)
+
+2. Connect the ports to the traffic generator, such as IXIA and Spirent.
+
+3. Check the PCI devices numa node(socket id) and get the cores number on the exact socket id. In this case, 82:00.0 and 85:00.0 are both in socket1, and the cores on socket1 in the referenced platform is 18-35,54-71. Note: Don't use one core's 2 thread(e.g core18 has 2 lcores, lcore18 and lcore54), instead, use 2 logical cores from different cores(e.g core18 and core19).
+
+4. Bind these two ports to igb_uio.
+
+5. As it is known that XL710 40G port need at least two queue pairs to achieve best performance, then two queues per port will be required, and each queue pair will need a dedicated CPU core for receiving/transmitting packets.
+
+6. Basically l3fwd will be using for performance testing, with using two ports for bi-directional forwarding. Compile the l3fwd sample with default lpm mode.
+
+7. Final command line of running l3fwd could be as followings. That means use core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding, core 20 for port 1, queue pair 0 forwarding, core 21 for port 1, queue pair 1 forwarding::
+
+      ./l3fwd -c 0x3c0000 -n 4 -w 82:00.0 -w 85:00.0 -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)'
+ 
+8. Configure the traffic to a traffic generator such as IXIA or Spirent.
+
+* Start creating a stream on packet generator, e.g. IXIA.
+* Set the Ethernet II type to 0x0800