From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id BDFBCA04BE; Sun, 6 Sep 2020 05:42:54 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id B86C32BF1; Sun, 6 Sep 2020 05:42:53 +0200 (CEST) Received: from mail-pl1-f171.google.com (mail-pl1-f171.google.com [209.85.214.171]) by dpdk.org (Postfix) with ESMTP id E18322BAB for ; Sun, 6 Sep 2020 05:42:51 +0200 (CEST) Received: by mail-pl1-f171.google.com with SMTP id m15so1817265pls.8 for ; Sat, 05 Sep 2020 20:42:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Yop7pRKwpPT2iWhHfreLDEfg3W9K61eqtSapXkhZ9Tg=; b=CsCOWUl4Fgz6i0TNy9atdkk2fRgV1c13raNw1esoY8tRr0ZfhVSvQTn0+tcpela5TB zdS53660civ2L6A3eFw2d3mQ0yor/E3nR+EobXRKPt6SDC8f5PYCt/rVIP3Ihn6SnIgs YKZfK2111SDPy+ze5y3q8y/XYRay/xk3HlUpvRInye76uYIK4FV+apGVyqMDiEJqaaev O07OXQKjSdgIU9bXCKJ/iEICrW1YpueHmWVG38MdNd9uVXZseavB73s+FqOriQgfizL/ MBduKqWSamK8lgE/DGp8zV8ZXaMhoK9cnxkU170frwNNwdixPmQt5iU5UmqRWP4TlF6Q B40g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Yop7pRKwpPT2iWhHfreLDEfg3W9K61eqtSapXkhZ9Tg=; b=i3tlZDbZKB5ZKni+RmDTBdQMpqhgOOzHeRn2RbNtHrqCUNgwDkJnz8tW9UfnqY7dm5 uG9D9B351KWNAEcZvZIZv3tDKnvxM8ertPJnS/jHxb4vO5TYJ7pTsc3Qsg6Q7GRxG9DT 1v26kLy8DWnKDwhKq+PXQDDhSZB4l+yMxCYJRTKkEsGEOSj87HCxg8ZUGn6iOQ8aaoZP MYH7wu6+cO/I6SijLL6Q7HLON1XDpRQQbHbVyYY2W6o2c+M/QjMZ05Dmd7k58/xTUJl4 CV0bu8u+kYLgCmKxOJQsJWYHMXBeY8KvazP1oGQddT5p6go3BKrbmDCERumJQLsq59aX iwfQ== X-Gm-Message-State: AOAM530udcezJH1vGPE8G/dsrDRy1qH0xRXGo+L+0xBVEIDAEbsjyxj3 7SyMmKAf50q2O8sLMVuPRA6ItTdmCk4kzg== X-Google-Smtp-Source: ABdhPJyttujPmzIrISLi+R48hnXu5wMOvs/k9pyxdrViWdPIlHNRUkYdNtrSM9tOz+oekz7t1KpOsw== X-Received: by 2002:a17:90a:634c:: with SMTP id v12mr14660847pjs.57.1599363770488; Sat, 05 Sep 2020 20:42:50 -0700 (PDT) Received: from hermes.lan (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id s8sm11874151pfd.153.2020.09.05.20.42.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 05 Sep 2020 20:42:49 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Date: Sat, 5 Sep 2020 20:42:47 -0700 Message-Id: <20200906034247.25111-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20200901165643.15668-1-stephen@networkplumber.org> References: <20200901165643.15668-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v5] usertools: add huge page setup script X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This is an improved version of the setup of huge pages bases on earlier DPDK setup. Differences are: * it autodetects NUMA vs non NUMA * it allows setting different page sizes recent kernels support multiple sizes. * it accepts a parameter in bytes (not pages). If necessary the steps of clearing old settings and mounting/umounting can be done individually. Signed-off-by: Stephen Hemminger --- v5 -- cleanup help messages add documentation and install script v4 -- more review feedback use argparser rather than getopt (thanks Bruce) silently handle already mounted type errors handle exceptions for permission and file not found fix numa bugs code now passes pylint v3 -- incorporate review feedback add missing SPDX and env header overengineer the memory prefix string code add numa node argument fix some pylint warnings doc/guides/tools/hugepagesetup.rst | 79 +++++++++ doc/guides/tools/index.rst | 1 + usertools/hugepage_setup.py | 271 +++++++++++++++++++++++++++++ usertools/meson.build | 7 +- 4 files changed, 357 insertions(+), 1 deletion(-) create mode 100644 doc/guides/tools/hugepagesetup.rst create mode 100755 usertools/hugepage_setup.py diff --git a/doc/guides/tools/hugepagesetup.rst b/doc/guides/tools/hugepagesetup.rst new file mode 100644 index 000000000000..b1a5a8993a25 --- /dev/null +++ b/doc/guides/tools/hugepagesetup.rst @@ -0,0 +1,79 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright (c) 2020 Microsoft Corporation + +hugepage_setup Application +========================== + +The ``hugepage_setup`` tool is a Data Plane Development Kit (DPDK) utility +that helps in reserving hugepages. +As well as checking for current settings. + + +Running the Application +----------------------- + +The tool has a number of command line options: + +.. code-block:: console + + + hugepage_setup [options] + + +OPTIONS +------- + +* ``-h, --help`` + + Display usage information and quit + +* ``-s, --show`` + + Print the current huge page configuration + +* ``-c driver, --clear`` + + Clear existing huge page reservation + +* ``-m, --mount`` + + Mount the huge page filesystem + +* ``-u, --unmount`` + + Unmount the huge page filesystem + +* ``-n NODE, --node=NODE`` + + Set NUMA node to reserve pages on + +* ``-p SIZE, --pagesize=SIZE`` + + Select hugepage size to use. + If not specified the default system huge page size is used. + +* ``-r SIZE, --reserve=SIZE`` + + Reserve huge pages. + Size is in bytes with K, M or G suffix. + +* ``--setup SIZE`` + + Short cut to clear, unmount, reserve and mount. + +.. warning:: + + While any user can run the ``hugepage_setup`` script to view the + status of huge pages, modifying the setup requires root privileges. + + +Examples +-------- + +To display current huge page settings:: + + hugepage_setup -s + +To a complete setup of with 2 Gigabyte of 1G huge pages:: + + hugepage_setup -p 1G --setup 2G diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst index c721943606f9..25c953ab01d4 100644 --- a/doc/guides/tools/index.rst +++ b/doc/guides/tools/index.rst @@ -11,6 +11,7 @@ DPDK Tools User Guides proc_info pdump pmdinfo + hugepagesetup devbind flow-perf testbbdev diff --git a/usertools/hugepage_setup.py b/usertools/hugepage_setup.py new file mode 100755 index 000000000000..bec010883e63 --- /dev/null +++ b/usertools/hugepage_setup.py @@ -0,0 +1,271 @@ +#! /usr/bin/env python3 +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2020 Microsoft Corporation +"""Script to query and setup huge pages for DPDK applications.""" + +import argparse +import glob +import os +import re +import sys +from math import log2 + +# Standard binary prefix +BINARY_PREFIX = "KMG" + +# systemd mount point for huge pages +HUGE_MOUNT = "/dev/hugepages" + + +def fmt_memsize(sz_k): + '''Format memory size in kB into conventional format''' + if sz_k.isdigit(): + return int(sz_k) / 1024 + logk = int(log2(sz_k) / 10) + return '{}{}b'.format(int(sz_k / (2**(logk * 10))), BINARY_PREFIX[logk]) + + +def get_memsize(arg): + '''Convert memory size with suffix to kB''' + match = re.match(r'(\d+)([' + BINARY_PREFIX + r']?)$', arg.upper()) + if match is None: + sys.exit('{} is not a valid page size'.format(arg)) + num = float(match.group(1)) + suffix = match.group(2) + if suffix == "": + return int(num / 1024) + idx = BINARY_PREFIX.find(suffix) + return int(num * (2**(idx * 10))) + + +def is_numa(): + '''Test if NUMA is necessary on this system''' + return os.path.exists('/sys/devices/system/node') + + +def get_hugepages(path): + '''Read number of reserved pages''' + with open(path + '/nr_hugepages') as nr_hugpages: + return int(nr_hugpages.read()) + return 0 + + +def set_hugepages(path, pages): + '''Write the number of reserved huge pages''' + filename = path + '/nr_hugepages' + try: + with open(filename, 'w') as nr_hugpages: + nr_hugpages.write('{}\n'.format(pages)) + except PermissionError: + sys.exit('Permission denied: need to be root!') + except FileNotFoundError: + filename = os.path.basename(path) + size = filename[10:] + sys.exit('{} is not a valid system huge page size'.format(size)) + + +def show_numa_pages(): + '''Show huge page reservations on Numa system''' + print('Node Pages Size') + for numa_path in glob.glob('/sys/devices/system/node/node*'): + node = numa_path[29:] # slice after /sys/devices/system/node/node + path = numa_path + '/hugepages' + for hdir in os.listdir(path): + pages = get_hugepages(path + '/' + hdir) + if pages > 0: + pg_sz = fmt_memsize( + hdir[10:-2]) # slice out of hugepages-NNNkB + print('{:<4} {:<5} {}'.format(node, pages, pg_sz)) + + +def show_non_numa_pages(): + '''Show huge page reservations on non Numa system''' + print('Pages Size') + path = '/sys/kernel/mm/hugepages' + for hdir in os.listdir(path): + pages = get_hugepages(path + '/' + hdir) + if pages > 0: + pg_sz = fmt_memsize(int(hdir[10:-2])) + print('{:<5} {}'.format(pages, pg_sz)) + + +def show_pages(): + '''Show existing huge page settings''' + if is_numa(): + show_numa_pages() + else: + show_non_numa_pages() + + +def clear_pages(): + '''Clear all existing huge page mappings''' + if is_numa(): + dirs = glob.glob( + '/sys/devices/system/node/node*/hugepages/hugepages-*') + else: + dirs = glob.glob('/sys/kernel/mm/hugepages/hugepages-*') + + for path in dirs: + set_hugepages(path, 0) + + +def default_pagesize(): + '''Get default huge page size from /proc/meminfo''' + with open('/proc/meminfo') as meminfo: + for line in meminfo: + if line.startswith('Hugepagesize:'): + return int(line.split()[1]) + return None + + +def set_numa_pages(pages, hugepgsz, node=None): + '''Set huge page reservation on Numa system''' + if node: + nodes = ['/sys/devices/system/node/node{}/hugepages'.format(node)] + else: + nodes = glob.glob('/sys/devices/system/node/node*/hugepages') + + for node_path in nodes: + huge_path = '{}/hugepages-{}kB'.format(node_path, hugepgsz) + set_hugepages(huge_path, pages) + + +def set_non_numa_pages(pages, hugepgsz): + '''Set huge page reservation on non Numa system''' + path = '/sys/kernel/mm/hugepages/hugepages-{}kB'.format(hugepgsz) + set_hugepages(path, pages) + + +def reserve_pages(pages, hugepgsz, node=None): + '''Sets the number of huge pages to be reserved''' + if node or is_numa(): + set_numa_pages(pages, hugepgsz, node=node) + else: + set_non_numa_pages(pages, hugepgsz) + + +def get_mountpoints(): + '''get list of of where hugepage filesystem is mounted''' + mounted = [] + with open('/proc/mounts') as mounts: + for line in mounts: + fields = line.split() + if fields[2] != 'hugetlbfs': + continue + mounted.append(fields[1]) + return mounted + + +def mount_huge(pagesize, mountpoint): + '''mount the huge tlb file system''' + if mountpoint in get_mountpoints(): + print(mountpoint, "already mounted") + return + cmd = "mount -t hugetlbfs" + if pagesize: + cmd += ' -o pagesize={}'.format(pagesize * 1024) + cmd += ' nodev ' + mountpoint + os.system(cmd) + + +def umount_huge(mountpoint): + '''unmount the huge tlb file system (if mounted)''' + if mountpoint in get_mountpoints(): + os.system("umount " + mountpoint) + + +def show_mount(): + '''Show where huge page filesystem is mounted''' + mounted = get_mountpoints() + if mounted: + print("Hugepages mounted on", *mounted) + else: + print("Hugepages not mounted") + + +def main(): + '''Process the command line arguments and setup huge pages''' + argv0 = os.path.basename(sys.argv[0]) + parser = argparse.ArgumentParser( + formatter_class=argparse.RawDescriptionHelpFormatter, + description="Setup huge pages", + epilog=""" +Examples: + +To display current huge page settings: + %(prog)s -s + +To a complete setup of with 2 Gigabyte of 1G huge pages: + %(prog)s -p 1G --setup 2G +""") + parser.add_argument( + '--show', + '-s', + action='store_true', + help="print the current huge page configuration") + parser.add_argument( + '--clear', '-c', action='store_true', help="clear existing huge pages") + parser.add_argument( + '--mount', + '-m', + action='store_true', + help='mount the huge page filesystem') + parser.add_argument( + '--unmount', + '-u', + action='store_true', + help='unmount the system huge page directory') + parser.add_argument( + '--node', + '-n', + help='select numa node to reserve pages on') + parser.add_argument( + '--pagesize', + '-p', + metavar='SIZE', + help='choose huge page size to use') + parser.add_argument( + '--reserve', + '-r', + metavar='SIZE', + help='reserve huge pages. Size is in bytes with K, M, or G suffix') + parser.add_argument( + '--setup', + metavar='SIZE', + help='setup huge pages by doing clear, unmount, reserve and mount') + args = parser.parse_args() + + if args.setup: + args.clear = True + args.unmount = True + args.reserve = args.setup + args.mount = True + + if args.pagesize: + pagesize_kb = get_memsize(args.pagesize) + else: + pagesize_kb = default_pagesize() + + if args.clear: + clear_pages() + if args.unmount: + umount_huge(HUGE_MOUNT) + + if args.reserve: + reserve_kb = get_memsize(args.reserve) + if reserve_kb % pagesize_kb != 0: + sys.exit( + 'Huge reservation {}kB is not a multiple of page size {}kB'. + format(reserve_kb, pagesize_kb)) + reserve_pages( + int(reserve_kb / pagesize_kb), pagesize_kb, node=args.node) + if args.mount: + mount_huge(pagesize_kb, HUGE_MOUNT) + if args.show: + show_pages() + print() + show_mount() + + +if __name__ == "__main__": + main() diff --git a/usertools/meson.build b/usertools/meson.build index 64e27238f45b..2bf2aeace5b5 100644 --- a/usertools/meson.build +++ b/usertools/meson.build @@ -1,4 +1,9 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -install_data(['dpdk-devbind.py', 'dpdk-pmdinfo.py', 'dpdk-telemetry.py'], install_dir: 'bin') +install_data([ + 'dpdk-devbind.py', + 'dpdk-pmdinfo.py', + 'dpdk-telemetry.py', + 'hugepage_setup.py' +],install_dir: 'bin') -- 2.27.0