DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Baran, MarcinX" <marcinx.baran@intel.com>
To: "Richardson, Bruce" <bruce.richardson@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app guide
Date: Fri, 27 Sep 2019 15:16:57 +0000	[thread overview]
Message-ID: <06CDC4676D44784DA2DF9423D4B672BE15ECCD8E@HASMSX114.ger.corp.intel.com> (raw)
In-Reply-To: <20190927150058.GB1865@bricha3-MOBL.ger.corp.intel.com>



-----Original Message-----
From: Bruce Richardson <bruce.richardson@intel.com> 
Sent: Friday, September 27, 2019 5:01 PM
To: Baran, MarcinX <marcinx.baran@intel.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app guide

On Fri, Sep 27, 2019 at 03:51:48PM +0100, Baran, MarcinX wrote:
> -----Original Message-----
> From: Bruce Richardson <bruce.richardson@intel.com>
> Sent: Friday, September 27, 2019 1:02 PM
> To: Baran, MarcinX <marcinx.baran@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT 
> sample app guide
> 
> On Fri, Sep 20, 2019 at 09:37:14AM +0200, Marcin Baran wrote:
> > Added guide for IOAT sample app usage and code description.
> > 
> > Signed-off-by: Marcin Baran <marcinx.baran@intel.com>
> > ---
> >  doc/guides/sample_app_ug/index.rst |   1 +
> >  doc/guides/sample_app_ug/intro.rst |   4 +
> >  doc/guides/sample_app_ug/ioat.rst  | 764
> > +++++++++++++++++++++++++++++
> >  3 files changed, 769 insertions(+)
> >  create mode 100644 doc/guides/sample_app_ug/ioat.rst
> > 
> > diff --git a/doc/guides/sample_app_ug/index.rst
> > b/doc/guides/sample_app_ug/index.rst
> > index f23f8f59e..a6a1d9e7a 100644
> > --- a/doc/guides/sample_app_ug/index.rst
> > +++ b/doc/guides/sample_app_ug/index.rst
> > @@ -23,6 +23,7 @@ Sample Applications User Guides
> >      ip_reassembly
> >      kernel_nic_interface
> >      keep_alive
> > +    ioat
> >      l2_forward_crypto
> >      l2_forward_job_stats
> >      l2_forward_real_virtual
> > diff --git a/doc/guides/sample_app_ug/intro.rst
> > b/doc/guides/sample_app_ug/intro.rst
> > index 90704194a..74462312f 100644
> > --- a/doc/guides/sample_app_ug/intro.rst
> > +++ b/doc/guides/sample_app_ug/intro.rst
> > @@ -91,6 +91,10 @@ examples are highlighted below.
> >    forwarding, or ``l3fwd`` application does forwarding based on Internet
> >    Protocol, IPv4 or IPv6 like a simple router.
> >  
> > +* :doc:`Hardware packet copying<ioat>`: The Hardware packet 
> > +copying,
> > +  or ``ioatfwd`` application demonstrates how to use IOAT rawdev 
> > +driver for
> > +  copying packets between two threads.
> > +
> >  * :doc:`Packet Distributor<dist_app>`: The Packet Distributor
> >    demonstrates how to distribute packets arriving on an Rx port to different
> >    cores for processing and transmission.
> > diff --git a/doc/guides/sample_app_ug/ioat.rst
> > b/doc/guides/sample_app_ug/ioat.rst
> > new file mode 100644
> > index 000000000..69621673b
> > --- /dev/null
> > +++ b/doc/guides/sample_app_ug/ioat.rst
> > @@ -0,0 +1,764 @@
> > +..  SPDX-License-Identifier: BSD-3-Clause
> > +    Copyright(c) 2019 Intel Corporation.
> > +
> > +Sample Application of packet copying using Intel\ |reg| QuickData 
> > +Technology 
> > +===================================================================
> > +==
> > +=======
> > +
> > +Overview
> > +--------
> > +
> > +This sample is intended as a demonstration of the basic components 
> > +of a DPDK forwarding application and example of how to use IOAT 
> > +driver API to make packets copies.
> > +
> > +Also while forwarding, the MAC addresses are affected as follows:
> > +
> > +*   The source MAC address is replaced by the TX port MAC address
> > +
> > +*   The destination MAC address is replaced by  02:00:00:00:00:TX_PORT_ID
> > +
> > +This application can be used to compare performance of using 
> > +software packet copy with copy done using a DMA device for different sizes of packets.
> > +The example will print out statistics each second. The stats shows 
> > +received/send packets and packets dropped or failed to copy.
> > +
> > +Compiling the Application
> > +-------------------------
> > +
> > +To compile the sample application see :doc:`compiling`.
> > +
> > +The application is located in the ``ioat`` sub-directory.
> > +
> > +
> > +Running the Application
> > +-----------------------
> > +
> > +In order to run the hardware copy application, the copying device 
> > +needs to be bound to user-space IO driver.
> > +
> > +Refer to the *IOAT Rawdev Driver for Intel\ |reg| QuickData
> > +Technology* guide for information on using the driver.
> > +
> 
> The document is not called that, as the IOAT guide is just part of the overall rawdev document. So I suggest you just reference the rawdev guide.
> [Marcin] I wanted to refer to the ioat guide in 
> /doc/guides/rawdevs/ioat.rst which has that title. Is there another document or I referenced this one incorrectly?
> 

It's one chapter in the overall "Rawdev Drivers" document:
https://doc.dpdk.org/guides/rawdevs/index.html

Since the (R) symbol doesn't seem to show up correctly in what you have above (though it looks correct to me), I suggest just referring to the "IOAT Rawdev Driver" chapter in the "Rawdev Drivers" document.
[Marcin] Ok, I will change it like that.

  reply	other threads:[~2019-09-27 15:17 UTC|newest]

Thread overview: 76+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-09  8:29 [dpdk-dev] [PATCH] examples/ioat: create sample app on ioat driver usage Marcin Baran
2019-09-09 13:12 ` Aaron Conole
2019-09-09 13:58   ` Bruce Richardson
2019-09-12  9:52 ` Bruce Richardson
2019-09-12 12:18   ` Baran, MarcinX
2019-09-13 14:39 ` [dpdk-dev] [PATCH v2 0/6] examples/ioat: " Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 1/6] examples/ioat: create " Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-09-13 18:45   ` [dpdk-dev] [PATCH v2 0/6] examples/ioat: sample app on ioat driver usage Aaron Conole
2019-09-16  9:42     ` Baran, MarcinX
2019-09-19  9:19       ` Aaron Conole
2019-09-18  9:11   ` [dpdk-dev] [PATCH v3 " Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 1/6] examples/ioat: create " Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-09-19  9:38     ` [dpdk-dev] [PATCH v4 0/6] examples/ioat: sample app on ioat driver usage Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 1/6] examples/ioat: create " Marcin Baran
2019-09-19 14:44         ` Bruce Richardson
2019-09-19 14:46           ` Baran, MarcinX
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-09-20  7:37       ` [dpdk-dev] [PATCH v5 0/6] examples/ioat: sample app on ioat driver usage Marcin Baran
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 1/6] examples/ioat: create " Marcin Baran
2019-09-27  9:58           ` Bruce Richardson
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-27 10:01           ` Bruce Richardson
2019-09-27 14:01             ` Baran, MarcinX
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-27 10:05           ` Bruce Richardson
2019-09-27 14:03             ` Baran, MarcinX
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-27 10:08           ` Bruce Richardson
2019-09-27 14:03             ` Baran, MarcinX
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-27 10:12           ` Bruce Richardson
2019-09-27 14:04             ` Baran, MarcinX
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-09-27 10:36           ` Bruce Richardson
2019-09-27 14:14             ` Baran, MarcinX
2019-09-27 10:37           ` Bruce Richardson
2019-09-27 11:01           ` Bruce Richardson
2019-09-27 14:51             ` Baran, MarcinX
2019-09-27 15:00               ` Bruce Richardson
2019-09-27 15:16                 ` Baran, MarcinX [this message]
2019-09-27 13:22           ` Bruce Richardson
2019-09-27 15:13             ` Baran, MarcinX
2019-09-30  7:50         ` [dpdk-dev] [PATCH v6 0/6] examples/ioat: sample app on ioat driver usage Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 1/6] examples/ioat: create " Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-10-03  9:48           ` [dpdk-dev] [PATCH v6 0/6] examples/ioat: sample app on ioat driver usage Bruce Richardson
2019-10-04 17:16           ` Kevin Traynor
2019-10-07 11:10             ` Bruce Richardson
2019-10-07 11:08         ` [dpdk-dev] [PATCH v7 0/6] examples/ioat: sample app for ioat driver Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 1/6] examples/ioat: new " Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 2/6] examples/ioat: add software copy support Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 3/6] examples/ioat: add rawdev copy mode support Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 4/6] examples/ioat: add two threads configuration Bruce Richardson
2019-10-27 17:04             ` Thomas Monjalon
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 5/6] examples/ioat: add stats printing for each port Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 6/6] doc/guides/: provide IOAT sample app guide Bruce Richardson
2019-10-27 17:07             ` Thomas Monjalon
2019-10-27 17:07           ` [dpdk-dev] [PATCH v7 0/6] examples/ioat: sample app for ioat driver Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=06CDC4676D44784DA2DF9423D4B672BE15ECCD8E@HASMSX114.ger.corp.intel.com \
    --to=marcinx.baran@intel.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).