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 D68FB42635; Mon, 25 Sep 2023 14:22:21 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C4CA040DCB; Mon, 25 Sep 2023 14:22:21 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.24]) by mails.dpdk.org (Postfix) with ESMTP id 0C83D402DF for ; Mon, 25 Sep 2023 14:22:19 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1695644540; x=1727180540; h=date:from:to:cc:subject:message-id:references: in-reply-to:mime-version; bh=qP8rdJyULC5XXUSlk+4/SxNM62U8lFIm3eJr38MFZUM=; b=g5BpZF7ZK5G6FcwiIMQ7emMegIPZhQFwxq7ScGvntdU5iKWIXFSudPJ4 FqK0Mvo7Uzyq1wAKDlAFc+JjJmZ7PwYe3+1WgSM3hIVt5v5vVnxJwHfqE lbW36EBI2qRfCSSEFSRCXtKWbfnGpkoFcQ0xoJ8+yT5NcZE6rHdMlGzPu /MzXd2xOM+D+wyow2TfA72llYkgRwgjI3IrPXNCLBJUrp7HG5CbEFQiUW uIqdkIB9NDI7bBK857aVSTXyYS3S3LE69mkWnp1YwgJcoBc4fnp40vGVv 5JOVtyVR9WC3P7VC70OunMkf3gEBAA9ikqXSmPJNmMMCZ/M4EaDUIZ2HD Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10843"; a="383996889" X-IronPort-AV: E=Sophos;i="6.03,174,1694761200"; d="scan'208";a="383996889" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 25 Sep 2023 05:22:19 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10843"; a="748330156" X-IronPort-AV: E=Sophos;i="6.03,174,1694761200"; d="scan'208";a="748330156" Received: from orsmsx603.amr.corp.intel.com ([10.22.229.16]) by orsmga002.jf.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 25 Sep 2023 05:22:19 -0700 Received: from orsmsx610.amr.corp.intel.com (10.22.229.23) 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.2507.32; Mon, 25 Sep 2023 05:22:18 -0700 Received: from orsmsx610.amr.corp.intel.com (10.22.229.23) by ORSMSX610.amr.corp.intel.com (10.22.229.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.32; Mon, 25 Sep 2023 05:22:18 -0700 Received: from ORSEDG602.ED.cps.intel.com (10.7.248.7) by orsmsx610.amr.corp.intel.com (10.22.229.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.32 via Frontend Transport; Mon, 25 Sep 2023 05:22:18 -0700 Received: from NAM12-MW2-obe.outbound.protection.outlook.com (104.47.66.46) 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.2507.32; Mon, 25 Sep 2023 05:22:17 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=UND5lzhTJmd/PEUOGbED3MVHLnvqMYaNU5bBi63Bv0+qLq1N+nxySdeX6OfEHjyw3slRJS17MCTIXcG05YbMMorbLY2rOu9IzqjdV5LPHkcpP0UlxUr+93QDsMlhHkwBsC1ws5HjG+EtPbGqHBiKWVaRQ38sVoE9ILlQNorN6ScKzdpx3UmZs4rfNAipzXeycByxhTZyrQWijxrQKT7HnuF+G9a0oz/vQv+5Krynh3nofu//exvONgYN78CWzcmT6xaYQYenelEyD0dn4YJ2GcYEtx4iLhFJcBKgPdZuHk6f126TEh7jA31xIrn8Yp0Qu7Ei/mIO3dmcwB/JrEvaHA== 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=qWhwYf5l1yJycR0fq6EPXshq3nDXTpzG+UFQQqPc2tw=; b=k/SYaexMv+57LYUVBVZUfHCmbBx658QSl34zbwB/H31oTCwpiqmXWian4PYkTnvS/bdmixzTgTMlToIQLIk7+RSJOrig+w3SlWUSNW95mInVmI6DYPF2/0L6MvckWQFav8pPFEesX/9Tyd0kjDpav5UP2AFQv2TB89zmrjJTpalcgjmUUUQlpvzMNyI50qEcoJ5BBMQ9/pxJ6SbODDegRuhs/zOayQ5Ke0zP+L3IFvzpK+u2NQIROjJHqKQ2bYqYQowGW/Sjdfbavh/KKz8qIOmv4/20VLX4wci7DXhDTwqMDuAdRnV/L4EZiF5mhIY31kEoU2P9F3kopZE3Cp5Jxg== 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 SA2PR11MB4940.namprd11.prod.outlook.com (2603:10b6:806:fa::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6813.20; Mon, 25 Sep 2023 12:22:15 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::43d1:af60:464:347]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::43d1:af60:464:347%5]) with mapi id 15.20.6768.029; Mon, 25 Sep 2023 12:22:15 +0000 Date: Mon, 25 Sep 2023 13:22:09 +0100 From: Bruce Richardson To: Ferruh Yigit CC: David Young , Subject: Re: [PATCH 3/6] Section 3: Setting up a System to Run DPDK Applications Message-ID: References: <20230920154817.617-1-dave@youngcopy.com> <20230920154817.617-4-dave@youngcopy.com> <1ce43f7f-4f28-4761-89dd-35816497006d@amd.com> Content-Type: text/plain; charset="us-ascii" Content-Disposition: inline In-Reply-To: <1ce43f7f-4f28-4761-89dd-35816497006d@amd.com> X-ClientProxiedBy: DU2PR04CA0193.eurprd04.prod.outlook.com (2603:10a6:10:28d::18) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|SA2PR11MB4940:EE_ X-MS-Office365-Filtering-Correlation-Id: 8a4175a2-9a09-4321-27c8-08dbbdc20daa X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: G9sJDHtcegcPWvpCiiyRyEpOZ5dXsPZL56VTdLwr0DjKtTbV6uNL43JsanhaMZP0rMeANjcXNLjZwcckzRTH8H3vXMvhy6RLA/OYreTVPy5B50tPp0yZpQfAS5bGgW4hO0dwO7h/wmhpgI1Wz1b09gHABerEeO4q1y8q4AvL346QUzyntJMkGrNqw8/8HYBT15xk5lU8yCvYz4APY0hO6JBhDxUyraIPAdrJH8hhTGP8SRO1NcV15wkc8hrz2s3BCaes2/5vA6UruR42+3PlH3q9o4seRzIgGYsSX/KY5xjJ5P8H3cM0tvORj0Fsr/6b4eKpX7SnUIp7V8mA1UzNcE3qUisC3hhZC2PEm926Ck0S06OrcR9UHE9mxXfO7lCP3Ela7aCIbifzHk+eaVK6Z8nY61riVpIEFBR5HMhX0JN/phWtVBmhkk3JNdfnSE6f+v9UpGjGnQZrY2d9fmfmZEqLnlSCZnhF7vhDg7A4NSzLIrGKlyXG5cHYC4p96qSVNDWSgxFnXP/65KGkzCBfchv09tG5Lq8y5x8PKmlvpabpN1NcRUuoSLUPXZCjqdfe 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)(346002)(376002)(136003)(396003)(366004)(39860400002)(230922051799003)(186009)(451199024)(1800799009)(26005)(5660300002)(38100700002)(41300700001)(2906002)(82960400001)(86362001)(4326008)(44832011)(8676002)(6512007)(6486002)(6666004)(478600001)(53546011)(6506007)(8936002)(316002)(6916009)(66556008)(66946007)(66476007); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?4/IRbEJ1c4o/dPrX8Mn5otVvQvQ8P7A6spG4uV2rPkqfWbp9aiqvgiqIN0I/?= =?us-ascii?Q?N/uUKmTCZ6FYwOo+gidhOJevPLpNFr8kD9Q0J1HvMB43tUBx6Vsm7NjEgn2Q?= =?us-ascii?Q?2ApYoxksa4g0NASLLHt0nAVngXT3iItLwfOoFZAo1ONkEIY15d680R2XPzos?= =?us-ascii?Q?e8FjxTXzsF26iCUbbNVl6crbZtJNQTZCNbBE994Y2fgivnnbhCb0S6NTSIsa?= =?us-ascii?Q?aHP/Ti/++WoypFCTZQewWcNjT6c1gD50aUG2vKXwhpKP2FLaPDYuIU19w9cC?= =?us-ascii?Q?O6Yc6OnRfiUXiyAAIKIbMnbz9gCguadch0bu5fXwqZDJtFKyDJZeBNQOGzPZ?= =?us-ascii?Q?4ylGMu39KZ/83CQyPHWg8RnCQjBqGpyDfv5t8giQqm0kYuVAbjprCYK4iZ2q?= =?us-ascii?Q?GeFICpaoLPS3alJvXDMelRso3NtRwllDOggjDWklWD3FxGE/RafkHVj72IR8?= =?us-ascii?Q?pN2xO5K/u5/xAGNtmsZ9INM633t5xrUkNXoACwEEREesfEqlq3+B69vdBLM7?= =?us-ascii?Q?MMgnjZ+VY1bPTaxMoheKTv7YbP4TqqAvpbx++ZSM9GW+kM+EuS+ZuVrV1hf/?= =?us-ascii?Q?SSMGccdMnUbNlIMqYazfAj3kPSrF0tKsFnj86KySCKZM8CgsRe3dI2aOKvuI?= =?us-ascii?Q?OUnrVoRd67RurcmNQRxnqGegjs8fjnENYmQ+4bUKgK04EElKPDhG/wiBwDIg?= =?us-ascii?Q?ye6aqdtbzBMDy3oGVE6t2+ksBExgyiLZ+XCgvm41SOo80BclYd3qrE9YFBhk?= =?us-ascii?Q?hgWRTTCYGC/zfNlfw+bZ+/9J1OFI3b5wiEA74IbKwOQ/09msithTjUqKm8AV?= =?us-ascii?Q?TUpZKx3nFMOgPIWaRboBWiVCVbWuMhzdcz0j4M9hdlXmRHAPIscAPztxsj/w?= =?us-ascii?Q?PmYvVHi+snKiEGTX14h38iZl7BaJXlIqCCNtsWEdoqH0pV9OT3aJlm+vW+RA?= =?us-ascii?Q?GVuGKiGIp2nkA44sbNbGMYKlCgQMoZ4vtsZ2QCSq2o5Sg/jmEAy8Byhw4Ga4?= =?us-ascii?Q?lQ2JKGs7oELHvMYumcbBafrwCkD7lb5H0hfukv2GzERVKaAGL38jgFSeNPVa?= =?us-ascii?Q?mWEeYFomU322NTO8i2hVZtjPjoXyqjnaCIT7hcenk+Qc+6fsdCFxvwBS3DhU?= =?us-ascii?Q?Zeu4Izvqb78oThyxLNyAEx0FEdkub7mv66X3HG5JHUfJJo8YGF7mUL23+H2s?= =?us-ascii?Q?TZWaBI/eCdNxdO22/UBFVzBtkQjflUnuJ7zK+Vs53tsJN1H48oedzccV19fw?= =?us-ascii?Q?psQAx9P/+Mvx4ZeNwezng8shKShz7jjFxXU/KT/2XckRO4ZpNmNzb0Rjnlp6?= =?us-ascii?Q?61iw2+JwMh+O/EEu9jsPMwgSjHjU9yz7pEfDaS5BZKTcOyH15L33sBdOHHE9?= =?us-ascii?Q?aOjuMvdG06e8sRpO+eaDa6vLhlavkEXhJOUBwhQrrVc/ak+RTqCQSf8zaBfr?= =?us-ascii?Q?69beiqPggrOosnwg9uSqXQrVgc4ZGfZxACfzaK3unXKyxySoxZTHibFFepJI?= =?us-ascii?Q?RZVs3IaLGndLmtHecLr5g+5wVWjBKWXhqhqO8LAFr3XdGb217+jPk6XBjMnV?= =?us-ascii?Q?1SAlDkMlHkqBWvK/bTzHoOpJaxSNqWgYhJHiAFS8qmGybsEy46+QtSDkEnPj?= =?us-ascii?Q?Ag=3D=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: 8a4175a2-9a09-4321-27c8-08dbbdc20daa X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Sep 2023 12:22:15.5638 (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: z+M9XkkrQ9hsBpJne7lDA39EN3XpMeMjKpfWRqXHXi466qNWFW4tViHA6y/VS5zMW7IWYbpIkzDuRHKWT5jka+1+AA9Rw1NUc9trNWL6ihk= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA2PR11MB4940 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 Mon, Sep 25, 2023 at 12:31:34PM +0100, Ferruh Yigit wrote: > On 9/20/2023 4:48 PM, David Young wrote: > > --- > > .../getting_started_guide/system_setup.rst | 195 ++++++++++++++++++ > > 1 file changed, 195 insertions(+) > > create mode 100644 doc/guides/getting_started_guide/system_setup.rst > > > > diff --git a/doc/guides/getting_started_guide/system_setup.rst b/doc/guides/getting_started_guide/system_setup.rst > > new file mode 100644 > > index 0000000000..fa9d249ec7 > > --- /dev/null > > +++ b/doc/guides/getting_started_guide/system_setup.rst > > @@ -0,0 +1,195 @@ > > +.. SPDX-License-Identifier: BSD-3-Clause > > + Copyright(c) 2010-2025 Intel Corporation. > > + > > +.. _memory_setup: > > + > > +.. |reg| unicode:: U+000AE > > + > > +Setting up a System to Run DPDK Applications > > +============================================ > > + > > +This section provides step-by-step instructions for setting up your system to run DPDK applications. It covers system configurations for Linux, FreeBSD, and Windows. Each section details the necessary memory and device setups for these operating systems. > > + > > +Navigate to the section that corresponds to your operating system to begin the setup process. > > + > > Not sure above sentences adds value. > > > > > +.. contents:: Table of Contents > > + :local: > > + > > +System Setup for Linux > > +---------------------- > > + > > +Memory Setup: Reserving Hugepages > > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > > + > > +For Linux, DPDK requires hugepages be reserved for its use on the system. To check if hugepages are are on your system, you can run the following command:: > > + > > + grep HugePages_Total /proc/meminfo > > + > > +If hugepages are not reserved, you will need to reserve them by following these steps: > > + > > +1. Determine the number of hugepages you want to allocate. For example, to allocate 1024 hugepages of 2MB each, you can use the following command:: > > + > > + echo 1024 | sudo tee /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages > > + > > +2. To make the hugepages configuration persistent across reboots, add the following line to your `/etc/sysctl.conf` file, adjusting the number of hugepages as needed:: > > + > > + vm.nr_hugepages = 1024 > > + > > +3. Most distributions make hugepages available via `/dev/hugepages`, so this step may not be necessary. If you need to manually mount the hugepages filesystem, add the following line to your `/etc/fstab` file:: > > + > > + nodev /mnt/huge hugetlbfs defaults 0 0 > > + > > + Then, create the mount directory and mount the filesystem:: > > + > > + mkdir -p /mnt/huge > > + mount -a > > + > > > > > We have './usertools/dpdk-hugepages.py' script for this, which I am > using regularly. > > Script is wrapper to what described above, so I think good to explain > basics, but also may worth mentioning from script, it is more user > friendly than above instructions. > Actually, if script can do all the basics - something I believe Stephen and Thomas also pointed out on a slack review earlier - then we should just drop the manual steps from here. If we think the script is sufficiently robust, we can drop them from the doc entirely, or if not, move them to an appendix which we reference here. /Bruce