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 4218945C87; Tue, 5 Nov 2024 11:30:03 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3048140663; Tue, 5 Nov 2024 11:30:03 +0100 (CET) Received: from NAM10-MW2-obe.outbound.protection.outlook.com (mail-mw2nam10on2081.outbound.protection.outlook.com [40.107.94.81]) by mails.dpdk.org (Postfix) with ESMTP id E8F2F40671 for ; Tue, 5 Nov 2024 11:30:01 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=qF9G15bjAtdCCV2gu9h66BBOOvfNO/z1IXL9sKR6vz0j0tlrfsDigSwvWBIaWujFUJfMT28gcMqfF3T39kDdA1WCLOcAO2uSTwh7dz1k225c89pWMTLy0eLuxwDLgGzqCNyUZCAXh/DUBBfHo38WdYG1zqMfQ7b6onJw8AdfkupKH4cv0n35n/UaxpQGsbEictJoSpcc+cy2K08cwUuWCwWXnYuausU01rbBBLadcDmz9ov5WKWL+SmGkb/oedpQ9IeXXhlFgFk7/TfqgT1PL3UllnR5l7w+UpZTdgSWQGSDYeayLX1uTsj44YAhFBaywLviXPuUusIqBFhJZhuYSg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; 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=1AGxq+YwynpSFyATJz/YtZuWXhGIOX5zfKP/zXUzi9k=; b=HlkUm1l+AEWadNjk2scvBrzmIFC/SNR4qjZxeOzjw02VI8OiU406pXPyLO0IVZKG+7ekiegY8GDZoiNLTV30f32K2CdZL1A0JXHYO2hD/Axu0/gTHfqnYcmpXJ9RTUHeMrGm80A1ZqHK7UaEfqbizSkglPUJ9sypn2G+HlEbVDkTVQ47R/ftbIkyNLN3p/CTDKIS7w8ekWq0pCqoOU0Qb3UyxGh7/ZgNlAV5ea+idtXolixLDfRj12RCqlFs654NNypeHEmDo0+SshcPzucj58RtoAPhbFWyn/afkBx9c9x5rWspkrud/fQB6ZpeC5PV4DwesBvdiykshie3rY8iyg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=dpdk.org smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=1AGxq+YwynpSFyATJz/YtZuWXhGIOX5zfKP/zXUzi9k=; b=z5rXeiiAhwVlNcQzzO57MJVP0oc84q5XXGDKfFKFRbjnlcacncdba1XhaoTRwBdJijs4AvuexgbEXD1scemrZUY7RkDrsuFuKmJ8eNfVjdmNvqwz29/FD2h1PgSa0sOJ2Ts6xOAECsGYqqfId69RRmq8JJ8nl4oDEA8AenB3wA4= Received: from PH7PR10CA0017.namprd10.prod.outlook.com (2603:10b6:510:23d::10) by MN2PR12MB4271.namprd12.prod.outlook.com (2603:10b6:208:1d7::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8137.18; Tue, 5 Nov 2024 10:29:58 +0000 Received: from SN1PEPF000252A1.namprd05.prod.outlook.com (2603:10b6:510:23d:cafe::fa) by PH7PR10CA0017.outlook.office365.com (2603:10b6:510:23d::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8114.31 via Frontend Transport; Tue, 5 Nov 2024 10:29:57 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C Received: from SATLEXMB04.amd.com (165.204.84.17) by SN1PEPF000252A1.mail.protection.outlook.com (10.167.242.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.8137.17 via Frontend Transport; Tue, 5 Nov 2024 10:29:57 +0000 Received: from BLRVIVARGHE.amd.com (10.180.168.240) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.39; Tue, 5 Nov 2024 04:29:52 -0600 From: Vipin Varghese To: , , , , CC: , , , , , , , , , , Subject: [PATCH v4 3/4] doc: add topology grouping details Date: Tue, 5 Nov 2024 15:58:48 +0530 Message-ID: <20241105102849.1947-4-vipin.varghese@amd.com> X-Mailer: git-send-email 2.47.0.windows.1 In-Reply-To: <20241105102849.1947-1-vipin.varghese@amd.com> References: <20241105102849.1947-1-vipin.varghese@amd.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [10.180.168.240] X-ClientProxiedBy: SATLEXMB03.amd.com (10.181.40.144) To SATLEXMB04.amd.com (10.181.40.145) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SN1PEPF000252A1:EE_|MN2PR12MB4271:EE_ X-MS-Office365-Filtering-Correlation-Id: 115af0c8-c28f-4b81-aea1-08dcfd84cbd1 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|376014|7416014|36860700013|1800799024|82310400026; X-Microsoft-Antispam-Message-Info: =?us-ascii?Q?ZxUpBpzT19Ga86DGn/hZKV/qVHcGHblKZjD45UPuibA4bFQ189lUEhofCBXa?= =?us-ascii?Q?nGxTZOgmd0v1MnvadnpxBOnC51qqFSyaetl9wGtRN2F+Os9vS2pkUQW4cwK0?= =?us-ascii?Q?iSEVKqOB2If6g3KjGrQpMa7c0SzlfSzBfnKJ+1igC5QPsYintp83BstlzgS3?= =?us-ascii?Q?IqjBakyZyQwaOEiiObM4gviEvwV7v37ODl+t4g4jpH3dloYjMFIB+WsFGdgU?= =?us-ascii?Q?WGysU5p0i73VDU2uQpq3we5thXvJie4RPAF8pc3e3v1+PzlBl+6daVbHiUl0?= =?us-ascii?Q?9DVpL+LHBdVfBaCfDAZUPrXAHVMXtz4E1yYL/2GbI0b76l44i5KMHzpcWL6Q?= =?us-ascii?Q?vkeaaIfbRcB0Wbw4IltCVawuTXQ7C0P6zox1SFc4u1UY31KCTJPSXmkHfJhF?= =?us-ascii?Q?bqXAXcVGwOJbeehrFksNePKcYNzd4FI7IXHtepaqU1Od1aKxealpWhef/Vwt?= =?us-ascii?Q?bQft2TNrIZfa7mVK8soDrgvD0RB2cMZ3gjK17R3BAkBB3J/GcjKLdgu5q71p?= =?us-ascii?Q?+An0ur40AEvz8bQWd6ch6AHVLWEu5Rtf7YrQcOdok9yq3CXZD6QF+G2c8nPX?= =?us-ascii?Q?Ejw93tdmXw9fLsQ2DmOtRa5Zu9Cjdvg8GAUUbU+/Ov4tGNxMkMB3gJiG48H3?= =?us-ascii?Q?xdRXwfOSmkTo2emZ0HNSStNR+4KOxHBSs3XtgvL2dhnaxXcrQ5Prg98VTX1R?= =?us-ascii?Q?BV9QvSvR4EWEm6hdy3heKvliFhDsHPYXUKU1RoSiLYrY8z/7JJrJ6TT70pAS?= =?us-ascii?Q?QqXJhTGTKnBzDoibXZB+BdFwS3tJfKaBeLL4Zy10xgORGgssNhCIJG3xByip?= =?us-ascii?Q?maQwTPyZyRK+ZKgL9K9WFIyZEFyaac8NjkmHI0NWEZEGIfRSkjEXJfIJQlpX?= =?us-ascii?Q?vP2dE35T0AKRPrwxeRG/+OM8dDcmSu7Bm/W0o3wCNM60BaBFjPhDgrnSUWgN?= =?us-ascii?Q?1RbLKhHMBUqbF4X1TwyfUyqk0cczgRUbXuIoPYdmEb8gPiYfvYOfmrVVVdJp?= =?us-ascii?Q?AOEoDhIWkNPQPvrFp1enBn7G09P5QoI/xWyV/ACbHZv5ex3TI/jhnH+rtJib?= =?us-ascii?Q?YS48DcrkCc9tyhxdIo8R9RVKIQUPSLOr/Eov0HapLMxIFl4tMovX+x+qrIBN?= =?us-ascii?Q?zRmndvc+Dc9Zu9W2UrOF0b+/T9HhBbByG8GsuovnOeGbrP/WKMIt77vkbHlT?= =?us-ascii?Q?gIEqClUPefRtuhe0D42usHNHPrRXXd25fA5UIlonU3MRwTHiINEUwcRyEBWD?= =?us-ascii?Q?Oxnpk7Y19xkNVUWu6rW+QUzwZS//nKZqeJhybPj3FFCH/m6UCNzaoOoDVYmP?= =?us-ascii?Q?NcrzWUR+SzyQgW36dNFXJZc7a2nlJPOHbOy87aSYOlREvF6EvEp23oTKj/0F?= =?us-ascii?Q?T7hhBlHVHq2nfGIYBpO7sXeL7BQmAGmY1IQ6X/GXYwUiUnbiew=3D=3D?= X-Forefront-Antispam-Report: CIP:165.204.84.17; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:SATLEXMB04.amd.com; PTR:InfoDomainNonexistent; CAT:NONE; SFS:(13230040)(376014)(7416014)(36860700013)(1800799024)(82310400026); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Nov 2024 10:29:57.5857 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 115af0c8-c28f-4b81-aea1-08dcfd84cbd1 X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d; Ip=[165.204.84.17]; Helo=[SATLEXMB04.amd.com] X-MS-Exchange-CrossTenant-AuthSource: SN1PEPF000252A1.namprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR12MB4271 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 Add `Topology` section into eal_init documentation. Signed-off-by: Vipin Varghese --- .../prog_guide/env_abstraction_layer.rst | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index b9fac1839d..3ff6a17501 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -1188,3 +1188,25 @@ will not be deallocated. Any successful deallocation event will trigger a callback, for which user applications and other DPDK subsystems can register. + +Topology +-------- + +During `rte_eal_init`, an internal topology structure is created to group DPDK enabled +lcores into various topology. Using HWLOC library, lcores are categorized into multiple +domains based on topology groups such as + +* L1 cache +* L2 cache +* L3 cache +* L4 cache +* IO + +Using `rte_lcore_` extended API, user can retrieve lcores from groups using topology flag and +domain index. Refer to the API documentation for details. + +.. note:: + + Topology API are tested on HWLOC library version `2.7.0`. + In absence of HWLOC library, initialization of topology objects is skipped. + For cross compile, please ensure appropriate path for `pkg-config` is enabled. -- 2.34.1