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 B395AA04B5; Wed, 9 Sep 2020 21:26:53 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7F9431BE0C; Wed, 9 Sep 2020 21:26:52 +0200 (CEST) Received: from mail-ot1-f66.google.com (mail-ot1-f66.google.com [209.85.210.66]) by dpdk.org (Postfix) with ESMTP id C91FB1DB8 for ; Wed, 9 Sep 2020 21:26:51 +0200 (CEST) Received: by mail-ot1-f66.google.com with SMTP id y5so3306909otg.5 for ; Wed, 09 Sep 2020 12:26:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=broadcom.com; s=google; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=r8JpCMAjepjMpt4tCismLyH7yzKQiChkwraTpSHXpw0=; b=h0tJTVKqGh2SUNcdMbBWtC04OZRiHit0QZjreC/KCMPAMC0uhZgMKdRBO06c1MH50W c/RYCJ0QgTFuVD3ncC2RfAf5NgXnpmdEWDt9BN8Nnakzmv3j5oJSVHW9XG6lQp1mMomi NKvsk5GowJPQiV3ePSOaGNdpD9SuP0PI/FYng= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=r8JpCMAjepjMpt4tCismLyH7yzKQiChkwraTpSHXpw0=; b=aU1t0eYZxpK51BzSkCHhBXXU+MdeoAgecoY0ByqOYxF7gncFJNZBoGcFaOwomD3OIo UFvLxLyk9ZQ0VHW9q99ElUeAOX94SWo3lHmpIC8IIcEV8hRZFPhI+lIs4j7PQFElFDyT 1Ptsm5P/68U3A5RKGNh4pYBvk0QPQ93i2JvphVAZiZYVpx0cL0yDXLxd2w5ulQUd3YKJ Wajp66AeuTcdwtZoC2+wqkS0S+2luCo48UQA5WOFlo+BemwhvKQjpNfjoZEXGMsDotSD jZpC4yTl3XJB6FXmf5CoC2rbIT+HN0aWJXY3BfdOBn/XXASjFctRcb7hNJKOcsvkE0eN optw== X-Gm-Message-State: AOAM5328BB/bnDjUgsfkHmaia7AZXQzqaOTcqaic7JYuuqz2Eycq17Bb MsBX0CC6UulolWtgvJYc9HzFEtrYafx/K3vlHBtoYbX2/WxK8A== X-Google-Smtp-Source: ABdhPJwhRopXVQ7OJtY/AnO9iFCDYqtWj4YT1trVrFdgXelAnscS9rUm9HlzvrmF0xpRA3yp33HIqnDT1BnktVSkgz8= X-Received: by 2002:a05:6830:1e0a:: with SMTP id s10mr1577040otr.95.1599679610859; Wed, 09 Sep 2020 12:26:50 -0700 (PDT) MIME-Version: 1.0 References: <20200901165643.15668-1-stephen@networkplumber.org> <20200908151707.18633-1-stephen@networkplumber.org> In-Reply-To: <20200908151707.18633-1-stephen@networkplumber.org> From: Ajit Khaparde Date: Wed, 9 Sep 2020 12:26:34 -0700 Message-ID: To: Stephen Hemminger Cc: dpdk-dev Content-Type: text/plain; charset="UTF-8" X-Content-Filtered-By: Mailman/MimeDel 2.1.15 Subject: Re: [dpdk-dev] [PATCH v6] usertools: add a 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" ::::snip:::: > > diff --git a/doc/guides/tools/hugepages.rst > b/doc/guides/tools/hugepages.rst > new file mode 100644 > index 000000000000..a82b71620011 > --- /dev/null > +++ b/doc/guides/tools/hugepages.rst > @@ -0,0 +1,79 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright (c) 2020 Microsoft Corporation > + > +dpdk-hugpages Application > Should this be dpdk-hugepages ? +========================== > + > +The ``dpdk-hugpages`` 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 > + > + > + dpdk-hugpages [options] > s/hugpages/hugepages ? > + > + > +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 ``dpdk-hugpages.py`` script to view the > + status of huge pages, modifying the setup requires root privileges. > + > + > +Examples > +-------- > + > +To display current huge page settings:: > + > + dpdk-hugpages.py -s > + > +To a complete setup of with 2 Gigabyte of 1G huge pages:: > + > + dpdk-hugpages.py -p 1G --setup 2G > > ::::snip:::: >