From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 5B69AA0613 for ; Fri, 27 Sep 2019 17:01:07 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 35C871B079; Fri, 27 Sep 2019 17:01:06 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 27C331BEE8 for ; Fri, 27 Sep 2019 17:01:03 +0200 (CEST) X-Amp-Result: UNKNOWN X-Amp-Original-Verdict: FILE UNKNOWN X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 27 Sep 2019 08:01:02 -0700 X-IronPort-AV: E=Sophos;i="5.64,555,1559545200"; d="scan'208";a="194508731" Received: from bricha3-mobl.ger.corp.intel.com ([10.252.2.75]) by orsmga006-auth.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 27 Sep 2019 08:01:01 -0700 Date: Fri, 27 Sep 2019 16:00:58 +0100 From: Bruce Richardson To: "Baran, MarcinX" Cc: "dev@dpdk.org" Message-ID: <20190927150058.GB1865@bricha3-MOBL.ger.corp.intel.com> References: <20190919093850.460-1-marcinx.baran@intel.com> <20190920073714.1314-1-marcinx.baran@intel.com> <20190920073714.1314-7-marcinx.baran@intel.com> <20190927110130.GH1847@bricha3-MOBL.ger.corp.intel.com> <06CDC4676D44784DA2DF9423D4B672BE15ECCD51@HASMSX114.ger.corp.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <06CDC4676D44784DA2DF9423D4B672BE15ECCD51@HASMSX114.ger.corp.intel.com> User-Agent: Mutt/1.11.4 (2019-03-13) Subject: Re: [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app guide 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On Fri, Sep 27, 2019 at 03:51:48PM +0100, Baran, MarcinX wrote: > -----Original Message----- > From: Bruce Richardson > Sent: Friday, September 27, 2019 1:02 PM > To: Baran, MarcinX > 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 > > --- > > 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`: The Hardware packet copying, > > + or ``ioatfwd`` application demonstrates how to use IOAT rawdev > > +driver for > > + copying packets between two threads. > > + > > * :doc:`Packet Distributor`: 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.