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 F201543BDE; Mon, 26 Feb 2024 05:51:32 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7EE5D402B2; Mon, 26 Feb 2024 05:51:32 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id EC7FD40271 for ; Mon, 26 Feb 2024 05:51:30 +0100 (CET) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id 41PMk1YD012344; Sun, 25 Feb 2024 20:51:30 -0800 Received: from nam12-mw2-obe.outbound.protection.outlook.com (mail-mw2nam12lp2041.outbound.protection.outlook.com [104.47.66.41]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3wfepr41d1-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Sun, 25 Feb 2024 20:51:29 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=nVxlWv4FNPzXyL4dg/dXOEG57n3W4IlC4Wq4SwXxN3Pg4bk7tsPiqMHw0mDMoZV5svh1e16T8IQ8/JGPZVoXbKoZRDPA+QFCw55rO9LH7SgYanLQXOGdFDCeO/hxuOAU/oZatH767vYlNk10vfA2mTGkoIpyM5h6Ge3RHzLRd1bcnsEwoqmauEexd6e64sYSVDLKdlPYv2t1Mr1dWJ+PBY8QIpoeuuAgVAlX021JYs6iwkV6lyk3dUQM1J7ADEYNgiZiJ2B6R9QtLl2FMpwHgSJ16G+R2yQfXl44ocl0BZgx68+UcMlX4d1TpTsOpkDcB6GLksUuIXHfpTd1tN37Sw== 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=nySi9WOzKevyVrgzlOw/TgPn85j8+F4kvq603mzbcOE=; b=Yr9FX6XIAn8H1kpTIOtB6aiYeNIqf9sX84wrE+2wKhNckIwthNH8S04opGk4/ey9Ii//1WnobM0T2/0hN2TX4RSKwWKhmn57IM7ZAkkILd5R3rxi0t+npYf/V6HondG/F+ZlHYc0Kzx1ptGWdx8gKxXQxOHnjqFhs2tDH/KoA5wT/heVMOG0YoEdHEveGMJEPH1hoiiABisE4+2K2oej8KQ30KS4H37d0nmt0f4ouQwKyPhnDZQVz1ydVTwT87n4mMJF8xFk1frqf9GniglbBtZEFZOhAWnpZ3K1JG3RHpiYkCZJGYe56qjxbp/zpN/C66hwKKR2Fw1D0SRQm4s1tQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=marvell.com; dmarc=pass action=none header.from=marvell.com; dkim=pass header.d=marvell.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.onmicrosoft.com; s=selector1-marvell-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=nySi9WOzKevyVrgzlOw/TgPn85j8+F4kvq603mzbcOE=; b=b31nwCdWJgXc2wsyBFRC2XCNQnsw71DXVTlER0vqpdzsaICzxAzK+V3kGwvdE2l3kjQzG5FEdtb5/47UrHqgx+5/pSJM01nLggapHU4S7eLOxFCVD3V1RJ3Xjl8vF2ru7kNtqPWSMc9NbfNBQXNXc1YMCkB8fNsVhnTNlrCbzoA= Received: from PH0PR18MB4086.namprd18.prod.outlook.com (2603:10b6:510:3::9) by SN7PR18MB5361.namprd18.prod.outlook.com (2603:10b6:806:2e0::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7316.34; Mon, 26 Feb 2024 04:51:26 +0000 Received: from PH0PR18MB4086.namprd18.prod.outlook.com ([fe80::baf5:a4b6:7776:10f4]) by PH0PR18MB4086.namprd18.prod.outlook.com ([fe80::baf5:a4b6:7776:10f4%6]) with mapi id 15.20.7316.034; Mon, 26 Feb 2024 04:51:26 +0000 From: Pavan Nikhilesh Bhagavatula To: Bruce Richardson , "dev@dpdk.org" , Jerin Jacob , "mattias.ronnblom@ericsson.com" Subject: RE: [EXT] [PATCH v4 01/12] eventdev: improve doxygen introduction text Thread-Topic: [EXT] [PATCH v4 01/12] eventdev: improve doxygen introduction text Thread-Index: AQHaZLFMT973S+9MxkmGp0m08NWbW7EcE1xQ Date: Mon, 26 Feb 2024 04:51:25 +0000 Message-ID: References: <20240119174346.108905-1-bruce.richardson@intel.com> <20240221103221.933238-1-bruce.richardson@intel.com> <20240221103221.933238-2-bruce.richardson@intel.com> In-Reply-To: <20240221103221.933238-2-bruce.richardson@intel.com> Accept-Language: en-US, en-IN Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-publictraffictype: Email x-ms-traffictypediagnostic: PH0PR18MB4086:EE_|SN7PR18MB5361:EE_ x-ms-office365-filtering-correlation-id: 01fc89d0-2134-4802-5285-08dc36869697 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: 05ocHPUpyTquutRRPWLwEqrePrj5TlGwtntEDqTu86LXpv+558HBRlLlnvcGJ1JWbOakgea6NFalc5CLidTt4N1lVK0H9GzKrozt9QY0d+sxnjgBOWJqEJWM3+NZ6iLakWEYUbwnXkmUtpNrmnJHImnjPygFvXiCBYwQUcPSTiZ5jYhxtg6xnGEYkRa1r/HTUucSdD/nI8lCaG9xYIKt2Lf1YPdF2qkkA9r1enQvj3qj+R5tgDJ6kqZaDzw8gadOqy5ybbZXLMGBuIACO+BSqSoFk2qqDAI7DNL5BWJPLg6RB6QW5qPuZn7ilCON9A+G4j4s8k5IlrrWfZwLfYHVBA8FskkSUTJiH0KjwmNh13FfQAlfuv00czyQa6kFr0ZjuFpt8Y3C/WffqdpWXf6wZJJdYObXJP+lj0Grpqi75d5qGkIUuvC6aR+Lh57BM0imZhtrM24B8KNg2rKGAPu3T79LGYK1RJv+8n+0wnUZobpJthh6psW2G3iC7IQHitFc0u9omJY69gVWxnL2Ep5WiYMA7qzVHz/iQXzH4M7lP04u858yj9QJ0thdrWBYtuRsWikpxdifiEU3Aa45usJzec1HusasrcuUk+ifrYOp3Ec0j6cfafExOiQx9jmZOvrNeIh0U/3f0QEcZn/2E0SZ6z7yOaBiC3MIadZot5aPvA4e7XZn5azI0F/EjIhUQj4JVYSlEQntkdPTwHxKt1iT8HMHuc5uV0W36rOif2+Hcag= x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PH0PR18MB4086.namprd18.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(38070700009); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?e5l2C9qrosQT1G1tp3b7i0y5YQYV0CMyHxirGNberOkupqNAbMhs3mNL0YYH?= =?us-ascii?Q?7fOdF+iDcq9it9E1YnkkEC9/clL32s5NZ0M7awjigG/TJ3imz/sQxAjlXEgl?= =?us-ascii?Q?IzAsaxRGJXMwq0eiYTAuNDAbL4/Bs0xAYMzsCwClHW4M5REg7B5zE++/Uyj6?= =?us-ascii?Q?BAMVy4kTdQyd5k9t2Nc/zu/LkPUtYe8DEuv3oRgRHxGrE5NE8F+63W9gdkUp?= =?us-ascii?Q?7lN8Q/xVQIo2LXK2OY4UsMytmQFV1NhwBMk0fzk+09fwIobvYfChRvZ1Mjn0?= =?us-ascii?Q?IXnLkGviKgNxHqt0HjM30Vdu5q7HR9MsOs+A6HqxiT3l+oQ5O9LRDt3QfPas?= =?us-ascii?Q?4HLU/E1auDLO5gA+MlNy7FhZ4Gpxusw3W1A6dYgGrSI69hYBRp7fIupK0C8q?= =?us-ascii?Q?qBkONlD29PmrX2moUnuepO0OEu52fKZRlKT0Yka035cqMSoyNCmRlDYkw170?= =?us-ascii?Q?iU3iwFRxp27/Lv++1v7aEWuSqsTSGORyjsec5yaPhsoiv1sULbZpUaDiAJO1?= =?us-ascii?Q?7Iesrhx9L+0C4BCdbI3impJ/fK/ki4OxW54oIr9v124kVH1zfHni62J12jJw?= =?us-ascii?Q?yYesOohEEDEoJXvxNLtHrtsHnm+BpPjnIvxco2B1M9+OnFg2GIaXchgBtu7N?= =?us-ascii?Q?BTZuvJiC5+zO0cEuTcAoKAVbYbhLwCSzPB2rTcZFnnnWSss16c88ebD2h6c0?= =?us-ascii?Q?nFrtQb4l5SXjsDZV5ZfP92nk8TPAvUfO4ADfQSO5o0HS0ZCUw2Y3TYHpfIDo?= =?us-ascii?Q?tSBJTBeqcD504q+69h4G9Nu3P/8MaE9vV/DT7hKtP4dxPlC27+U5RL+OCs6I?= =?us-ascii?Q?qc4msqjsb3lnITOhOYG75jIYlQZuPk/g7zVvDltABRKmJBlCGeJXeTVdxCwV?= =?us-ascii?Q?d3B7O+YrrukzJyf06NSgihl33bCPSxuEObbzUighuOQwoBnm9TSEmgZHXoAE?= =?us-ascii?Q?3tJO/auJfpmN1dB1Kl8c+YiWIZ/+2sRG0aq+fB9ASupHlG2+d1zarEEnU9BF?= =?us-ascii?Q?UnDQh4UyKAYh4+UUhddYA4ugdza8QoWtDGNrtO764LBcx2H2KEe5VUi9dayz?= =?us-ascii?Q?shNi6cpfkBcNSbNh7lcuD4Gb5jVZa249Q3XdIbwtDTKRd0al/mZFESPTAlHJ?= =?us-ascii?Q?muEjIqUBHeHXEuy0kIeUeBLaEdJXOnezApqFq93zS4uv04dgAe3O9OmsaqUc?= =?us-ascii?Q?aVwScFHFkXqOFlgKQi/FRPv+u3+SJeauZvJBNglpexmWVLszUuDh2q/sIKTG?= =?us-ascii?Q?IOHOkvul12pueHV2GaF8lMUGW5fhv58qEpMIUKddEj3oCAp8C/tLNmW+3cYm?= =?us-ascii?Q?F/Sfs1WKEWK7SiWJyLH5Td+FfB+vt/UTp7DTjvqkm7BEQnqkj4Y4PY/0FmJY?= =?us-ascii?Q?Bksh3Oef5ZqGoXKLMkSwxSe3H4dMS9B/GiS7ZTKp1xMJfzrfzk61PLtgn0qt?= =?us-ascii?Q?NtrNb1/cw8PJdxx6FxzmpWvPxBN69RShQcTVR0mHgDJm24bvmI5XvSkJcCj+?= =?us-ascii?Q?+/7R9OysJ56fXp1PFbXDyxWWoPtLj30C/rryQarRaxL0vxKrmWiKNUWDVoJ3?= =?us-ascii?Q?MuhNIEtTPnx5sWYg5961wJRDxcXlek4qA1mDLr1b?= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: marvell.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: PH0PR18MB4086.namprd18.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 01fc89d0-2134-4802-5285-08dc36869697 X-MS-Exchange-CrossTenant-originalarrivaltime: 26 Feb 2024 04:51:25.9687 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: 6EWn1LNZsJs7jwhbOBH+h2Q2dUQjap3lF4IIcA6yr/HrMmiSLy5aUfMGF9AnipHKhHtPVdYcc9oOtbr7/kWK6mufRj7U8UdYih4PcXIv6Jc= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN7PR18MB5361 X-Proofpoint-ORIG-GUID: qmnCvG_wRleInerCgAHQ9Uk9gOghHJRB X-Proofpoint-GUID: qmnCvG_wRleInerCgAHQ9Uk9gOghHJRB X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.1011,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2024-02-26_01,2024-02-23_01,2023-05-22_02 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 > 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. >=20 > 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. >=20 > No large-scale changes are made, and blocks are not reordered >=20 > Signed-off-by: Bruce Richardson >=20 Acked-by: Pavan Nikhilesh > --- > V4: reworked following review by Jerin > V3: reworked following feedback from Mattias > --- > lib/eventdev/rte_eventdev.h | 140 ++++++++++++++++++++++-------------- > 1 file changed, 86 insertions(+), 54 deletions(-) >=20 > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > index 1f99e933c0..985286c616 100644 > --- a/lib/eventdev/rte_eventdev.h > +++ b/lib/eventdev/rte_eventdev.h > @@ -12,25 +12,35 @@ > * @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, l= cores > - * 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 scali= ng, > - * dynamic load balancing, pipelining, packet ingress order maintenance = and > - * synchronization services to simplify application packet processing. > + * =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + * > + * 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-completio= n > manner, > + * after which the packets are transmitted on a Ethdev TX queue. Load is > + * distributed by statically assigning ports and queues to lcores, and N= IC > + * receive-side scaling (RSS), or similar, is employed to distribute net= work > flows > + * (and thus work) on the same port across multiple RX queues. > + * > + * In contrast, in an event-driver model, as supported by this "eventdev= " Should be event-driven model. > library, > + * incoming packets (or other input events) are fed into an event device= , > which > + * schedules those packets across the available lcores, in accordance wi= th its > configuration. > + * This event-driven programming model offers applications automatic > multicore scaling, > + * dynamic load balancing, pipelining, packet order maintenance, > synchronization,