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 7846543B55; Tue, 20 Feb 2024 17:28:44 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0DAC0402A7; Tue, 20 Feb 2024 17:28:44 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.12]) by mails.dpdk.org (Postfix) with ESMTP id 6C26D40289 for ; Tue, 20 Feb 2024 17:28:42 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1708446522; x=1739982522; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=Ce3/g+OKs2cCDxmY3NHr3E8pfl7XvbgnniJqc/Li77Q=; b=bOVnnWcDhA6aWOaYRb7uN2NjrIc7yLQxo7nM7fGT3L0WTwgm88MerBus rnynnZ4fJsIWvWE4FU255jjFYcVuoP3rCq03woUUdlPkk3Mu2MVLOhZ3m zPWxadQD0p6IWybefvVpLSsHPR5/U4XLC8ga1i+i3LZ1SsqSxzGy2XVxB FAugJFKV464DGYe2mBe1yFUqZcl4SQwUz7hWv7PVvb6NBiMGlojDDlwP4 DzLp0pTMDVEmmoLSOGI3TVcLdnRoIYory/aT22uhdTMMogkHyp4aznsdH zvjv/6TuVqxDFya9w1JsPplxMuQJCe7OFcDSqSm4QsapASPQHFQp1TPnf Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10990"; a="6331674" X-IronPort-AV: E=Sophos;i="6.06,174,1705392000"; d="scan'208";a="6331674" Received: from orviesa008.jf.intel.com ([10.64.159.148]) by fmvoesa106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Feb 2024 08:28:37 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.06,174,1705392000"; d="scan'208";a="5186025" Received: from orsmsx602.amr.corp.intel.com ([10.22.229.15]) by orviesa008.jf.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 20 Feb 2024 08:28:37 -0800 Received: from orsmsx612.amr.corp.intel.com (10.22.229.25) by ORSMSX602.amr.corp.intel.com (10.22.229.15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Tue, 20 Feb 2024 08:28:36 -0800 Received: from ORSEDG601.ED.cps.intel.com (10.7.248.6) by orsmsx612.amr.corp.intel.com (10.22.229.25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35 via Frontend Transport; Tue, 20 Feb 2024 08:28:36 -0800 Received: from NAM10-MW2-obe.outbound.protection.outlook.com (104.47.55.101) by edgegateway.intel.com (134.134.137.102) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.35; Tue, 20 Feb 2024 08:28:36 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=UIw3Bbm3k/xBLG0zRX8nJT8F/U8m14+yHnKZQGlqjnHtS1BqdWIfnP+rqECAg+HRZX4egDLHlitggRZiQxf6K1NZ6XnNEqLjAcJu5/QwhjaB6ev9k95ZgYBKLclQ4iqQSqjL7sdXjn/rrsLpT0GNuynqoY2H/codO5AuDIQUiqUuFMcFSB41eN1whtAsu/nl3KqbbVvdipai3s6jO2J0lwJagclsNAcC+vaG3QUqfzxqPVgAelx0doZxdneaZxEfGCZ5caNC2k+MCOm/zumK2vk4CAL1qE7zi5KC404VeJbLiIFjH/CuAd7ylAOQpm2KRrPdskMHHJKEHhhe006vcA== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=zVQRLuACLwOqRgXY2gbFDqrylwJ6tdfi53l3vw7ZyBU=; b=iUZE7sVw70oUj+lF+z3V1oumwcm8jrPEBMpSdi2PQaEozP1lqtHcaWTJjp3TNf1IzCzxtyX+wfb+w25NOHQkGOfvLh9b2+QgCttGHkHrvIFfHwdTSy6vFXgY+ddq5T+seos2ULYJOa1O7K8y9MS9lLACdJg9H+H9Wg2LZpabRNT05173upDdaF/nvvNzC0bdiiuejuQnjCaSTAYh3JrmzqRKgIO8wGmx0Jz5TfrpUIEJQyHOR5VjrYrkScrav82loJSiM5DR/tZo9enzm0VKpgQ37ieRE8eExoaycGrB6TrcKJr2Jw1oHdzFiIkahn99lXMYcpqPLaXC9HIwF8NdUA== 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 Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; Received: from DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) by SJ1PR11MB6132.namprd11.prod.outlook.com (2603:10b6:a03:45d::8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7292.39; Tue, 20 Feb 2024 16:28:33 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::d10:3009:a8d3:1d2e]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::d10:3009:a8d3:1d2e%7]) with mapi id 15.20.7292.036; Tue, 20 Feb 2024 16:28:32 +0000 Date: Tue, 20 Feb 2024 16:28:27 +0000 From: Bruce Richardson To: Mattias =?iso-8859-1?Q?R=F6nnblom?= CC: Jerin Jacob , , , , , , , , Subject: Re: [PATCH v3 01/11] eventdev: improve doxygen introduction text Message-ID: References: <20240119174346.108905-1-bruce.richardson@intel.com> <20240202123953.77166-1-bruce.richardson@intel.com> <20240202123953.77166-2-bruce.richardson@intel.com> <7177dc02-8e31-47cd-baf2-41cb3eee6fe4@lysator.liu.se> <381c64e4-4d45-44ee-8fa5-433c44b38fc0@lysator.liu.se> Content-Type: text/plain; charset="utf-8" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <381c64e4-4d45-44ee-8fa5-433c44b38fc0@lysator.liu.se> X-ClientProxiedBy: DU7P190CA0026.EURP190.PROD.OUTLOOK.COM (2603:10a6:10:550::10) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|SJ1PR11MB6132:EE_ X-MS-Office365-Filtering-Correlation-Id: 11b1c442-44ae-4926-9b0d-08dc3230fa9f X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: w5F4QGUZgtKdFZOAIvg1EqNpmB12O6VQatX79BACqFGmD2sR6rJlWF6C3xzJxbl7j/6YlWCdNMOUMC7aJ6UmV/vYTbbkVE7/h+dKUX43QDVjiB5NonISizmfpFOzfxOSwEeirZb5UJTD0+Oj/TTx3WTKx0yobEh3m5tM8gIDkiiXO8f1lb0WhTGmQNnJFY+p8QO675r2Nwg0sB3Ky7WDseaq3Xy806ghC4Px7gQLSoWlqxPpTAL4O0j8Gxq9SU9Eq6GOAttKf5LembkcicycrUK0Nt5t7T6xO11WgNoo4IMLV+8hLTXmTI3g2DlvZ0LFumJyvdlP8isu3abo+bBSr3yU0fB8SivH+KP8ZfyRsU7oCA2xJf4S8u9mO5W9tVsfZQYMglghUOXi5QRyQYbXQHrYZEkfpZ/kjpUQ7FTnaBalJDKVFmuB1dNvq7QmhkpyBxhL0TQIER66SXaUQhQ8tDLnhP2D1fjOCbEnYMUCLrAi6MSKzLxIY339BENRoWaWBdVLCCdXufPeau3FoQ196JVZ/gkigAesk0XxklMGSTc= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DS0PR11MB7309.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?aHhOUXZ2SU9TVWVMYnVFZWdWRG9JZERrelZmMkVWcWdDdUxoN2NXWTBXRytU?= =?utf-8?B?QjFoRXQ2cHdBeE9FWGtvWVcvMmluMmNZV2ZvWUNNeEd4MkVaSi9RY1pZMWV4?= =?utf-8?B?QUJFMXpwdnQ5QnV4b2IyZFN2blVqNE16WEdxWXpROEErQ3pkUzFsWUhXbVIx?= =?utf-8?B?L2R0T3hocmZyYXdIK29wVERTZTM2cC9NNDQ4M3dqRnRHZTRyL3BSTHRwa3Vp?= =?utf-8?B?K0J0QjMyR1hrMGo3cVV1ZGNkMDI5dnAzZm9xZU5rSEZ1V3AxSEZaVjhaMHRx?= =?utf-8?B?VUliRXBkL00zRTREcE5vUGNDcWdST3NTcTZNK0VNeCtCK2VmcUlJakxSQk1h?= =?utf-8?B?cXUwT0xtTlYya0NYSGMzU3JudkpFT1lQT1lNNzJOdGNEb2FuNmFTZXN2eU4r?= =?utf-8?B?cHVuM0NhUjlPV3prY25iYUF1YzdidkVFcGV6U0dJQW0xRXN0T0pJNFd6NkpP?= =?utf-8?B?V0NJR1BPODh5WVoydUdPRGtUUjFBYndWamoxeHVmSmZmcTRpSVp6Y3NqS0NI?= =?utf-8?B?cm5JL3ZDQUo2Ni8yYXdQUkphUEU5Ly94QmVIcnVrSGRRL3NaaTl2VElsUDN2?= =?utf-8?B?ZS8yUFdua3pFa2NQdlB0endoTk15RHc0V3lPM0pkc3FobDVsNFNrbzZBUVF4?= =?utf-8?B?bVEydGU4SlBpOGR3aVNhQzVrTWM2dzM0eTMrMXpueHhUSjQ3UGJHaENub093?= =?utf-8?B?b094bld1TGJ5T1FNR0xNaXVtTWFDRjJIRGJjSmRDQ0ZZSHl2MnVhVng0cTc5?= =?utf-8?B?c1lQR1c2c0o0MkpRWnVUZHg3UXhLWlNDSFBHMHBmaENCV0tSNENxZi8yZVFj?= =?utf-8?B?Y1FibGgyczhKS2hva2tJMEcxcGNWVXRKYms5TE1NZUthajUvKzE3Nk9oM0tF?= =?utf-8?B?bUhDKzlQYlNsbnlBVFNwdmdXK0FPWWdNcmxNbmVkN1hnalJjUUFnY2tEaFVQ?= =?utf-8?B?aWk4bm10UVluaEhTZHpxYjZvWjMrN3VoNXN0Mjd3bk44a3F6MTR4Nm9CQXJT?= =?utf-8?B?K0NTNElzaklZT250T1Avb0J2ZWtKUGdoaGR6dWVvMzhTRi9KTFVLS1p2M0ly?= =?utf-8?B?K2ZuVWJqMi84MWpGWitGaUNJUFdVdmJpVUNzT1kzcVh2WERBZTJqNUtNaHhy?= =?utf-8?B?azRFaXhMb1ozWDhzSWFiSHF4NGhUTjBzdmFOYmpMazF3OGhwcFY4SVlHOGlJ?= =?utf-8?B?MnFXeU9YRjVPZ2xabkl4TkFvUTdoWk5QOXJzQ1JDMGlHbWxTR2wyTm5MaVU0?= =?utf-8?B?M1I3OGNYSWpRVDU1WmdqbDNhSG1SWXNmeHgzVGlMMkpKQ0l2eEs3WkhEa3Rh?= =?utf-8?B?L2NLVkEwSnE1d29UMWx4c2NRbVdzVUdXRXZBQ2dST2VRcjIyTlZnRnRzNm83?= =?utf-8?B?OXdQN3lPMk90cXRrRUwrcmtDOHpLZUYrdU94RzZxSU0vK0tnY0NaS3ByYXBa?= =?utf-8?B?ZWlRWVErS2dlUGc2NUpMZ3FhU0ltQ1ZOcGZZU3BtYWZVeXR5REpuV2s0aDMy?= =?utf-8?B?SHdjQ1VBeFlsWWFwZ3FjQUtsM2ZGOEtScUlwbGd1MkJBNmEwcHR4TEFtRU9m?= =?utf-8?B?N3gyWnpHRGZZR210TjY5bERCaDJWTVFQT2NxcFhTaHlPSjdzV3ZtUG5Kdlh6?= =?utf-8?B?d3daaDNOZFdnMkxPaEdrWlc1MXZTSnI0NkJVdEFBS25Qa1lOZktzN3ZiQ3Rl?= =?utf-8?B?aEYvYW1pdUx2TS90anFOUlBPSWFRekpuWndKdnlDVzlGQTBBTlNTT3Jsa3Ir?= =?utf-8?B?OG0rZVp5ZFFwckxkOERkMFhmcmwxclJndjdvYnZyZ2h3ZDNRb2JNLzF2U1Q4?= =?utf-8?B?NWloUUc3a3NwMC92cjN6RWlzYWRXUU5uem83MXVaNG9Gb3p6VTVKUU44UDNJ?= =?utf-8?B?OGJ1Z05iU0hLZTYyc3h6Qm9uOGF5a1JxRmhvUmhZUUJIcktLSnd6UE1Ic2pq?= =?utf-8?B?UXc3L0xUWnExTkRxLzlwMHRWUzg0VW0zbHJNOEpOMDVlNjNSVnlJSExSTzJV?= =?utf-8?B?UlNtUnFyY1F4OWNkeGZiRzlOVndFUGJLQ2VwUnVtNGRpSTlPN2pxTzQ1WFg5?= =?utf-8?B?ak1WNnpYUVJoMUNIbUhUcnJJSy8rNGRkTW5oOG9oTiszNlAyNFFwam9SNGli?= =?utf-8?B?UTN5M1R1N0traG1xWWlsTkhKRXBZRHdyeERXMWd1SDQwQ2REYklEV1JTV0ts?= =?utf-8?B?cVE9PQ==?= X-MS-Exchange-CrossTenant-Network-Message-Id: 11b1c442-44ae-4926-9b0d-08dc3230fa9f X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Feb 2024 16:28:32.6762 (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: qoF7LjBHX2+XNJXk7Q2wVf9A1ep1UQmttd7MyYwrD9So7Qb+99CHAwyOAG6kIhs9NuAFXJpIEjZHciWddW+j5gXHO3kb1RnHJVO7p+p7JWc= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ1PR11MB6132 X-OriginatorOrg: intel.com 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 On Sat, Feb 10, 2024 at 08:24:29AM +0100, Mattias Rönnblom wrote: > On 2024-02-09 09:43, Jerin Jacob wrote: > > On Thu, Feb 8, 2024 at 3:20 PM Mattias Rönnblom wrote: > > > > > > On 2024-02-07 11:14, Jerin Jacob wrote: > > > > On Fri, Feb 2, 2024 at 7:29 PM Bruce Richardson > > > > wrote: > > > > > > > > > > Make some textual improvements to the introduction to eventdev and event > > > > > devices in the eventdev header file. This text appears in the doxygen > > > > > output for the header file, and introduces the key concepts, for > > > > > example: events, event devices, queues, ports and scheduling. > > > > > > > > > > This patch makes the following improvements: > > > > > * small textual fixups, e.g. correcting use of singular/plural > > > > > * rewrites of some sentences to improve clarity > > > > > * using doxygen markdown to split the whole large block up into > > > > > sections, thereby making it easier to read. > > > > > > > > > > No large-scale changes are made, and blocks are not reordered > > > > > > > > > > Signed-off-by: Bruce Richardson > > > > > > > > Thanks Bruce, While you are cleaning up, Please add following or > > > > similar change to fix for not properly > > > > parsing the struct rte_event_vector. i.e it is coming as global > > > > variables in html files. > > > > > > > > l[dpdk.org] $ git diff > > > > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > > > > index e31c927905..ce4a195a8f 100644 > > > > --- a/lib/eventdev/rte_eventdev.h > > > > +++ b/lib/eventdev/rte_eventdev.h > > > > @@ -1309,9 +1309,9 @@ struct rte_event_vector { > > > > */ > > > > struct { > > > > uint16_t port; > > > > - /* Ethernet device port id. */ > > > > + /**< Ethernet device port id. */ > > > > uint16_t queue; > > > > - /* Ethernet device queue id. */ > > > > + /**< Ethernet device queue id. */ > > > > }; > > > > }; > > > > /**< Union to hold common attributes of the vector array. */ > > > > @@ -1340,7 +1340,11 @@ struct rte_event_vector { > > > > * vector array can be an array of mbufs or pointers or opaque u64 > > > > * values. > > > > */ > > > > +#ifndef __DOXYGEN__ > > > > } __rte_aligned(16); > > > > +#else > > > > +}; > > > > +#endif > > > > > > > > /* Scheduler type definitions */ > > > > #define RTE_SCHED_TYPE_ORDERED 0 > > > > > > > > > > > > > > --- > > > > > V3: reworked following feedback from Mattias > > > > > --- > > > > > lib/eventdev/rte_eventdev.h | 132 ++++++++++++++++++++++-------------- > > > > > 1 file changed, 81 insertions(+), 51 deletions(-) > > > > > > > > > > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > > > > > index ec9b02455d..a741832e8e 100644 > > > > > --- a/lib/eventdev/rte_eventdev.h > > > > > +++ b/lib/eventdev/rte_eventdev.h > > > > > @@ -12,25 +12,33 @@ > > > > > * @file > > > > > * > > > > > * RTE Event Device API > > > > > + * ==================== > > > > > * > > > > > - * In a polling model, lcores poll ethdev ports and associated rx queues > > > > > - * directly to look for packet. In an event driven model, by contrast, lcores > > > > > - * call the scheduler that selects packets for them based on programmer > > > > > - * specified criteria. Eventdev library adds support for event driven > > > > > - * programming model, which offer applications automatic multicore scaling, > > > > > - * dynamic load balancing, pipelining, packet ingress order maintenance and > > > > > - * synchronization services to simplify application packet processing. > > > > > + * In a traditional run-to-completion application model, lcores pick up packets > > > > > > > > Can we keep it is as poll mode instead of run-to-completion as event mode also > > > > supports run to completion by having dequuee() and then Tx. > > > > > > > > > > A "traditional" DPDK app is both polling and run-to-completion. You > > > could always add "polling" somewhere, but "run-to-completion" in that > > > context serves a purpose, imo. > > > > Yeah. Some event devices can actually sleep to save power if packet is > > not present(using WFE in arm64 world). > > > > Sure, and I believe you can do that with certain Ethdevs as well. Also, you > can also use interrupts. So polling/energy-efficient polling > (wfe/umwait)/interrupts aren't really a differentiator between Eventdev and > "raw" Ethdev. > > > I think, We can be more specific then, like > > > > In a traditional run-to-completion application model where packet are > > dequeued from NIC RX queues, ....... > > > > "In a traditional DPDK application model, the application polls Ethdev port > RX queues to look for work, and processing is done in a run-to-completion > manner, after which the packets are transmitted on a Ethdev TX queue. Load > is distributed by statically assigning ports and queues to lcores, and NIC > receive-side scaling (RSS, or similar) is employed to distribute network > flows (and thus work) on the same port across multiple RX queues." > > I don̈́'t know if that's too much. > Looks fine to me, I'll just use that text in V4.