1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright (c) 2020 Microsoft Corporation 3 4dpdk-hugepages Application 5========================== 6 7The ``dpdk-hugepages`` tool is a Data Plane Development Kit (DPDK) utility 8that helps in reserving hugepages. 9As well as checking for current settings. 10 11 12Running the Application 13----------------------- 14 15The tool has a number of command line options: 16 17.. code-block:: console 18 19 dpdk-hugepages [options] 20 21 22Options 23------- 24 25* ``-h, --help`` 26 27 Display usage information and quit 28 29* ``-s, --show`` 30 31 Print the current huge page configuration 32 33* ``-c driver, --clear`` 34 35 Clear existing huge page reservation 36 37* ``-m, --mount`` 38 39 Mount the huge page filesystem 40 41* ``-u, --unmount`` 42 43 Unmount the huge page filesystem 44 45* ``-n NODE, --node=NODE`` 46 47 Set NUMA node to reserve pages on 48 49* ``-p SIZE, --pagesize=SIZE`` 50 51 Select hugepage size to use. 52 If not specified the default system huge page size is used. 53 54* ``-r SIZE, --reserve=SIZE`` 55 56 Reserve huge pages. 57 Size is in bytes with K, M or G suffix. 58 59* ``--setup SIZE`` 60 61 Short cut to clear, unmount, reserve and mount. 62 63.. warning:: 64 65 While any user can run the ``dpdk-hugepages.py`` script to view the 66 status of huge pages, modifying the setup requires root privileges. 67 68 69Examples 70-------- 71 72To display current huge page settings:: 73 74 dpdk-hugepages.py -s 75 76To a complete setup of with 2 Gigabyte of 1G huge pages:: 77 78 dpdk-hugepages.py -p 1G --setup 2G 79