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 26A7C439A6; Tue, 23 Jan 2024 10:43:43 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 143E7402C5; Tue, 23 Jan 2024 10:43:43 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.10]) by mails.dpdk.org (Postfix) with ESMTP id 32382402BD for ; Tue, 23 Jan 2024 10:43:41 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1706003021; x=1737539021; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=yUnSTP8eLfvxYbfgDro6wHhpOHtm0joHK/E5zlZQy0Y=; b=ZtXKAN5mU7yU4C/JyGoi1QcjMAO064faJx40tzqcu45uR5jhU26w1agQ s878LOGAwXgvMjwQMuHbVUacUkm0CxgtkIqoVnr0ejykpfg5VhC3rZDvL oPkAxhldeIvHoARbVFJcQoMNd+UWaDFN4KBoV9WzIzKZKmUo8N/Ovj/nN BYIDaRNZrYj3P8HfjGqwctbFllCoDyNxVpXgx8C/oKP9kSZyYQj1zQuvy ZFlK/8JP9J6ZAWaYGcdTkKZs/qZCNzLvMcx4iNIdJNXumfh2hG62ST0eb 1zwqx3+b2DFzePUDgDgh4vANuborur1m8NRds7bVn9s5rLgoN70BgOvT7 g==; X-IronPort-AV: E=McAfee;i="6600,9927,10961"; a="8864221" X-IronPort-AV: E=Sophos;i="6.05,214,1701158400"; d="scan'208";a="8864221" Received: from fmviesa002.fm.intel.com ([10.60.135.142]) by fmvoesa104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 23 Jan 2024 01:43:40 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.05,214,1701158400"; d="scan'208";a="20273762" Received: from orsmsx602.amr.corp.intel.com ([10.22.229.15]) by fmviesa002.fm.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 23 Jan 2024 01:43:40 -0800 Received: from orsmsx601.amr.corp.intel.com (10.22.229.14) 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, 23 Jan 2024 01:43:39 -0800 Received: from ORSEDG601.ED.cps.intel.com (10.7.248.6) by orsmsx601.amr.corp.intel.com (10.22.229.14) 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, 23 Jan 2024 01:43:39 -0800 Received: from NAM12-MW2-obe.outbound.protection.outlook.com (104.47.66.41) 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, 23 Jan 2024 01:43:38 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=BKR8VNh5tNFF2rcy+1kzVGdNJBA4m5Gy3wIN+I/arR2uAxSkfTF30lIt3a4N8AFC2Xe5ZZcB866u6qjd3FizT/quxUAB+FlYM/qFQLULOz05zaoJ6P98vNjCEl2sKEi6+f02KeHp2pv/ThMr89sy5IgvA+NZhmlFGXOCRTHnsGPiuqJQcBZS1bQpnN1edsXd7E1EdxtRmRKsTmICJsY+BAmFZOycifLdAQmMMXmfl+3JHLQ2GH4C9n6AsIKosfmYcMfdukeceQwtoPxltKihpGftwNhtwNVlbAuxs92dWt3KP43gOfJvOXo0FKYalOMfjbvJ3EsZZZ44ZTcI74QpzQ== 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=NwDhYTT/LGAihLPLdu+KrABUYtQMl23Q9ig/Hhad5mE=; b=QpOYr3JvwMRqgVK392ZOL4eFQtIR195OI11/oElmRJUcrHrF2ma2+a8cX2MImSHuEVMTLbLFuyGZOASoDkqsC2WOqW38YUlSyWdKFbHNKz/6F4lcHG0WvfpNfFiS/l+JV1rz2qnn/OT2Xk2d9SwkWE68SkC88ow75HycXphAbZPqhFpppL9x1u0lNv+zM7f8H7jxJh8zz3Clf653TucV9ECUX8CoZVkkcZiRJdEeivSl6bfUwsys9VhTHNyPiC4uODVnFCY/pk3ZXCP8C0oqTXgtT+bT+ue9JiJlw9GjuTcN6boS869pnC2IljYuupPqa+ACsUuitmBSR2Euh1G3VA== 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 PH0PR11MB7660.namprd11.prod.outlook.com (2603:10b6:510:26f::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7202.34; Tue, 23 Jan 2024 09:43:37 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::df88:b743:97f8:516c]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::df88:b743:97f8:516c%5]) with mapi id 15.20.7202.035; Tue, 23 Jan 2024 09:43:37 +0000 Date: Tue, 23 Jan 2024 09:43:31 +0000 From: Bruce Richardson To: Mattias =?iso-8859-1?Q?R=F6nnblom?= CC: , , , , , , , Subject: Re: [PATCH v2 04/11] eventdev: cleanup doxygen comments on info structure Message-ID: References: <20240118134557.73172-1-bruce.richardson@intel.com> <20240119174346.108905-1-bruce.richardson@intel.com> <20240119174346.108905-5-bruce.richardson@intel.com> <65d09512-f184-4ac4-a513-e5820754889e@lysator.liu.se> Content-Type: text/plain; charset="iso-8859-1" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <65d09512-f184-4ac4-a513-e5820754889e@lysator.liu.se> X-ClientProxiedBy: DUZPR01CA0263.eurprd01.prod.exchangelabs.com (2603:10a6:10:4b9::11) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|PH0PR11MB7660:EE_ X-MS-Office365-Filtering-Correlation-Id: 053432a1-afa5-4647-a36c-08dc1bf7c574 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: WmNPZUVoTaFuNMaOdfWvNSSX3yTqb9V1nrwKuHdQhVnisTQqDhJ9gui0FyBinmyB5MK72gsVDYZK3XaEMXe5yShauE6QzLyC+2zxqrpMSPF1Sqoha5LCEd74MLaJWgDycttYHLvc1Q8egnTipQU+GZNhnS3p1rSn0XR+29j3pn81XEcUTd2b0oSTWsfVYbrV3EI1QFJOElVAG/bEI520X9P5AN8s5JUXe08mWJjxH4IhrPn5sFfP+YUMpggAAXn3Fj7c546NAaNuV/f6PauyKkk/M58lqM7YvyHLghaBQzF1bDpytccgQZT7tD6x55bBYw4O6XEXRKe1GFjUnru2RPfpEJ1cQeC9g6z+4a6b5cI5/1OsTl4cmTjqljsSvBj86xBjrHepTd4AaB5ITW7IIXpqKGguGthbxwYlSKWONAVJ8Ovf3QqwpOkpIOwTgDOIBoiHRye4vwVGd7aqY5yRwqh9YetJ234k2uEYQalOYXZwdVUMoCVT/s2qKCfXWDfdEdU4Bysvdom/4FTeRqI2UjJ6PG6Ea50Al7jB6SxmaGjnSZbAs4xb5T83y2gRfHl1 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)(366004)(346002)(376002)(39860400002)(136003)(396003)(230922051799003)(451199024)(1800799012)(186009)(64100799003)(82960400001)(6666004)(26005)(107886003)(6506007)(66574015)(6512007)(53546011)(83380400001)(5660300002)(478600001)(2906002)(44832011)(41300700001)(66556008)(66946007)(6486002)(6916009)(4326008)(316002)(8676002)(66476007)(296002)(8936002)(86362001)(38100700002); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?iso-8859-1?Q?TfgitTwexQUCpqAI8ySPd1XxjSJQbanY5SY5zVKo30FXlu8ZXYu+EM+pp0?= =?iso-8859-1?Q?Q0HVZO9bqoN6QVw7PStbTaogCxmWSahoAixf9Cz/iOrkz7lusze+uid942?= =?iso-8859-1?Q?GOQxPIelWFqi13TmxBQzStYuz5GSmdF5lfeaqU9dorkvxokAFeBVdSrRaq?= =?iso-8859-1?Q?P70BsMgsKNaJ21FQyV1uPCMxPS2foN1oR26hYFn3x7SYc3l3l8jqIjyXb/?= =?iso-8859-1?Q?2LKRgh5+lS5/wuB97ujU49qeUVIW/QKy/rojsvR/OrIOuXT75kyNshsZb6?= =?iso-8859-1?Q?tiiLp2AXqYrpoK4sv5FjXCk9OxcSNuRMZ+IQdTaj/h4RRmX0BfLdQF4kbw?= =?iso-8859-1?Q?b1nx2QpA714e4zpzK8zO52F4bLAOPXmjyhvM8mB7nFnslABdqeX6Oy8P/O?= =?iso-8859-1?Q?UnIX7KhaIeEtbBBBOHbmtuamZa9ex82HvKRLE/Aqy6bA2MXIZYFd8IodJt?= =?iso-8859-1?Q?+WGWALnvAiIKzKU5e2UAAfH/RD36AnE6vKoyAX07/fOGtb6k1+FEWVYS5H?= =?iso-8859-1?Q?Xu3KdOynWmImRGkCQ/zWadUcCkhc96dki2ftN+qHPaH8HPafCZUb4+Sn1n?= =?iso-8859-1?Q?Vyl1OXKbo+ZqfgDs4QTcjE/3cI84RIlTlJGPWmLJdFpyYSeS5HJzhB565+?= =?iso-8859-1?Q?QPJ8XpOOBaYuwqoKLZau/d6n242Q4D5ENvRTUbVX73V0Mwjfpipqm6xs/o?= =?iso-8859-1?Q?h5CQ2oU2WHBVzg9Sh37pEYozzhey1wEaXPZuarZw3gp5XF3dfg8Gc3Rz+G?= =?iso-8859-1?Q?rt/s1UnB8VdD+cmJrozBY+PY0715VzVx5KNeaRUEMu1mF+dhHOJAG6ldtD?= =?iso-8859-1?Q?e4iU4yWq7Qq90ayRnINHlmi8NLsQjVBBBkARDXKr9btiahmqeK1uUG65Iu?= =?iso-8859-1?Q?f3Vdk4E6WkG9XlBVJhJ6JoaH2pbxY4XOQvf29HQV92hD3A87hWr2j0Vajn?= =?iso-8859-1?Q?T8Gmdsokf9GuhiJ0lW3kR3kBHcVV9dhB1TUTLZb6znWWmbHmO/xnk/joK7?= =?iso-8859-1?Q?XIropz4vWSCnvTHtgtbeyME915i3nwC9oAIY+XaIfiaVUEqr0FRn7EQ3wZ?= =?iso-8859-1?Q?OhgLzv8CRJUJpORO7tYAigDgko+tMLX9o8SYhmoagxAGPc/PBTY5WzbuDE?= =?iso-8859-1?Q?i79wFq9j2KVOYQP9+QT4FgyNr0zcf/5KZUbOe1niHYPndWFeaxuByK2u/o?= =?iso-8859-1?Q?BPLn6fcUNBby7gCWw6eqdKK6d9ZrP5iCJKZVRESWThbuuk3X7S+er+k7b7?= =?iso-8859-1?Q?DauunQ74wVLIpgpPE4PYrP/cFDN7n3eqOiPLX+Qu75zXmp3/jRxMBG5OvU?= =?iso-8859-1?Q?eN8CJuTZYpBI2rIQO7dL+vbqTg9iJX2ODVFfTol3hNog7D4pniUO0O5WaP?= =?iso-8859-1?Q?YluHWuFpZ9q3eQkbwWtFtS/8/Pl7OpSftUDjSqF7SJNsVFpHo63EswDZna?= =?iso-8859-1?Q?Hs44NH3HwjIr2/qrFUj0dS6HgCtVog1WMc0OKepMXkQyft/P9CNI9tLSWj?= =?iso-8859-1?Q?rw0abFjyb379qYc3lQWuYWzd/JoPiqjIaKpqXxiI//kXPF0BJgn8YkzwWG?= =?iso-8859-1?Q?viQKnWlANkotE3CuaUdUXVoAxD3eZd4IfpfhUVJ5CCsA3PFVWqgPEKjYZF?= =?iso-8859-1?Q?8E3VUSqRf44KHh1kY4s5du2//cmG0h6QxEOOtlaXr3qjcmxpKBfyfCFA?= =?iso-8859-1?Q?=3D=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: 053432a1-afa5-4647-a36c-08dc1bf7c574 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Jan 2024 09:43:36.5090 (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: 4MgpgEkKQFxFhz205yp9n4c/fDTTIt8nwTIun5D+YuXE/rbeMPHBE5HMIJQV6bXtqqTaMjLtYjbnkshWMmyDiIha0gsIdcQykGm7e0udJRc= X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR11MB7660 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 Tue, Jan 23, 2024 at 10:35:02AM +0100, Mattias Rönnblom wrote: > On 2024-01-19 18:43, Bruce Richardson wrote: > > Some small rewording changes to the doxygen comments on struct > > rte_event_dev_info. > > > > Signed-off-by: Bruce Richardson > > --- > > lib/eventdev/rte_eventdev.h | 46 ++++++++++++++++++++----------------- > > 1 file changed, 25 insertions(+), 21 deletions(-) > > > > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > > index 57a2791946..872f241df2 100644 > > --- a/lib/eventdev/rte_eventdev.h > > +++ b/lib/eventdev/rte_eventdev.h > > @@ -482,54 +482,58 @@ struct rte_event_dev_info { > > const char *driver_name; /**< Event driver name */ > > struct rte_device *dev; /**< Device information */ > > uint32_t min_dequeue_timeout_ns; > > - /**< Minimum supported global dequeue timeout(ns) by this device */ > > + /**< Minimum global dequeue timeout(ns) supported by this device */ > > Are we missing a bunch of "." here and in the other fields? > > > uint32_t max_dequeue_timeout_ns; > > - /**< Maximum supported global dequeue timeout(ns) by this device */ > > + /**< Maximum global dequeue timeout(ns) supported by this device */ > > uint32_t dequeue_timeout_ns; > > /**< Configured global dequeue timeout(ns) for this device */ > > uint8_t max_event_queues; > > - /**< Maximum event_queues supported by this device */ > > + /**< Maximum event queues supported by this device */ > > uint32_t max_event_queue_flows; > > - /**< Maximum supported flows in an event queue by this device*/ > > + /**< Maximum number of flows within an event queue supported by this device*/ > > uint8_t max_event_queue_priority_levels; > > /**< Maximum number of event queue priority levels by this device. > > - * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability > > + * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability. > > + * The priority levels are evenly distributed between > > + * @ref RTE_EVENT_DEV_PRIORITY_HIGHEST and @ref RTE_EVENT_DEV_PRIORITY_LOWEST. > > This is a change of the API, in the sense it's defining something previously > left undefined? > Well, undefined is pretty useless for app writers, no? However, agreed that the range between HIGHEST and LOWEST is an assumption on my part, chosen because it matches what happens to the event priorities which are documented in event struct as "The implementation shall normalize the requested priority to supported priority value" - which, while better than nothing, does technically leave the details of how normalization occurs up to the implementation. > If you need 6 different priority levels in an app, how do you go about > making sure you find the correct (distinct) Eventdev levels on any event > device supporting >= 6 levels? > > #define NUM_MY_LEVELS 6 > > #define MY_LEVEL_TO_EVENTDEV_LEVEL(my_level) (((my_level) * > (RTE_EVENT_DEV_PRIORITY_HIGHEST-RTE_EVENT_DEV_PRIORTY_LOWEST) / > NUM_MY_LEVELS) > > This way? One would worry a bit exactly what "evenly" means, in terms of > rounding errors. If you have an event device with 255 priority levels of > (say) 256 levels available in the API, which two levels are the same > priority? Yes, round etc. will be an issue in cases of non-powers-of 2. However, I think we do need to clarify this behaviour, so I'm open to alternative suggestions as to how update this. /Bruce