Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/84364/?format=api
{ "id": 84364, "url": "http://patchwork.dpdk.org/api/patches/84364/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/232d6d0413903434d0dcef516570d424d0dfab53.1605783141.git.anatoly.burakov@intel.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<232d6d0413903434d0dcef516570d424d0dfab53.1605783141.git.anatoly.burakov@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/232d6d0413903434d0dcef516570d424d0dfab53.1605783141.git.anatoly.burakov@intel.com", "date": "2020-11-19T10:52:45", "name": "[v4,2/2] doc/linux_gsg: update information on using hugepages", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "ea49470b474d9098602bc10d9463b34e8b46364f", "submitter": { "id": 4, "url": "http://patchwork.dpdk.org/api/people/4/?format=api", "name": "Burakov, Anatoly", "email": "anatoly.burakov@intel.com" }, "delegate": { "id": 1, "url": "http://patchwork.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/232d6d0413903434d0dcef516570d424d0dfab53.1605783141.git.anatoly.burakov@intel.com/mbox/", "series": [ { "id": 13976, "url": "http://patchwork.dpdk.org/api/series/13976/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=13976", "date": "2020-11-19T10:52:44", "name": "[v4,1/2] doc: clarify instructions on running as non-root", "version": 4, "mbox": "http://patchwork.dpdk.org/series/13976/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/84364/comments/", "check": "fail", "checks": "http://patchwork.dpdk.org/api/patches/84364/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from dpdk.org (dpdk.org [92.243.14.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 5B4B1A04DD;\n\tThu, 19 Nov 2020 11:53:18 +0100 (CET)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 09606C872;\n\tThu, 19 Nov 2020 11:52:54 +0100 (CET)", "from mga04.intel.com (mga04.intel.com [192.55.52.120])\n by dpdk.org (Postfix) with ESMTP id A3878F90;\n Thu, 19 Nov 2020 11:52:49 +0100 (CET)", "from orsmga006.jf.intel.com ([10.7.209.51])\n by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 19 Nov 2020 02:52:48 -0800", "from silpixa00399498.ir.intel.com (HELO\n silpixa00399498.ger.corp.intel.com) ([10.237.222.52])\n by orsmga006.jf.intel.com with ESMTP; 19 Nov 2020 02:52:47 -0800" ], "IronPort-SDR": [ "\n xkHbNcXrkqtgct+QuXCENYHx50hvF7+fx2W2Cl9Ygbbn/KFK4BHTo9pP9SEzDUKlUSDwj629BP\n 7fKKSvWck48A==", "\n jFuLp3jvRGspizkD6gyrtJWINfFb+AJFnwSLveyI5QoTSTW8brujK3SJHEXkDTbCCUeN9ZxoC3\n 3y7ZWAQfMXXw==" ], "X-IronPort-AV": [ "E=McAfee;i=\"6000,8403,9809\"; a=\"168697373\"", "E=Sophos;i=\"5.77,490,1596524400\"; d=\"scan'208\";a=\"168697373\"", "E=Sophos;i=\"5.77,490,1596524400\"; d=\"scan'208\";a=\"330894670\"" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "From": "Anatoly Burakov <anatoly.burakov@intel.com>", "To": "dev@dpdk.org", "Cc": "ferruh.yigit@intel.com, bruce.richardson@intel.com,\n padraig.j.connolly@intel.com, stable@dpdk.org", "Date": "Thu, 19 Nov 2020 10:52:45 +0000", "Message-Id": "\n <232d6d0413903434d0dcef516570d424d0dfab53.1605783141.git.anatoly.burakov@intel.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": [ "\n <863ac4ae1f8a1002b06e092cafba0ddaf6c7b1bd.1605783141.git.anatoly.burakov@intel.com>", "\n <242515b3b0d4ac57ee86cada96af90fb78e14997.1598363848.git.anatoly.burakov@intel.com>" ], "References": [ "\n <863ac4ae1f8a1002b06e092cafba0ddaf6c7b1bd.1605783141.git.anatoly.burakov@intel.com>", "\n <242515b3b0d4ac57ee86cada96af90fb78e14997.1598363848.git.anatoly.burakov@intel.com>" ], "Subject": "[dpdk-dev] [PATCH v4 2/2] doc/linux_gsg: update information on\n\tusing hugepages", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Current information regarding hugepage usage is a little out of date.\nUpdate it to include information on in-memory mode, as well as on\ndefault mountpoints provided by systemd.\n\nCc: stable@dpdk.org\n\nSigned-off-by: Anatoly Burakov <anatoly.burakov@intel.com>\nAcked-by: Bruce Richardson <bruce.richardson@intel.com>\n---\n\nNotes:\n v3:\n - Clarified wording around non-default hugepage sizes\n \n v2:\n - Reworked the description\n - Put runtime reservation first, and boot time as an alternative\n - Clarified wording and fixed typos\n - Mentioned that some kernel versions not supporting reserving 1G pages\n\n doc/guides/linux_gsg/sys_reqs.rst | 70 +++++++++++++++++++------------\n 1 file changed, 44 insertions(+), 26 deletions(-)", "diff": "diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst\nindex 6ecdc04aa9..3966c30456 100644\n--- a/doc/guides/linux_gsg/sys_reqs.rst\n+++ b/doc/guides/linux_gsg/sys_reqs.rst\n@@ -147,8 +147,35 @@ Without hugepages, high TLB miss rates would occur with the standard 4k page siz\n Reserving Hugepages for DPDK Use\n ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n \n-The allocation of hugepages should be done at boot time or as soon as possible after system boot\n-to prevent memory from being fragmented in physical memory.\n+The reservation of hugepages can be performed at run time. This is done by\n+echoing the number of hugepages required to a ``nr_hugepages`` file in the\n+``/sys/kernel/`` directory corresponding to a specific page size (in\n+Kilobytes). For a single-node system, the command to use is as follows\n+(assuming that 1024 of 2MB pages are required)::\n+\n+ echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages\n+\n+On a NUMA machine, the above command will usually divide the number of hugepages\n+equally across all NUMA nodes (assuming there is enough memory on all NUMA\n+nodes). However, pages can also be reserved explicitly on individual NUMA\n+nodes using a ``nr_hugepages`` file in the ``/sys/devices/`` directory::\n+\n+ echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages\n+ echo 1024 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages\n+\n+.. note::\n+\n+ Some kernel versions may not allow reserving 1 GB hugepages at run time, so\n+ reserving them at boot time may be the only option. Please see below for\n+ instructions.\n+\n+**Alternative:**\n+\n+In the general case, reserving hugepages at run time is perfectly fine, but in\n+use cases where having lots of physically contiguous memory is required, it is\n+preferable to reserve hugepages at boot time, as that will help in preventing\n+physical memory from becoming heavily fragmented.\n+\n To reserve hugepages at boot time, a parameter is passed to the Linux kernel on the kernel command line.\n \n For 2 MB pages, just pass the hugepages option to the kernel. For example, to reserve 1024 pages of 2 MB, use::\n@@ -177,35 +204,26 @@ the number of hugepages reserved at boot time is generally divided equally betwe\n \n See the Documentation/admin-guide/kernel-parameters.txt file in your Linux source tree for further details of these and other kernel options.\n \n-**Alternative:**\n-\n-For 2 MB pages, there is also the option of allocating hugepages after the system has booted.\n-This is done by echoing the number of hugepages required to a nr_hugepages file in the ``/sys/devices/`` directory.\n-For a single-node system, the command to use is as follows (assuming that 1024 pages are required)::\n-\n- echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages\n-\n-On a NUMA machine, pages should be allocated explicitly on separate nodes::\n-\n- echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages\n- echo 1024 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages\n-\n-.. note::\n-\n- For 1G pages, it is not possible to reserve the hugepage memory after the system has booted.\n-\n Using Hugepages with the DPDK\n ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n \n-Once the hugepage memory is reserved, to make the memory available for DPDK use, perform the following steps::\n+If secondary process support is not required, DPDK is able to use hugepages\n+without any configuration by using \"in-memory\" mode. Please see\n+:ref:`linux_eal_parameters` for more details.\n+\n+If secondary process support is required, mount points for hugepages need to be\n+created. On modern Linux distributions, a default mount point for hugepages is provided\n+by the system and is located at ``/dev/hugepages``. This mount point will use the\n+default hugepage size set by the kernel parameters as described above.\n+\n+However, in order to use hugepage sizes other than the default, it is necessary\n+to manually create mount points for those hugepage sizes (e.g. 1GB pages).\n+\n+To make the hugepages of size 1GB available for DPDK use, perform the following steps::\n \n mkdir /mnt/huge\n- mount -t hugetlbfs nodev /mnt/huge\n+ mount -t hugetlbfs pagesize=1GB /mnt/huge\n \n The mount point can be made permanent across reboots, by adding the following line to the ``/etc/fstab`` file::\n \n- nodev /mnt/huge hugetlbfs defaults 0 0\n-\n-For 1GB pages, the page size must be specified as a mount option::\n-\n- nodev /mnt/huge_1GB hugetlbfs pagesize=1GB 0 0\n+ nodev /mnt/huge hugetlbfs pagesize=1GB 0 0\n", "prefixes": [ "v4", "2/2" ] }