From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6D5F4A0C51; Fri, 6 Aug 2021 19:46:31 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id DAE29410F8; Fri, 6 Aug 2021 19:46:30 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by mails.dpdk.org (Postfix) with ESMTP id 184CD4014D for ; Fri, 6 Aug 2021 19:46:28 +0200 (CEST) X-IronPort-AV: E=McAfee;i="6200,9189,10068"; a="201589335" X-IronPort-AV: E=Sophos;i="5.84,301,1620716400"; d="scan'208";a="201589335" Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Aug 2021 10:46:27 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.84,301,1620716400"; d="scan'208";a="502070957" Received: from orsmsx603.amr.corp.intel.com ([10.22.229.16]) by orsmga001.jf.intel.com with ESMTP; 06 Aug 2021 10:46:27 -0700 Received: from orsmsx607.amr.corp.intel.com (10.22.229.20) by ORSMSX603.amr.corp.intel.com (10.22.229.16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2242.10; Fri, 6 Aug 2021 10:46:27 -0700 Received: from ORSEDG602.ED.cps.intel.com (10.7.248.7) by orsmsx607.amr.corp.intel.com (10.22.229.20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2242.10 via Frontend Transport; Fri, 6 Aug 2021 10:46:27 -0700 Received: from NAM11-BN8-obe.outbound.protection.outlook.com (104.47.58.175) by edgegateway.intel.com (134.134.137.103) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2242.10; Fri, 6 Aug 2021 10:46:27 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=SJng80p0Bwtoe+twvVM0ZDEjT1wJlfgMUaz6wpuqfhH0cgyVu9R+HLN0G2/G8Me0/IW6Pr+oJhuqa11jGKHQ5XC1G4c53j5klE3ROQ1WtV/5g/pD4iI+f06/mJtK2hjlEGN0m49TYc+bRKmZbmmlXvtKIjmSxHisJcrHeX7wTZU5ZdccOusuTx3cLgbvyPSEw0KwuoY2tcB9MqAhtGKEpogAtkXkC1J5UkkzkdL2tkvgPlX3IBHrK4Pft63GnMIpjYq7FsT76P6aSRUjmTy33ztKj/t2MywOvhQRojGl3BpRbkvmK/ziNz4V1TFvUAKYGGgh/Mp0sH48yMfdfTHMGw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=NL9CuqXWAzURgGZjIRBRaaTQpZznueaYyrqFcFczCtc=; b=aOQI6W17Kfv/fh54KJhrciV7iU/xuQBXkLcf2qI2FhG6/dSj+wnANJeIV84tG1Ayl6e/eFaIZ0u8vhaXdj6EiYSKhgCS8F8Qpta2Cj2RgclyMkSNF/KVR5BhLBtskZY+KAbWtqvffSWLVKD1tuXnDm91hsncgTuZWAhdKCpkGVR6Ap+DKLUSWQ/uOpTckO+zgm9mEaNQbnuwL45bi61BM4zx9FaD4Z6pG2ziluaKfUKIecWY2M7Q5JM3Gapgn0/LPqW7sU7gAR+m9qBcFhlr02Ma+5gUk18N1WT4OSxVKYqCbszhVFpFepvHykbiTLfoR6Ak7KxRWHctIx9axi618A== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=NL9CuqXWAzURgGZjIRBRaaTQpZznueaYyrqFcFczCtc=; b=DBuKtfgt7o2YkyC4yCukBD+0f1CMTob0iUgkMzgkZK0htmlzx6AK3Fz9l83Fct0LUskcvzSvJQtHYRFfus5r+pvW22MYjj3S/0M4zwIfvieubFOeEmSAiWBnxinWLpaTkEOz1pvPQuWFzE69RVU57im/HXWHGSHwoI7EbrczkEo= Received: from DM8PR11MB5670.namprd11.prod.outlook.com (2603:10b6:8:37::12) by DM8PR11MB5605.namprd11.prod.outlook.com (2603:10b6:8:26::11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4394.15; Fri, 6 Aug 2021 17:46:25 +0000 Received: from DM8PR11MB5670.namprd11.prod.outlook.com ([fe80::9592:c11a:785d:d972]) by DM8PR11MB5670.namprd11.prod.outlook.com ([fe80::9592:c11a:785d:d972%4]) with mapi id 15.20.4394.020; Fri, 6 Aug 2021 17:46:25 +0000 From: "Dumitrescu, Cristian" To: "jerinj@marvell.com" , Thomas Monjalon , "Yigit, Ferruh" , "Andrew Rybchenko" CC: "dev@dpdk.org" , "arybchenko@solarflare.com" , "lizh@nvidia.com" , "ajit.khaparde@broadcom.com" , "Singh, Jasvinder" , "matan@nvidia.com" Thread-Topic: [WARNING: UNSCANNABLE EXTRACTION FAILED][WARNING: UNSCANNABLE EXTRACTION FAILED][dpdk-dev] [PATCH v5] doc: mtr: add API walk through Thread-Index: AQHXiqgAA1xNORWKiEelw6Kb2KEiuatmp1Xg Date: Fri, 6 Aug 2021 17:46:25 +0000 Message-ID: References: <20210806094320.796914-1-jerinj@marvell.com> <20210806094518.807965-1-jerinj@marvell.com> In-Reply-To: <20210806094518.807965-1-jerinj@marvell.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-version: 11.5.1.3 dlp-reaction: no-action dlp-product: dlpe-windows authentication-results: marvell.com; dkim=none (message not signed) header.d=none;marvell.com; dmarc=none action=none header.from=intel.com; x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: c4d39892-eee3-4188-6a74-08d959021ce4 x-ms-traffictypediagnostic: DM8PR11MB5605: x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:9508; x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: xwWVTYA3Zv3Xf9XXsgZVrdRQEU9LY5GajqLtCv410QcR02CaZDMx2hRtvbfsqIwOrk2oLgXxmTunSqfH0BRgKEqYMsI+W0c8hTKBKSVDWELHk4qKTDzqVbvZgGpuZJV/yXS0lk7fgAoBiJSZyzWhyUW6qljq9eqRSnjShxu13VmZ+9OLSoGgdj2SLx9DTBUJvx5qMRrk2VXg8k5+xSzmcsxAn7QDXop43k2Istd8Iv7ZQgjv1Pk1gUOYpgSW96YTALYqVGQ0vjT8vR63+520cNKosRcIBffcLp/C2DgRcAJkgCecO22g13hyFMXrSBRYnaFnwlKrlM2GEXX37ilo3RL0SUAkGWhStDCx/YIgw6qFkoA8HCYbpUln8tfy0yxlKkyiBhAE0BfJg0bNVm0boRgOKoyZQp7XMU9RLXkwk6y79SsOQUUozfhOxxrtaF9xjIeHBBktj7NCGreRYW6hN1hB0r4pFYObwIICisH4pW+bFZtuiZOB2XdT20YKs6cvoOUWzcoJLEt9PwpzFpv8h4AYMGy1UN9HaZORxF3FKP1uXXJEzogd8nP8qy6T9oKzz3rJMWpjizm2b2dzBEPROlKS6o5U5FGLYBF8hxCedANwBpXFcCRQ8fCXXt+lz+9QlbKkbY3BRHyTezeibCG5PYlVERXAbqj1i+vLQoa2AEJTggP0Ov4Dk3UhObyUtLAheyebe2hDmRTECMc92MMPDQ== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DM8PR11MB5670.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(39860400002)(376002)(366004)(396003)(136003)(346002)(71200400001)(66476007)(66446008)(66946007)(186003)(38070700005)(26005)(66556008)(86362001)(55016002)(8676002)(5660300002)(6506007)(64756008)(7696005)(9686003)(316002)(76116006)(8936002)(52536014)(33656002)(4326008)(54906003)(2906002)(110136005)(122000001)(478600001)(38100700002)(83380400001); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?bHTjYXOcgOpmKs1fRY59ZG7eguPeChDOCOZWE5cBUFH77Tokk5EfIE2yNaRH?= =?us-ascii?Q?tvzvXgn5Gu8hoR3QD090OVv3cHa8L/quyIJldoVi3WlPLfm0yWY56idkuubR?= =?us-ascii?Q?FGJ+K6Gd2x9VDF7JiFouPmOKrKE3W3bbkocJTRNHNI8o03pfNnT3Y9f1ppiu?= =?us-ascii?Q?Og2mZ3ydCWkuQ33Ob41UWW8r4i/dwMM6h0RY6q9T4SzPY/74vAH6pPO5TBhk?= =?us-ascii?Q?DTc7MU3OEMnprs7yxAT59UMLDGtkOPiM681B2jEeDwM9Z0O8dqj8ttJBDnq8?= =?us-ascii?Q?8Ll7zRx9gEf7g1lQhsOkSIcYUxHGnIqkHDHvvlegyKqEDokapNGTj4Wkv2xz?= =?us-ascii?Q?2SdX7d7aq4uowDvdNH5iYhrxPgcwMzmQaOd3htLrzCludqnzyScwCM06DYtw?= =?us-ascii?Q?pFyUa1HWbQscZH3nEyoh0Qp7x3UNnMi5u2pRPCqJFst0JPzGFIKPQP/b7jap?= =?us-ascii?Q?SgTNITcU1+H4UeMJTpyodwaCsE9d0g4szU2kWAITTCvoIdjc1t72+I+zthg8?= =?us-ascii?Q?7S+pQJCCJswY8Ta+Bkice1K3ehnLmb4MzEB8mGEmSptfwS1mK+u5BwXPnMys?= =?us-ascii?Q?ixsKuF09EcirrGuwWAbH9UNlO7awAEh65Fh6GVPqooMEJcFcNJObVAE7Uwqt?= =?us-ascii?Q?JErBv5u+klCvoBJS39oyLoFImxD+ip3j2IbDao2MNfnzoAG478pEkAr9h6Rg?= =?us-ascii?Q?sqy6NPXPRuY6JWyAuW9ASV7kFuyvHuropaBPzWBedAAvOrl78dxI2ektodMr?= =?us-ascii?Q?VhFnhirh0GBMEvs+ADr8SaIO5dqODjFsXTWrUYkcFsShelQ/1ZfbLXLjOCKc?= =?us-ascii?Q?I1FJ8YPKHFHI6TwA7WnHIc5oOI7IOVTgOtio0SbWTZ4F8AynOfYIlwYBR4Tl?= =?us-ascii?Q?mGki3xrnZ4sn/JjW8NpbhqT4N0++Z42ivwUvI8yrw7RDX3gPBkBG2zFZnpD/?= =?us-ascii?Q?Myq04BsTXwjPjh7f+02qt8dP4r5dwa4n5vF8+93IlKe10MUVpJRmNA9F8d0o?= =?us-ascii?Q?yaioFlKJwLidPhGNYVWwRiyb8rItMPsbHtwY1vRLG7jwgY5b155CKrIMDbw6?= =?us-ascii?Q?Hq5ApfZf679f/2sYldCqMYNY1CcB9aDBosNIHLTbz1KScP/aRGzZyjdgH9CL?= =?us-ascii?Q?Iz00VIfHn/JLAR38qUhkjlV3eXFQ7AQLQD3wXJZxO2uYoKw26wJEb4JY/+oN?= =?us-ascii?Q?jDQ4mIir5QlXLayOfXIqtcbds5tejdFBfHVnSt7mnfkHuf1aim8W6NaQAuRS?= =?us-ascii?Q?tgYOL5x65/+DckLZXn+JUAUN9TYzKl0I5yPom+cR4KTfX/izTICLjcLamvVh?= =?us-ascii?Q?XwzXGKMnfxcvD2nlt45ftzPw?= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: DM8PR11MB5670.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: c4d39892-eee3-4188-6a74-08d959021ce4 X-MS-Exchange-CrossTenant-originalarrivaltime: 06 Aug 2021 17:46:25.8258 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: n8Mlfo+UayS/xjk0DXfQvTaBwDl6Xba/6wDGdWFKA7uewtfM80aNUxXuxj78I5wmuAUery3KgAVHPM2hJAZknW5XXOFMHoEGlH6DgTFMdPs= X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM8PR11MB5605 X-OriginatorOrg: intel.com Subject: Re: [dpdk-dev] [WARNING: UNSCANNABLE EXTRACTION FAILED][WARNING: UNSCANNABLE EXTRACTION FAILED] [PATCH v5] doc: mtr: add API walk through X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 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" Hi Jerin, > +API Walk-through > +---------------- > + > +.. _figure_rte_mtr_chaining: > + > +.. figure:: img/rte_mtr_meter_chaining.* > + > + Meter components > + > +This section will introduce the reader to the critical APIs to use > +the traffic meter and policing library. > + > +In general, the application performs the following steps to configure th= e > +traffic meter and policing library. > + > +#. Application gets the meter driver capabilities using > ``rte_mtr_capabilities_get()``. > +#. The application creates the required meter profiles by using the > + ``rte_mtr_meter_profile_add()`` API function. > +#. The application creates the required meter policies by using the > + ``rte_mtr_meter_policy_add()`` API function. > +#. One of the previously created meter profile > + (``struct rte_mtr_params::meter_profile_id``) and meter policy > + (``struct rte_mtr_params::meter_policy_id``) are provided as argument= s > + at this step. You somehow dropped the first statement from this last bullet: The application creates a meter object using the rte_mtr_create() API func= tion. > +#. The application enables the meter object execution as part of the flo= w > action > + processing by calling the ``rte_flow_create()`` API function with one= of the > + flow action set to ``RTE_FLOW_ACTION_TYPE_METER`` and the associated > + meter object ID set to this meter object. > +#. The API allows chaining the meter objects to create complex metering > topology > + by the following methods. > + > + * Stacking multiple ``rte_flow_action`` as > + ``RTE_FLOW_ACTION_TYPE_METER`` with ``struct > rte_flow_action_meter::mtr_id`` > + as meter ID. The last added RTE_FLOW_ACTION_TYPE_METER object > represent as > + leaf node (closest to ethdev receive queue) > + Stacking might point people to reverse order execution of actions, which is= not the case, as the flow actions are executed sequentially from first to = last. Also the last meter action is not the last flow action (your referenc= e to leaf node?), as the last flow action must be the END action, right? How about: * Adding multiple flow actions of the type ``RTE_FLOW_ACTION_TYPE_METER`` = to the same flow. Each of the meter action typically refers to a different = meter object. I was suggesting a similar diagram for this case, but it might be too much = to ask for :) > + * As show in :numref:`figure_rte_mtr_chaining` specify > + ``struct rte_mtr_meter_policy_params::actions`` action as > + ``RTE_FLOW_ACTION_TYPE_METER`` per color. I would add a high level statement before yours, something like: * Adding one (or multiple) actions of the type ``RTE_FLOW_ACTION_TYPE_METE= R`` to the list of meter actions specified per color. Regards, Cristian