16e1b58faSStephen Hemminger.. SPDX-License-Identifier: BSD-3-Clause 26e1b58faSStephen Hemminger Copyright (c) 2020 Microsoft Corporation 36e1b58faSStephen Hemminger 46e1b58faSStephen Hemmingerdpdk-hugepages Application 56e1b58faSStephen Hemminger========================== 66e1b58faSStephen Hemminger 76e1b58faSStephen HemmingerThe ``dpdk-hugepages`` tool is a Data Plane Development Kit (DPDK) utility 86e1b58faSStephen Hemmingerthat helps in reserving hugepages. 96e1b58faSStephen HemmingerAs well as checking for current settings. 106e1b58faSStephen Hemminger 116e1b58faSStephen Hemminger 126e1b58faSStephen HemmingerRunning the Application 136e1b58faSStephen Hemminger----------------------- 146e1b58faSStephen Hemminger 156e1b58faSStephen HemmingerThe tool has a number of command line options: 166e1b58faSStephen Hemminger 176e1b58faSStephen Hemminger.. code-block:: console 186e1b58faSStephen Hemminger 196e1b58faSStephen Hemminger dpdk-hugepages [options] 206e1b58faSStephen Hemminger 216e1b58faSStephen Hemminger 226e1b58faSStephen HemmingerOptions 236e1b58faSStephen Hemminger------- 246e1b58faSStephen Hemminger 256e1b58faSStephen Hemminger* ``-h, --help`` 266e1b58faSStephen Hemminger 276e1b58faSStephen Hemminger Display usage information and quit 286e1b58faSStephen Hemminger 296e1b58faSStephen Hemminger* ``-s, --show`` 306e1b58faSStephen Hemminger 316e1b58faSStephen Hemminger Print the current huge page configuration 326e1b58faSStephen Hemminger 336e1b58faSStephen Hemminger* ``-c driver, --clear`` 346e1b58faSStephen Hemminger 356e1b58faSStephen Hemminger Clear existing huge page reservation 366e1b58faSStephen Hemminger 376e1b58faSStephen Hemminger* ``-m, --mount`` 386e1b58faSStephen Hemminger 396e1b58faSStephen Hemminger Mount the huge page filesystem 406e1b58faSStephen Hemminger 416e1b58faSStephen Hemminger* ``-u, --unmount`` 426e1b58faSStephen Hemminger 436e1b58faSStephen Hemminger Unmount the huge page filesystem 446e1b58faSStephen Hemminger 456e1b58faSStephen Hemminger* ``-n NODE, --node=NODE`` 466e1b58faSStephen Hemminger 476e1b58faSStephen Hemminger Set NUMA node to reserve pages on 486e1b58faSStephen Hemminger 496e1b58faSStephen Hemminger* ``-p SIZE, --pagesize=SIZE`` 506e1b58faSStephen Hemminger 516e1b58faSStephen Hemminger Select hugepage size to use. 526e1b58faSStephen Hemminger If not specified the default system huge page size is used. 536e1b58faSStephen Hemminger 546e1b58faSStephen Hemminger* ``-r SIZE, --reserve=SIZE`` 556e1b58faSStephen Hemminger 566e1b58faSStephen Hemminger Reserve huge pages. 576e1b58faSStephen Hemminger Size is in bytes with K, M or G suffix. 586e1b58faSStephen Hemminger 596e1b58faSStephen Hemminger* ``--setup SIZE`` 606e1b58faSStephen Hemminger 616e1b58faSStephen Hemminger Short cut to clear, unmount, reserve and mount. 626e1b58faSStephen Hemminger 636e1b58faSStephen Hemminger.. warning:: 646e1b58faSStephen Hemminger 65*9c30a6f3SHenry Nadeau While any user can run the ``dpdk-hugepages.py`` script to view the 666e1b58faSStephen Hemminger status of huge pages, modifying the setup requires root privileges. 676e1b58faSStephen Hemminger 686e1b58faSStephen Hemminger 696e1b58faSStephen HemmingerExamples 706e1b58faSStephen Hemminger-------- 716e1b58faSStephen Hemminger 726e1b58faSStephen HemmingerTo display current huge page settings:: 736e1b58faSStephen Hemminger 74*9c30a6f3SHenry Nadeau dpdk-hugepages.py -s 756e1b58faSStephen Hemminger 766e1b58faSStephen HemmingerTo a complete setup of with 2 Gigabyte of 1G huge pages:: 776e1b58faSStephen Hemminger 78*9c30a6f3SHenry Nadeau dpdk-hugepages.py -p 1G --setup 2G 79